@midwayjs/faas 3.4.0-beta.1 → 3.4.0-beta.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 - Now midwayjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/configuration.js

@@ -33,8 +33,10 @@ let FaaSConfiguration = class FaaSConfiguration {
     async onReady(container) { }
     async onServerReady() {
         if (!this.framework.isEnable()) {
+            // just in legacy local dev and test
             await this.framework.run();
         }
+        await this.framework.loadFunction();
     }
 };
 __decorate([

package/dist/framework.d.ts

@@ -11,34 +11,29 @@ export declare class MidwayFaaSFramework extends BaseFramework<Application, Cont
     app: Application;
     private isReplaceLogger;
     private developmentRun;
-    private serverlessRoutes;
     private server;
     private respond;
     private applicationAdapter;
+    private serverlessFunctionService;
     protected httpMiddlewareManager: ContextMiddlewareManager<Context, unknown, unknown>;
     protected eventMiddlewareManager: ContextMiddlewareManager<Context, unknown, unknown>;
+    private legacyVersion;
+    private loadedFunction;
     environmentService: MidwayEnvironmentService;
     middlewareService: MidwayMiddlewareService<Context, any>;
     configure(options: IFaaSConfigurationOptions): any;
     isEnable(): boolean;
     applicationInitialize(options: IMidwayBootstrapOptions): Promise<void>;
     run(): Promise<void>;
+    loadFunction(): Promise<void>;
     getFrameworkType(): MidwayFrameworkType;
     /**
      * @deprecated
      * @param handlerMapping
      */
     handleInvokeWrapper(handlerMapping: string): (...args: any[]) => Promise<any>;
-    getTriggerFunction(handlerMapping: string): (context: any, options: HandlerOptions) => Promise<{
-        result: any;
-        error: Error;
-    } | {
-        isBase64Encoded: boolean;
-        statusCode: any;
-        headers: any;
-        body: any;
-    }>;
-    wrapHttpRequest(req: http.IncomingMessage, res?: http.ServerResponse): Promise<unknown>;
+    getTriggerFunction(handlerMapping: string): (context: any, options: HandlerOptions) => Promise<any>;
+    wrapHttpRequest(req: http.IncomingMessage | Record<string, any>, res?: http.ServerResponse): Promise<unknown>;
     /**
      * @deprecated
      * @param middlewareId
@@ -50,11 +45,11 @@ export declare class MidwayFaaSFramework extends BaseFramework<Application, Cont
     createLogger(name: string, option?: LoggerOptions): import("@midwayjs/core").ILogger;
     getFrameworkName(): string;
     getServer(): http.Server;
+    beforeStop(): Promise<void>;
     protected createHttpContext(req: any, res: any): Promise<unknown>;
     useMiddleware(middleware: CommonMiddlewareUnion<Context, NextFunction, undefined>): void;
     useEventMiddleware(middleware: CommonMiddlewareUnion<Context, NextFunction, undefined>): void;
     getEventMiddleware(): ContextMiddlewareManager<Context, NextFunction, undefined>;
     getAllHandlerNames(): string[];
 }
-export declare const createModuleServerlessFramework: (globalOption: Omit<IMidwayBootstrapOptions, 'applicationContext'> & IFaaSConfigurationOptions) => Promise<MidwayFaaSFramework>;
 //# sourceMappingURL=framework.d.ts.map

package/dist/framework.js

@@ -9,12 +9,14 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createModuleServerlessFramework = exports.MidwayFaaSFramework = void 0;
+exports.MidwayFaaSFramework = void 0;
 const core_1 = require("@midwayjs/core");
 const decorator_1 = require("@midwayjs/decorator");
 const simple_lock_1 = require("@midwayjs/simple-lock");
 const logger_1 = require("@midwayjs/logger");
 const serverless_http_parser_1 = require("@midwayjs/serverless-http-parser");
+const util_1 = require("util");
+const { isAnyArrayBuffer, isUint8Array } = util_1.types;
 const LOCK_KEY = '_faas_starter_start_key';
 let MidwayFaaSFramework = class MidwayFaaSFramework extends core_1.BaseFramework {
     constructor() {
@@ -24,9 +26,10 @@ let MidwayFaaSFramework = class MidwayFaaSFramework extends core_1.BaseFramework
         this.lock = new simple_lock_1.default();
         this.isReplaceLogger = process.env['MIDWAY_SERVERLESS_REPLACE_LOGGER'] === 'true';
         this.developmentRun = false;
-        this.serverlessRoutes = [];
         this.httpMiddlewareManager = this.createMiddlewareManager();
         this.eventMiddlewareManager = this.createMiddlewareManager();
+        this.legacyVersion = false;
+        this.loadedFunction = false;
     }
     configure(options) {
         var _a;
@@ -49,6 +52,9 @@ let MidwayFaaSFramework = class MidwayFaaSFramework extends core_1.BaseFramework
         }
         this.applicationAdapter =
             this.configurationOptions.applicationAdapter || {};
+        if (this.applicationAdapter.getApplication) {
+            this.legacyVersion = true;
+        }
         this.app =
             ((_b = (_a = this.applicationAdapter).getApplication) === null || _b === void 0 ? void 0 : _b.call(_a)) ||
                 new serverless_http_parser_1.Application();
@@ -104,26 +110,27 @@ let MidwayFaaSFramework = class MidwayFaaSFramework extends core_1.BaseFramework
         }
     }
     async run() {
-        return this.lock.sureOnce(async () => {
-            var _a;
-            // set app keys
-            this.app['keys'] = (_a = this.configService.getConfiguration('keys')) !== null && _a !== void 0 ? _a : '';
-            // store all http function entry
-            const collector = new core_1.ServerlessTriggerCollector();
-            const functionList = await collector.getFunctionList();
-            for (const funcInfo of functionList) {
-                // store handler
-                this.funMappingStore.set(funcInfo.funcHandlerName, funcInfo);
-                if (funcInfo.url) {
-                    // store router
-                    this.serverlessRoutes.push({
-                        matchPattern: (0, core_1.pathToRegexp)(funcInfo.url, [], { end: false }),
-                        funcInfo: funcInfo,
-                    });
+        if (this.legacyVersion) {
+            return this.loadFunction();
+        }
+    }
+    async loadFunction() {
+        if (!this.loadedFunction) {
+            this.loadedFunction = true;
+            return this.lock.sureOnce(async () => {
+                var _a;
+                // set app keys
+                this.app['keys'] = (_a = this.configService.getConfiguration('keys')) !== null && _a !== void 0 ? _a : '';
+                // store all http function entry
+                this.serverlessFunctionService = await this.applicationContext.getAsync(core_1.MidwayServerlessFunctionService);
+                const functionList = await this.serverlessFunctionService.getFunctionList();
+                for (const funcInfo of functionList) {
+                    // store handler
+                    this.funMappingStore.set(funcInfo.funcHandlerName, funcInfo);
                 }
-            }
-            this.respond = this.app.callback();
-        }, LOCK_KEY);
+                this.respond = this.app.callback();
+            }, LOCK_KEY);
+        }
     }
     getFrameworkType() {
         return core_1.MidwayFrameworkType.FAAS;
@@ -160,7 +167,13 @@ let MidwayFaaSFramework = class MidwayFaaSFramework extends core_1.BaseFramework
                         // invoke handler
                         const result = await this.invokeHandler(funOptions, ctx, args, isHttpFunction);
                         if (isHttpFunction && result !== undefined) {
-                            ctx.body = result;
+                            if (result === null) {
+                                // 这样设置可以绕过 koa 的 _explicitStatus 赋值机制
+                                ctx.response._body = null;
+                            }
+                            else {
+                                ctx.body = result;
+                            }
                         }
                         return result;
                     },
@@ -177,12 +190,10 @@ let MidwayFaaSFramework = class MidwayFaaSFramework extends core_1.BaseFramework
             var _a;
             const isHttpFunction = options.isHttpFunction;
             if (!funOptions && isHttpFunction) {
-                for (const item of this.serverlessRoutes) {
-                    if (context.method === item.funcInfo['requestMethod'].toUpperCase() &&
-                        item.matchPattern.test(context.path)) {
-                        funOptions = item.funcInfo;
-                        break;
-                    }
+                funOptions = await this.serverlessFunctionService.getMatchedRouterInfo(context.path, context.method);
+                if (funOptions) {
+                    const matchRes = core_1.PathToRegexpUtil.match(funOptions.fullUrlFlattenString)(context.path);
+                    context.req.pathParameters = matchRes['params'] || {};
                 }
             }
             if (!funOptions) {
@@ -207,9 +218,18 @@ let MidwayFaaSFramework = class MidwayFaaSFramework extends core_1.BaseFramework
                         // invoke handler
                         const result = await this.invokeHandler(funOptions, ctx, args, isHttpFunction);
                         if (isHttpFunction && result !== undefined) {
-                            ctx.body = result;
+                            if (result === null) {
+                                // 这样设置可以绕过 koa 的 _explicitStatus 赋值机制
+                                ctx.response._body = null;
+                            }
+                            else {
+                                ctx.body = result;
+                            }
+                        }
+                        // http 靠 ctx.body，否则会出现状态码不正确的问题
+                        if (!isHttpFunction) {
+                            return result;
                         }
-                        return result;
                     },
                 ], this.app);
                 return await fn(ctx, next);
@@ -230,13 +250,13 @@ let MidwayFaaSFramework = class MidwayFaaSFramework extends core_1.BaseFramework
                     }
                     context.body = data;
                 }
-                else if (Buffer.isBuffer(data)) {
+                else if (isAnyArrayBuffer(data) || isUint8Array(data)) {
                     encoded = true;
                     if (!context.type) {
                         context.type = 'application/octet-stream';
                     }
                     // data is reserved as buffer
-                    context.body = data.toString('base64');
+                    context.body = Buffer.from(data).toString('base64');
                 }
                 else if (typeof data === 'object') {
                     if (!context.type) {
@@ -252,6 +272,13 @@ let MidwayFaaSFramework = class MidwayFaaSFramework extends core_1.BaseFramework
                     // set data to string
                     context.body = data = data + '';
                 }
+                // middleware return value and will be got 204 status
+                if (context.body === undefined &&
+                    !context.response._explicitStatus &&
+                    context._matchedRoute) {
+                    // 如果进了路由，重新赋值，防止 404
+                    context.body = undefined;
+                }
                 return {
                     isBase64Encoded: encoded,
                     statusCode: context.status,
@@ -296,36 +323,44 @@ let MidwayFaaSFramework = class MidwayFaaSFramework extends core_1.BaseFramework
         return context;
     }
     async invokeHandler(routerInfo, context, args, isHttpFunction) {
-        const funModule = await context.requestContext.getAsync(routerInfo.controllerId);
-        const handlerName = this.getFunctionHandler(context, args, funModule, routerInfo.method) ||
-            this.defaultHandlerMethod;
-        if (funModule[handlerName]) {
-            // invoke real method
-            const result = await funModule[handlerName](...args);
-            // implement response decorator
-            const routerResponseData = routerInfo.responseMetadata;
-            if (isHttpFunction) {
-                for (const routerRes of routerResponseData) {
-                    switch (routerRes.type) {
-                        case decorator_1.WEB_RESPONSE_HTTP_CODE:
-                            context.status = routerRes.code;
-                            break;
-                        case decorator_1.WEB_RESPONSE_HEADER:
-                            for (const key in (routerRes === null || routerRes === void 0 ? void 0 : routerRes.setHeaders) || {}) {
-                                context.set(key, routerRes.setHeaders[key]);
-                            }
-                            break;
-                        case decorator_1.WEB_RESPONSE_CONTENT_TYPE:
-                            context.type = routerRes.contentType;
-                            break;
-                        case decorator_1.WEB_RESPONSE_REDIRECT:
-                            context.status = routerRes.code;
-                            context.redirect(routerRes.url);
-                            return;
+        if (typeof routerInfo.method !== 'string') {
+            if (!isHttpFunction) {
+                args.unshift(context);
+            }
+            return routerInfo.method(...args);
+        }
+        else {
+            const funModule = await context.requestContext.getAsync(routerInfo.controllerId);
+            const handlerName = this.getFunctionHandler(context, args, funModule, routerInfo.method) ||
+                this.defaultHandlerMethod;
+            if (funModule[handlerName]) {
+                // invoke real method
+                const result = await funModule[handlerName](...args);
+                // implement response decorator
+                const routerResponseData = routerInfo.responseMetadata;
+                if (isHttpFunction) {
+                    for (const routerRes of routerResponseData) {
+                        switch (routerRes.type) {
+                            case decorator_1.WEB_RESPONSE_HTTP_CODE:
+                                context.status = routerRes.code;
+                                break;
+                            case decorator_1.WEB_RESPONSE_HEADER:
+                                for (const key in (routerRes === null || routerRes === void 0 ? void 0 : routerRes.setHeaders) || {}) {
+                                    context.set(key, routerRes.setHeaders[key]);
+                                }
+                                break;
+                            case decorator_1.WEB_RESPONSE_CONTENT_TYPE:
+                                context.type = routerRes.contentType;
+                                break;
+                            case decorator_1.WEB_RESPONSE_REDIRECT:
+                                context.status = routerRes.code;
+                                context.redirect(routerRes.url);
+                                return;
+                        }
                     }
                 }
+                return result;
             }
-            return result;
         }
     }
     getFunctionHandler(ctx, args, target, method) {
@@ -348,6 +383,13 @@ let MidwayFaaSFramework = class MidwayFaaSFramework extends core_1.BaseFramework
     getServer() {
         return this.server;
     }
+    async beforeStop() {
+        if (this.server) {
+            new Promise(resolve => {
+                this.server.close(resolve);
+            });
+        }
+    }
     async createHttpContext(req, res) {
         return new Promise(resolve => {
             this.respond(req, res, resolve);
@@ -378,13 +420,4 @@ MidwayFaaSFramework = __decorate([
     (0, decorator_1.Framework)()
 ], MidwayFaaSFramework);
 exports.MidwayFaaSFramework = MidwayFaaSFramework;
-const createModuleServerlessFramework = async (globalOption) => {
-    const applicationContext = await (0, core_1.initializeGlobalApplicationContext)({
-        ...globalOption,
-        baseDir: '',
-        appDir: '',
-    });
-    return applicationContext.get(MidwayFaaSFramework);
-};
-exports.createModuleServerlessFramework = createModuleServerlessFramework;
 //# sourceMappingURL=framework.js.map

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './interface';
-export { MidwayFaaSFramework as Framework, createModuleServerlessFramework, } from './framework';
+export { MidwayFaaSFramework as Framework } from './framework';
 export { FaaSConfiguration as Configuration } from './configuration';
+export { AbstractBootstrapStarter } from './starter';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,11 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Configuration = exports.createModuleServerlessFramework = exports.Framework = void 0;
+exports.AbstractBootstrapStarter = exports.Configuration = exports.Framework = void 0;
 __exportStar(require("./interface"), exports);
 var framework_1 = require("./framework");
 Object.defineProperty(exports, "Framework", { enumerable: true, get: function () { return framework_1.MidwayFaaSFramework; } });
-Object.defineProperty(exports, "createModuleServerlessFramework", { enumerable: true, get: function () { return framework_1.createModuleServerlessFramework; } });
 var configuration_1 = require("./configuration");
 Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.FaaSConfiguration; } });
+var starter_1 = require("./starter");
+Object.defineProperty(exports, "AbstractBootstrapStarter", { enumerable: true, get: function () { return starter_1.AbstractBootstrapStarter; } });
 //# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -47,6 +47,9 @@ export interface IFaaSConfigurationOptions extends IConfigurationOptions {
     config?: object;
     initializeContext?: object;
     applicationAdapter?: {
+        /**
+         * @deprecated
+         */
         getApplication(): Application;
         getFunctionName(): string;
         getFunctionServiceName(): string;
@@ -61,6 +64,9 @@ export interface IWebMiddleware {
 }
 export interface ServerlessStarterOptions extends IMidwayBootstrapOptions {
     initializeMethodName?: string;
+    handlerName?: string;
+    aggregationHandlerName?: string;
+    handlerNameMapping?: (handlerName: string, ...args: unknown[]) => [string, ...unknown[]];
     createAdapter?: () => Promise<{
         close(): any;
         createAppHook(app?: any): any;
@@ -69,6 +75,5 @@ export interface ServerlessStarterOptions extends IMidwayBootstrapOptions {
         mark(label: string): any;
         end(): any;
     };
-    exportAllHandler?: boolean;
 }
 //# sourceMappingURL=interface.d.ts.map

package/dist/starter.d.ts

@@ -0,0 +1,17 @@
+import { ServerlessStarterOptions } from './interface';
+import { IMidwayBootstrapOptions } from '@midwayjs/core';
+export declare abstract class AbstractBootstrapStarter {
+    protected options: ServerlessStarterOptions;
+    protected applicationContext: any;
+    protected framework: any;
+    constructor(options?: ServerlessStarterOptions);
+    getApplicationContext(): any;
+    close(): Promise<void>;
+    start(options?: ServerlessStarterOptions): any;
+    initFramework(bootstrapOptions?: IMidwayBootstrapOptions): Promise<void>;
+    abstract onStart(): any;
+    abstract onInit(...args: unknown[]): any;
+    abstract onRequest(...args: unknown[]): any;
+    abstract onClose(): any;
+}
+//# sourceMappingURL=starter.d.ts.map

package/dist/starter.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractBootstrapStarter = void 0;
+const core_1 = require("@midwayjs/core");
+class AbstractBootstrapStarter {
+    constructor(options = {}) {
+        this.options = options;
+    }
+    getApplicationContext() {
+        return this.applicationContext;
+    }
+    async close() {
+        await this.onClose();
+    }
+    start(options) {
+        this.options = Object.assign(this.options, options);
+        return this.onStart();
+    }
+    async initFramework(bootstrapOptions = {}) {
+        // init midway
+        this.applicationContext = await (0, core_1.initializeGlobalApplicationContext)(bootstrapOptions);
+        const midwayFrameworkService = this.applicationContext.get(core_1.MidwayFrameworkService);
+        this.framework = midwayFrameworkService.getMainFramework();
+    }
+}
+exports.AbstractBootstrapStarter = AbstractBootstrapStarter;
+//# sourceMappingURL=starter.js.map

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@midwayjs/faas",
-  "version": "3.4.0-beta.1",
+  "version": "3.4.0-beta.10",
   "main": "dist/index",
   "typings": "index.d.ts",
   "dependencies": {
-    "@midwayjs/core": "^3.4.0-beta.1",
+    "@midwayjs/core": "^3.4.0-beta.10",
     "@midwayjs/faas-typings": "^3.3.5",
     "@midwayjs/logger": "^2.15.0",
-    "@midwayjs/serverless-http-parser": "^3.3.5",
+    "@midwayjs/serverless-http-parser": "^3.4.0-beta.10",
     "@midwayjs/simple-lock": "^1.1.4"
   },
   "devDependencies": {
-    "@midwayjs/decorator": "^3.4.0-beta.1",
-    "@midwayjs/mock": "^3.4.0-beta.1",
-    "@midwayjs/serverless-fc-starter": "^3.4.0-beta.1",
-    "@midwayjs/serverless-scf-starter": "^3.3.5",
+    "@midwayjs/decorator": "^3.4.0-beta.10",
+    "@midwayjs/mock": "^3.4.0-beta.10",
+    "@midwayjs/serverless-fc-starter": "^3.4.0-beta.10",
+    "@midwayjs/serverless-scf-starter": "^3.4.0-beta.10",
     "mm": "3.2.0"
   },
   "engines": {
@@ -46,5 +46,5 @@
     "url": "git@github.com:midwayjs/midway.git"
   },
   "license": "MIT",
-  "gitHead": "a603d2348d6141f8f723901498f03a162a037708"
+  "gitHead": "560a5fa311605e4008c55f31c31bc4e12eeff2a5"
 }