@modern-js/bff-core 1.2.2 → 1.17.0

package/CHANGELOG.md

@@ -0,0 +1,34 @@
+# @modern-js/bff-core
+
+## 1.17.0
+
+### Patch Changes
+
+- Updated dependencies [1b9176f]
+- Updated dependencies [77d3a38]
+- Updated dependencies [151329d]
+- Updated dependencies [5af9472]
+- Updated dependencies [6b6a534]
+- Updated dependencies [6b43a2b]
+- Updated dependencies [a7be124]
+- Updated dependencies [31547b4]
+  - @modern-js/utils@1.17.0
+  - @modern-js/bff-runtime@1.17.0
+
+## 1.16.0
+
+### Minor Changes
+
+- 020b9bd52: feat: support frame mode without lambda directories
+  feat: 支持无 lambda 目录的框架模式
+
+### Patch Changes
+
+- Updated dependencies [641592f52]
+- Updated dependencies [3904b30a5]
+- Updated dependencies [1100dd58c]
+- Updated dependencies [e04e6e76a]
+- Updated dependencies [81c66e4a4]
+- Updated dependencies [2c305b6f5]
+  - @modern-js/utils@1.16.0
+  - @modern-js/bff-runtime@1.16.0

package/dist/js/modern/index.js

@@ -2,6 +2,6 @@ export { Api } from "./api";
 export { HttpError, ValidationError } from "./errors/http";
 export * from "./router";
 export * from "./types";
-export * from "./utils";
 export * from "./client";
-export * from "./operators/http";
+export * from "./operators/http";
+export { getRelativeRuntimePath, HANDLER_WITH_META, isWithMetaHandler, createStorage, registerPaths } from "./utils";

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

