@modern-js/bff-core 1.22.2-beta.0 → 1.22.3

package/dist/js/modern/router/index.js

@@ -1,83 +1,104 @@
-import path from "path";
-import { fs, logger } from "@modern-js/utils";
-import "reflect-metadata";
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import path from 'path';
+import { fs, logger } from '@modern-js/utils';
+import 'reflect-metadata';
 import { HttpMethod, httpMethods, OperatorType, TriggerType } from "../types";
 import { debug } from "../utils";
-import {
-  APIMode,
-  FRAMEWORK_MODE_LAMBDA_DIR,
-  API_FILE_RULES,
-  FRAMEWORK_MODE_APP_DIR
-} from "./constants";
-import {
-  getFiles,
-  getPathFromFilename,
-  requireHandlerModule,
-  sortRoutes
-} from "./utils";
+import { APIMode, FRAMEWORK_MODE_LAMBDA_DIR, API_FILE_RULES, FRAMEWORK_MODE_APP_DIR } from "./constants";
+import { getFiles, getPathFromFilename, requireHandlerModule, sortRoutes } from "./utils";
 export * from "./types";
 export * from "./constants";
-class ApiRouter {
+export class ApiRouter {
+  // lambdaDir is the dir which equal to the apiDir in function mode, and equal to the api/lambda dir in framework mode
   constructor({
-    apiDir,
-    lambdaDir,
+    apiDir: _apiDir,
+    lambdaDir: _lambdaDir,
     prefix
   }) {
-    this.apiFiles = [];
-    this.getExactApiMode = (apiDir) => {
+    _defineProperty(this, "apiMode", void 0);
+
+    _defineProperty(this, "apiDir", void 0);
+
+    _defineProperty(this, "existLambdaDir", void 0);
+
+    _defineProperty(this, "lambdaDir", void 0);
+
+    _defineProperty(this, "prefix", void 0);
+
+    _defineProperty(this, "apiFiles", []);
+
+    _defineProperty(this, "getExactApiMode", apiDir => {
       const exist = this.createExistChecker(apiDir);
       const existLambdaDir = exist(FRAMEWORK_MODE_LAMBDA_DIR);
       const existAppDir = exist(FRAMEWORK_MODE_APP_DIR);
-      const existAppFile = exist("app.ts") || exist("app.js");
+      const existAppFile = exist('app.ts') || exist('app.js');
+
       if (existLambdaDir || existAppDir || existAppFile) {
         return APIMode.FARMEWORK;
       }
+
       return APIMode.FUNCTION;
-    };
-    this.createExistChecker = (base) => (target) => fs.pathExistsSync(path.resolve(base, target));
-    this.getExactLambdaDir = (apiDir) => {
+    });
+
+    _defineProperty(this, "createExistChecker", base => target => fs.pathExistsSync(path.resolve(base, target)));
+
+    _defineProperty(this, "getExactLambdaDir", apiDir => {
       if (this.lambdaDir) {
         return this.lambdaDir;
       }
+
       const lambdaDir = this.apiMode === APIMode.FARMEWORK ? path.join(apiDir, FRAMEWORK_MODE_LAMBDA_DIR) : apiDir;
       return lambdaDir;
-    };
-    this.validateAbsolute(apiDir, "apiDir");
-    this.validateAbsolute(lambdaDir, "lambdaDir");
+    });
+
+    this.validateAbsolute(_apiDir, 'apiDir');
+    this.validateAbsolute(_lambdaDir, 'lambdaDir');
     this.prefix = this.initPrefix(prefix);
-    this.apiDir = apiDir;
-    this.apiMode = this.getExactApiMode(apiDir);
-    this.lambdaDir = lambdaDir || this.getExactLambdaDir(this.apiDir);
+    this.apiDir = _apiDir;
+    this.apiMode = this.getExactApiMode(_apiDir);
+    this.lambdaDir = _lambdaDir || this.getExactLambdaDir(this.apiDir);
     this.existLambdaDir = fs.existsSync(this.lambdaDir);
   }
+
   isExistLambda() {
     return this.existLambdaDir;
   }
+
   getApiMode() {
     return this.apiMode;
   }
+
   getLambdaDir() {
     return this.lambdaDir;
   }
+
   isApiFile(filename) {
     if (this.existLambdaDir) {
       return false;
     }
+
     if (!this.apiFiles.includes(filename)) {
       return false;
     }
+
     return true;
   }
+
   getSingleModuleHandlers(filename) {
     const moduleInfo = this.getModuleInfo(filename);
+
     if (moduleInfo) {
       return this.getModuleHandlerInfos(moduleInfo);
     }
+
     return null;
   }
+
   getHandlerInfo(filename, originFuncName, handler) {
     const httpMethod = this.getHttpMethod(originFuncName, handler);
     const routeName = this.getRouteName(filename, handler);
+
     if (httpMethod && routeName) {
       return {
         handler,
@@ -88,101 +109,135 @@ class ApiRouter {
         routePath: this.getRoutePath(this.prefix, routeName)
       };
     }
+
     return null;
-  }
+  } // TODO: 性能提升，开发环境，判断下 lambda 目录修改时间
+
+
   getSafeRoutePath(filename, handler) {
     this.loadApiFiles();
     this.validateValidApifile(filename);
     return this.getRouteName(filename, handler);
   }
+
   getRouteName(filename, handler) {
     if (handler) {
       const trigger = Reflect.getMetadata(OperatorType.Trigger, handler);
+
       if (trigger && trigger.type === TriggerType.Http) {
         if (!trigger.path) {
-          throw new Error(
-            `The http trigger ${trigger.name} needs to specify a path`
-          );
+          throw new Error(`The http trigger ${trigger.name} needs to specify a path`);
         }
+
         return trigger.path;
       }
     }
+
     const routePath = getPathFromFilename(this.lambdaDir, filename);
     return routePath;
   }
+
   getHttpMethod(originHandlerName, handler) {
     if (handler) {
       const trigger = Reflect.getMetadata(OperatorType.Trigger, handler);
+
       if (trigger && httpMethods.includes(trigger.method)) {
         return trigger.method;
       }
     }
+
     const upperName = originHandlerName.toUpperCase();
+
     switch (upperName) {
-      case "GET":
+      case 'GET':
         return HttpMethod.Get;
-      case "POST":
+
+      case 'POST':
         return HttpMethod.Post;
-      case "PUT":
+
+      case 'PUT':
         return HttpMethod.Put;
-      case "DELETE":
-      case "DEL":
+
+      case 'DELETE':
+      case 'DEL':
         return HttpMethod.Delete;
-      case "CONNECT":
+
+      case 'CONNECT':
         return HttpMethod.Connect;
-      case "TRACE":
+
+      case 'TRACE':
         return HttpMethod.Trace;
-      case "PATCH":
+
+      case 'PATCH':
         return HttpMethod.Patch;
-      case "OPTION":
+
+      case 'OPTION':
         return HttpMethod.Option;
-      case "DEFAULT": {
-        return HttpMethod.Get;
-      }
+
+      case 'DEFAULT':
+        {
+          return HttpMethod.Get;
+        }
+
       default:
-        logger.warn(
-          `Only api handlers are allowd to be exported, please remove the function ${originHandlerName} from exports`
-        );
+        logger.warn(`Only api handlers are allowd to be exported, please remove the function ${originHandlerName} from exports`);
         return null;
     }
   }
+
   loadApiFiles() {
     if (!this.existLambdaDir) {
       return [];
-    }
+    } // eslint-disable-next-line no-multi-assign
+
+
     const apiFiles = this.apiFiles = getFiles(this.lambdaDir, API_FILE_RULES);
     return apiFiles;
   }
+
   getApiFiles() {
     if (!this.existLambdaDir) {
       return [];
     }
+
     if (this.apiFiles.length > 0) {
       return this.apiFiles;
     }
+
     return this.loadApiFiles();
   }
+
   getApiHandlers() {
     const filenames = this.getApiFiles();
     const moduleInfos = this.getModuleInfos(filenames);
     const apiHandlers = this.getHandlerInfos(moduleInfos);
-    debug("apiHandlers", apiHandlers.length, apiHandlers);
+    debug('apiHandlers', apiHandlers.length, apiHandlers);
     return apiHandlers;
   }
+  /**
+   * 如果用户未传入或传入空串，默认为 /api
+   * 如果传入 /，则 prefix 为 /
+   */
+
+
   initPrefix(prefix) {
-    if (prefix === "/") {
-      return "";
+    if (prefix === '/') {
+      return '';
     }
-    return prefix || "/api";
+
+    return prefix || '/api';
   }
+
   validateAbsolute(filename, paramsName) {
-    if (typeof filename === "string" && !path.isAbsolute(filename)) {
+    if (typeof filename === 'string' && !path.isAbsolute(filename)) {
       throw new Error(`The ${paramsName} ${filename} is not a abolute path`);
     }
   }
+
   getModuleInfos(filenames) {
-    return filenames.map((filename) => this.getModuleInfo(filename)).filter((moduleInfo) => Boolean(moduleInfo));
+    return filenames.map(filename => this.getModuleInfo(filename)).filter(moduleInfo => Boolean(moduleInfo));
   }
+
   getModuleInfo(filename) {
     try {
       const module = requireHandlerModule(filename);
@@ -191,7 +246,7 @@ class ApiRouter {
         module
       };
     } catch (err) {
-      if (process.env.NODE_ENV === "production") {
+      if (process.env.NODE_ENV === 'production') {
         throw err;
       } else {
         console.error(err);
@@ -199,10 +254,12 @@ class ApiRouter {
       }
     }
   }
+
   getHandlerInfos(moduleInfos) {
     let apiHandlers = [];
-    moduleInfos.forEach((moduleInfo) => {
+    moduleInfos.forEach(moduleInfo => {
       const handlerInfos = this.getModuleHandlerInfos(moduleInfo);
+
       if (handlerInfos) {
         apiHandlers = apiHandlers.concat(handlerInfos);
       }
@@ -210,27 +267,33 @@ class ApiRouter {
     const sortedHandlers = sortRoutes(apiHandlers);
     return sortedHandlers;
   }
+
   getModuleHandlerInfos(moduleInfo) {
-    const { module, filename } = moduleInfo;
-    return Object.entries(module).filter(([, handler]) => typeof handler === "function").map(([key]) => {
+    const {
+      module,
+      filename
+    } = moduleInfo;
+    return Object.entries(module).filter(([, handler]) => typeof handler === 'function').map(([key]) => {
       const handler = module[key];
       const handlerInfo = this.getHandlerInfo(filename, key, handler);
       return handlerInfo;
-    }).filter((handlerInfo) => Boolean(handlerInfo));
+    }).filter(handlerInfo => Boolean(handlerInfo));
   }
+
   validateValidApifile(filename) {
     if (!this.apiFiles.includes(filename)) {
       throw new Error(`The ${filename} is not a valid api file.`);
     }
   }
+
   getRoutePath(prefix, routeName) {
-    const finalRouteName = routeName === "/" ? "" : routeName;
-    if (prefix === "" && finalRouteName === "") {
-      return "/";
+    const finalRouteName = routeName === '/' ? '' : routeName;
+
+    if (prefix === '' && finalRouteName === '') {
+      return '/';
     }
+
     return `${prefix}${finalRouteName}`;
   }
-}
-export {
-  ApiRouter
-};
+
+}

package/dist/js/modern/router/types.js

@@ -0,0 +1 @@
+export {};

package/dist/js/modern/router/utils.js

@@ -1,83 +1,101 @@
-import path from "path";
-import { globby } from "@modern-js/utils";
+import path from 'path';
+import { globby } from '@modern-js/utils';
 import { INDEX_SUFFIX } from "./constants";
-const getFiles = (lambdaDir, rules) => globby.sync(rules, {
+export const getFiles = (lambdaDir, rules) => globby.sync(rules, {
   cwd: lambdaDir,
   gitignore: true
-}).map((file) => path.resolve(lambdaDir, file));
-const getPathFromFilename = (baseDir, filename) => {
+}).map(file => path.resolve(lambdaDir, file));
+export const getPathFromFilename = (baseDir, filename) => {
   const relativeName = filename.substring(baseDir.length);
-  const relativePath = relativeName.split(".").slice(0, -1).join(".");
-  const nameSplit = relativePath.split(path.sep).map((item) => {
+  const relativePath = relativeName.split('.').slice(0, -1).join('.');
+  const nameSplit = relativePath.split(path.sep).map(item => {
     if (item.length > 2) {
-      if (item.startsWith("[") && item.endsWith("]")) {
+      if (item.startsWith('[') && item.endsWith(']')) {
         return `:${item.substring(1, item.length - 1)}`;
       }
     }
+
     return item;
   });
-  const name = nameSplit.join("/");
+  const name = nameSplit.join('/');
   const finalName = name.endsWith(INDEX_SUFFIX) ? name.substring(0, name.length - INDEX_SUFFIX.length) : name;
   return clearRouteName(finalName);
 };
-const clearRouteName = (routeName) => {
+
+const clearRouteName = routeName => {
   let finalRouteName = routeName.trim();
-  if (!finalRouteName.startsWith("/")) {
+
+  if (!finalRouteName.startsWith('/')) {
     finalRouteName = `/${finalRouteName}`;
   }
-  if (finalRouteName.length > 1 && finalRouteName.endsWith("/")) {
+
+  if (finalRouteName.length > 1 && finalRouteName.endsWith('/')) {
     finalRouteName = finalRouteName.substring(0, finalRouteName.length - 1);
   }
+
   return finalRouteName;
 };
-const isHandler = (input) => input && typeof input === "function";
-const enableRegister = (requireFn) => {
+
+export const isHandler = input => input && typeof input === 'function';
+
+const enableRegister = requireFn => {
+  // esbuild-register 做 unRegister 时，不会删除 register 添加的 require.extensions，导致第二次调用时 require.extensions['.ts'] 是 nodejs 默认 loader
+  // 所以这里根据第一次调用时，require.extensions 有没有，来判断是否需要使用 esbuild-register
   let existTsLoader = false;
   let firstCall = true;
-  return (modulePath) => {
+  return modulePath => {
     if (firstCall) {
-      existTsLoader = Boolean(require.extensions[".ts"]);
+      // eslint-disable-next-line node/no-deprecated-api
+      existTsLoader = Boolean(require.extensions['.ts']);
       firstCall = false;
     }
+
     if (!existTsLoader) {
       const {
         register
-      } = require("esbuild-register/dist/node");
-      const { unregister } = register({
-        extensions: [".ts"]
+      } = require('esbuild-register/dist/node');
+
+      const {
+        unregister
+      } = register({
+        extensions: ['.ts']
       });
-      const requiredModule2 = requireFn(modulePath);
+      const requiredModule = requireFn(modulePath);
       unregister();
-      return requiredModule2;
+      return requiredModule;
     }
+
     const requiredModule = requireFn(modulePath);
     return requiredModule;
   };
 };
-const isFunction = (input) => input && {}.toString.call(input) === "[object Function]";
-const requireHandlerModule = enableRegister((modulePath) => {
-  const originRequire = process.env.NODE_ENV === "test" ? jest.requireActual : require;
+
+const isFunction = input => input && {}.toString.call(input) === '[object Function]';
+
+export const requireHandlerModule = enableRegister(modulePath => {
+  // 测试环境不走缓存，因为缓存的 h andler 文件，会被 mockAPI 函数进行 mock，升级 jest28，setupFilesAfterEnv 能做异步操作的话，可解此问题
+  const originRequire = process.env.NODE_ENV === 'test' ? jest.requireActual : require;
   const module = originRequire(modulePath);
+
   if (isFunction(module)) {
-    return { default: module };
+    return {
+      default: module
+    };
   }
+
   return module;
 });
-const routeValue = (routePath) => {
-  if (routePath.includes(":")) {
+
+const routeValue = routePath => {
+  if (routePath.includes(':')) {
     return 11;
   }
+
   return 1;
 };
-const sortRoutes = (apiHandlers) => {
+
+export const sortRoutes = apiHandlers => {
   return apiHandlers.sort((handlerA, handlerB) => {
     return routeValue(handlerA.routeName) - routeValue(handlerB.routeName);
   });
-};
-export {
-  getFiles,
-  getPathFromFilename,
-  isHandler,
-  requireHandlerModule,
-  sortRoutes
-};
+};

package/dist/js/modern/types.js

@@ -1,45 +1,47 @@
-var OperatorType = /* @__PURE__ */ ((OperatorType2) => {
-  OperatorType2[OperatorType2["Trigger"] = 0] = "Trigger";
-  OperatorType2[OperatorType2["Middleware"] = 1] = "Middleware";
-  return OperatorType2;
-})(OperatorType || {});
-var TriggerType = /* @__PURE__ */ ((TriggerType2) => {
-  TriggerType2[TriggerType2["Http"] = 0] = "Http";
-  return TriggerType2;
-})(TriggerType || {});
-var HttpMetadata = /* @__PURE__ */ ((HttpMetadata2) => {
-  HttpMetadata2["Method"] = "METHOD";
-  HttpMetadata2["Data"] = "DATA";
-  HttpMetadata2["Query"] = "QUERY";
-  HttpMetadata2["Params"] = "PARAMS";
-  HttpMetadata2["Headers"] = "HEADERS";
-  HttpMetadata2["Response"] = "RESPONSE";
-  return HttpMetadata2;
-})(HttpMetadata || {});
-var ResponseMetaType = /* @__PURE__ */ ((ResponseMetaType2) => {
-  ResponseMetaType2[ResponseMetaType2["StatusCode"] = 0] = "StatusCode";
-  ResponseMetaType2[ResponseMetaType2["Redirect"] = 1] = "Redirect";
-  ResponseMetaType2[ResponseMetaType2["Headers"] = 2] = "Headers";
-  return ResponseMetaType2;
-})(ResponseMetaType || {});
-var HttpMethod = /* @__PURE__ */ ((HttpMethod2) => {
-  HttpMethod2["Get"] = "GET";
-  HttpMethod2["Post"] = "POST";
-  HttpMethod2["Put"] = "PUT";
-  HttpMethod2["Delete"] = "DELETE";
-  HttpMethod2["Connect"] = "CONNECT";
-  HttpMethod2["Trace"] = "TRACE";
-  HttpMethod2["Patch"] = "PATCH";
-  HttpMethod2["Option"] = "OPTION";
-  HttpMethod2["Head"] = "HEAD";
-  return HttpMethod2;
-})(HttpMethod || {});
-const httpMethods = Object.values(HttpMethod);
-export {
-  HttpMetadata,
-  HttpMethod,
-  OperatorType,
-  ResponseMetaType,
-  TriggerType,
-  httpMethods
-};
+export let OperatorType;
+
+(function (OperatorType) {
+  OperatorType[OperatorType["Trigger"] = 0] = "Trigger";
+  OperatorType[OperatorType["Middleware"] = 1] = "Middleware";
+})(OperatorType || (OperatorType = {}));
+
+export let TriggerType;
+
+(function (TriggerType) {
+  TriggerType[TriggerType["Http"] = 0] = "Http";
+})(TriggerType || (TriggerType = {}));
+
+export let HttpMetadata;
+
+(function (HttpMetadata) {
+  HttpMetadata["Method"] = "METHOD";
+  HttpMetadata["Data"] = "DATA";
+  HttpMetadata["Query"] = "QUERY";
+  HttpMetadata["Params"] = "PARAMS";
+  HttpMetadata["Headers"] = "HEADERS";
+  HttpMetadata["Response"] = "RESPONSE";
+})(HttpMetadata || (HttpMetadata = {}));
+
+export let ResponseMetaType;
+
+(function (ResponseMetaType) {
+  ResponseMetaType[ResponseMetaType["StatusCode"] = 0] = "StatusCode";
+  ResponseMetaType[ResponseMetaType["Redirect"] = 1] = "Redirect";
+  ResponseMetaType[ResponseMetaType["Headers"] = 2] = "Headers";
+})(ResponseMetaType || (ResponseMetaType = {}));
+
+export let HttpMethod;
+
+(function (HttpMethod) {
+  HttpMethod["Get"] = "GET";
+  HttpMethod["Post"] = "POST";
+  HttpMethod["Put"] = "PUT";
+  HttpMethod["Delete"] = "DELETE";
+  HttpMethod["Connect"] = "CONNECT";
+  HttpMethod["Trace"] = "TRACE";
+  HttpMethod["Patch"] = "PATCH";
+  HttpMethod["Option"] = "OPTION";
+  HttpMethod["Head"] = "HEAD";
+})(HttpMethod || (HttpMethod = {}));
+
+export const httpMethods = Object.values(HttpMethod);