@midwayjs/fc-starter 3.4.0-beta.1

package/README.md

@@ -0,0 +1,29 @@
+# serverless fc starter
+
+本模块用于包裹无法定制运行时的 FaaS 平台，比如阿里云 FC。
+
+## 阿里云 FC
+
+```ts
+import { asyncWrapper, start } from '@midwayjs/serverless-fc-starter';
+
+let runtime;
+exports.init = asyncWrapper(async () => {
+  runtime = await start();
+});
+
+// for web request
+exports.handler = asyncWrapper(async (...args) => {
+  return runtime.asyncEvent(async function(ctx) {
+    return 'hello world';  // ctx.body = 'hello world';
+  })(...args);
+});
+
+// for event
+exports.handler = asyncWrapper(async (...args) => {
+  return runtime.asyncEvent(async function(ctx, event) {
+    return {data: 1};
+  })(...args);
+});
+
+```

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import type { ServerlessStarterOptions } from '@midwayjs/faas';
+export declare class BootstrapStarter {
+    applicationContext: any;
+    start(options?: ServerlessStarterOptions): {};
+    getApplicationContext(): any;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,199 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BootstrapStarter = void 0;
+const core_1 = require("@midwayjs/core");
+const getRawBody = require("raw-body");
+function isOutputError() {
+    return (process.env.SERVERLESS_OUTPUT_ERROR_STACK === 'true' ||
+        ['local', 'development'].includes(process.env.MIDWAY_SERVER_ENV) ||
+        ['local', 'development'].includes(process.env.NODE_ENV));
+}
+class BootstrapStarter {
+    start(options = {}) {
+        if (!process.env.NODE_ENV) {
+            process.env.NODE_ENV = 'production';
+        }
+        if (process.env['FC_FUNC_CODE_PATH']) {
+            // 用于替换默认的上下文日志
+            process.env['MIDWAY_SERVERLESS_REPLACE_LOGGER'] = 'true';
+            // 移除控制台颜色，fc 控制台无法探测是否支持，日志采集也必须把颜色禁用掉
+            process.env['MIDWAY_LOGGER_DISABLE_COLORS'] = 'true';
+        }
+        const exports = {};
+        let framework;
+        exports[options.initializeMethodName || 'initializer'] = (0, core_1.wrapAsync)(async (context) => {
+            var _a, _b, _c;
+            const applicationAdapter = {
+                getFunctionName() {
+                    return context.function.name;
+                },
+                getFunctionServiceName() {
+                    return context.service.name;
+                },
+            };
+            (_a = options.performance) === null || _a === void 0 ? void 0 : _a.mark('starterRuntimeStartTime');
+            // init midway
+            const applicationContext = (this.applicationContext =
+                await (0, core_1.initializeGlobalApplicationContext)(Object.assign(options, {
+                    globalConfig: {
+                        faas: {
+                            applicationAdapter,
+                        },
+                    },
+                })));
+            (_b = options.performance) === null || _b === void 0 ? void 0 : _b.mark('frameworkStartTime');
+            const midwayFrameworkService = applicationContext.get(core_1.MidwayFrameworkService);
+            framework = midwayFrameworkService.getMainFramework();
+            const handlerWrapper = (0, core_1.wrapAsync)(async (event, context, oldContext) => {
+                var _a, _b, _c, _d;
+                const isHTTPMode = event.constructor.name === 'IncomingMessage' ||
+                    event.constructor.name === 'EventEmitter';
+                const isApiGateway = event &&
+                    event.headers &&
+                    'queryParameters' in event &&
+                    'httpMethod' in event;
+                if (isHTTPMode) {
+                    if (!((_a = oldContext.logger) === null || _a === void 0 ? void 0 : _a.info)) {
+                        oldContext.logger = console;
+                    }
+                }
+                else {
+                    if (!((_b = context.logger) === null || _b === void 0 ? void 0 : _b.info)) {
+                        context.logger = console;
+                    }
+                }
+                const triggerFunction = framework.getTriggerFunction((oldContext === null || oldContext === void 0 ? void 0 : oldContext.function.handler) || context.function.handler);
+                let ctx;
+                if (isHTTPMode) {
+                    event.getOriginContext = () => {
+                        return oldContext;
+                    };
+                    // 如果需要解析body并且body是个stream
+                    if (['post', 'put', 'delete'].indexOf(event.method.toLowerCase()) !==
+                        -1 &&
+                        !event.body &&
+                        typeof event.on === 'function') {
+                        event.body = await getRawBody(event, {
+                            limit: '10mb',
+                        });
+                    }
+                    ctx = await framework.wrapHttpRequest(event);
+                }
+                else if (isApiGateway) {
+                    ctx = await framework.wrapHttpRequest(event, context);
+                }
+                else {
+                    // 阿里云事件触发器，入参是 buffer
+                    if (Buffer.isBuffer(event)) {
+                        event = event.toString('utf8');
+                        try {
+                            event = JSON.parse(event);
+                        }
+                        catch (_err) {
+                            /** ignore */
+                        }
+                    }
+                    // format context
+                    ctx = {
+                        originEvent: event,
+                        originContext: context,
+                        logger: context.logger,
+                    };
+                }
+                try {
+                    const result = await triggerFunction(ctx, {
+                        isHttpFunction: isHTTPMode || isApiGateway,
+                        originEvent: event,
+                        originContext: context,
+                    });
+                    if (isHTTPMode || isApiGateway) {
+                        const { isBase64Encoded, statusCode, headers, body } = result;
+                        if (isApiGateway) {
+                            const newHeader = {};
+                            for (const key in headers) {
+                                // The length after base64 is wrong.
+                                if (!['content-length'].includes(key)) {
+                                    if ('set-cookie' === key && !isHTTPMode) {
+                                        // unsupport multiple cookie when use apiGateway
+                                        newHeader[key] = headers[key][0];
+                                        if (headers[key].length > 1) {
+                                            ctx.logger.warn('[fc-starter]: unsupport multiple cookie when use apiGateway');
+                                        }
+                                    }
+                                    else {
+                                        newHeader[key] = headers[key];
+                                    }
+                                }
+                            }
+                            return {
+                                isBase64Encoded,
+                                statusCode,
+                                headers: newHeader,
+                                body,
+                            };
+                        }
+                        else {
+                            const res = context;
+                            if (res.headersSent) {
+                                return;
+                            }
+                            if (res.setHeader) {
+                                for (const key in headers) {
+                                    res.setHeader(key, headers[key]);
+                                }
+                            }
+                            if (res.statusCode !== statusCode) {
+                                if (res.setStatusCode) {
+                                    res.setStatusCode(statusCode);
+                                }
+                                if (res.statusCode) {
+                                    res.statusCode = statusCode;
+                                }
+                            }
+                            if (res.send) {
+                                // http trigger only support `Buffer` or a `string` or a `stream.Readable`
+                                res.send(body);
+                            }
+                        }
+                    }
+                    else {
+                        return result;
+                    }
+                }
+                catch (err) {
+                    ctx.logger.error(err);
+                    const res = context;
+                    if (res.setHeader) {
+                        res.setHeader('content-type', 'text/plain');
+                    }
+                    if (res.send) {
+                        res.setStatusCode((_c = err.status) !== null && _c !== void 0 ? _c : 500);
+                        res.send(isOutputError() ? err.stack : 'Internal Server Error');
+                    }
+                    return {
+                        isBase64Encoded: false,
+                        statusCode: (_d = err.status) !== null && _d !== void 0 ? _d : 500,
+                        headers: {},
+                        body: isOutputError() ? err.stack : 'Internal Server Error',
+                    };
+                }
+            });
+            if (options.exportAllHandler) {
+                for (const handlerName of framework.getAllHandlerNames()) {
+                    exports[handlerName.split('.')[1]] = handlerWrapper;
+                }
+            }
+            else {
+                const handlerMethodName = context.function.handler.split('.')[1];
+                exports[handlerMethodName] = handlerWrapper;
+            }
+            (_c = options.performance) === null || _c === void 0 ? void 0 : _c.end();
+        });
+        return exports;
+    }
+    getApplicationContext() {
+        return this.applicationContext;
+    }
+}
+exports.BootstrapStarter = BootstrapStarter;
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@midwayjs/fc-starter",
+  "version": "3.4.0-beta.1",
+  "main": "dist/index",
+  "typings": "dist/index.d.ts",
+  "dependencies": {
+    "@midwayjs/faas": "^3.4.0-beta.1",
+    "raw-body": "2.5.1"
+  },
+  "devDependencies": {
+    "@midwayjs/core": "^3.4.0-beta.1",
+    "@midwayjs/decorator": "^3.4.0-beta.1",
+    "@midwayjs/runtime-mock": "^3.0.4",
+    "@midwayjs/serverless-http-parser": "^3.3.5"
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:midwayjs/midway.git"
+  },
+  "license": "MIT",
+  "gitHead": "14d8440f20978426184c988808343cc24bcf6e20"
+}