@loopback/express 1.2.5 → 1.4.1

package/CHANGELOG.md

@@ -3,6 +3,46 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.4.1](https://github.com/strongloop/loopback-next/compare/@loopback/express@1.4.0...@loopback/express@1.4.1) (2020-08-27)
+
+**Note:** Version bump only for package @loopback/express
+
+
+
+
+
+# [1.4.0](https://github.com/strongloop/loopback-next/compare/@loopback/express@1.3.0...@loopback/express@1.4.0) (2020-08-19)
+
+
+### Features
+
+* **express:** add middleware view to watch registered middleware ([205d948](https://github.com/strongloop/loopback-next/commit/205d948cb91cf48d187ce247ee5e77b1204be35e))
+* **rest:** add the ability to validate sorted middleware groups ([227dbf8](https://github.com/strongloop/loopback-next/commit/227dbf8045990536ac1437ea4a7ae1f1a1e571bb))
+* **rest:** optimize middleware sequence to reuse middleware binding keys ([0041a24](https://github.com/strongloop/loopback-next/commit/0041a246df89f7dbff179ed7c5e08a65ec5bcbda))
+
+
+
+
+
+# [1.3.0](https://github.com/strongloop/loopback-next/compare/@loopback/express@1.2.6...@loopback/express@1.3.0) (2020-08-05)
+
+
+### Features
+
+* **express:** sort middleware by group dependencies and ordered groups ([5582f06](https://github.com/strongloop/loopback-next/commit/5582f069834666a6d6a9d8d2f2d66fa1a9a5f7d3))
+
+
+
+
+
+## [1.2.6](https://github.com/strongloop/loopback-next/compare/@loopback/express@1.2.5...@loopback/express@1.2.6) (2020-07-20)
+
+**Note:** Version bump only for package @loopback/express
+
+
+
+
+
 ## [1.2.5](https://github.com/strongloop/loopback-next/compare/@loopback/express@1.2.4...@loopback/express@1.2.5) (2020-06-30)
 
 **Note:** Version bump only for package @loopback/express

package/dist/group-sorter.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Sort the groups by their relative order
+ * @param orderedGroups - A list of arrays - each of which represents a partial
+ * order of groups.
+ */
+export declare function sortListOfGroups(...orderedGroups: string[][]): string[];

package/dist/group-sorter.js

@@ -0,0 +1,37 @@
+"use strict";
+// Copyright IBM Corp. 2020. All Rights Reserved.
+// Node module: @loopback/express
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortListOfGroups = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const toposort_1 = tslib_1.__importDefault(require("toposort"));
+const debug = debug_1.default('loopback:middleware');
+/**
+ * Sort the groups by their relative order
+ * @param orderedGroups - A list of arrays - each of which represents a partial
+ * order of groups.
+ */
+function sortListOfGroups(...orderedGroups) {
+    if (debug.enabled) {
+        debug('Dependency graph: %s', orderedGroups.map(edge => edge.join('->')).join(', '));
+    }
+    const graph = [];
+    for (const groups of orderedGroups) {
+        if (groups.length >= 2) {
+            groups.reduce((prev, group) => {
+                if (typeof prev === 'string') {
+                    graph.push([prev, group]);
+                }
+                return group;
+            }, undefined);
+        }
+    }
+    const sorted = toposort_1.default(graph);
+    debug('Sorted groups: %s', sorted.join('->'));
+    return sorted;
+}
+exports.sortListOfGroups = sortListOfGroups;
+//# sourceMappingURL=group-sorter.js.map

package/dist/group-sorter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"group-sorter.js","sourceRoot":"","sources":["../src/group-sorter.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,0DAAiC;AACjC,gEAAgC;AAChC,MAAM,KAAK,GAAG,eAAY,CAAC,qBAAqB,CAAC,CAAC;AAClD;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,GAAG,aAAyB;IAC3D,IAAI,KAAK,CAAC,OAAO,EAAE;QACjB,KAAK,CACH,sBAAsB,EACtB,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACtD,CAAC;KACH;IACD,MAAM,KAAK,GAAuB,EAAE,CAAC;IACrC,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE;QAClC,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE;YACtB,MAAM,CAAC,MAAM,CAAC,CAAC,IAAwB,EAAE,KAAK,EAAE,EAAE;gBAChD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;oBAC5B,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;iBAC3B;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,EAAE,SAAS,CAAC,CAAC;SACf;KACF;IACD,MAAM,MAAM,GAAG,kBAAQ,CAAC,KAAK,CAAC,CAAC;IAC/B,KAAK,CAAC,mBAAmB,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC;AAChB,CAAC;AArBD,4CAqBC"}

package/dist/index.d.ts

@@ -17,6 +17,7 @@
  */
 export * from './express.application';
 export * from './express.server';
+export * from './group-sorter';
 export * from './keys';
 export * from './middleware';
 export * from './middleware-interceptor';

package/dist/index.js

@@ -24,6 +24,7 @@ const tslib_1 = require("tslib");
  */
 tslib_1.__exportStar(require("./express.application"), exports);
 tslib_1.__exportStar(require("./express.server"), exports);
+tslib_1.__exportStar(require("./group-sorter"), exports);
 tslib_1.__exportStar(require("./keys"), exports);
 tslib_1.__exportStar(require("./middleware"), exports);
 tslib_1.__exportStar(require("./middleware-interceptor"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAEhE;;;;;;;;;;;;;;;;GAgBG;AACH,gEAAsC;AACtC,2DAAiC;AACjC,iDAAuB;AACvB,uDAA6B;AAC7B,mEAAyC;AACzC,gEAAsC;AACtC,oEAA0C;AAC1C,iFAAuD;AACvD,kDAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAEhE;;;;;;;;;;;;;;;;GAgBG;AACH,gEAAsC;AACtC,2DAAiC;AACjC,yDAA+B;AAC/B,iDAAuB;AACvB,uDAA6B;AAC7B,mEAAyC;AACzC,gEAAsC;AACtC,oEAA0C;AAC1C,iFAAuD;AACvD,kDAAwB"}

package/dist/keys.js

@@ -6,6 +6,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_MIDDLEWARE_GROUP = exports.MIDDLEWARE_INTERCEPTOR_NAMESPACE = exports.GLOBAL_MIDDLEWARE_INTERCEPTOR_NAMESPACE = exports.MIDDLEWARE_NAMESPACE = exports.MiddlewareBindings = void 0;
 const core_1 = require("@loopback/core");
+const types_1 = require("./types");
 var MiddlewareBindings;
 (function (MiddlewareBindings) {
     /**
@@ -28,5 +29,5 @@ exports.MIDDLEWARE_INTERCEPTOR_NAMESPACE = 'globalInterceptors.middleware';
 /**
  * Default order group name for Express middleware based global interceptors
  */
-exports.DEFAULT_MIDDLEWARE_GROUP = 'middleware';
+exports.DEFAULT_MIDDLEWARE_GROUP = types_1.MiddlewareGroups.DEFAULT;
 //# sourceMappingURL=keys.js.map

package/dist/keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"keys.js","sourceRoot":"","sources":["../src/keys.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,yCAA0C;AAG1C,IAAiB,kBAAkB,CAOlC;AAPD,WAAiB,kBAAkB;IACjC;;OAEG;IACU,0BAAO,GAAG,iBAAU,CAAC,MAAM,CACtC,yBAAyB,CAC1B,CAAC;AACJ,CAAC,EAPgB,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAOlC;AAED;;GAEG;AACU,QAAA,oBAAoB,GAAG,YAAY,CAAC;AAEjD;;GAEG;AACU,QAAA,uCAAuC,GAClD,+BAA+B,CAAC;AAElC;;GAEG;AACU,QAAA,gCAAgC,GAAG,+BAA+B,CAAC;AAEhF;;GAEG;AACU,QAAA,wBAAwB,GAAG,YAAY,CAAC"}
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../src/keys.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,yCAA0C;AAC1C,mCAA4D;AAE5D,IAAiB,kBAAkB,CAOlC;AAPD,WAAiB,kBAAkB;IACjC;;OAEG;IACU,0BAAO,GAAG,iBAAU,CAAC,MAAM,CACtC,yBAAyB,CAC1B,CAAC;AACJ,CAAC,EAPgB,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAOlC;AAED;;GAEG;AACU,QAAA,oBAAoB,GAAG,YAAY,CAAC;AAEjD;;GAEG;AACU,QAAA,uCAAuC,GAClD,+BAA+B,CAAC;AAElC;;GAEG;AACU,QAAA,gCAAgC,GAAG,+BAA+B,CAAC;AAEhF;;GAEG;AACU,QAAA,wBAAwB,GAAG,wBAAgB,CAAC,OAAO,CAAC"}

package/dist/middleware.d.ts

@@ -1,4 +1,4 @@
-import { Binding, BindingTemplate, Constructor, Context, InvocationResult, Provider, ValueOrPromise } from '@loopback/core';
+import { Binding, BindingTemplate, Constructor, Context, ContextView, InvocationResult, Provider, ValueOrPromise } from '@loopback/core';
 import { ExpressMiddlewareFactory, ExpressRequestHandler, InvokeMiddlewareOptions, Middleware, MiddlewareBindingOptions, MiddlewareContext } from './types';
 /**
  * An adapter function to create a LoopBack middleware that invokes the list
@@ -63,6 +63,23 @@ export declare function createMiddlewareBinding(middlewareProviderClass: Constru
  * @param options - Options to invoke the middleware chain
  */
 export declare function invokeMiddleware(middlewareCtx: MiddlewareContext, options?: InvokeMiddlewareOptions): ValueOrPromise<InvocationResult>;
+/**
+ * Watch middleware binding keys for the given context and sort them by
+ * group
+ * @param ctx - Context object
+ * @param options - Middleware options
+ */
+export declare class MiddlewareView extends ContextView {
+    private options;
+    private keys;
+    constructor(ctx: Context, options?: InvokeMiddlewareOptions);
+    refresh(): void;
+    /**
+     * A list of binding keys sorted by group for registered middleware
+     */
+    get middlewareBindingKeys(): string[];
+    private buildMiddlewareKeys;
+}
 /**
  * Invoke a list of Express middleware handler functions
  *

package/dist/middleware.js

@@ -4,10 +4,11 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toExpressMiddleware = exports.invokeExpressMiddleware = exports.invokeMiddleware = exports.createMiddlewareBinding = exports.registerMiddleware = exports.asMiddleware = exports.registerExpressMiddleware = exports.createMiddleware = exports.toMiddleware = void 0;
+exports.toExpressMiddleware = exports.invokeExpressMiddleware = exports.MiddlewareView = exports.invokeMiddleware = exports.createMiddlewareBinding = exports.registerMiddleware = exports.asMiddleware = exports.registerExpressMiddleware = exports.createMiddleware = exports.toMiddleware = void 0;
 const tslib_1 = require("tslib");
 const core_1 = require("@loopback/core");
 const debug_1 = tslib_1.__importDefault(require("debug"));
+const group_sorter_1 = require("./group-sorter");
 const keys_1 = require("./keys");
 const middleware_interceptor_1 = require("./middleware-interceptor");
 const types_1 = require("./types");
@@ -84,6 +85,18 @@ function asMiddleware(options = {}) {
         binding
             .apply(core_1.extensionFor((_a = options.chain) !== null && _a !== void 0 ? _a : types_1.DEFAULT_MIDDLEWARE_CHAIN))
             .tag({ group: (_b = options.group) !== null && _b !== void 0 ? _b : keys_1.DEFAULT_MIDDLEWARE_GROUP });
+        const groupsBefore = options.upstreamGroups;
+        if (groupsBefore != null) {
+            binding.tag({
+                upstreamGroups: typeof groupsBefore === 'string' ? [groupsBefore] : groupsBefore,
+            });
+        }
+        const groupsAfter = options.downstreamGroups;
+        if (groupsAfter != null) {
+            binding.tag({
+                downstreamGroups: typeof groupsAfter === 'string' ? [groupsAfter] : groupsAfter,
+            });
+        }
     };
 }
 exports.asMiddleware = asMiddleware;
@@ -134,16 +147,75 @@ exports.createMiddlewareBinding = createMiddlewareBinding;
  */
 function invokeMiddleware(middlewareCtx, options) {
     debug('Invoke middleware chain for %s %s with options', middlewareCtx.request.method, middlewareCtx.request.originalUrl, options);
-    const { chain = types_1.DEFAULT_MIDDLEWARE_CHAIN, orderedGroups } = options !== null && options !== void 0 ? options : {};
-    // Find extensions for the given extension point binding
-    const filter = core_1.extensionFilter(chain);
-    if (debug.enabled) {
-        debug('Middleware for extension point "%s":', chain, middlewareCtx.find(filter).map(b => b.key));
+    let keys = options === null || options === void 0 ? void 0 : options.middlewareList;
+    if (keys == null) {
+        const view = new MiddlewareView(middlewareCtx, options);
+        keys = view.middlewareBindingKeys;
+        view.close();
     }
-    const mwChain = new types_1.MiddlewareChain(middlewareCtx, filter, core_1.compareBindingsByTag('group', orderedGroups));
+    const mwChain = new types_1.MiddlewareChain(middlewareCtx, keys);
     return mwChain.invokeInterceptors(options === null || options === void 0 ? void 0 : options.next);
 }
 exports.invokeMiddleware = invokeMiddleware;
+/**
+ * Watch middleware binding keys for the given context and sort them by
+ * group
+ * @param ctx - Context object
+ * @param options - Middleware options
+ */
+class MiddlewareView extends core_1.ContextView {
+    constructor(ctx, options) {
+        var _a;
+        // Find extensions for the given extension point binding
+        const filter = core_1.extensionFilter((_a = options === null || options === void 0 ? void 0 : options.chain) !== null && _a !== void 0 ? _a : types_1.DEFAULT_MIDDLEWARE_CHAIN);
+        super(ctx, filter);
+        this.options = {
+            chain: types_1.DEFAULT_MIDDLEWARE_CHAIN,
+            orderedGroups: [],
+            ...options,
+        };
+        this.buildMiddlewareKeys();
+        this.open();
+    }
+    refresh() {
+        super.refresh();
+        this.buildMiddlewareKeys();
+    }
+    /**
+     * A list of binding keys sorted by group for registered middleware
+     */
+    get middlewareBindingKeys() {
+        return this.keys;
+    }
+    buildMiddlewareKeys() {
+        var _a;
+        const middlewareBindings = this.bindings;
+        if (debug.enabled) {
+            debug('Middleware for extension point "%s":', this.options.chain, middlewareBindings.map(b => b.key));
+        }
+        // Calculate orders from middleware dependencies
+        const ordersFromDependencies = [];
+        middlewareBindings.forEach(b => {
+            var _a, _b, _c;
+            const group = (_a = b.tagMap.group) !== null && _a !== void 0 ? _a : keys_1.DEFAULT_MIDDLEWARE_GROUP;
+            const groupsBefore = (_b = b.tagMap.upstreamGroups) !== null && _b !== void 0 ? _b : [];
+            groupsBefore.forEach(d => ordersFromDependencies.push([d, group]));
+            const groupsAfter = (_c = b.tagMap.downstreamGroups) !== null && _c !== void 0 ? _c : [];
+            groupsAfter.forEach(d => ordersFromDependencies.push([group, d]));
+        });
+        const order = group_sorter_1.sortListOfGroups(...ordersFromDependencies, this.options.orderedGroups);
+        /**
+         * Validate sorted groups
+         */
+        if (typeof ((_a = this.options) === null || _a === void 0 ? void 0 : _a.validate) === 'function') {
+            this.options.validate(order);
+        }
+        this.keys = middlewareBindings
+            .sort(core_1.compareBindingsByTag('group', order))
+            .map(b => b.key);
+    }
+}
+exports.MiddlewareView = MiddlewareView;
 /**
  * Invoke a list of Express middleware handler functions
  *

package/dist/middleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../src/middleware.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCAgBwB;AACxB,0DAAiC;AACjC,iCAAsE;AACtE,qEAIkC;AAClC,mCAUiB;AAEjB,MAAM,KAAK,GAAG,eAAY,CAAC,qBAAqB,CAAC,CAAC;AAElD;;;;;;;;;;;;GAYG;AACH,SAAgB,YAAY,CAC1B,YAAmC,EACnC,GAAG,kBAA2C;IAE9C,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,sCAAa,CAAC,YAAY,CAAC,CAAC;IACxE,MAAM,QAAQ,GAAG,CAAC,YAAY,EAAE,GAAG,kBAAkB,CAAC,CAAC;IACvD,MAAM,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAC5C,sCAAa,CAAoB,OAAO,CAAC,CAC1C,CAAC;IACF,OAAO,CAAC,aAAa,EAAE,IAAI,EAAE,EAAE;QAC7B,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;YAC/B,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;SAC/C;QACD,MAAM,eAAe,GAAG,IAAI,uBAAe,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAC3E,OAAO,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC,CAAC;AACJ,CAAC;AAhBD,oCAgBC;AAED;;;;;;;;GAQG;AACH,SAAgB,gBAAgB,CAC9B,iBAAgD,EAChD,gBAAsB;IAEtB,OAAO,0CAAiB,CACtB,iBAAiB,EACjB,gBAAgB,CACjB,CAAC;AACJ,CAAC;AARD,4CAQC;AAED;;;;;;;;;GASG;AACH,SAAgB,yBAAyB,CACvC,GAAY,EACZ,iBAAgD,EAChD,gBAAsB,EACtB,UAAoC,EAAE;;IAEtC,OAAO,GAAG,EAAC,mBAAmB,EAAE,IAAI,EAAE,GAAG,OAAO,EAAC,CAAC;IAClD,OAAO,CAAC,KAAK,SAAG,OAAO,CAAC,KAAK,mCAAI,gCAAwB,CAAC;IAC1D,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE;QAChC,MAAM,UAAU,GAAG,gBAAgB,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;QACzE,OAAO,kBAAkB,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;KACrD;IAED,MAAM,aAAa,GAAG,kDAAyB,CAC7C,iBAAiB,EACjB,gBAAgB,EAChB,OAAO,CACR,CAAC;IACF,OAAO,kBAAkB,CAAC,GAAG,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;AACzD,CAAC;AAnBD,8DAmBC;AAED;;;GAGG;AACH,SAAgB,YAAY,CAC1B,UAAoC,EAAE;IAEtC,OAAO,SAAS,yBAAyB,CAAC,OAAO;;QAC/C,OAAO;aACJ,KAAK,CAAC,mBAAY,OAAC,OAAO,CAAC,KAAK,mCAAI,gCAAwB,CAAC,CAAC;aAC9D,GAAG,CAAC,EAAC,KAAK,QAAE,OAAO,CAAC,KAAK,mCAAI,+BAAwB,EAAC,CAAC,CAAC;IAC7D,CAAC,CAAC;AACJ,CAAC;AARD,oCAQC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,GAAY,EACZ,UAA0D,EAC1D,OAAiC;;IAEjC,IAAI,sBAAe,CAAC,UAA+C,CAAC,EAAE;QACpE,MAAM,OAAO,GAAG,uBAAuB,CACrC,UAA+C,EAC/C,OAAO,CACR,CAAC;QACF,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACjB,OAAO,OAAO,CAAC;KAChB;IACD,MAAM,GAAG,SAAG,OAAO,CAAC,GAAG,mCAAI,iBAAU,CAAC,QAAQ,CAAC,2BAAoB,CAAC,CAAC;IACrE,OAAO,GAAG;SACP,IAAI,CAAC,GAAG,CAAC;SACT,EAAE,CAAC,UAAwB,CAAC;SAC5B,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;AAClC,CAAC;AAlBD,gDAkBC;AAED;;;;;;GAMG;AACH,SAAgB,uBAAuB,CACrC,uBAA0D,EAC1D,UAAoC,EAAE;;IAEtC,OAAO,CAAC,KAAK,SAAG,OAAO,CAAC,KAAK,mCAAI,gCAAwB,CAAC;IAC1D,MAAM,OAAO,GAAG,6BAAsB,CAAC,uBAAuB,EAAE;QAC9D,YAAY,EAAE,mBAAY,CAAC,SAAS;QACpC,SAAS,EAAE,2BAAoB;QAC/B,GAAG,EAAE,OAAO,CAAC,GAAG;KACjB,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;IAChC,OAAO,OAAO,CAAC;AACjB,CAAC;AAXD,0DAWC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,aAAgC,EAChC,OAAiC;IAEjC,KAAK,CACH,gDAAgD,EAChD,aAAa,CAAC,OAAO,CAAC,MAAM,EAC5B,aAAa,CAAC,OAAO,CAAC,WAAW,EACjC,OAAO,CACR,CAAC;IACF,MAAM,EAAC,KAAK,GAAG,gCAAwB,EAAE,aAAa,EAAC,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;IACxE,wDAAwD;IACxD,MAAM,MAAM,GAAG,sBAAe,CAAC,KAAK,CAAC,CAAC;IACtC,IAAI,KAAK,CAAC,OAAO,EAAE;QACjB,KAAK,CACH,sCAAsC,EACtC,KAAK,EACL,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAC3C,CAAC;KACH;IACD,MAAM,OAAO,GAAG,IAAI,uBAAe,CACjC,aAAa,EACb,MAAM,EACN,2BAAoB,CAAC,OAAO,EAAE,aAAa,CAAC,CAC7C,CAAC;IACF,OAAO,OAAO,CAAC,kBAAkB,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,CAAC,CAAC;AACnD,CAAC;AA1BD,4CA0BC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAgB,uBAAuB,CACrC,aAAgC,EAChC,GAAG,QAAiC;IAEpC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;KACxE;IACD,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACnE,KAAK,CACH,qCAAqC,EACrC,aAAa,CAAC,OAAO,CAAC,MAAM,EAC5B,aAAa,CAAC,OAAO,CAAC,WAAW,CAClC,CAAC;IACF,4CAA4C;IAC5C,MAAM,MAAM,GAAG,UAAU,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC1D,oCAAoC;IACpC,OAAO,8BAAuB,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,aAAa,CAAC,QAAQ,CAAC,CAAC;AAChF,CAAC;AAjBD,0DAiBC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,GAAY;IAC9C,OAAO,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC9B,MAAM,aAAa,GAAG,IAAI,yBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QAC3D,iDAAiD;QACjD,8DAA8D;QAC7D,GAAW,CAAC,0BAAkB,CAAC,GAAG,aAAa,CAAC;QAEjD,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,aAAa,CAAC,CAAC;YACrD,IAAI,MAAM,KAAK,GAAG,EAAE;gBAClB,IAAI,EAAE,CAAC;aACR;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,GAAG,CAAC,CAAC;SACX;IACH,CAAC,CAAC;AACJ,CAAC;AAhBD,kDAgBC"}
+{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../src/middleware.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCAiBwB;AACxB,0DAAiC;AACjC,iDAAgD;AAChD,iCAAsE;AACtE,qEAIkC;AAClC,mCAUiB;AAEjB,MAAM,KAAK,GAAG,eAAY,CAAC,qBAAqB,CAAC,CAAC;AAElD;;;;;;;;;;;;GAYG;AACH,SAAgB,YAAY,CAC1B,YAAmC,EACnC,GAAG,kBAA2C;IAE9C,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,sCAAa,CAAC,YAAY,CAAC,CAAC;IACxE,MAAM,QAAQ,GAAG,CAAC,YAAY,EAAE,GAAG,kBAAkB,CAAC,CAAC;IACvD,MAAM,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAC5C,sCAAa,CAAoB,OAAO,CAAC,CAC1C,CAAC;IACF,OAAO,CAAC,aAAa,EAAE,IAAI,EAAE,EAAE;QAC7B,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;YAC/B,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;SAC/C;QACD,MAAM,eAAe,GAAG,IAAI,uBAAe,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAC3E,OAAO,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC,CAAC;AACJ,CAAC;AAhBD,oCAgBC;AAED;;;;;;;;GAQG;AACH,SAAgB,gBAAgB,CAC9B,iBAAgD,EAChD,gBAAsB;IAEtB,OAAO,0CAAiB,CACtB,iBAAiB,EACjB,gBAAgB,CACjB,CAAC;AACJ,CAAC;AARD,4CAQC;AAED;;;;;;;;;GASG;AACH,SAAgB,yBAAyB,CACvC,GAAY,EACZ,iBAAgD,EAChD,gBAAsB,EACtB,UAAoC,EAAE;;IAEtC,OAAO,GAAG,EAAC,mBAAmB,EAAE,IAAI,EAAE,GAAG,OAAO,EAAC,CAAC;IAClD,OAAO,CAAC,KAAK,SAAG,OAAO,CAAC,KAAK,mCAAI,gCAAwB,CAAC;IAC1D,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE;QAChC,MAAM,UAAU,GAAG,gBAAgB,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;QACzE,OAAO,kBAAkB,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;KACrD;IAED,MAAM,aAAa,GAAG,kDAAyB,CAC7C,iBAAiB,EACjB,gBAAgB,EAChB,OAAO,CACR,CAAC;IACF,OAAO,kBAAkB,CAAC,GAAG,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;AACzD,CAAC;AAnBD,8DAmBC;AAED;;;GAGG;AACH,SAAgB,YAAY,CAC1B,UAAoC,EAAE;IAEtC,OAAO,SAAS,yBAAyB,CAAC,OAAO;;QAC/C,OAAO;aACJ,KAAK,CAAC,mBAAY,OAAC,OAAO,CAAC,KAAK,mCAAI,gCAAwB,CAAC,CAAC;aAC9D,GAAG,CAAC,EAAC,KAAK,QAAE,OAAO,CAAC,KAAK,mCAAI,+BAAwB,EAAC,CAAC,CAAC;QAC3D,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;QAC5C,IAAI,YAAY,IAAI,IAAI,EAAE;YACxB,OAAO,CAAC,GAAG,CAAC;gBACV,cAAc,EACZ,OAAO,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY;aACnE,CAAC,CAAC;SACJ;QACD,MAAM,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC;QAC7C,IAAI,WAAW,IAAI,IAAI,EAAE;YACvB,OAAO,CAAC,GAAG,CAAC;gBACV,gBAAgB,EACd,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW;aAChE,CAAC,CAAC;SACJ;IACH,CAAC,CAAC;AACJ,CAAC;AAtBD,oCAsBC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,GAAY,EACZ,UAA0D,EAC1D,OAAiC;;IAEjC,IAAI,sBAAe,CAAC,UAA+C,CAAC,EAAE;QACpE,MAAM,OAAO,GAAG,uBAAuB,CACrC,UAA+C,EAC/C,OAAO,CACR,CAAC;QACF,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACjB,OAAO,OAAO,CAAC;KAChB;IACD,MAAM,GAAG,SAAG,OAAO,CAAC,GAAG,mCAAI,iBAAU,CAAC,QAAQ,CAAC,2BAAoB,CAAC,CAAC;IACrE,OAAO,GAAG;SACP,IAAI,CAAC,GAAG,CAAC;SACT,EAAE,CAAC,UAAwB,CAAC;SAC5B,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;AAClC,CAAC;AAlBD,gDAkBC;AAED;;;;;;GAMG;AACH,SAAgB,uBAAuB,CACrC,uBAA0D,EAC1D,UAAoC,EAAE;;IAEtC,OAAO,CAAC,KAAK,SAAG,OAAO,CAAC,KAAK,mCAAI,gCAAwB,CAAC;IAC1D,MAAM,OAAO,GAAG,6BAAsB,CAAC,uBAAuB,EAAE;QAC9D,YAAY,EAAE,mBAAY,CAAC,SAAS;QACpC,SAAS,EAAE,2BAAoB;QAC/B,GAAG,EAAE,OAAO,CAAC,GAAG;KACjB,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;IAChC,OAAO,OAAO,CAAC;AACjB,CAAC;AAXD,0DAWC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,aAAgC,EAChC,OAAiC;IAEjC,KAAK,CACH,gDAAgD,EAChD,aAAa,CAAC,OAAO,CAAC,MAAM,EAC5B,aAAa,CAAC,OAAO,CAAC,WAAW,EACjC,OAAO,CACR,CAAC;IACF,IAAI,IAAI,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,CAAC;IACnC,IAAI,IAAI,IAAI,IAAI,EAAE;QAChB,MAAM,IAAI,GAAG,IAAI,cAAc,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAClC,IAAI,CAAC,KAAK,EAAE,CAAC;KACd;IACD,MAAM,OAAO,GAAG,IAAI,uBAAe,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IACzD,OAAO,OAAO,CAAC,kBAAkB,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,CAAC,CAAC;AACnD,CAAC;AAlBD,4CAkBC;AAED;;;;;GAKG;AACH,MAAa,cAAe,SAAQ,kBAAW;IAI7C,YAAY,GAAY,EAAE,OAAiC;;QACzD,wDAAwD;QACxD,MAAM,MAAM,GAAG,sBAAe,OAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,mCAAI,gCAAwB,CAAC,CAAC;QAC3E,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG;YACb,KAAK,EAAE,gCAAwB;YAC/B,aAAa,EAAE,EAAE;YACjB,GAAG,OAAO;SACX,CAAC;QACF,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAED,OAAO;QACL,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,qBAAqB;QACvB,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAEO,mBAAmB;;QACzB,MAAM,kBAAkB,GAAG,IAAI,CAAC,QAAQ,CAAC;QACzC,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,KAAK,CACH,sCAAsC,EACtC,IAAI,CAAC,OAAO,CAAC,KAAK,EAClB,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CACnC,CAAC;SACH;QAED,gDAAgD;QAChD,MAAM,sBAAsB,GAAe,EAAE,CAAC;QAC9C,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;;YAC7B,MAAM,KAAK,SAAW,CAAC,CAAC,MAAM,CAAC,KAAK,mCAAI,+BAAwB,CAAC;YACjE,MAAM,YAAY,SAAa,CAAC,CAAC,MAAM,CAAC,cAAc,mCAAI,EAAE,CAAC;YAC7D,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;YACnE,MAAM,WAAW,SAAa,CAAC,CAAC,MAAM,CAAC,gBAAgB,mCAAI,EAAE,CAAC;YAC9D,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,+BAAgB,CAC5B,GAAG,sBAAsB,EACzB,IAAI,CAAC,OAAO,CAAC,aAAc,CAC5B,CAAC;QAEF;;WAEG;QACH,IAAI,cAAO,IAAI,CAAC,OAAO,0CAAE,QAAQ,CAAA,KAAK,UAAU,EAAE;YAChD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAC9B;QAED,IAAI,CAAC,IAAI,GAAG,kBAAkB;aAC3B,IAAI,CAAC,2BAAoB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;aAC1C,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACrB,CAAC;CACF;AAjED,wCAiEC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAgB,uBAAuB,CACrC,aAAgC,EAChC,GAAG,QAAiC;IAEpC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;KACxE;IACD,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACnE,KAAK,CACH,qCAAqC,EACrC,aAAa,CAAC,OAAO,CAAC,MAAM,EAC5B,aAAa,CAAC,OAAO,CAAC,WAAW,CAClC,CAAC;IACF,4CAA4C;IAC5C,MAAM,MAAM,GAAG,UAAU,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC1D,oCAAoC;IACpC,OAAO,8BAAuB,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,aAAa,CAAC,QAAQ,CAAC,CAAC;AAChF,CAAC;AAjBD,0DAiBC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,GAAY;IAC9C,OAAO,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC9B,MAAM,aAAa,GAAG,IAAI,yBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QAC3D,iDAAiD;QACjD,8DAA8D;QAC7D,GAAW,CAAC,0BAAkB,CAAC,GAAG,aAAa,CAAC;QAEjD,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,aAAa,CAAC,CAAC;YACrD,IAAI,MAAM,KAAK,GAAG,EAAE;gBAClB,IAAI,EAAE,CAAC;aACR;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,GAAG,CAAC,CAAC;SACX;IACH,CAAC,CAAC;AACJ,CAAC;AAhBD,kDAgBC"}

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { BindingAddress, Context, GenericInterceptor, GenericInterceptorChain, InvocationContext, Next, ValueOrPromise } from '@loopback/core';
+import { BindingAddress, Context, GenericInterceptor, GenericInterceptorChain, GenericInterceptorOrKey, InvocationContext, Next, ValueOrPromise } from '@loopback/core';
 import { Request, RequestHandler, Response } from 'express';
 export { Request, Response, Router, RouterOptions } from 'express';
 /**
@@ -20,6 +20,10 @@ export declare type ExpressRequestHandler = RequestHandler;
 export declare class MiddlewareContext extends Context implements HandlerContext {
     readonly request: Request;
     readonly response: Response;
+    /**
+     * A flag to tell if the response is finished.
+     */
+    responseFinished: boolean;
     /**
      * Constructor for `MiddlewareContext`
      * @param request - Express request object
@@ -33,7 +37,28 @@ export declare class MiddlewareContext extends Context implements HandlerContext
 /**
  * Interface LoopBack 4 middleware to be executed within sequence of actions.
  * A middleware for LoopBack is basically a generic interceptor that uses
- * `RequestContext`.
+ * `MiddlewareContext`.
+ *
+ * @remarks
+ *
+ * The middleware function is responsible for processing HTTP requests and
+ * responses. It typically includes the following logic.
+ *
+ * 1. Process the request with one of the following outcome
+ *   - Reject the request by throwing an error if request is invalid, such as
+ *     validation or authentication failures
+ *   - Produce a response by itself, such as from the cache
+ *   - Proceed by calling `await next()` to invoke downstream middleware. When
+ *     `await next()` returns, it goes to step 2. If an error thrown from
+ *     `await next()`, step 3 handles the error.
+ *
+ * 2. Process the response with one the following outcome
+ *   - Reject the response by throwing an error
+ *   - Replace the response with its own value
+ *   - Return the response to upstream middleware
+ *
+ * 3. Catch the error thrown from `await next()`. If the `catch` block does not
+ * exist, the error will be bubbled up to upstream middleware
  *
  * The signature of a middleware function is described at
  * {@link https://loopback.io/doc/en/lb4/apidocs.express.middleware.html | Middleware}.
@@ -64,6 +89,10 @@ export interface Middleware extends GenericInterceptor<MiddlewareContext> {
  */
 export declare class MiddlewareChain extends GenericInterceptorChain<MiddlewareContext> {
 }
+/**
+ * A middleware function or binding key
+ */
+export declare type MiddlewareOrKey = GenericInterceptorOrKey<MiddlewareContext>;
 /**
  * Default extension point name for middleware
  */
@@ -78,9 +107,23 @@ export interface InvokeMiddlewareOptions {
      */
     chain?: string;
     /**
-     * An array of group names to denote the order of execution
+     * An array of group names to denote the order of execution, such as
+     * `['cors', 'caching', 'rate-limiting']`.
      */
     orderedGroups?: string[];
+    /**
+     * An optional function to validate the sorted groups before invoking the
+     * middleware chain
+     */
+    validate?: (groups: string[]) => void;
+    /**
+     * Pre-built middleware list. If set, the list will be used to create the
+     * middleware chain without discovering again within the context.
+     */
+    middlewareList?: MiddlewareOrKey[];
+    /**
+     * Optional next handler
+     */
     next?: Next;
 }
 /**
@@ -173,6 +216,22 @@ export interface MiddlewareBindingOptions extends BaseMiddlewareBindingOptions<M
      * Name of the middleware extension point. Default to `DEFAULT_MIDDLEWARE_CHAIN`.
      */
     chain?: string;
+    /**
+     * An array of group names for upstream middleware in the cascading order.
+     *
+     * For example, the  `invokeMethod` depends on `parseParams` for request
+     * processing. The `upstreamGroups` for `invokeMethod` should be
+     * `['parseParams']`. The order of groups in the array does not matter.
+     */
+    upstreamGroups?: string | string[];
+    /**
+     * An array of group names for downstream middleware in the cascading order.
+     *
+     * For example, the  `sendResponse` depends on `invokeMethod` for response
+     * processing. The `downstreamGroups` for `sendResponse` should be
+     * `['invokeMethod']`. The order of groups in the array does not matter.
+     */
+    downstreamGroups?: string | string[];
 }
 /**
  * Interface for an express middleware factory
@@ -185,3 +244,21 @@ export interface ExpressMiddlewareFactory<C> {
  * A symbol to store `MiddlewareContext` on the request object
  */
 export declare const MIDDLEWARE_CONTEXT: unique symbol;
+/**
+ * Constants for middleware groups
+ */
+export declare namespace MiddlewareGroups {
+    /**
+     * Enforce CORS
+     */
+    const CORS = "cors";
+    /**
+     * Server OpenAPI specs
+     */
+    const API_SPEC = "apiSpec";
+    /**
+     * Default middleware group
+     */
+    const MIDDLEWARE = "middleware";
+    const DEFAULT = "middleware";
+}

package/dist/types.js

@@ -4,7 +4,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MIDDLEWARE_CONTEXT = exports.DEFAULT_MIDDLEWARE_CHAIN = exports.MiddlewareChain = exports.MiddlewareContext = void 0;
+exports.MiddlewareGroups = exports.MIDDLEWARE_CONTEXT = exports.DEFAULT_MIDDLEWARE_CHAIN = exports.MiddlewareChain = exports.MiddlewareContext = exports.Router = void 0;
 const tslib_1 = require("tslib");
 const core_1 = require("@loopback/core");
 const on_finished_1 = tslib_1.__importDefault(require("on-finished"));
@@ -27,8 +27,13 @@ class MiddlewareContext extends core_1.Context {
         super(parent, name);
         this.request = request;
         this.response = response;
+        /**
+         * A flag to tell if the response is finished.
+         */
+        this.responseFinished = false;
         this.setupBindings();
         on_finished_1.default(this.response, () => {
+            this.responseFinished = true;
             // Close the request context when the http response is finished so that
             // it can be recycled by GC
             this.emit('close');
@@ -55,4 +60,23 @@ exports.DEFAULT_MIDDLEWARE_CHAIN = 'middlewareChain.default';
  * A symbol to store `MiddlewareContext` on the request object
  */
 exports.MIDDLEWARE_CONTEXT = Symbol('loopback.middleware.context');
+/**
+ * Constants for middleware groups
+ */
+var MiddlewareGroups;
+(function (MiddlewareGroups) {
+    /**
+     * Enforce CORS
+     */
+    MiddlewareGroups.CORS = 'cors';
+    /**
+     * Server OpenAPI specs
+     */
+    MiddlewareGroups.API_SPEC = 'apiSpec';
+    /**
+     * Default middleware group
+     */
+    MiddlewareGroups.MIDDLEWARE = 'middleware';
+    MiddlewareGroups.DEFAULT = MiddlewareGroups.MIDDLEWARE;
+})(MiddlewareGroups = exports.MiddlewareGroups || (exports.MiddlewareGroups = {}));
 //# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCAQwB;AAExB,sEAAqC;AACrC,iCAA0C;AAE1C,mCAAiE;AAAtC,iGAAA,MAAM,OAAA;AAgBjC;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,cAAO;IAC5C;;;;;;OAMG;IACH,YACkB,OAAgB,EAChB,QAAkB,EAClC,MAAgB,EAChB,IAAa;QAEb,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QALJ,YAAO,GAAP,OAAO,CAAS;QAChB,aAAQ,GAAR,QAAQ,CAAU;QAKlC,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,qBAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE;YAC7B,uEAAuE;YACvE,2BAA2B;YAC3B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnB,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC;IAES,aAAa;QACrB,IAAI,CAAC,IAAI,CAAC,yBAAkB,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IACxD,CAAC;CACF;AA3BD,8CA2BC;AA8BD;;;GAGG;AACH,MAAa,eAAgB,SAAQ,8BAEpC;CAAG;AAFJ,0CAEI;AAEJ;;GAEG;AACU,QAAA,wBAAwB,GAAG,yBAAyB,CAAC;AAqIlE;;GAEG;AACU,QAAA,kBAAkB,GAAG,MAAM,CAAC,6BAA6B,CAAC,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCASwB;AAExB,sEAAqC;AACrC,iCAA0C;AAE1C,mCAAiE;AAAtC,iGAAA,MAAM,OAAA;AAgBjC;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,cAAO;IAM5C;;;;;;OAMG;IACH,YACkB,OAAgB,EAChB,QAAkB,EAClC,MAAgB,EAChB,IAAa;QAEb,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QALJ,YAAO,GAAP,OAAO,CAAS;QAChB,aAAQ,GAAR,QAAQ,CAAU;QAdpC;;WAEG;QACH,qBAAgB,GAAG,KAAK,CAAC;QAgBvB,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,qBAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE;YAC7B,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;YAC7B,uEAAuE;YACvE,2BAA2B;YAC3B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnB,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC;IAES,aAAa;QACrB,IAAI,CAAC,IAAI,CAAC,yBAAkB,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IACxD,CAAC;CACF;AAjCD,8CAiCC;AAmDD;;;GAGG;AACH,MAAa,eAAgB,SAAQ,8BAEpC;CAAG;AAFJ,0CAEI;AAOJ;;GAEG;AACU,QAAA,wBAAwB,GAAG,yBAAyB,CAAC;AAwKlE;;GAEG;AACU,QAAA,kBAAkB,GAAG,MAAM,CAAC,6BAA6B,CAAC,CAAC;AAExE;;GAEG;AACH,IAAiB,gBAAgB,CAgBhC;AAhBD,WAAiB,gBAAgB;IAC/B;;OAEG;IACU,qBAAI,GAAG,MAAM,CAAC;IAE3B;;OAEG;IACU,yBAAQ,GAAG,SAAS,CAAC;IAElC;;OAEG;IACU,2BAAU,GAAG,YAAY,CAAC;IAC1B,wBAAO,GAAG,iBAAA,UAAU,CAAC;AACpC,CAAC,EAhBgB,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAgBhC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loopback/express",
-  "version": "1.2.5",
+  "version": "1.4.1",
   "description": "Integrate with Express and expose middleware infrastructure for sequence and interceptors",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -37,28 +37,30 @@
     "!*/__tests__"
   ],
   "dependencies": {
-    "@loopback/core": "^2.9.1",
-    "@loopback/http-server": "^2.1.9",
+    "@loopback/core": "^2.9.5",
+    "@loopback/http-server": "^2.2.0",
     "@types/body-parser": "^1.19.0",
-    "@types/express": "^4.17.6",
-    "@types/express-serve-static-core": "^4.17.8",
-    "@types/http-errors": "^1.6.3",
+    "@types/express": "^4.17.7",
+    "@types/express-serve-static-core": "^4.17.9",
+    "@types/http-errors": "^1.8.0",
     "body-parser": "^1.19.0",
     "debug": "^4.1.1",
     "express": "^4.17.1",
     "http-errors": "^1.8.0",
     "on-finished": "^2.3.0",
-    "tslib": "^2.0.0"
+    "toposort": "^2.0.2",
+    "tslib": "^2.0.1"
   },
   "devDependencies": {
-    "@loopback/build": "^6.1.0",
-    "@loopback/testlab": "^3.2.0",
+    "@loopback/build": "^6.2.2",
+    "@loopback/testlab": "^3.2.4",
     "@types/debug": "^4.1.5",
-    "@types/node": "^10.17.26",
+    "@types/node": "^10.17.28",
     "@types/on-finished": "^2.3.1",
+    "@types/toposort": "^2.0.3",
     "http-errors": "^1.8.0",
     "source-map-support": "^0.5.19",
-    "typescript": "~3.9.5"
+    "typescript": "~4.0.2"
   },
-  "gitHead": "b89db3d3b8be6a36e63e91c2331d217fda7538de"
+  "gitHead": "a3f54273814de63819e0d8bc86509f8a737800bb"
 }

package/src/group-sorter.ts

@@ -0,0 +1,35 @@
+// Copyright IBM Corp. 2020. All Rights Reserved.
+// Node module: @loopback/express
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import debugFactory from 'debug';
+import toposort from 'toposort';
+const debug = debugFactory('loopback:middleware');
+/**
+ * Sort the groups by their relative order
+ * @param orderedGroups - A list of arrays - each of which represents a partial
+ * order of groups.
+ */
+export function sortListOfGroups(...orderedGroups: string[][]) {
+  if (debug.enabled) {
+    debug(
+      'Dependency graph: %s',
+      orderedGroups.map(edge => edge.join('->')).join(', '),
+    );
+  }
+  const graph: [string, string][] = [];
+  for (const groups of orderedGroups) {
+    if (groups.length >= 2) {
+      groups.reduce((prev: string | undefined, group) => {
+        if (typeof prev === 'string') {
+          graph.push([prev, group]);
+        }
+        return group;
+      }, undefined);
+    }
+  }
+  const sorted = toposort(graph);
+  debug('Sorted groups: %s', sorted.join('->'));
+  return sorted;
+}

package/src/index.ts

@@ -22,6 +22,7 @@
  */
 export * from './express.application';
 export * from './express.server';
+export * from './group-sorter';
 export * from './keys';
 export * from './middleware';
 export * from './middleware-interceptor';

package/src/keys.ts

@@ -4,7 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {BindingKey} from '@loopback/core';
-import {MiddlewareContext} from './types';
+import {MiddlewareContext, MiddlewareGroups} from './types';
 
 export namespace MiddlewareBindings {
   /**
@@ -34,4 +34,4 @@ export const MIDDLEWARE_INTERCEPTOR_NAMESPACE = 'globalInterceptors.middleware';
 /**
  * Default order group name for Express middleware based global interceptors
  */
-export const DEFAULT_MIDDLEWARE_GROUP = 'middleware';
+export const DEFAULT_MIDDLEWARE_GROUP = MiddlewareGroups.DEFAULT;

package/src/middleware.ts

@@ -11,6 +11,7 @@ import {
   compareBindingsByTag,
   Constructor,
   Context,
+  ContextView,
   createBindingFromClass,
   extensionFilter,
   extensionFor,
@@ -21,6 +22,7 @@ import {
   ValueOrPromise,
 } from '@loopback/core';
 import debugFactory from 'debug';
+import {sortListOfGroups} from './group-sorter';
 import {DEFAULT_MIDDLEWARE_GROUP, MIDDLEWARE_NAMESPACE} from './keys';
 import {
   createInterceptor,
@@ -133,6 +135,20 @@ export function asMiddleware(
     binding
       .apply(extensionFor(options.chain ?? DEFAULT_MIDDLEWARE_CHAIN))
       .tag({group: options.group ?? DEFAULT_MIDDLEWARE_GROUP});
+    const groupsBefore = options.upstreamGroups;
+    if (groupsBefore != null) {
+      binding.tag({
+        upstreamGroups:
+          typeof groupsBefore === 'string' ? [groupsBefore] : groupsBefore,
+      });
+    }
+    const groupsAfter = options.downstreamGroups;
+    if (groupsAfter != null) {
+      binding.tag({
+        downstreamGroups:
+          typeof groupsAfter === 'string' ? [groupsAfter] : groupsAfter,
+      });
+    }
   };
 }
 
@@ -199,24 +215,89 @@ export function invokeMiddleware(
     middlewareCtx.request.originalUrl,
     options,
   );
-  const {chain = DEFAULT_MIDDLEWARE_CHAIN, orderedGroups} = options ?? {};
-  // Find extensions for the given extension point binding
-  const filter = extensionFilter(chain);
-  if (debug.enabled) {
-    debug(
-      'Middleware for extension point "%s":',
-      chain,
-      middlewareCtx.find(filter).map(b => b.key),
-    );
+  let keys = options?.middlewareList;
+  if (keys == null) {
+    const view = new MiddlewareView(middlewareCtx, options);
+    keys = view.middlewareBindingKeys;
+    view.close();
   }
-  const mwChain = new MiddlewareChain(
-    middlewareCtx,
-    filter,
-    compareBindingsByTag('group', orderedGroups),
-  );
+  const mwChain = new MiddlewareChain(middlewareCtx, keys);
   return mwChain.invokeInterceptors(options?.next);
 }
 
+/**
+ * Watch middleware binding keys for the given context and sort them by
+ * group
+ * @param ctx - Context object
+ * @param options - Middleware options
+ */
+export class MiddlewareView extends ContextView {
+  private options: InvokeMiddlewareOptions;
+  private keys: string[];
+
+  constructor(ctx: Context, options?: InvokeMiddlewareOptions) {
+    // Find extensions for the given extension point binding
+    const filter = extensionFilter(options?.chain ?? DEFAULT_MIDDLEWARE_CHAIN);
+    super(ctx, filter);
+    this.options = {
+      chain: DEFAULT_MIDDLEWARE_CHAIN,
+      orderedGroups: [],
+      ...options,
+    };
+    this.buildMiddlewareKeys();
+    this.open();
+  }
+
+  refresh() {
+    super.refresh();
+    this.buildMiddlewareKeys();
+  }
+
+  /**
+   * A list of binding keys sorted by group for registered middleware
+   */
+  get middlewareBindingKeys() {
+    return this.keys;
+  }
+
+  private buildMiddlewareKeys() {
+    const middlewareBindings = this.bindings;
+    if (debug.enabled) {
+      debug(
+        'Middleware for extension point "%s":',
+        this.options.chain,
+        middlewareBindings.map(b => b.key),
+      );
+    }
+
+    // Calculate orders from middleware dependencies
+    const ordersFromDependencies: string[][] = [];
+    middlewareBindings.forEach(b => {
+      const group: string = b.tagMap.group ?? DEFAULT_MIDDLEWARE_GROUP;
+      const groupsBefore: string[] = b.tagMap.upstreamGroups ?? [];
+      groupsBefore.forEach(d => ordersFromDependencies.push([d, group]));
+      const groupsAfter: string[] = b.tagMap.downstreamGroups ?? [];
+      groupsAfter.forEach(d => ordersFromDependencies.push([group, d]));
+    });
+
+    const order = sortListOfGroups(
+      ...ordersFromDependencies,
+      this.options.orderedGroups!,
+    );
+
+    /**
+     * Validate sorted groups
+     */
+    if (typeof this.options?.validate === 'function') {
+      this.options.validate(order);
+    }
+
+    this.keys = middlewareBindings
+      .sort(compareBindingsByTag('group', order))
+      .map(b => b.key);
+  }
+}
+
 /**
  * Invoke a list of Express middleware handler functions
  *

package/src/types.ts

@@ -8,6 +8,7 @@ import {
   Context,
   GenericInterceptor,
   GenericInterceptorChain,
+  GenericInterceptorOrKey,
   InvocationContext,
   Next,
   ValueOrPromise,
@@ -37,6 +38,11 @@ export type ExpressRequestHandler = RequestHandler;
  * context (request, response, etc.).
  */
 export class MiddlewareContext extends Context implements HandlerContext {
+  /**
+   * A flag to tell if the response is finished.
+   */
+  responseFinished = false;
+
   /**
    * Constructor for `MiddlewareContext`
    * @param request - Express request object
@@ -53,6 +59,7 @@ export class MiddlewareContext extends Context implements HandlerContext {
     super(parent, name);
     this.setupBindings();
     onFinished(this.response, () => {
+      this.responseFinished = true;
       // Close the request context when the http response is finished so that
       // it can be recycled by GC
       this.emit('close');
@@ -68,7 +75,28 @@ export class MiddlewareContext extends Context implements HandlerContext {
 /**
  * Interface LoopBack 4 middleware to be executed within sequence of actions.
  * A middleware for LoopBack is basically a generic interceptor that uses
- * `RequestContext`.
+ * `MiddlewareContext`.
+ *
+ * @remarks
+ *
+ * The middleware function is responsible for processing HTTP requests and
+ * responses. It typically includes the following logic.
+ *
+ * 1. Process the request with one of the following outcome
+ *   - Reject the request by throwing an error if request is invalid, such as
+ *     validation or authentication failures
+ *   - Produce a response by itself, such as from the cache
+ *   - Proceed by calling `await next()` to invoke downstream middleware. When
+ *     `await next()` returns, it goes to step 2. If an error thrown from
+ *     `await next()`, step 3 handles the error.
+ *
+ * 2. Process the response with one the following outcome
+ *   - Reject the response by throwing an error
+ *   - Replace the response with its own value
+ *   - Return the response to upstream middleware
+ *
+ * 3. Catch the error thrown from `await next()`. If the `catch` block does not
+ * exist, the error will be bubbled up to upstream middleware
  *
  * The signature of a middleware function is described at
  * {@link https://loopback.io/doc/en/lb4/apidocs.express.middleware.html | Middleware}.
@@ -101,6 +129,11 @@ export class MiddlewareChain extends GenericInterceptorChain<
   MiddlewareContext
 > {}
 
+/**
+ * A middleware function or binding key
+ */
+export type MiddlewareOrKey = GenericInterceptorOrKey<MiddlewareContext>;
+
 /**
  * Default extension point name for middleware
  */
@@ -115,11 +148,28 @@ export interface InvokeMiddlewareOptions {
    * from the binding
    */
   chain?: string;
+
   /**
-   * An array of group names to denote the order of execution
+   * An array of group names to denote the order of execution, such as
+   * `['cors', 'caching', 'rate-limiting']`.
    */
   orderedGroups?: string[];
 
+  /**
+   * An optional function to validate the sorted groups before invoking the
+   * middleware chain
+   */
+  validate?: (groups: string[]) => void;
+
+  /**
+   * Pre-built middleware list. If set, the list will be used to create the
+   * middleware chain without discovering again within the context.
+   */
+  middlewareList?: MiddlewareOrKey[];
+
+  /**
+   * Optional next handler
+   */
   next?: Next;
 }
 
@@ -227,6 +277,24 @@ export interface MiddlewareBindingOptions
    * Name of the middleware extension point. Default to `DEFAULT_MIDDLEWARE_CHAIN`.
    */
   chain?: string;
+
+  /**
+   * An array of group names for upstream middleware in the cascading order.
+   *
+   * For example, the  `invokeMethod` depends on `parseParams` for request
+   * processing. The `upstreamGroups` for `invokeMethod` should be
+   * `['parseParams']`. The order of groups in the array does not matter.
+   */
+  upstreamGroups?: string | string[];
+
+  /**
+   * An array of group names for downstream middleware in the cascading order.
+   *
+   * For example, the  `sendResponse` depends on `invokeMethod` for response
+   * processing. The `downstreamGroups` for `sendResponse` should be
+   * `['invokeMethod']`. The order of groups in the array does not matter.
+   */
+  downstreamGroups?: string | string[];
 }
 
 /**
@@ -241,3 +309,24 @@ export interface ExpressMiddlewareFactory<C> {
  * A symbol to store `MiddlewareContext` on the request object
  */
 export const MIDDLEWARE_CONTEXT = Symbol('loopback.middleware.context');
+
+/**
+ * Constants for middleware groups
+ */
+export namespace MiddlewareGroups {
+  /**
+   * Enforce CORS
+   */
+  export const CORS = 'cors';
+
+  /**
+   * Server OpenAPI specs
+   */
+  export const API_SPEC = 'apiSpec';
+
+  /**
+   * Default middleware group
+   */
+  export const MIDDLEWARE = 'middleware';
+  export const DEFAULT = MIDDLEWARE;
+}