Route isInternal flag. Closes hapijs#2750

hueniverse · hueniverse · commit 66730f979f05 · 2015-09-03T22:33:48.000-07:00
diff --git a/API.md b/API.md
@@ -1,4 +1,4 @@
-# 9.0.x API Reference
+# 9.1.x API Reference
 
 - [Server](#server)
     - [`new Server([options])`](#new-serveroptions)
@@ -2043,7 +2043,11 @@ following options:
 - `handler` - an alternative location for the route `handler` option.
 
 - `id` - an optional unique identifier used to look up the route using
-  [`server.lookup()`](#serverlookupid).
+  [`server.lookup()`](#serverlookupid). Cannot be assigned to routes with an array of methods.
+
+- `isInternal` - if `true`, the route cannot be accessed through the HTTP connection but only
+  through the `server.inject()` interface. Used for internal routes that should not be accessible
+  to the outside world. Defaults to `false`.
 
 - `json` - optional arguments passed to `JSON.stringify()` when converting an object or
   error response to a string payload. Supports the following:
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ Lead Maintainer: [Eran Hammer](https://github.com/hueniverse)
 authentication, and other essential facilities for building web and services applications. **hapi** enables
 developers to focus on writing reusable application logic in a highly modular and prescriptive approach. 
 
-Development version: **9.0.x** ([release notes](https://github.com/hapijs/hapi/issues?labels=release+notes&page=1&state=closed)) 
+Development version: **9.1.x** ([release notes](https://github.com/hapijs/hapi/issues?labels=release+notes&page=1&state=closed)) 
 [![Build Status](https://secure.travis-ci.org/hapijs/hapi.svg)](http://travis-ci.org/hapijs/hapi)
 
 For the latest updates, [change log](http://hapijs.com/updates), and release information visit [hapijs.com](http://hapijs.com) and follow [@hapijs](https://twitter.com/hapijs) on twitter. If you have questions, please open an issue in the
diff --git a/lib/request.js b/lib/request.js
@@ -7,6 +7,7 @@ var Boom = require('boom');
 var Hoek = require('hoek');
 var Items = require('items');
 var Peekaboo = require('peekaboo');
+var Shot = require('shot');
 var Qs = require('qs');
 var Handler = require('./handler');
 var Protect = require('./protect');
@@ -326,8 +327,13 @@ internals.Request.prototype._execute = function () {
         // Lookup route
 
         var match = self.connection._router.route(self.method, self.path, self.info.hostname);
-        self._route = match.route;
-        self.route = self._route.public;
+        if (!match.route.settings.isInternal ||
+            Shot.isInjection(self.raw.req)) {
+
+            self._route = match.route;
+            self.route = self._route.public;
+        }
+
         self.params = match.params;
         self.paramsArray = match.paramsArray;
 
diff --git a/lib/schema.js b/lib/schema.js
@@ -238,6 +238,7 @@ internals.pre = [
 
 internals.routeConfig = internals.routeBase.keys({
     id: Joi.string(),
+    isInternal: Joi.boolean(),
     pre: Joi.array().items(internals.pre.concat(Joi.array().items(internals.pre).min(1))),
     handler: [
         Joi.func(),
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "hapi",
   "description": "HTTP Server framework",
   "homepage": "http://hapijs.com",
-  "version": "9.0.4",
+  "version": "9.1.0",
   "repository": {
     "type": "git",
     "url": "git://github.com/hapijs/hapi"
diff --git a/test/request.js b/test/request.js
@@ -372,6 +372,40 @@ describe('Request', function () {
                 clientRequest.end();
             });
         });
+
+        it('returns not found on internal only route', function (done) {
+
+            var server = new Hapi.Server();
+            server.connection();
+            server.route({
+                method: 'GET',
+                path: '/some/route',
+                config: {
+                    isInternal: true,
+                    handler: function (request, reply) {
+
+                        return reply('ok');
+                    }
+                }
+            });
+
+            server.start(function (err) {
+
+                expect(err).to.not.exist();
+                Wreck.get('http://localhost:' + server.info.port, function (err, res1, body) {
+
+                    expect(res1.statusCode).to.equal(404);
+                    expect(body.toString()).to.equal('{"statusCode":404,"error":"Not Found"}');
+
+                    server.inject('/some/route', function (res2) {
+
+                        expect(res2.statusCode).to.equal(200);
+                        expect(res2.result).to.equal('ok');
+                        server.stop(done);
+                    });
+                });
+            });
+        });
     });
 
     describe('_finalize()', function (done) {
