feat: Add possibility to define custom response header

Closes micromata/http-fake-backend#10

This also can be configured via the new setting in `.env` after generation.

Author: mischah

__tests__/app.js

@@ -5,12 +5,15 @@ const helpers = require('yeoman-test');
 const helper = require('../generators/app/promptingHelpers');
 const chalk = require('chalk');
 
-describe('generator-http-fake-backend → server', () => {
+describe('generator-http-fake-backend → server with custom header', () => {
   beforeAll(done => {
     helpers.run(path.join(__dirname, '../generators/app'))
       .withPrompts({
         serverPort: 8081,
-        apiPrefix: '/api'
+        apiPrefix: '/api',
+        customHeader: true,
+        customHeaderName: 'HeaderName',
+        customHeaderValue: 'HeaderValue'
       })
       .on('end', done);
   });
@@ -32,6 +35,12 @@ describe('generator-http-fake-backend → server', () => {
       it('should contain the prompted api url prefix', () => {
         assert.fileContent('.env', /API_PREFIX=\/api/);
       });
+      it('should contain the prompted custom header name', () => {
+        assert.fileContent('.env', /CUSTOM_HEADER_NAME=HeaderName/);
+      });
+      it('should contain the prompted custom header value', () => {
+        assert.fileContent('.env', /CUSTOM_HEADER_VALUE=HeaderValue/);
+      });
     });
 
     it('should create meta files', () => {
@@ -62,6 +71,7 @@ describe('generator-http-fake-backend → server', () => {
     it('should create server files', () => {
       assert.file([
         'server/api/setup/lib/getContentDisposition.js',
+        'server/api/setup/lib/getCustomResponseHeader.js',
         'server/api/setup/index.js',
         'server/api/setup/supportedMethod.js',
         'server/api/setup/unsupportedMethods.js',
@@ -83,6 +93,7 @@ describe('generator-http-fake-backend → server', () => {
         'test/config.js',
         'test/index.js',
         'test/manifest.js',
+        'test/server/api/customResponseHeader.js',
         'test/server/api/endpoint.js',
         'test/server/api/fakeStatusCode.js',
         'test/server/api/fileTypes.js',
@@ -96,6 +107,27 @@ describe('generator-http-fake-backend → server', () => {
   });
 });
 
+describe('generator-http-fake-backend → server without custom header', () => {
+  beforeAll(done => {
+    helpers.run(path.join(__dirname, '../generators/app'))
+      .withPrompts({
+        serverPort: 8081,
+        apiPrefix: '/api',
+        customHeader: false
+      })
+      .on('end', done);
+  });
+
+  describe('.env', () => {
+    it('should contain the prompted custom header name', () => {
+      assert.fileContent('.env', /CUSTOM_HEADER_NAME=\n/);
+    });
+    it('should contain the prompted custom header value', () => {
+      assert.fileContent('.env', /CUSTOM_HEADER_VALUE=\n/);
+    });
+  });
+});
+
 describe('generator-http-fake-backend → server → prompting helpers', () => {
   describe('→ validateApiPrefix()', () => {
     it('should accept a leading slash', () => {
@@ -108,4 +140,16 @@ describe('generator-http-fake-backend → server → prompting helpers', () => {
       assert.equal(helper.validateApiPrefix('api'), chalk.red('API prefix has to begin with a `/`.'));
     });
   });
+
+  describe('→ validateCustomHeader()', () => {
+    it('should accept a non empty string', () => {
+      assert.equal(helper.validateCustomHeader('x-powered-by'), true);
+    });
+    it('should fail with a empty string', () => {
+      assert.equal(helper.validateCustomHeader(''), chalk.red('Can’t be an empty string.'));
+    });
+    it('should fail with a empty string', () => {
+      assert.equal(helper.validateCustomHeader('   '), chalk.red('Can’t be an empty string.'));
+    });
+  });
 });

generators/app/index.js

@@ -29,6 +29,27 @@ module.exports = class extends Generator {
         default: '/api',
         store: true,
         validate: helper.validateApiPrefix
+      }, {
+        type: 'confirm',
+        name: 'customHeader',
+        message: 'Would you like to add a custom response header (e.g. Authorization)?',
+        default: false
+      }, {
+        type: 'input',
+        name: 'customHeaderName',
+        message: 'Custom header name:',
+        validate: helper.validateCustomHeader,
+        when(answers) {
+          return answers.customHeader;
+        }
+      }, {
+        type: 'input',
+        name: 'customHeaderValue',
+        message: 'Custom header value:',
+        validate: helper.validateCustomHeader,
+        when(answers) {
+          return answers.customHeader;
+        }
       }
     ];
 
@@ -50,7 +71,9 @@ module.exports = class extends Generator {
       this.templatePath('_env'),
       this.destinationPath('.env'), {
         serverPort: this.props.serverPort,
-        apiPrefix: this.props.apiPrefix
+        apiPrefix: this.props.apiPrefix,
+        customHeaderName: this.props.customHeaderName,
+        customHeaderValue: this.props.customHeaderValue
       }
     );
     this.fs.copy(

generators/app/promptingHelpers.js

@@ -15,4 +15,11 @@ helper.validateApiPrefix = function (value) {
   return returnValue;
 };
 
+helper.validateCustomHeader = function (value) {
+  if (value.trim() === '') {
+    return chalk.red('Can’t be an empty string.');
+  }
+  return true;
+};
+
 module.exports = helper;

generators/app/templates/README.md

@@ -255,6 +255,10 @@ TEST_PORT=9090
 # eg. http://localhost:8081/api/foo
 API_PREFIX=/api
 
+# Custom response header
+#CUSTOM_HEADER_NAME=Authorization
+#CUSTOM_HEADER_VALUE=Bearer eyJhbGciOiJIUzUxMiJ9
+
 ```
 
 

generators/app/templates/_env

@@ -11,3 +11,7 @@ TEST_PORT=9090
 # URL Prefix for the endpoints
 # eg. http://localhost:8081/api/foo
 API_PREFIX=<%= apiPrefix %>
+
+# Custom response header
+CUSTOM_HEADER_NAME=<%= customHeaderName %>
+CUSTOM_HEADER_VALUE=<%= customHeaderValue %>

generators/app/templates/manifest.js

@@ -4,6 +4,7 @@ const Confidence = require('confidence');
 const Config = require('./config');
 const Fs = require('fs');
 const Path = require('path');
+const GetCustomResponseHeader = require('./server/api/setup/lib/getCustomResponseHeader');
 
 const criteria = {
     env: process.env.NODE_ENV
@@ -22,7 +23,8 @@ const manifest = {
                 security: true,
                 cors: {
                     origin: ['*'],
-                    credentials: true
+                    credentials: true,
+                    additionalExposedHeaders: [GetCustomResponseHeader(process.env).name]
                 }
             },
             router: {

generators/app/templates/server/api/setup/lib/getCustomResponseHeader.js

@@ -0,0 +1,9 @@
+'use strict';
+
+module.exports = function (env) {
+
+    return {
+        name: env.CUSTOM_HEADER_NAME || 'X-Powered-By',
+        value: env.CUSTOM_HEADER_VALUE || 'https://hapijs.com'
+    };
+};

generators/app/templates/server/api/setup/supportedMethod.js

@@ -4,7 +4,8 @@ const Boom = require('boom');
 const Fs = require('fs');
 const Path = require('path');
 
-const GetContentDisposition = require('./lib/getContentDisposition.js');
+const GetContentDisposition = require('./lib/getContentDisposition');
+const CustomResponseHeader = require('./lib/getCustomResponseHeader')(process.env);
 
 module.exports = function (server, proposedRequest, settings, params, path) {
 
@@ -39,23 +40,18 @@ module.exports = function (server, proposedRequest, settings, params, path) {
 
             }
 
-            if (proposedRequest.statusCode && proposedRequest.response) {
-
-                if (sendFile && isFile) {
-                    return reply(response).code(proposedRequest.statusCode).type(mimeType).header('Content-Disposition', GetContentDisposition(proposedRequest.response));
-                }
-                return reply(response).code(proposedRequest.statusCode).type(mimeType);
-            }
-
             if (response.isBoom === true) {
+                response.output.headers[CustomResponseHeader.name] = CustomResponseHeader.value;
                 return reply(response);
             }
 
             if (sendFile && isFile) {
-                return reply(response).type(mimeType).header('Content-Disposition', GetContentDisposition(proposedRequest.response));
+                return reply(response).code(proposedRequest.statusCode || 200).type(mimeType)
+                    .header('Content-Disposition', GetContentDisposition(proposedRequest.response))
+                    .header(CustomResponseHeader.name, CustomResponseHeader.value);
             }
-
-            return reply(response).type(mimeType);
+            return reply(response).code(proposedRequest.statusCode || 200).type(mimeType)
+                .header(CustomResponseHeader.name, CustomResponseHeader.value);
         }
     };
 };

generators/app/templates/server/api/setup/unsupportedMethods.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const Boom = require('boom');
+const CustomResponseHeader = require('./lib/getCustomResponseHeader')(process.env);
 
 module.exports = function (settings, params, path) {
 
@@ -18,6 +19,7 @@ module.exports = function (settings, params, path) {
                 response = Boom.methodNotAllowed();
             }
 
+            response.output.headers[CustomResponseHeader.name] = CustomResponseHeader.value;
             return reply(response);
         }
     };

generators/app/templates/test/manifest.js

@@ -22,4 +22,10 @@ lab.experiment('Manifest', () => {
         Code.expect(Manifest.meta('/')).to.match(/hapi server config used by glue to compose the server/i);
         done();
     });
+
+    lab.test('it gets the correct custom response header', (done) => {
+
+        Code.expect(Manifest.get('/').server.connections.routes.cors.additionalExposedHeaders).to.equal(['X-Powered-By']);
+        done();
+    });
 });