Enable the context middleware from loopback.rest

strongloop · Nov 5, 2014 · 885f4e0 · 885f4e0
1 parent 246f38c
commit 885f4e0
Show file tree

Hide file tree

Showing 4 changed files with 145 additions and 74 deletions.
diff --git a/example/client-server/server.js b/example/client-server/server.js
@@ -5,13 +5,7 @@ var memory = loopback.createDataSource({
   connector: loopback.Memory
 });
 
-server.use(loopback.context());
-server.use(function(req, res, next) {
-  loopback.getCurrentContext().set('http', {req: req, res: res});
-  next();
-});
-
-server.use(loopback.rest());
+server.use(loopback.rest({context: {enableHttpContext: true}}));
 server.model(CartItem);
 
 CartItem.attachTo(memory);

diff --git a/lib/middleware/context.js b/lib/middleware/context.js
@@ -7,33 +7,42 @@ module.exports = context;
 
 var name = 'loopback';
 
-function context(options) {
-  options = options || {};
-  var scope = options.name || name;
-  var enableHttpContext = options.enableHttpContext || false;
-  var ns = cls.createNamespace(scope);
-
+function createContext(scope) {
   // Make the namespace globally visible via the process.context property
   process.context = process.context || {};
-  process.context[scope] = ns;
-
-  // Set up loopback.getCurrentContext()
-  loopback.getCurrentContext = function() {
-    return ns;
-  };
+  var ns = process.context[scope];
+  if (!ns) {
+    ns = cls.createNamespace(scope);
+    process.context[scope] = ns;
+    // Set up loopback.getCurrentContext()
+    loopback.getCurrentContext = function() {
+      return ns;
+    };
 
-  chain(juggler);
-  chain(remoting);
+    chain(juggler);
+    chain(remoting);
+  }
+  return ns;
+}
 
+function context(options) {
+  options = options || {};
+  var scope = options.name || name;
+  var enableHttpContext = options.enableHttpContext || false;
+  var ns = createContext(scope);
   // Return the middleware
-  return function(req, res, next) {
+  return function contextHandler(req, res, next) {
+    if (req.loopbackContext) {
+      return next();
+    }
+    req.loopbackContext = ns;
     // Bind req/res event emitters to the given namespace
     ns.bindEmitter(req);
     ns.bindEmitter(res);
     // Create namespace for the request context
-    ns.run(function(context) {
+    ns.run(function processRequestInContext(context) {
       // Run the code in the context of the namespace
-      if(enableHttpContext) {
+      if (enableHttpContext) {
         ns.set('http', {req: req, res: res}); // Set up the transport context
       }
       next();
@@ -59,22 +68,22 @@ function ChainedContext(child, parent) {
  * @param {String} name Name of the context property
  * @returns {*} Value of the context property
  */
-ChainedContext.prototype.get = function (name) {
+ChainedContext.prototype.get = function(name) {
   var val = this.child && this.child.get(name);
   if (val === undefined) {
     return this.parent && this.parent.get(name);
   }
 };
 
-ChainedContext.prototype.set = function (name, val) {
+ChainedContext.prototype.set = function(name, val) {
   if (this.child) {
     return this.child.set(name, val);
   } else {
     return this.parent && this.parent.set(name, val);
   }
 };
 
-ChainedContext.prototype.reset = function (name, val) {
+ChainedContext.prototype.reset = function(name, val) {
   if (this.child) {
     return this.child.reset(name, val);
   } else {

diff --git a/lib/middleware/rest.js b/lib/middleware/rest.js
@@ -3,6 +3,7 @@
  */
 
 var loopback = require('../loopback');
+var async = require('async');
 
 /*!
  * Export the middleware.
@@ -21,17 +22,32 @@ module.exports = rest;
  * @header loopback.rest()
  */
 
-function rest() {
+function rest(options) {
+  options = options || {};
   var tokenParser = null;
-  return function(req, res, next) {
+  var contextHandler = null;
+  if (options.context) {
+    var contextOptions = options.context;
+    if(typeof contextOptions !== 'object') {
+      contextOptions = {};
+    }
+    contextHandler = loopback.context(contextOptions);
+  }
+  return function restApiHandler(req, res, next) {
     var app = req.app;
     var handler = app.handler('rest');
 
     if (req.url === '/routes') {
-      res.send(handler.adapter.allRoutes());
+      return res.send(handler.adapter.allRoutes());
     } else if (req.url === '/models') {
       return res.send(app.remotes().toJSON());
-    } else if (app.isAuthEnabled) {
+    }
+
+    var handlers = [];
+    if (options.context) {
+      handlers.push(contextHandler);
+    }
+    if (app.isAuthEnabled) {
       if (!tokenParser) {
         // NOTE(bajtos) It would be better to search app.models for a model
         // of type AccessToken instead of searching all loopback models.
@@ -41,17 +57,12 @@ function rest() {
         // https://github.com/strongloop/loopback/commit/f07446a
         var AccessToken = loopback.getModelByType(loopback.AccessToken);
         tokenParser = loopback.token({ model: AccessToken });
+        handlers.push(tokenParser);
       }
-
-      tokenParser(req, res, function(err) {
-        if (err) {
-          next(err);
-        } else {
-          handler(req, res, next);
-        }
-      });
-    } else {
-      handler(req, res, next);
     }
+    handlers.push(handler);
+    async.eachSeries(handlers, function(handler, done) {
+      handler(req, res, done);
+    }, next);
   };
 }
diff --git a/test/rest.middleware.test.js b/test/rest.middleware.test.js
@@ -130,46 +130,103 @@ describe('loopback.rest', function() {
     });
   });
 
-  it('should pass req to remote method via context', function(done) {
-    var User = givenUserModelWithAuth();
-    User.getToken = function(cb) {
-      var context = loopback.getCurrentContext();
-      var req = context.get('http').req;
-      expect(req).to.have.property('accessToken');
+  describe('context propagation', function() {
+    var User;
 
-      var juggler = require('loopback-datasource-juggler');
-      expect(juggler.getCurrentContext().get('http').req)
-        .to.have.property('accessToken');
+    beforeEach(function() {
+      User = givenUserModelWithAuth();
+      User.getToken = function(cb) {
+        var context = loopback.getCurrentContext();
+        var req = context.get('http').req;
+        expect(req).to.have.property('accessToken');
 
-      var remoting = require('strong-remoting');
-      expect(remoting.getCurrentContext().get('http').req)
-        .to.have.property('accessToken');
+        var juggler = require('loopback-datasource-juggler');
+        expect(juggler.getCurrentContext().get('http').req)
+          .to.have.property('accessToken');
 
-      cb(null, req && req.accessToken ? req.accessToken.id : null);
-    };
-    // Set up the ACL
-    User.settings.acls.push({principalType: 'ROLE',
-      principalId: '$authenticated', permission: 'ALLOW', property: 'getToken'});
+        var remoting = require('strong-remoting');
+        expect(remoting.getCurrentContext().get('http').req)
+          .to.have.property('accessToken');
 
-    loopback.remoteMethod(User.getToken, {
-      accepts: [],
-      returns: [{ type: 'object', name: 'id' }]
+        cb(null, req && req.accessToken ? req.accessToken.id : null);
+      };
+      // Set up the ACL
+      User.settings.acls.push({principalType: 'ROLE',
+        principalId: '$authenticated', permission: 'ALLOW',
+        property: 'getToken'});
+
+      loopback.remoteMethod(User.getToken, {
+        accepts: [],
+        returns: [
+          { type: 'object', name: 'id' }
+        ]
+      });
     });
 
-    app.use(loopback.context({enableHttpContext: true}));
-    app.enableAuth();
-    app.use(loopback.rest());
+    function invokeGetToken(done) {
+      givenLoggedInUser(function(err, token) {
+        if (err) return done(err);
+        request(app).get('/users/getToken')
+          .set('Authorization', token.id)
+          .expect(200)
+          .end(function(err, res) {
+            if (err) return done(err);
+            expect(res.body.id).to.equal(token.id);
+            done();
+          });
+      });
+    }
 
-    givenLoggedInUser(function(err, token) {
-      if (err) return done(err);
-      request(app).get('/users/getToken')
-        .set('Authorization', token.id)
-        .expect(200)
-        .end(function(err, res) {
-          if (err) return done(err);
-          expect(res.body.id).to.equal(token.id);
-          done();
-        });
+    it('should enable context using loopback.context', function(done) {
+      app.use(loopback.context({enableHttpContext: true}));
+      app.enableAuth();
+      app.use(loopback.rest());
+
+      invokeGetToken(done);
+    });
+
+    it('should enable context with loopback.rest', function(done) {
+      app.enableAuth();
+      app.use(loopback.rest({context: {enableHttpContext: true}}));
+
+      invokeGetToken(done);
+    });
+
+    it('should support explicit context', function(done) {
+      app.enableAuth();
+      app.use(loopback.context());
+      app.use(loopback.token(
+        { model: loopback.getModelByType(loopback.AccessToken) }));
+      app.use(function(req, res, next) {
+        loopback.getCurrentContext().set('accessToken', req.accessToken);
+        next();
+      });
+      app.use(loopback.rest());
+
+      User.getToken = function(cb) {
+        var context = loopback.getCurrentContext();
+        var accessToken = context.get('accessToken');
+        expect(context.get('accessToken')).to.have.property('id');
+
+        var juggler = require('loopback-datasource-juggler');
+        context = juggler.getCurrentContext();
+        expect(context.get('accessToken')).to.have.property('id');
+
+        var remoting = require('strong-remoting');
+        context = remoting.getCurrentContext();
+        expect(context.get('accessToken')).to.have.property('id');
+
+        cb(null, accessToken ? accessToken.id : null);
+      };
+
+      loopback.remoteMethod(User.getToken, {
+        accepts: [],
+        returns: [
+          { type: 'object', name: 'id' }
+        ]
+      });
+
+      invokeGetToken(done);
     });
   });