update: fix async-app app chaining when mounting sub app

features/advanced.feature

@@ -239,4 +239,30 @@ Scenario: get negative TODO permissions with errors
         }
       }
     }
-    """
+    """
+
+Scenario: mounted apps (nest level 1)
+  Given app setting "trust proxy" is enabled
+  Given the request header X-Forwarded-For is "1.1.1.1"
+  When GET /sub/test
+  Then the response is 200
+  And the response payload includes
+  """
+  {
+    "route": "/sub/test",
+    "ip": "1.1.1.1"
+  }
+  """
+
+Scenario: mounted apps (nest level 2)
+  Given app setting "trust proxy" is enabled
+  Given the request header X-Forwarded-For is "10.0.1.3"
+  When GET /sub/sub/test
+  Then the response is 200
+  And the response payload includes
+  """
+  {
+    "route": "/sub/sub/test",
+    "ip": "10.0.1.3"
+  }
+  """

package.json

@@ -1,6 +1,6 @@
 {
   "name": "async-app",
-  "version": "4.9.0",
+  "version": "4.10.0",
   "description": "An express wrapper for handling async middlewares, order middlewares, schema validator, and other stuff",
   "type": "commonjs",
   "main": "dist/index.js",
@@ -52,7 +52,9 @@
     "build": "tsc",
     "dist": "rm -rf dist && npm run build",
     "lint": "tslint -p .",
+    "lint:fix": "tslint -p . --fix",
     "test": "cucumber-js --require-module ts-node/register --exit -r src/test.ts",
+    "test:debug": "node --inspect-brk=0.0.0.0:9429 --no-lazy ./node_modules/.bin/cucumber-js --require-module ts-node/register --exit -r src/test.ts",
     "watch": "tsc -w",
     "prepack": "npm run test",
     "prepare": "npm run dist"

src/async.ts

@@ -25,7 +25,7 @@ interface AsyncOptions<TEntities extends Entities, TSchema> {
   mapAsyncResultFn?: MapAsyncResultFn<TEntities>;
 }
 
-type Options<TEntities extends Entities> =  {
+type Options<TEntities extends Entities> = {
   statusCode: number;
   isLastMiddleware: boolean;
   validateSchema?: ValidateSchema;
@@ -36,11 +36,11 @@ const copyDecorators = <TSrc extends Decorator, TDest extends Decorator>(
   src: TSrc,
   dest: TDest,
 ) => {
-  const keys = Object
-    .keys(src)
-    .filter(k => k.startsWith('$')) as (keyof Decorator)[];
+  const keys = Object.keys(src).filter(k =>
+    k.startsWith('$'),
+  ) as (keyof Decorator)[];
 
-  keys.forEach(k => dest[k] = src[k]);
+  keys.forEach(k => (dest[k] = src[k]));
 };
 
 const mapMiddleware = <TEntities extends Entities>(
@@ -64,16 +64,16 @@ const mapMiddleware = <TEntities extends Entities>(
       const isAsync = isAsyncMiddleware(middleware);
 
       const mappedVal = options.mapAsyncResultFn
-      ? await options.mapAsyncResultFn(result, {
-        isAsyncMiddleware: isAsync,
-        isLastMiddleware: options.isLastMiddleware,
-        req,
-      })
-      : result;
+        ? await options.mapAsyncResultFn(result, {
+          isAsyncMiddleware: isAsync,
+          isLastMiddleware: options.isLastMiddleware,
+          req,
+        })
+        : result;
 
       let val = mappedVal;
       let isRaw = false;
-      let headers: Record<string, string|string[]> | undefined;
+      let headers: Record<string, string | string[]> | undefined;
 
       if (mappedVal instanceof CustomResponse) {
         val = mappedVal.value;
@@ -125,7 +125,9 @@ const mapMiddleware = <TEntities extends Entities>(
         res.json(val || {});
       }
     } catch (err) {
-      if (!err || !(err instanceof CustomError)) { return next(err); }
+      if (!err || !(err instanceof CustomError)) {
+        return next(err);
+      }
 
       const { statusCode, error, extra } = err;
 
@@ -148,42 +150,48 @@ const mapMiddleware = <TEntities extends Entities>(
 };
 
 export default <TEntities extends Entities, TSchema>({
-    errorHandler,
-    compileSchema,
-    mapAsyncResultFn,
-  }: AsyncOptions<TEntities, TSchema> = {}): Converter<TEntities, TSchema> =>
-  (args, context) => {
-    const statusCode = args.find(isNumber) || DEFAULT_STATUS_CODE;
-
-    const schema = args
-      .filter(isSchema<TSchema>())
-      .find(s => s.$scope === 'response');
-    const rawSchema = schema
+  errorHandler,
+  compileSchema,
+  mapAsyncResultFn,
+}: AsyncOptions<TEntities, TSchema> = {}): Converter<TEntities, TSchema> => (
+  args,
+  context,
+) => {
+  if (context.method === 'use') {
+    return args;
+  }
+
+  const statusCode = args.find(isNumber) || DEFAULT_STATUS_CODE;
+
+  const schema = args
+    .filter(isSchema<TSchema>())
+    .find(s => s.$scope === 'response');
+  const rawSchema = schema
+    ? schema.$schema
       ? schema.$schema
-        ? schema.$schema
-        : schema
-      : undefined;
-    const validateSchema =
-      compileSchema && rawSchema && compileSchema(rawSchema, context);
-
-    const middlewares = args.filter(isMiddleware);
-    const lastMiddleware = middlewares[middlewares.length - 1];
-
-    // 4 argument middlewares are error handlers, and we leave them untouched
-    return args.map(m =>
-      isMiddleware(m) && m.length < 4
-        ? mapMiddleware(
-          m,
-          // Check if this is the last valid middleware (not the statusCode arg)
-          {
-            isLastMiddleware: m === lastMiddleware,
-            mapAsyncResultFn,
-            statusCode,
-            validateSchema,
-          },
-          // Passes a custom error handler
-          errorHandler,
-        )
-        : m,
-    );
-  };
+      : schema
+    : undefined;
+  const validateSchema =
+    compileSchema && rawSchema && compileSchema(rawSchema, context);
+
+  const middlewares = args.filter(isMiddleware);
+  const lastMiddleware = middlewares[middlewares.length - 1];
+
+  // 4 argument middlewares are error handlers, and we leave them untouched
+  return args.map(m =>
+    isMiddleware(m) && m.length < 4
+      ? mapMiddleware(
+        m,
+        // Check if this is the last valid middleware (not the statusCode arg)
+        {
+          isLastMiddleware: m === lastMiddleware,
+          mapAsyncResultFn,
+          statusCode,
+          validateSchema,
+        },
+        // Passes a custom error handler
+        errorHandler,
+      )
+      : m,
+  );
+};

src/examples/advanced/app.ts

@@ -7,14 +7,22 @@ import bodyParser from 'body-parser';
 import express from 'express';
 import { join } from 'path';
 
-import { computePermissions, createCustomResponse, deprecate } from '../..';
-import createApp, { Req } from './async-app';
+import {
+  App,
+  computePermissions,
+  createCustomResponse,
+  deprecate,
+} from '../..';
+import createApp, { ExampleEntities, Req } from './async-app';
 import can, { entities } from './can';
 import { addTodo, addUser, getTodosForUser } from './db';
 import load from './load';
 import purgeUser from './purge-user';
 
 const app = createApp();
+
+app.disable('x-powered-by');
+
 app.use(bodyParser.json());
 
 // --- Deprecated ----------------------------------------------------------- //
@@ -46,11 +54,13 @@ app.get(
 app.post(
   '/users',
   'Creates a user', // This is the summary string for the endpoint
-  { // This is the expected schema of the body
+  {
+    // This is the expected schema of the body
     name: 'string',
     username: 'string',
   },
-  { // This is the expected schema of the response (optional)
+  {
+    // This is the expected schema of the response (optional)
     $scope: 'response',
     username: 'string',
   },
@@ -95,12 +105,14 @@ app.get(
   '/todos/:username',
   'Returns the TODOs for the specified user',
   {
-    $schema: [{
-      id: 'number',
-      item: 'string',
-      owner: 'string',
-      readOnly: 'boolean',
-    }],
+    $schema: [
+      {
+        id: 'number',
+        item: 'string',
+        owner: 'string',
+        readOnly: 'boolean',
+      },
+    ],
     $scope: 'response',
   },
   load.user.fromParams(),
@@ -185,6 +197,20 @@ app.use(
   express.static(join(__dirname, '../../../src/examples/advanced/docs')),
 );
 
-app.disable('x-powered-by');
+// --- Mounted sub app --- //
+const mountSubApp = (app: App<ExampleEntities, {}>) => {
+  const subApp = createApp();
+  app.use('/sub', subApp);
+
+  subApp.get('/test', 'Mounted app route information', (req: Req) => ({
+    ip: req.ip,
+    route: join(req.app.path(), req.path),
+  }));
+
+  return subApp;
+};
+
+const sub = mountSubApp(app);
+mountSubApp(sub);
 
 export default app;