@@ -19,6 +19,8 @@ export class ApiRouter {
 
     _defineProperty(this, "lambdaDir", void 0);
 
+    _defineProperty(this, "existLambda", void 0);
+
     _defineProperty(this, "prefix", void 0);
 
     _defineProperty(this, "apiFiles", void 0);
@@ -35,7 +37,7 @@ export class ApiRouter {
 
     _defineProperty(this, "createExistChecker", base => target => fs.pathExistsSync(path.resolve(base, target)));
 
-    _defineProperty(this, "getLambdaDir", apiDir => {
+    _defineProperty(this, "getExactLambdaDir", apiDir => {
       if (this.lambdaDir) {
         return this.lambdaDir;
       }
@@ -57,10 +59,23 @@ export class ApiRouter {
 
     this.prefix = this.initPrefix(prefix);
     this.apiDir = _apiDir;
-    this.lambdaDir = _lambdaDir || this.getLambdaDir(this.apiDir);
+    this.lambdaDir = _lambdaDir || this.getExactLambdaDir(this.apiDir);
+    this.existLambda = this.checkExistLambda(this.apiDir, this.lambdaDir);
+  }
+
+  isExistLambda() {
+    return this.existLambda;
+  }
+
+  getLambdaDir() {
+    return this.lambdaDir;
   }
 
   isApiFile(filename) {
+    if (this.existLambda) {
+      return false;
+    }
+
     if (!this.apiFiles.includes(filename)) {
       return false;
     }
@@ -169,12 +184,20 @@ export class ApiRouter {
   }
 
   loadApiFiles() {
-    // eslint-disable-next-line no-multi-assign
+    if (!this.existLambda) {
+      return [];
+    } // eslint-disable-next-line no-multi-assign
+
+
     const apiFiles = this.apiFiles = getFiles(this.lambdaDir, API_FILE_RULES);
     return apiFiles;
   }
 
   getApiFiles() {
+    if (!this.existLambda) {
+      return [];
+    }
+
     if (this.apiFiles.length > 0) {
       return this.apiFiles;
     }
@@ -203,6 +226,37 @@ export class ApiRouter {
     return prefix || '/api';
   }
 
+  checkExistLambda(apiDir, lambdaDir) {
+    const isSame = apiDir === lambdaDir;
+
+    if (!isSame) {
+      return true;
+    }
+
+    const exts = ['.ts', '.js'];
+
+    const existAppDir = apiDir => {
+      return fs.existsSync(path.join(apiDir, 'app'));
+    };
+
+    const existAppFile = apiDir => {
+      const exists = exts.some(ext => {
+        return fs.existsSync(path.join(apiDir, `app${ext}`));
+      });
+      return exists;
+    };
+
+    if (isSame && existAppDir(apiDir)) {
+      return false;
+    }
+
+    if (isSame && existAppFile(apiDir)) {
+      return false;
+    }
+
+    return true;
+  }
+
   validateAbsolute(filename, paramsName) {
     if (!path.isAbsolute(filename)) {
       throw new Error(`The ${paramsName} ${filename} is not a abolute path`);

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

@@ -71,7 +71,9 @@ const enableRegister = requireFn => {
 const isFunction = input => input && {}.toString.call(input) === '[object Function]';
 
 export const requireHandlerModule = enableRegister(modulePath => {
-  const module = require(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 {

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/index.js

@@ -6,7 +6,12 @@ Object.defineProperty(exports, "__esModule", {
 var _exportNames = {
   Api: true,
   HttpError: true,
-  ValidationError: true
+  ValidationError: true,
+  getRelativeRuntimePath: true,
+  HANDLER_WITH_META: true,
+  isWithMetaHandler: true,
+  createStorage: true,
+  registerPaths: true
 };
 Object.defineProperty(exports, "Api", {
   enumerable: true,
@@ -14,6 +19,12 @@ Object.defineProperty(exports, "Api", {
     return _api.Api;
   }
 });
+Object.defineProperty(exports, "HANDLER_WITH_META", {
+  enumerable: true,
+  get: function () {
+    return _utils.HANDLER_WITH_META;
+  }
+});
 Object.defineProperty(exports, "HttpError", {
   enumerable: true,
   get: function () {
@@ -26,6 +37,30 @@ Object.defineProperty(exports, "ValidationError", {
     return _http.ValidationError;
   }
 });
+Object.defineProperty(exports, "createStorage", {
+  enumerable: true,
+  get: function () {
+    return _utils.createStorage;
+  }
+});
+Object.defineProperty(exports, "getRelativeRuntimePath", {
+  enumerable: true,
+  get: function () {
+    return _utils.getRelativeRuntimePath;
+  }
+});
+Object.defineProperty(exports, "isWithMetaHandler", {
+  enumerable: true,
+  get: function () {
+    return _utils.isWithMetaHandler;
+  }
+});
+Object.defineProperty(exports, "registerPaths", {
+  enumerable: true,
+  get: function () {
+    return _utils.registerPaths;
+  }
+});
 
 var _api = require("./api");
 
@@ -59,20 +94,6 @@ Object.keys(_types).forEach(function (key) {
   });
 });
 
-var _utils = require("./utils");
-
-Object.keys(_utils).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
-  if (key in exports && exports[key] === _utils[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _utils[key];
-    }
-  });
-});
-
 var _client = require("./client");
 
 Object.keys(_client).forEach(function (key) {
@@ -99,4 +120,6 @@ Object.keys(_http2).forEach(function (key) {
       return _http2[key];
     }
   });
-});
+});
+
+var _utils = require("./utils");

package/dist/js/node/router/index.js

@@ -62,6 +62,8 @@ class ApiRouter {
 
     _defineProperty(this, "lambdaDir", void 0);
 
+    _defineProperty(this, "existLambda", void 0);
+
     _defineProperty(this, "prefix", void 0);
 
     _defineProperty(this, "apiFiles", void 0);
@@ -78,7 +80,7 @@ class ApiRouter {
 
     _defineProperty(this, "createExistChecker", base => target => _utils.fs.pathExistsSync(_path.default.resolve(base, target)));
 
-    _defineProperty(this, "getLambdaDir", apiDir => {
+    _defineProperty(this, "getExactLambdaDir", apiDir => {
       if (this.lambdaDir) {
         return this.lambdaDir;
       }
@@ -100,10 +102,23 @@ class ApiRouter {
 
     this.prefix = this.initPrefix(prefix);
     this.apiDir = _apiDir;
-    this.lambdaDir = _lambdaDir || this.getLambdaDir(this.apiDir);
+    this.lambdaDir = _lambdaDir || this.getExactLambdaDir(this.apiDir);
+    this.existLambda = this.checkExistLambda(this.apiDir, this.lambdaDir);
+  }
+
+  isExistLambda() {
+    return this.existLambda;
+  }
+
+  getLambdaDir() {
+    return this.lambdaDir;
   }
 
   isApiFile(filename) {
+    if (this.existLambda) {
+      return false;
+    }
+
     if (!this.apiFiles.includes(filename)) {
       return false;
     }
@@ -213,12 +228,20 @@ class ApiRouter {
   }
 
   loadApiFiles() {
-    // eslint-disable-next-line no-multi-assign
+    if (!this.existLambda) {
+      return [];
+    } // eslint-disable-next-line no-multi-assign
+
+
     const apiFiles = this.apiFiles = (0, _utils3.getFiles)(this.lambdaDir, _constants.API_FILE_RULES);
     return apiFiles;
   }
 
   getApiFiles() {
+    if (!this.existLambda) {
+      return [];
+    }
+
     if (this.apiFiles.length > 0) {
       return this.apiFiles;
     }
@@ -247,6 +270,37 @@ class ApiRouter {
     return prefix || '/api';
   }
 
+  checkExistLambda(apiDir, lambdaDir) {
+    const isSame = apiDir === lambdaDir;
+
+    if (!isSame) {
+      return true;
+    }
+
+    const exts = ['.ts', '.js'];
+
+    const existAppDir = apiDir => {
+      return _utils.fs.existsSync(_path.default.join(apiDir, 'app'));
+    };
+
+    const existAppFile = apiDir => {
+      const exists = exts.some(ext => {
+        return _utils.fs.existsSync(_path.default.join(apiDir, `app${ext}`));
+      });
+      return exists;
+    };
+
+    if (isSame && existAppDir(apiDir)) {
+      return false;
+    }
+
+    if (isSame && existAppFile(apiDir)) {
+      return false;
+    }
+
+    return true;
+  }
+
   validateAbsolute(filename, paramsName) {
     if (!_path.default.isAbsolute(filename)) {
       throw new Error(`The ${paramsName} ${filename} is not a abolute path`);

package/dist/js/node/router/utils.js

@@ -90,7 +90,9 @@ const enableRegister = requireFn => {
 const isFunction = input => input && {}.toString.call(input) === '[object Function]';
 
 const requireHandlerModule = enableRegister(modulePath => {
-  const module = require(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 {

package/dist/js/node/utils/alias.js

@@ -0,0 +1,115 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.registerPaths = exports.getRelativeRuntimePath = exports.createMatchPath = void 0;
+
+var path = _interopRequireWildcard(require("path"));
+
+var os = _interopRequireWildcard(require("os"));
+
+var _fs = _interopRequireDefault(require("fs"));
+
+var _module = _interopRequireDefault(require("module"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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 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;
+};
+
+exports.getRelativeRuntimePath = getRelativeRuntimePath;
+
+const sortByLongestPrefix = arr => {
+  return arr.concat().sort((a, b) => b.length - a.length);
+};
+
+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.default.existsSync(foundPath)) {
+          return foundPath;
+        }
+      }
+
+      return request.replace(found, foundPaths[0]);
+    }
+
+    return null;
+  };
+}; // every path must be a absolute path;
+
+
+exports.createMatchPath = createMatchPath;
+
+const registerPaths = paths => {
+  const originalResolveFilename = _module.default._resolveFilename; // eslint-disable-next-line node/no-unsupported-features/node-builtins
+
+  const {
+    builtinModules
+  } = _module.default;
+  const matchPath = createMatchPath(paths);
+
+  _module.default._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.default._resolveFilename = originalResolveFilename;
+  };
+};
+
+exports.registerPaths = registerPaths;

package/dist/js/node/utils/debug.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.debug = void 0;
+
+var _utils = require("@modern-js/utils");
+
+const debug = (0, _utils.createDebugger)('bff');
+exports.debug = debug;