@modern-js/prod-server 2.5.1-alpha.3 → 2.6.0

package/dist/esm/libs/render/ssr.js

@@ -124,16 +124,15 @@ var __generator = this && this.__generator || function(thisArg, body) {
 };
 import path from "path";
 import { fs, LOADABLE_STATS_FILE, mime, ROUTE_MINIFEST_FILE, SERVER_RENDER_FUNCTION_NAME } from "@modern-js/utils";
-import cookie from "cookie";
 import cache from "./cache";
 import { createLogger, createMetrics } from "./measure";
 var render = function() {
     var _ref = _asyncToGenerator(function(ctx, renderOptions, runner) {
-        var _ctx_res, urlPath, bundle, distDir, template, entryName, staticGenerate, bundleJS, loadableUri, loadableStats, routesManifestUri, routeManifest, context, serverRender, content, _context_redirection, url, _context_redirection_status, status;
+        var _ctx_res, urlPath, bundle, distDir, template, entryName, staticGenerate, _renderOptions_enableUnsafeCtx, enableUnsafeCtx, bundleJS, loadableUri, loadableStats, routesManifestUri, routeManifest, context, serverRender, content, _context_redirection, url, _context_redirection_status, status;
         return __generator(this, function(_state) {
             switch(_state.label){
                 case 0:
-                    urlPath = renderOptions.urlPath, bundle = renderOptions.bundle, distDir = renderOptions.distDir, template = renderOptions.template, entryName = renderOptions.entryName, staticGenerate = renderOptions.staticGenerate;
+                    urlPath = renderOptions.urlPath, bundle = renderOptions.bundle, distDir = renderOptions.distDir, template = renderOptions.template, entryName = renderOptions.entryName, staticGenerate = renderOptions.staticGenerate, _renderOptions_enableUnsafeCtx = renderOptions.enableUnsafeCtx, enableUnsafeCtx = _renderOptions_enableUnsafeCtx === void 0 ? false : _renderOptions_enableUnsafeCtx;
                     bundleJS = path.join(distDir, bundle);
                     loadableUri = path.join(distDir, LOADABLE_STATS_FILE);
                     loadableStats = fs.existsSync(loadableUri) ? require(loadableUri) : "";
@@ -147,7 +146,6 @@ var render = function() {
                             host: ctx.host,
                             query: ctx.query,
                             url: ctx.href,
-                            cookieMap: cookie.parse(ctx.headers.cookie || ""),
                             headers: ctx.headers
                         },
                         response: {
@@ -163,12 +161,14 @@ var render = function() {
                         template: template,
                         loadableStats: loadableStats,
                         routeManifest: routeManifest,
+                        // for streaming ssr
                         entryName: entryName,
                         staticGenerate: staticGenerate,
                         logger: void 0,
                         metrics: void 0,
                         req: ctx.req,
-                        res: ctx.res
+                        res: ctx.res,
+                        enableUnsafeCtx: enableUnsafeCtx
                     };
                     context.logger = createLogger(context, ctx.logger);
                     context.metrics = createMetrics(context, ctx.metrics);

package/dist/esm/libs/route/index.js

@@ -41,6 +41,7 @@ var RouteMatchManager = /*#__PURE__*/ function() {
     }
     _createClass(RouteMatchManager, [
         {
+            // get all routes matches pathname
             key: "filter",
             value: function filter(pathname) {
                 return this.matchers.reduce(function(matches, matcher) {
@@ -52,6 +53,7 @@ var RouteMatchManager = /*#__PURE__*/ function() {
             }
         },
         {
+            // get best match from a set of matches
             key: "best",
             value: function best(pathname, matches) {
                 var best;
@@ -87,6 +89,7 @@ var RouteMatchManager = /*#__PURE__*/ function() {
             }
         },
         {
+            // reset routes matcher
             key: "reset",
             value: function reset(specs) {
                 this.specs = specs;
@@ -98,6 +101,7 @@ var RouteMatchManager = /*#__PURE__*/ function() {
             }
         },
         {
+            // get best match from all matcher in manager
             key: "match",
             value: function match(pathname) {
                 var matches = this.filter(pathname);

package/dist/esm/libs/route/matcher.js

@@ -61,6 +61,7 @@ var RouteMatcher = /*#__PURE__*/ function() {
     }
     _createClass(RouteMatcher, [
         {
+            // generate modern route object
             key: "generate",
             value: function generate(url) {
                 var route = new ModernRoute(this.spec);
@@ -84,6 +85,7 @@ var RouteMatcher = /*#__PURE__*/ function() {
             }
         },
         {
+            // get match url length
             key: "matchLength",
             value: function matchLength(pathname) {
                 if (!this.urlReg) {
@@ -96,6 +98,7 @@ var RouteMatcher = /*#__PURE__*/ function() {
             }
         },
         {
+            // if match url path
             key: "matchUrlPath",
             value: function matchUrlPath(requestUrl) {
                 var urlWithoutSlash = requestUrl.endsWith("/") && requestUrl !== "/" ? requestUrl.slice(0, -1) : requestUrl;
@@ -121,6 +124,7 @@ var RouteMatcher = /*#__PURE__*/ function() {
             }
         },
         {
+            // compiler urlPath to regexp if necessary
             key: "setupUrlPath",
             value: function setupUrlPath() {
                 var urlPath = this.spec.urlPath;

package/dist/esm/libs/serve-file.js

@@ -146,7 +146,8 @@ var faviconFallbackHandler = function(context, next) {
 var createStaticFileHandler = function(rules) {
     var output = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
     return function() {
-        var _ref = _asyncToGenerator(function(context, next) {
+        var _ref = // eslint-disable-next-line consistent-return
+        _asyncToGenerator(function(context, next) {
             var requestUrl, req, res, _output_assetPrefix, assetPrefix, hitRule, resume;
             return __generator(this, function(_state) {
                 requestUrl = context.url, req = context.req, res = context.res;

package/dist/esm/server/index.js

@@ -246,7 +246,20 @@ var Server = /*#__PURE__*/ function() {
     _createClass(Server, [
         {
             key: "init",
-            value: function init() {
+            value: /**
+   * 初始化顺序
+   * - 读取 .env.{process.env.MODERN_ENV} 文件，加载环境变量
+   * - 获取 server runtime config
+   * - 设置 context
+   * - 创建 hooksRunner
+   * - 合并插件，内置插件和 serverConfig 中配置的插件
+   * - 执行 config hook
+   * - 获取最终的配置
+   * - 设置配置到 context
+   * - 初始化 server
+   * - 执行 prepare hook
+   * - 执行 server init
+   */ function init() {
                 var _this = this;
                 return _asyncToGenerator(function() {
                     var options;
@@ -309,7 +322,11 @@ var Server = /*#__PURE__*/ function() {
             }
         },
         {
-            key: "runConfigHook",
+            /**
+   * Execute config hooks
+   * @param runner
+   * @param options
+   */ key: "runConfigHook",
             value: function runConfigHook(runner, serverConfig) {
                 var newServerConfig = runner.config(serverConfig || {});
                 return newServerConfig;
@@ -340,7 +357,10 @@ var Server = /*#__PURE__*/ function() {
         },
         {
             key: "initConfig",
-            value: function initConfig(runner, options) {
+            value: /**
+   *
+   * merge cliConfig and serverConfig
+   */ function initConfig(runner, options) {
                 var _this = this;
                 return _asyncToGenerator(function() {
                     var pwd, config, serverConfig, finalServerConfig, resolvedConfigPath;
@@ -382,6 +402,11 @@ var Server = /*#__PURE__*/ function() {
                     listener === null || listener === void 0 ? void 0 : listener();
                 };
                 if (typeof options === "object") {
+                    if (process.env.PORT) {
+                        Object.assign(options, {
+                            port: process.env.PORT
+                        });
+                    }
                     this.app.listen(options, callback);
                 } else {
                     this.app.listen(process.env.PORT || options || 8080, callback);
@@ -471,7 +496,7 @@ var Server = /*#__PURE__*/ function() {
             key: "initAppContext",
             value: function initAppContext() {
                 var options = this.options;
-                var appDirectory = options.pwd, _options_plugins = options.plugins, plugins = _options_plugins === void 0 ? [] : _options_plugins, config = options.config, appContext = options.appContext;
+                var appDirectory = options.pwd, _options_plugins = options.plugins, plugins = _options_plugins === void 0 ? [] : _options_plugins, config = options.config;
                 var serverPlugins = plugins.map(function(p) {
                     return {
                         server: p
@@ -479,10 +504,8 @@ var Server = /*#__PURE__*/ function() {
                 });
                 return {
                     appDirectory: appDirectory,
-                    apiDirectory: appContext === null || appContext === void 0 ? void 0 : appContext.apiDirectory,
-                    lambdaDirectory: appContext === null || appContext === void 0 ? void 0 : appContext.lambdaDirectory,
-                    sharedDirectory: (appContext === null || appContext === void 0 ? void 0 : appContext.sharedDirectory) || path.resolve(appDirectory, SHARED_DIR),
                     distDirectory: path.join(appDirectory, config.output.path || "dist"),
+                    sharedDirectory: path.resolve(appDirectory, SHARED_DIR),
                     plugins: serverPlugins
                 };
             }

package/dist/esm/server/modern-server.js

@@ -216,8 +216,11 @@ var ModernServer = /*#__PURE__*/ function() {
     function ModernServer(param) {
         var pwd = param.pwd, config = param.config, routes = param.routes, staticGenerate = param.staticGenerate, logger = param.logger, metrics = param.metrics, runMode = param.runMode, proxyTarget = param.proxyTarget;
         _classCallCheck(this, ModernServer);
+        // appDirectory
         _defineProperty(this, "pwd", void 0);
+        // product dist dir
         _defineProperty(this, "distDir", void 0);
+        // work on src or dist
         _defineProperty(this, "workDir", void 0);
         _defineProperty(this, "router", void 0);
         _defineProperty(this, "conf", void 0);
@@ -254,7 +257,8 @@ var ModernServer = /*#__PURE__*/ function() {
     _createClass(ModernServer, [
         {
             key: "onInit",
-            value: function onInit(runner, app) {
+            value: // server prepare
+            function onInit(runner, app) {
                 var _this = this;
                 return _asyncToGenerator(function() {
                     var _conf_bff, _this_conf_server, distDir, staticGenerate, conf, usageRoutes, staticPathRegExp, ssrConfig, forceCSR;
@@ -323,6 +327,7 @@ var ModernServer = /*#__PURE__*/ function() {
             }
         },
         {
+            // server ready
             key: "onRepack",
             value: function onRepack(_) {}
         },
@@ -382,6 +387,7 @@ var ModernServer = /*#__PURE__*/ function() {
             }
         },
         {
+            // exposed requestHandler
             key: "getRequestHandler",
             value: function getRequestHandler() {
                 return this.requestHandler.bind(this);
@@ -442,6 +448,7 @@ var ModernServer = /*#__PURE__*/ function() {
             }
         },
         {
+            /* —————————————————————— function will be overwrite —————————————————————— */ // get routes info
             key: "getRoutes",
             value: function getRoutes() {
                 if (this.presetRoutes) {
@@ -456,12 +463,15 @@ var ModernServer = /*#__PURE__*/ function() {
             }
         },
         {
+            // add promisify request handler to server
+            // handler should do not do more things after invoke next
             key: "addHandler",
             value: function addHandler(handler) {
                 this.handlers.push(handler);
             }
         },
         {
+            // return 404 page
             key: "render404",
             value: function render404(context) {
                 context.error(ERROR_DIGEST.ENOTF, "404 Not Found");
@@ -502,7 +512,8 @@ var ModernServer = /*#__PURE__*/ function() {
         },
         {
             key: "prepareFrameHandler",
-            value: function prepareFrameHandler(options) {
+            value: // gather frame extension and get framework handler
+            function prepareFrameHandler(options) {
                 var _this = this;
                 return _asyncToGenerator(function() {
                     var workDir, runner, _ref, onlyApi, onlyWeb, _createMiddlewareCollecter, getMiddlewares, collector, _getMiddlewares, pluginAPIExt, pluginWebExt, apiDir, serverDir, webExtension, apiExtension;
@@ -610,7 +621,6 @@ var ModernServer = /*#__PURE__*/ function() {
                                 pwd: workDir,
                                 config: extension,
                                 prefix: Array.isArray(prefix) ? prefix[0] : prefix,
-                                httpMethodDecider: bff === null || bff === void 0 ? void 0 : bff.httpMethodDecider,
                                 render: _this.render.bind(_this)
                             }, {
                                 onLast: function() {
@@ -714,6 +724,7 @@ var ModernServer = /*#__PURE__*/ function() {
             }
         },
         {
+            // warmup ssr function
             key: "warmupSSRBundle",
             value: function warmupSSRBundle() {
                 var distDir = this.distDir;
@@ -735,7 +746,8 @@ var ModernServer = /*#__PURE__*/ function() {
         },
         {
             key: "routeHandler",
-            value: function routeHandler(context) {
+            value: /* —————————————————————— private function —————————————————————— */ // handler route.json, include api / csr / ssr
+            function routeHandler(context) {
                 var _this = this;
                 return _asyncToGenerator(function() {
                     var res, matched, route, afterMatchContext, _afterMatchContext_router, current, url, status, matched2, middlewareContext, renderResult, contentStream, response, afterRenderContext;
@@ -920,6 +932,7 @@ var ModernServer = /*#__PURE__*/ function() {
             }
         },
         {
+            // compose handlers and create the final handler
             key: "compose",
             value: function compose() {
                 var _this = this;

package/dist/esm-node/libs/context/context.js

@@ -6,6 +6,9 @@ import fresh from "fresh";
 import { headersWithoutCookie } from "../../utils";
 class ModernServerContext {
   constructor(req, res, options) {
+    /**
+     * url params
+     */
     this.params = {};
     this.options = {};
     this.req = req;
@@ -28,6 +31,7 @@ class ModernServerContext {
       this.send(body);
     };
   }
+  // compat express res.send, only support etag now
   send(body) {
     try {
       const generateETag = !this.res.getHeader("ETag") && this.options.etag;
@@ -77,6 +81,7 @@ class ModernServerContext {
     }
     return false;
   }
+  /* request property */
   get headers() {
     return this.req.headers;
   }
@@ -137,12 +142,16 @@ class ModernServerContext {
     const str = this.querystring;
     return qs.parse(str);
   }
+  /* response property */
   get status() {
     return this.res.statusCode;
   }
   set status(statusCode) {
     this.res.statusCode = statusCode;
   }
+  /**
+   * 判断链接是否已经关闭
+   */
   resHasHandled() {
     return this.res.writableEnded;
   }

package/dist/esm-node/libs/loadConfig.js

@@ -23,6 +23,7 @@ const loadConfig = ({
       {
         ...resolvedConfig,
         plugins: []
+        // filter cli plugins
       },
       serverConfig,
       cliConfig

package/dist/esm-node/libs/render/cache/spr.js

@@ -54,6 +54,7 @@ class CacheManager {
     this.cacheOptions = cacheOptions;
     this.cache = new LRUCache({
       max: Math.min(MAX_SIZE_EACH_CLUSTER, 600) * 1024 * 1024,
+      // 默认存 100M，最大 600M
       length(n) {
         const len = n.caches.keys().reduce((total, cur) => {
           var _a;

package/dist/esm-node/libs/render/reader.js

@@ -12,11 +12,13 @@ const createCacheItem = async (filepath, mtime) => {
   };
 };
 class LruReader {
+  // private timer?: NodeJS.Timeout;
   constructor() {
     this.cache = new LRU({
       max: 256 * MB,
       length: getContentLength,
       maxAge: 5 * 60 * 5e3
+      // 60s
     });
   }
   init() {
@@ -61,6 +63,9 @@ class LruReader {
       }
     }
   }
+  // private timeTask() {
+  // this.timer = setInterval(() => this.update, 5 * 60 * 1000).unref();
+  // }
 }
 const reader = new LruReader();
 const readFile = async (filepath) => {

package/dist/esm-node/libs/render/ssr.js

@@ -6,12 +6,19 @@ import {
   ROUTE_MINIFEST_FILE,
   SERVER_RENDER_FUNCTION_NAME
 } from "@modern-js/utils";
-import cookie from "cookie";
 import cache from "./cache";
 import { createLogger, createMetrics } from "./measure";
 const render = async (ctx, renderOptions, runner) => {
   var _a;
-  const { urlPath, bundle, distDir, template, entryName, staticGenerate } = renderOptions;
+  const {
+    urlPath,
+    bundle,
+    distDir,
+    template,
+    entryName,
+    staticGenerate,
+    enableUnsafeCtx = false
+  } = renderOptions;
   const bundleJS = path.join(distDir, bundle);
   const loadableUri = path.join(distDir, LOADABLE_STATS_FILE);
   const loadableStats = fs.existsSync(loadableUri) ? require(loadableUri) : "";
@@ -25,7 +32,6 @@ const render = async (ctx, renderOptions, runner) => {
       host: ctx.host,
       query: ctx.query,
       url: ctx.href,
-      cookieMap: cookie.parse(ctx.headers.cookie || ""),
       headers: ctx.headers
     },
     response: {
@@ -41,12 +47,14 @@ const render = async (ctx, renderOptions, runner) => {
     template,
     loadableStats,
     routeManifest,
+    // for streaming ssr
     entryName,
     staticGenerate,
     logger: void 0,
     metrics: void 0,
     req: ctx.req,
-    res: ctx.res
+    res: ctx.res,
+    enableUnsafeCtx
   };
   context.logger = createLogger(context, ctx.logger);
   context.metrics = createMetrics(context, ctx.metrics);

package/dist/esm-node/libs/route/index.js

@@ -4,6 +4,7 @@ class RouteMatchManager {
     this.specs = [];
     this.matchers = [];
   }
+  // get all routes matches pathname
   filter(pathname) {
     return this.matchers.reduce((matches, matcher) => {
       if (matcher.matchUrlPath(pathname)) {
@@ -12,6 +13,7 @@ class RouteMatchManager {
       return matches;
     }, []);
   }
+  // get best match from a set of matches
   best(pathname, matches) {
     let best;
     let matchedLen = 0;
@@ -27,6 +29,7 @@ class RouteMatchManager {
     }
     return best;
   }
+  // reset routes matcher
   reset(specs) {
     this.specs = specs;
     const matchers = specs.reduce((ms, spec) => {
@@ -35,6 +38,7 @@ class RouteMatchManager {
     }, []);
     this.matchers = matchers;
   }
+  // get best match from all matcher in manager
   match(pathname) {
     const matches = this.filter(pathname);
     const best = this.best(pathname, matches);

package/dist/esm-node/libs/route/matcher.js

@@ -22,6 +22,7 @@ class RouteMatcher {
     this.spec = spec;
     this.setupUrlPath();
   }
+  // generate modern route object
   generate(url) {
     const route = new ModernRoute(this.spec);
     if (this.urlPath) {
@@ -39,6 +40,7 @@ class RouteMatcher {
       return matchResult.params;
     }
   }
+  // get match url length
   matchLength(pathname) {
     var _a;
     if (!this.urlReg) {
@@ -48,6 +50,7 @@ class RouteMatcher {
       return ((_a = result == null ? void 0 : result[0]) == null ? void 0 : _a.length) || null;
     }
   }
+  // if match url path
   matchUrlPath(requestUrl) {
     let urlWithoutSlash = requestUrl.endsWith("/") && requestUrl !== "/" ? requestUrl.slice(0, -1) : requestUrl;
     urlWithoutSlash = removeHtmlSuffix(urlWithoutSlash);
@@ -67,6 +70,7 @@ class RouteMatcher {
   matchEntry(entryName) {
     return this.spec.entryName === entryName;
   }
+  // compiler urlPath to regexp if necessary
   setupUrlPath() {
     const { urlPath } = this.spec;
     this.urlPath = urlPath === "/" ? urlPath : removeTailSlash(urlPath);

package/dist/esm-node/libs/serve-file.js

@@ -20,27 +20,30 @@ const faviconFallbackHandler = (context, next) => {
     next();
   }
 };
-const createStaticFileHandler = (rules, output = {}) => async (context, next) => {
-  const { url: requestUrl, req, res } = context;
-  const { assetPrefix = "/" } = output;
-  const hitRule = rules.find((item) => {
-    if (isString(item.path) && requestUrl.startsWith(item.path)) {
-      return true;
-    } else if (isRegExp(item.path) && item.path.test(requestUrl)) {
-      return true;
-    }
-    return false;
-  });
-  if (hitRule) {
-    const resume = removedPrefix(req, assetPrefix);
-    serve(hitRule.target)(req, res, () => {
-      resume();
-      next();
+const createStaticFileHandler = (rules, output = {}) => (
+  // eslint-disable-next-line consistent-return
+  async (context, next) => {
+    const { url: requestUrl, req, res } = context;
+    const { assetPrefix = "/" } = output;
+    const hitRule = rules.find((item) => {
+      if (isString(item.path) && requestUrl.startsWith(item.path)) {
+        return true;
+      } else if (isRegExp(item.path) && item.path.test(requestUrl)) {
+        return true;
+      }
+      return false;
     });
-  } else {
-    return next();
+    if (hitRule) {
+      const resume = removedPrefix(req, assetPrefix);
+      serve(hitRule.target)(req, res, () => {
+        resume();
+        next();
+      });
+    } else {
+      return next();
+    }
   }
-};
+);
 export {
   createStaticFileHandler,
   faviconFallbackHandler

package/dist/esm-node/server/index.js

@@ -32,6 +32,20 @@ class Server {
     this.options = options;
     this.serverConfig = {};
   }
+  /**
+   * 初始化顺序
+   * - 读取 .env.{process.env.MODERN_ENV} 文件，加载环境变量
+   * - 获取 server runtime config
+   * - 设置 context
+   * - 创建 hooksRunner
+   * - 合并插件，内置插件和 serverConfig 中配置的插件
+   * - 执行 config hook
+   * - 获取最终的配置
+   * - 设置配置到 context
+   * - 初始化 server
+   * - 执行 prepare hook
+   * - 执行 server init
+   */
   async init() {
     const { options } = this;
     this.loadServerEnv(options);
@@ -46,6 +60,11 @@ class Server {
     await this.server.onInit(this.runner, this.app);
     return this;
   }
+  /**
+   * Execute config hooks
+   * @param runner
+   * @param options
+   */
   runConfigHook(runner, serverConfig) {
     const newServerConfig = runner.config(serverConfig || {});
     return newServerConfig;
@@ -63,6 +82,10 @@ class Server {
     const serverConfig = requireConfig(serverConfigPath);
     this.serverConfig = serverConfig;
   }
+  /**
+   *
+   * merge cliConfig and serverConfig
+   */
   async initConfig(runner, options) {
     const { pwd, config } = options;
     const { serverConfig } = this;
@@ -86,6 +109,9 @@ class Server {
       listener == null ? void 0 : listener();
     };
     if (typeof options === "object") {
+      if (process.env.PORT) {
+        Object.assign(options, { port: process.env.PORT });
+      }
       this.app.listen(options, callback);
     } else {
       this.app.listen(process.env.PORT || options || 8080, callback);
@@ -130,16 +156,14 @@ class Server {
   }
   initAppContext() {
     const { options } = this;
-    const { pwd: appDirectory, plugins = [], config, appContext } = options;
+    const { pwd: appDirectory, plugins = [], config } = options;
     const serverPlugins = plugins.map((p) => ({
       server: p
     }));
     return {
       appDirectory,
-      apiDirectory: appContext == null ? void 0 : appContext.apiDirectory,
-      lambdaDirectory: appContext == null ? void 0 : appContext.lambdaDirectory,
-      sharedDirectory: (appContext == null ? void 0 : appContext.sharedDirectory) || path.resolve(appDirectory, SHARED_DIR),
       distDirectory: path.join(appDirectory, config.output.path || "dist"),
+      sharedDirectory: path.resolve(appDirectory, SHARED_DIR),
       plugins: serverPlugins
     };
   }