@modern-js/bff-core 1.21.2-beta.1 → 1.21.2-beta.2

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

@@ -0,0 +1,99 @@
+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({});
+      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

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

@@ -0,0 +1,91 @@
+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

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

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

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

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

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,48 @@
+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

@@ -0,0 +1,49 @@
+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;
+};

package/dist/js/node/api.js

@@ -0,0 +1,66 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Api = Api;
+
+require("reflect-metadata");
+
+var _koaCompose = _interopRequireDefault(require("koa-compose"));
+
+var _utils = require("./utils");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function Api(...args) {
+  const handler = args.pop();
+  (0, _utils.validateFunction)(handler, 'Apihandler');
+  const operators = args;
+  const metadataHelper = {
+    getMetadata(key) {
+      return Reflect.getMetadata(key, runner);
+    },
+
+    setMetadata(key, value) {
+      return Reflect.defineMetadata(key, value, runner);
+    }
+
+  };
+
+  for (const operator of operators) {
+    if (operator.metadata) {
+      operator.metadata(metadataHelper);
+    }
+  }
+
+  const validateHandlers = operators.filter(operator => operator.validate).map(operator => operator.validate);
+  const pipeHandlers = operators.filter(operator => operator.execute).map(operator => operator.execute);
+
+  async function runner(inputs) {
+    const executeHelper = {
+      result: null,
+
+      get inputs() {
+        return inputs;
+      },
+
+      set inputs(val) {
+        // eslint-disable-next-line no-param-reassign
+        inputs = val;
+      }
+
+    };
+    const stack = [...validateHandlers, ...pipeHandlers];
+    stack.push(async (helper, next) => {
+      const res = await handler(helper.inputs);
+      helper.result = res;
+      return next();
+    });
+    await (0, _koaCompose.default)(stack)(executeHelper);
+    return executeHelper.result;
+  }
+
+  runner[_utils.HANDLER_WITH_META] = true;
+  return runner;
+}

package/dist/js/node/client/generate-client.js

@@ -0,0 +1,81 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.generateClient = exports.DEFAULT_CLIENT_REQUEST_CREATOR = void 0;
+
+var path = _interopRequireWildcard(require("path"));
+
+var _router = require("../router");
+
+var _result = require("./result");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+const DEFAULT_CLIENT_REQUEST_CREATOR = '@modern-js/create-request';
+exports.DEFAULT_CLIENT_REQUEST_CREATOR = DEFAULT_CLIENT_REQUEST_CREATOR;
+
+const generateClient = async ({
+  resourcePath,
+  apiDir,
+  prefix,
+  port,
+  target,
+  requestCreator,
+  fetcher,
+  requireResolve: _requireResolve = require.resolve
+}) => {
+  if (!requestCreator) {
+    // eslint-disable-next-line no-param-reassign
+    requestCreator = _requireResolve(`${DEFAULT_CLIENT_REQUEST_CREATOR}${target ? `/${target}` : ''}`).replace(/\\/g, '/');
+  } else {
+    // 这里约束传入的 requestCreator 包也必须有两个导出 client 和 server，因为目前的机制 client 和 server 要导出不同的 configure 函数；该 api 不对使用者暴露，后续可优化
+    let resolvedPath = requestCreator;
+
+    try {
+      resolvedPath = path.dirname(_requireResolve(requestCreator));
+    } catch (error) {} // eslint-disable-next-line no-param-reassign
+
+
+    requestCreator = `${resolvedPath}${target ? `/${target}` : ''}`.replace(/\\/g, '/');
+  }
+
+  const apiRouter = new _router.ApiRouter({
+    apiDir,
+    prefix
+  });
+  const handlerInfos = apiRouter.getSingleModuleHandlers(resourcePath);
+
+  if (!handlerInfos) {
+    return (0, _result.Err)(`generate client error: Cannot require module ${resourcePath}`);
+  }
+
+  let handlersCode = '';
+
+  for (const handlerInfo of handlerInfos) {
+    const {
+      name,
+      httpMethod,
+      routePath
+    } = handlerInfo;
+    let exportStatement = `const ${name} =`;
+
+    if (name.toLowerCase() === 'default') {
+      exportStatement = 'default';
+    }
+
+    const upperHttpMethod = httpMethod.toUpperCase();
+    const routeName = routePath;
+    handlersCode += `export ${exportStatement} createRequest('${routeName}', '${upperHttpMethod}', process.env.PORT || ${String(port)}${fetcher ? `, fetch` : ''});
+`;
+  }
+
+  const importCode = `import { createRequest } from '${requestCreator}';
+${fetcher ? `import { fetch } from '${fetcher}';\n` : ''}`;
+  return (0, _result.Ok)(`${importCode}\n${handlersCode}`);
+};
+
+exports.generateClient = generateClient;

package/dist/js/node/client/index.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _generateClient = require("./generate-client");
+
+Object.keys(_generateClient).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _generateClient[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _generateClient[key];
+    }
+  });
+});

package/dist/js/node/client/result.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Ok = exports.Err = void 0;
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+const Err = value => {
+  const err = {
+    kind: 'Err',
+    value,
+    isErr: true,
+    isOk: false
+  };
+  return err;
+}; // eslint-disable-next-line @typescript-eslint/no-redeclare
+
+
+exports.Err = Err;
+
+const Ok = value => {
+  const ok = {
+    kind: 'Ok',
+    value,
+    isErr: false,
+    isOk: true
+  };
+  return ok;
+};
+
+exports.Ok = Ok;

package/dist/js/node/errors/http.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ValidationError = exports.HttpError = void 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; }
+
+class HttpError extends Error {
+  constructor(status, message) {
+    super(message);
+
+    _defineProperty(this, "status", void 0);
+
+    this.status = status;
+  }
+
+}
+
+exports.HttpError = HttpError;
+
+class ValidationError extends HttpError {
+  constructor(status, message) {
+    super(status, message);
+
+    _defineProperty(this, "code", void 0);
+
+    this.code = 'VALIDATION_ERROR';
+  }
+
+}
+
+exports.ValidationError = ValidationError;