@modern-js/bff-core 1.21.2-beta.4 → 1.21.3-beta.0

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

@@ -1,299 +0,0 @@
-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";
-export * from "./types";
-export * from "./constants";
-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: _apiDir,
-    lambdaDir: _lambdaDir,
-    prefix
-  }) {
-    _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');
-
-      if (existLambdaDir || existAppDir || existAppFile) {
-        return APIMode.FARMEWORK;
-      }
-
-      return APIMode.FUNCTION;
-    });
-
-    _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.prefix = this.initPrefix(prefix);
-    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,
-        name: originFuncName,
-        httpMethod,
-        routeName,
-        filename,
-        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`);
-        }
-
-        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':
-        return HttpMethod.Get;
-
-      case 'POST':
-        return HttpMethod.Post;
-
-      case 'PUT':
-        return HttpMethod.Put;
-
-      case 'DELETE':
-      case 'DEL':
-        return HttpMethod.Delete;
-
-      case 'CONNECT':
-        return HttpMethod.Connect;
-
-      case 'TRACE':
-        return HttpMethod.Trace;
-
-      case 'PATCH':
-        return HttpMethod.Patch;
-
-      case 'OPTION':
-        return HttpMethod.Option;
-
-      case 'DEFAULT':
-        {
-          return HttpMethod.Get;
-        }
-
-      default:
-        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);
-    return apiHandlers;
-  }
-  /**
-   * 如果用户未传入或传入空串，默认为 /api
-   * 如果传入 /，则 prefix 为 /
-   */
-
-
-  initPrefix(prefix) {
-    if (prefix === '/') {
-      return '';
-    }
-
-    return prefix || '/api';
-  }
-
-  validateAbsolute(filename, paramsName) {
-    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));
-  }
-
-  getModuleInfo(filename) {
-    try {
-      const module = requireHandlerModule(filename);
-      return {
-        filename,
-        module
-      };
-    } catch (err) {
-      if (process.env.NODE_ENV === 'production') {
-        throw err;
-      } else {
-        console.error(err);
-        return null;
-      }
-    }
-  }
-
-  getHandlerInfos(moduleInfos) {
-    let apiHandlers = [];
-    moduleInfos.forEach(moduleInfo => {
-      const handlerInfos = this.getModuleHandlerInfos(moduleInfo);
-
-      if (handlerInfos) {
-        apiHandlers = apiHandlers.concat(handlerInfos);
-      }
-    });
-    const sortedHandlers = sortRoutes(apiHandlers);
-    return sortedHandlers;
-  }
-
-  getModuleHandlerInfos(moduleInfo) {
-    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));
-  }
-
-  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 '/';
-    }
-
-    return `${prefix}${finalRouteName}`;
-  }
-
-}

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

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

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

@@ -1,101 +0,0 @@
-import path from 'path';
-import { globby } from '@modern-js/utils';
-import { INDEX_SUFFIX } from "./constants";
-export const getFiles = (lambdaDir, rules) => globby.sync(rules, {
-  cwd: lambdaDir,
-  gitignore: true
-}).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 => {
-    if (item.length > 2) {
-      if (item.startsWith('[') && item.endsWith(']')) {
-        return `:${item.substring(1, item.length - 1)}`;
-      }
-    }
-
-    return item;
-  });
-  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 => {
-  let finalRouteName = routeName.trim();
-
-  if (!finalRouteName.startsWith('/')) {
-    finalRouteName = `/${finalRouteName}`;
-  }
-
-  if (finalRouteName.length > 1 && finalRouteName.endsWith('/')) {
-    finalRouteName = finalRouteName.substring(0, finalRouteName.length - 1);
-  }
-
-  return finalRouteName;
-};
-
-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 => {
-    if (firstCall) {
-      // 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({
-        extension: ['.ts']
-      });
-      const requiredModule = requireFn(modulePath);
-      unregister();
-      return requiredModule;
-    }
-
-    const requiredModule = requireFn(modulePath);
-    return requiredModule;
-  };
-};
-
-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 module;
-});
-
-const routeValue = routePath => {
-  if (routePath.includes(':')) {
-    return 11;
-  }
-
-  return 1;
-};
-
-export const sortRoutes = apiHandlers => {
-  return apiHandlers.sort((handlerA, handlerB) => {
-    return routeValue(handlerA.routeName) - routeValue(handlerB.routeName);
-  });
-};

package/dist/js/modern/types.js

@@ -1,47 +0,0 @@
-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);

package/dist/js/modern/utils/alias.js

@@ -1,91 +0,0 @@
-import * as path from 'path';
-import * as os from 'os';
-import fs from 'fs';
-import Module from 'module';
-export const getRelativeRuntimePath = (appDirectory, serverRuntimePath) => {
-  let relativeRuntimePath = '';
-
-  if (os.platform() === 'win32') {
-    // isRelative function in babel-plugin-resolver plugin can't handle windows relative path correctly, see babel-plugin-resolver's utils.
-    relativeRuntimePath = `../${path.relative(appDirectory, serverRuntimePath)}`;
-  } else {
-    // Look up one level, because the artifacts after build have dist directories
-    relativeRuntimePath = path.join('../', path.relative(appDirectory, serverRuntimePath));
-  }
-
-  if (process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') {
-    relativeRuntimePath = `./${path.relative(appDirectory, serverRuntimePath)}`;
-  }
-
-  return relativeRuntimePath;
-};
-
-const sortByLongestPrefix = arr => {
-  return arr.concat().sort((a, b) => b.length - a.length);
-};
-
-export const createMatchPath = paths => {
-  const sortedKeys = sortByLongestPrefix(Object.keys(paths));
-  const sortedPaths = {};
-  sortedKeys.forEach(key => {
-    sortedPaths[key] = paths[key];
-  });
-  return request => {
-    const found = Object.keys(sortedPaths).find(key => {
-      return request.startsWith(key);
-    });
-
-    if (found) {
-      let foundPaths = sortedPaths[found];
-
-      if (!Array.isArray(foundPaths)) {
-        foundPaths = [foundPaths];
-      }
-
-      foundPaths = foundPaths.filter(foundPath => path.isAbsolute(foundPath));
-
-      for (const p of foundPaths) {
-        const foundPath = request.replace(found, p);
-
-        if (fs.existsSync(foundPath)) {
-          return foundPath;
-        }
-      }
-
-      return request.replace(found, foundPaths[0]);
-    }
-
-    return null;
-  };
-}; // every path must be a absolute path;
-
-export const registerPaths = paths => {
-  const originalResolveFilename = Module._resolveFilename; // eslint-disable-next-line node/no-unsupported-features/node-builtins
-
-  const {
-    builtinModules
-  } = Module;
-  const matchPath = createMatchPath(paths);
-
-  Module._resolveFilename = function (request, _parent) {
-    const isCoreModule = builtinModules.includes(request);
-
-    if (!isCoreModule) {
-      const matched = matchPath(request);
-
-      if (matched) {
-        // eslint-disable-next-line prefer-rest-params
-        const modifiedArguments = [matched, ...[].slice.call(arguments, 1)]; // Passes all arguments. Even those that is not specified above.
-
-        return originalResolveFilename.apply(this, modifiedArguments);
-      }
-    } // eslint-disable-next-line prefer-rest-params
-
-
-    return originalResolveFilename.apply(this, arguments);
-  };
-
-  return () => {
-    Module._resolveFilename = originalResolveFilename;
-  };
-};

package/dist/js/modern/utils/debug.js

@@ -1,2 +0,0 @@
-import { createDebugger } from '@modern-js/utils';
-export const debug = createDebugger('bff');

package/dist/js/modern/utils/index.js

@@ -1,5 +0,0 @@
-export * from "./storage";
-export * from "./alias";
-export { debug } from "./debug";
-export * from "./meta";
-export * from "./validate";

package/dist/js/modern/utils/meta.js

@@ -1,4 +0,0 @@
-export const HANDLER_WITH_META = 'HANDLER_WITH_META';
-export const isWithMetaHandler = handler => {
-  return typeof handler === 'function' && handler[HANDLER_WITH_META];
-};

package/dist/js/modern/utils/storage.js

@@ -1,48 +0,0 @@
-import * as ah from 'async_hooks';
-
-const createStorage = () => {
-  let storage;
-
-  if (typeof ah.AsyncLocalStorage !== 'undefined') {
-    storage = new ah.AsyncLocalStorage();
-  }
-
-  const run = (context, cb) => {
-    if (!storage) {
-      throw new Error(`Unable to use async_hook, please confirm the node version >= 12.17
-        `);
-    }
-
-    return new Promise((resolve, reject) => {
-      storage.run(context, () => {
-        try {
-          return resolve(cb());
-        } catch (error) {
-          return reject(error);
-        }
-      });
-    });
-  };
-
-  const useContext = () => {
-    if (!storage) {
-      throw new Error(`Unable to use async_hook, please confirm the node version >= 12.17
-        `);
-    }
-
-    const context = storage.getStore();
-
-    if (!context) {
-      throw new Error(`Can't call useContext out of scope, it should be placed in the bff function`);
-    }
-
-    return context;
-  };
-
-  return {
-    run,
-    useContext
-  };
-};
-
-export { createStorage };

