Decorate request. Closes hapijs#2481

hueniverse · hueniverse · commit 5f032a33ddd1 · 2015-05-21T11:41:12.000-07:00
diff --git a/lib/connection.js b/lib/connection.js
@@ -12,7 +12,6 @@ var Shot = require('shot');
 var Statehood = require('statehood');
 var Topo = require('topo');
 var Auth = require('./auth');
-var Request = require('./request');
 var Route = require('./route');
 var Schema = require('./schema');
 
@@ -212,7 +211,7 @@ internals.Connection.prototype._dispatch = function (options) {
 
         // Create request
 
-        var request = new Request(self, req, res, options);
+        var request = self.server._requestor.request(self, req, res, options);
 
         // Check load
 
diff --git a/lib/plugin.js b/lib/plugin.js
@@ -289,11 +289,17 @@ internals.Plugin.prototype.cache = function (options, _segment) {
 
 internals.Plugin.prototype.decorate = function (type, property, method) {
 
-    Hoek.assert(type === 'reply' || type === 'server', 'Unknown decoration type:', type);
+    Hoek.assert(['reply', 'request', 'server'].indexOf(type) !== -1, 'Unknown decoration type:', type);
     Hoek.assert(property, 'Missing decoration property name');
     Hoek.assert(typeof property === 'string', 'Decoration property must be a string');
     Hoek.assert(property[0] !== '_', 'Property name cannot begin with an underscore:', property);
 
+    // Request
+
+    if (type === 'request') {
+        return this.root._requestor.decorate(property, method);
+    }
+
     // Reply
 
     if (type === 'reply') {
diff --git a/lib/reply.js b/lib/reply.js
@@ -11,15 +11,16 @@ var internals = {};
 
 exports = module.exports = internals.Reply = function () {
 
-    this._decorations = {};
+    this._decorations = null;
 };
 
 
 internals.Reply.prototype.decorate = function (property, method) {
 
-    Hoek.assert(!this._decorations[property], 'Reply interface decoration already defined:', property);
+    Hoek.assert(!this._decorations || !this._decorations[property], 'Reply interface decoration already defined:', property);
     Hoek.assert(['request', 'response', 'close', 'state', 'unstate', 'redirect', 'continue'].indexOf(property) === -1, 'Cannot override built-in reply interface decoration:', property);
 
+    this._decorations = this._decorations || {};
     this._decorations[property] = method;
 };
 
@@ -80,10 +81,12 @@ internals.Reply.prototype.interface = function (request, realm, next) {       //
     reply.redirect = internals.redirect;
     reply.continue = internals.continue;
 
-    var methods = Object.keys(this._decorations);
-    for (var i = 0, il = methods.length; i < il; ++i) {
-        var method = methods[i];
-        reply[method] = this._decorations[method];
+    if (this._decorations) {
+        var methods = Object.keys(this._decorations);
+        for (var i = 0, il = methods.length; i < il; ++i) {
+            var method = methods[i];
+            reply[method] = this._decorations[method];
+        }
     }
 
     return reply;
diff --git a/lib/request.js b/lib/request.js
@@ -17,10 +17,46 @@ var Transmit = require('./transmit');
 
 // Declare internals
 
-var internals = {};
+var internals = {
+    properties: ['connection', 'server', 'url', 'query', 'path', 'method', 'mime', 'setUrl', 'setMethod', 'headers', 'id', 'app', 'plugins', 'route', 'auth', 'session', 'pre', 'preResponses', 'info', 'orig', 'params', 'paramsArray', 'payload', 'state', 'jsonp', 'response', 'raw', 'tail', 'addTail', 'domain', 'log', 'getLog', 'generateResponse']
+};
+
+
+exports = module.exports = internals.Generator = function () {
+
+    this._decorations = null;
+};
+
+
+internals.Generator.prototype.request = function (connection, req, res, options) {
+
+    var request = new internals.Request(connection, req, res, options);
+
+    // Decorate
+
+    if (this._decorations) {
+        var methods = Object.keys(this._decorations);
+        for (var i = 0, il = methods.length; i < il; ++i) {
+            var method = methods[i];
+            request[method] = this._decorations[method];
+        }
+    }
 
+    return request;
+};
+
+
+internals.Generator.prototype.decorate = function (property, method) {
+
+    Hoek.assert(!this._decorations || !this._decorations[property], 'Request interface decoration already defined:', property);
+    Hoek.assert(internals.properties.indexOf(property) === -1, 'Cannot override built-in request interface decoration:', property);
+
+    this._decorations = this._decorations || {};
+    this._decorations[property] = method;
+};
 
-exports = module.exports = internals.Request = function (connection, req, res, options) {
+
+internals.Request = function (connection, req, res, options) {
 
     var self = this;
 
@@ -89,16 +125,11 @@ exports = module.exports = internals.Request = function (connection, req, res, o
     if (options.credentials) {
         this.auth.credentials = options.credentials;
     }
-    if (options.artifacts) {
-        this.auth.artifacts = options.artifacts;
-    }
-
 
     if (options.artifacts) {
         this.auth.artifacts = options.artifacts;
     }
 
-
     // Assigned elsewhere:
 
     this.orig = {};
@@ -314,7 +345,7 @@ internals.Request.prototype._execute = function () {
             serverTimeout = Math.floor(serverTimeout - self._bench.elapsed());      // Calculate the timeout from when the request was constructed
             var timeoutReply = function () {
 
-                self._log(['request', 'server', 'timeout', 'error'], { timeout: serverTimeout, elapsed: self._bench.elapsed()});
+                self._log(['request', 'server', 'timeout', 'error'], { timeout: serverTimeout, elapsed: self._bench.elapsed() });
                 self._reply(Boom.serverTimeout());
             };
 
diff --git a/lib/server.js b/lib/server.js
@@ -17,6 +17,7 @@ var Handler = require('./handler');
 var Methods = require('./methods');
 var Plugin = require('./plugin');
 var Reply = require('./reply');
+var Request = require('./request');
 var Schema = require('./schema');
 
 
@@ -46,6 +47,7 @@ exports = module.exports = internals.Server = function (options) {
     this._heavy = new Heavy(this._settings.load);
     this._mime = new Mimos(this._settings.mime);
     this._replier = new Reply();
+    this._requestor = new Request();
     this._decorations = {};
     this._plugins = {};                                                 // Exposed plugin properties by name
     this._app = {};
diff --git a/test/plugin.js b/test/plugin.js
@@ -1298,6 +1298,33 @@ describe('Plugin', function () {
 
     describe('decorate()', function () {
 
+        it('decorates request', function (done) {
+
+            var server = new Hapi.Server();
+            server.connection();
+
+            server.decorate('request', 'getId', function () {
+
+                return this.id;
+            });
+
+            server.route({
+                method: 'GET',
+                path: '/',
+                handler: function (request, reply) {
+
+                    return reply(request.getId());
+                }
+            });
+
+            server.inject('/', function (res) {
+
+                expect(res.statusCode).to.equal(200);
+                expect(res.result).to.match(/^.*\:.*\:.*\:.*\:.*$/);
+                done();
+            });
+        });
+
         it('decorates reply', function (done) {
 
             var server = new Hapi.Server();
diff --git a/test/reply.js b/test/reply.js
@@ -60,7 +60,7 @@ describe('Reply', function () {
         });
     });
 
-    describe('_interface()', function () {
+    describe('interface()', function () {
 
         it('uses reply(null, result) for result', function (done) {
 
@@ -113,6 +113,23 @@ describe('Reply', function () {
                 done();
             });
         });
+
+        it('skips decorations on minimal server', function (done) {
+
+            var handler = function (request, reply) {
+
+                return reply(reply.view === undefined);
+            };
+
+            var server = new Hapi.Server({ minimal: true });
+            server.connection();
+            server.route({ method: 'GET', path: '/', handler: handler });
+            server.inject('/', function (res) {
+
+                expect(res.result).to.equal(true);
+                done();
+            });
+        });
     });
 
     describe('response()', function () {
diff --git a/test/request.js b/test/request.js
@@ -24,6 +24,38 @@ var it = lab.it;
 var expect = Code.expect;
 
 
+describe('Request.Generator', function () {
+
+    it('decorates request multiple times', function (done) {
+
+        var server = new Hapi.Server();
+        server.connection();
+
+        server.decorate('request', 'x2', function () {
+
+            return 2;
+        });
+
+        server.decorate('request', 'abc', 1);
+
+        server.route({
+            method: 'GET',
+            path: '/',
+            handler: function (request, reply) {
+
+                return reply(request.x2() + request.abc);
+            }
+        });
+
+        server.inject('/', function (res) {
+
+            expect(res.statusCode).to.equal(200);
+            expect(res.result).to.equal(3);
+            done();
+        });
+    });
+});
+
 describe('Request', function () {
 
     it('sets client address', function (done) {
