Merge pull request #1267 from opencomponents/add-express-promise-router

[CB-INTERNAL] add express-promise-router to allow promises on routes

Author: ricardo-devis-agullo

package-lock.json

@@ -101,6 +101,7 @@
     "dependency-graph": "0.11.0",
     "errorhandler": "1.5.1",
     "express": "4.17.1",
+    "express-promise-router": "^4.1.0",
     "form-data": "4.0.0",
     "fs-extra": "10.0.0",
     "getport": "0.1.0",

package.json

@@ -9,7 +9,7 @@ import * as eventsHandler from './domain/events-handler';
 import * as middleware from './middleware';
 import * as pluginsInitialiser from './domain/plugins-initialiser';
 import Repository from './domain/repository';
-import * as router from './router';
+import { create as createRouter } from './router';
 import sanitiseOptions from './domain/options-sanitiser';
 import * as validator from './domain/validators';
 import { ComponentsList, Config, Plugin } from '../types';
@@ -20,15 +20,16 @@ interface Input extends Partial<Omit<Config, 'beforePublish'>> {
 }
 
 export default function registry(inputOptions: Input) {
-  const validationResult =
-    validator.validateRegistryConfiguration(inputOptions);
+  const validationResult = validator.validateRegistryConfiguration(
+    inputOptions
+  );
   if (!validationResult.isValid) {
     throw validationResult.message;
   }
   const options = sanitiseOptions(inputOptions);
 
   const plugins: Plugin[] = [];
-  const app = middleware.bind(express(), options);
+  const { app, router } = middleware.bind(express(), options);
   let server: http.Server;
   const repository = Repository(options);
 
@@ -54,7 +55,7 @@ export default function registry(inputOptions: Input) {
     if (typeof callback !== 'function') {
       callback = _.noop;
     }
-    router.create(app, options, repository);
+    createRouter(router, options, repository);
     async.waterfall(
       [
         (cb: Callback<Dictionary<(...args: unknown[]) => unknown>, unknown>) =>

src/registry/index.ts

@@ -1,6 +1,7 @@
 import express, { Express } from 'express';
 import errorhandler from 'errorhandler';
 import morgan from 'morgan';
+import Router from 'express-promise-router';
 
 import baseUrlHandler from './base-url-handler';
 import cors from './cors';
@@ -16,9 +17,13 @@ const bodyParserUrlEncodedArgument: { extended: boolean; limit?: number } = {
   extended: true
 };
 
-export const bind = (app: Express, options: Config): Express => {
+export const bind = (
+  app: Express,
+  options: Config
+): { app: Express; router: express.Router } => {
   app.set('port', options.port);
   app.set('json spaces', 0);
+  app.set('etag', 'strong');
 
   app.use((_req, res, next) => {
     res.conf = options;
@@ -48,5 +53,8 @@ export const bind = (app: Express, options: Config): Express => {
     app.use(errorhandler());
   }
 
-  return app;
+  const router = Router();
+  app.use(router);
+
+  return { app, router };
 };

src/registry/middleware/index.ts

@@ -8,14 +8,10 @@ import StaticRedirectorRoute from './routes/static-redirector';
 import PluginsRoute from './routes/plugins';
 import DependenciesRoute from './routes/dependencies';
 import settings from '../resources/settings';
-import { Express } from 'express';
+import { Router } from 'express';
 import { Config, Repository } from '../types';
 
-export function create(
-  app: Express,
-  conf: Config,
-  repository: Repository
-): Express {
+export function create(app: Router, conf: Config, repository: Repository) {
   const routes = {
     component: ComponentRoute(conf, repository),
     components: ComponentsRoute(conf, repository),
@@ -85,8 +81,4 @@ export function create(
       ](route.route, route.handler)
     );
   }
-
-  app.set('etag', 'strong');
-
-  return app;
 }

src/registry/router.ts

@@ -14,7 +14,7 @@ describe('registry', () => {
     http: {
       createServer: sinon.stub()
     },
-    './middleware': { bind: sinon.stub() },
+    './middleware': { bind: sinon.stub().returns({}) },
     './domain/plugins-initialiser': { init: sinon.stub() },
     './domain/repository': sinon.stub().returns({
       init: repositoryInitStub