package/dist/js/modern/utils/validate.js

@@ -1,49 +0,0 @@
-import util from 'util'; // fork from https://github.com/nodejs/node/blob/master/lib/internal/errors.js
-
-export const getTypeErrorMessage = actual => {
-  let msg = '';
-
-  if (actual == null) {
-    msg += `. Received ${actual}`;
-  } else if (typeof actual === 'function' && actual.name) {
-    msg += `. Received function ${actual.name}`;
-  } else if (typeof actual === 'object') {
-    var _actual$constructor;
-
-    if ((_actual$constructor = actual.constructor) !== null && _actual$constructor !== void 0 && _actual$constructor.name) {
-      msg += `. Received an instance of ${actual.constructor.name}`;
-    } else {
-      const inspected = util.inspect(actual, {
-        depth: -1
-      });
-      msg += `. Received ${inspected}`;
-    }
-  } else {
-    let inspected = util.inspect(actual, {
-      colors: false
-    });
-
-    if (inspected.length > 25) {
-      inspected = `${inspected.slice(0, 25)}...`;
-    }
-
-    msg += `. Received type ${typeof actual} (${inspected})`;
-  }
-
-  return msg;
-}; // eslint-disable-next-line @typescript-eslint/naming-convention
-
-export class ERR_INVALID_ARG_TYPE extends Error {
-  constructor(funcName, expectedType, actual) {
-    const message = `[ERR_INVALID_ARG_TYPE]: The '${funcName}' argument must be of type ${expectedType}${getTypeErrorMessage(actual)}`;
-    super(message);
-  }
-
-}
-export const validateFunction = (maybeFunc, name) => {
-  if (typeof maybeFunc !== 'function') {
-    throw new ERR_INVALID_ARG_TYPE(name, 'function', maybeFunc);
-  }
-
-  return true;
-};