express-logical-routes

    0.0.4 • Public • Published

    Build Status NPM version

    Express Logical Routes

    A library for building middleware as a series of logic gates to reduce and reuse code.

    Getting Started

    > npm install
    > npm test
    

    Typical Middleware

    Typically writing business rules in your routes may look like this.

     
    app.put('/user/:id/edit', getUser, editUser )
     
    app.post('/user/:id/items', getUser, addItem )
     
    function editUser (req, res) {
        if (!(req.currentUser.isAdmin || req.currentUser.id == req.user.id))
            return next(Error('Unauthorized'))
        util.extend(req.user, req.body)
        req.user.save(function (err) {
            res.redirect('/user/'+req.user.id);
        })
    }
     
    function addItem (req, res) {
        if (!(req.currentUser.isAdmin || req.currentUser.id == req.user.id))
            return next(Error('Unauthorized'))
        UserItem(req.body).save(function (err, doc) {
            res.redirect('/user/'+req.user.id+'/item/'+doc._id);
        })
    }
     
    //And so on!

    Notice we have duplicated this line

    if (!(req.currentUser.isAdmin || req.currentUser.id == req.user.id))
        return next(Error('Unauthorized'))

    Instead of copying and pasting that logic around we can put it into middleware functions

    var isAdmin = function (req, res, next) { next(req.user.isAdmin) }
      , isSameUser = function (req, res, next) { next(req.user.id == req.target.id) }

    Now lets wrap those logical tests into an or()

    app.put('/user/:id/edit', getUser, or(isAdmin, isSameUser).then(editUser))
     
    app.post('/user/:id/items', getUser, or(isAdmin, isSameUser).then(addItem))
     
    //we took out the busness logic out of our domain logic
     
    function editUser (req, res, next) {
        util.extend(req.user, req.body)
        req.user.save(function (err) {
            res.redirect('/user/'+req.user.id);
        })
    }
     
    function addItem (req, res, next) {
        UserItem(req.body).save(function (err, doc) {
            res.redirect('/user/'+req.user.id+'/item/'+doc._id);
        })
    }

    Or we could combine the isAdmin and isSameUser into a middleware

    var isValidUser = or(isAdmin, isSameUser)

    and then apply it

    app.put('/user/:id/edit', getUser, isValidUser().succeed(editUser))
     
    app.post('/user/:id/items', getUser, isValidUser().succeed(addItem))

    Here we used the "succeed()" method to editUser and addItem, we can also support a failure

    NOTE that we called isValidUser() with no arguments. This creates a new middlware that we can attach succeed(), failure(), and then() methods to.

    app.put('/user/:id/edit', getUser, isValidUser().succeed(editUser).failure(goAway))
     
    app.post('/user/:id/items', getUser, isValidUser().succeed(addItem).failure(goAway))

    Say we want to combine all this logic into a single object

    var getAndValidateUser = [getUser, or(isAdmin, isSameUser).failure(goAway)];
     
    app.put('/user/:id/edit', getAndValidateUser , editUser)
     
    app.post('/user/:id/items', getAndValidateUser, addItem)

    API Documentation

    fn(method)

    This method will build us a function that will internally used the passed async method

    e.g.

    var every = fn('every')
        , validUser = every( isLoggedIn, isAllowed )

    This object has the following chainable methods

    succeed(fn)

    When the operation succeeds, the passed method will be called

    validUser.succeed(function (req, res, next) { /* do something */ next() })

    failure(fn)

    When the operation fails, the passed method will be called

    validUser.failure(function (req, res, next) { /* do something with the errors */ next() })

    The errors are stored on the request object

    validUser.failure(function (req, res, next) {
        res.status(400).json(req.errors);
    });

    Say we have defined this middleware

    var validUser = every( isLoggedIn, isAllowed )
        .failure(function (req, res, next) { res.redirect('/login') })

    And we want to reuse it but change how we handle the failure.
    For instance we want to return a JSON response for our 'v1' api and a redirect to the login page for the standard interface.

    app.get('/resource/:id', validUser, getResource); 
    app.get('/v1/resource/:id', validUser.failure(function (req, res, next) { 
        res.status(403).json(new Error('You must be logged in')) }), getResource);

    By doing this we are actually replacing the failure function for validUser. If we want to reuse the logic but modify either "failure", "succeed", or "then" methods, we can call the middleware without parameters to clone it.

    var validUserClone = validUser();

    Now we can modify the "failure" method

    validUserClone.failure(function (req, res, next) {
        res.status(403).json(new Error('You must be logged in'))
    })

    We can easily take our previous example and do

    app.get('/resource/:id', validUser, getResource); 
    app.get('/v1/resource/:id', validUser().failure(function (req, res, next) { 
        res.status(403).json(new Error('You must be logged in')) }), getResource);

    Better yet

    app.get('/resource/:id', validUser, getResource); 
    app.get('/v1/resource/:id', validUser().failure(die), getResource);
     
    function die (req, res, next) {
        res.status(403).json(new Error('You must be logged in')) }
    }

    All of theses capabilities are inherited to the other logic operators

    then(fn)

    After the succeed() or failure() method is called then the fn() passed will be called

    validUser
        .succeed(function (req, res, next) { 
            req.awesome = true
        })
        .then(function (req,res) { 
            res.json({awesome:req.awesome}) 
        })

    and(...)

    This method will produce an object with the same chainable functions as the result of fn('every')

    var validUser = and (isLoggedIn, isAllowedToView)
        .failure(function (req, res) { 
            res.status(403).json(req.errors)
        })
     
    app.get('/resource/:id', validUser, getResource);

    or(...)

    This method will produce an object with the same chainable functions as the result of fn('some')

    var validUser = or (isAdmin, isAllowedToView )
     
    app.get('/resource/:id', validUser, getResource);

    not(...)

    This method will produce an object with the same chainable functions as the result of fn('every') but only supports one middleware function

    var notLoggedIn = not(isLoggedIn);
     
    app.get('/resource/:id', notLoggedIn.succeed(showLogin), validUser, getResource);

    Install

    npm i express-logical-routes

    DownloadsWeekly Downloads

    5

    Version

    0.0.4

    License

    ISC

    Last publish

    Collaborators

    • nromano