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

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

@@ -0,0 +1,50 @@
+import serve from "serve-static";
+import { isString, isRegExp } from "@modern-js/utils";
+import { useLocalPrefix } from "../utils";
+const removedPrefix = (req, prefix) => {
+  if (useLocalPrefix(prefix)) {
+    req.url = req.url.slice(prefix.length);
+    return () => {
+      req.url = prefix + req.url;
+    };
+  } else {
+    return () => {
+    };
+  }
+};
+const faviconFallbackHandler = (context, next) => {
+  if (context.url === "/favicon.ico") {
+    context.res.statusCode = 204;
+    context.res.end();
+  } else {
+    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;
+    });
+    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

@@ -21,7 +21,7 @@ import {
   requireConfig
 } from "../libs/loadConfig";
 import { debug } from "../utils";
-import { createProdServer } from "./modern-server-split";
+import { createProdServer } from "./modernServerSplit";
 class Server {
   constructor(options) {
     this.serverImpl = createProdServer;
@@ -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);

package/dist/esm-node/server/{modern-server.js → modernServer.js}

@@ -8,7 +8,7 @@ import { createRenderHandler } from "../libs/render";
 import {
   createStaticFileHandler,
   faviconFallbackHandler
-} from "../libs/serve-file";
+} from "../libs/serveFile";
 import {
   createErrorDocument,
   createMiddlewareCollecter,
@@ -33,7 +33,6 @@ import {
   createAfterRenderContext,
   createMiddlewareContext
 } from "../libs/hook-api";
-const API_DIR = "./api";
 const SERVER_DIR = "./server";
 class ModernServer {
   constructor({
@@ -66,6 +65,7 @@ class ModernServer {
     this.staticGenerate = staticGenerate || false;
     this.runMode = runMode || RUN_MODE.FULL;
   }
+  // server prepare
   async onInit(runner, app) {
     var _a, _b;
     this.runner = runner;
@@ -113,6 +113,7 @@ class ModernServer {
     this.addHandler(this.routeHandler.bind(this));
     this.compose();
   }
+  // server ready
   onRepack(_) {
   }
   addBeforeRouteHandler() {
@@ -135,6 +136,7 @@ class ModernServer {
     const onlyWeb = filepath.startsWith(serverPath);
     this.prepareFrameHandler({ onlyWeb, onlyApi });
   }
+  // exposed requestHandler
   getRequestHandler() {
     return this.requestHandler.bind(this);
   }
@@ -156,6 +158,8 @@ class ModernServer {
   async createHTTPServer(handler) {
     return createServer(handler);
   }
+  /* —————————————————————— function will be overwrite —————————————————————— */
+  // get routes info
   getRoutes() {
     if (this.presetRoutes) {
       return this.presetRoutes;
@@ -167,9 +171,12 @@ class ModernServer {
     }
     return [];
   }
+  // add promisify request handler to server
+  // handler should do not do more things after invoke next
   addHandler(handler) {
     this.handlers.push(handler);
   }
+  // return 404 page
   render404(context) {
     context.error(ERROR_DIGEST.ENOTF, "404 Not Found");
     this.renderErrorPage(context, 404);
@@ -187,19 +194,19 @@ class ModernServer {
     );
     this.beforeRouteHandler = handler;
   }
+  // gather frame extension and get framework handler
   async prepareFrameHandler(options) {
     const { workDir, runner } = this;
     const { onlyApi, onlyWeb } = options || {};
     const { getMiddlewares, ...collector } = createMiddlewareCollecter();
     await runner.gather(collector);
     const { api: pluginAPIExt, web: pluginWebExt } = getMiddlewares();
-    const apiDir = path.join(workDir, API_DIR);
     const serverDir = path.join(workDir, SERVER_DIR);
     if (await fs.pathExists(path.join(serverDir)) && !onlyApi) {
       const webExtension = mergeExtension(pluginWebExt);
       this.frameWebHandler = await this.prepareWebHandler(webExtension);
     }
-    if (fs.existsSync(apiDir) && !onlyWeb) {
+    if (!onlyWeb) {
       const apiExtension = mergeExtension(pluginAPIExt);
       this.frameAPIHandler = await this.prepareAPIHandler(apiExtension);
     }
@@ -257,6 +264,7 @@ class ModernServer {
   async proxy() {
     return null;
   }
+  // warmup ssr function
   warmupSSRBundle() {
     const { distDir } = this;
     const bundles = this.router.getBundles();
@@ -270,6 +278,8 @@ class ModernServer {
   createContext(req, res, options = {}) {
     return createContext(req, res, options);
   }
+  /* —————————————————————— private function —————————————————————— */
+  // handler route.json, include api / csr / ssr
   async routeHandler(context) {
     const { res } = context;
     const matched = this.router.match(context.path);
@@ -350,7 +360,7 @@ class ModernServer {
         templateInjectableStream({
           prependHead: route.entryName ? `<script>window._SERVER_DATA=${JSON.stringify(
             context.serverData
-          )}<\/script>` : void 0
+          )}</script>` : void 0
         })
       ).pipe(res);
       return;
@@ -370,7 +380,7 @@ class ModernServer {
       afterRenderContext.template.prependHead(
         `<script>window._SERVER_DATA=${JSON.stringify(
           context.serverData
-        )}<\/script>`
+        )}</script>`
       );
       response = afterRenderContext.template.get();
     }
@@ -386,6 +396,7 @@ class ModernServer {
     }
     return false;
   }
+  // compose handlers and create the final handler
   compose() {
     const { handlers } = this;
     if (!Array.isArray(handlers)) {

package/dist/esm-node/server/{modern-server-split.js → modernServerSplit.js}

@@ -1,4 +1,4 @@
-import { ModernServer } from "./modern-server";
+import { ModernServer } from "./modernServer";
 class ModernSSRServer extends ModernServer {
   prepareAPIHandler(_) {
     return null;

package/dist/types/index.d.ts

@@ -2,7 +2,7 @@ import { ModernServerOptions } from './type';
 import { Server } from './server';
 export { Server };
 export type { ServerConfig } from '@modern-js/server-core';
-export { ModernServer } from './server/modern-server';
+export { ModernServer } from './server/modernServer';
 export { createProxyHandler } from './libs/proxy';
 export * from './type';
 export * from './constants';

package/dist/types/libs/context/context.d.ts

@@ -3,7 +3,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node/http" />
-/// <reference types=".dts-temp/vruupblf2_wmqdzbkln3e/src/type" />
+/// <reference types=".dts-temp/i8fchs4liml2xhpvizgjb/src/type" />
 import { IncomingMessage, ServerResponse } from 'http';
 import { URL } from 'url';
 import qs from 'querystring';

package/dist/types/libs/render/ssr.d.ts

@@ -7,4 +7,5 @@ export declare const render: (ctx: ModernServerContext, renderOptions: {
   template: string;
   entryName: string;
   staticGenerate: boolean;
+  enableUnsafeCtx?: boolean;
 }, runner: ServerHookRunner) => Promise<RenderResult>;

package/dist/types/type.d.ts

@@ -27,7 +27,7 @@ export type ModernServerOptions = {
   webOnly?: boolean;
   runMode?: string;
   appContext?: {
-    appDirectory: string;
+    appDirectory?: string;
     sharedDirectory: string;
     apiDirectory: string;
     lambdaDirectory: string;

package/dist/types/utils.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node/http" />
-/// <reference types=".dts-temp/vruupblf2_wmqdzbkln3e/src/type" />
+/// <reference types=".dts-temp/i8fchs4liml2xhpvizgjb/src/type" />
 import { IncomingMessage } from 'http';
 import type { OutputNormalizedConfig, HtmlNormalizedConfig } from '@modern-js/server-core';
 export declare const debug: any;

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.5.1-alpha.3",
+  "version": "2.6.1-alpha.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -27,11 +27,11 @@
     },
     "./worker": {
       "node": {
-        "jsnext:source": "./src/worker-server.ts",
-        "import": "./dist/esm-node/worker-server.js",
-        "require": "./dist/cjs/worker-server.js"
+        "jsnext:source": "./src/workerServer.ts",
+        "import": "./dist/esm-node/workerServer.js",
+        "require": "./dist/cjs/workerServer.js"
       },
-      "default": "./dist/esm/worker-server.js"
+      "default": "./dist/esm/workerServer.js"
     }
   },
   "typesVersions": {
@@ -40,13 +40,13 @@
         "./dist/types/index.d.ts"
       ],
       "worker": [
-        "./dist/types/worker-server.d.ts"
+        "./dist/types/workerServer.d.ts"
       ]
     }
   },
   "dependencies": {
-    "@modern-js/utils": "2.5.0",
-    "@modern-js/server-core": "2.5.1-alpha.0",
+    "@modern-js/utils": "2.6.0",
+    "@modern-js/server-core": "2.6.0",
     "etag": "^1.8.1",
     "fresh": "^0.5.2",
     "cookie": "^0.4.2",
@@ -58,10 +58,10 @@
     "serve-static": "^1.14.1"
   },
   "devDependencies": {
-    "@modern-js/types": "2.5.1-alpha.0",
-    "@modern-js/server-core": "2.5.1-alpha.0",
-    "@scripts/jest-config": "2.5.0",
-    "@scripts/build": "2.5.0",
+    "@modern-js/types": "2.6.0",
+    "@modern-js/server-core": "2.6.0",
+    "@scripts/jest-config": "2.6.0",
+    "@scripts/build": "2.6.0",
     "@types/cookie": "^0.4.1",
     "@types/jest": "^27",
     "@types/lru-cache": "^5.1.1",

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

@@ -1,47 +0,0 @@
-import serve from "serve-static";
-import { isString, isRegExp } from "@modern-js/utils";
-import { useLocalPrefix } from "../utils";
-const removedPrefix = (req, prefix) => {
-  if (useLocalPrefix(prefix)) {
-    req.url = req.url.slice(prefix.length);
-    return () => {
-      req.url = prefix + req.url;
-    };
-  } else {
-    return () => {
-    };
-  }
-};
-const faviconFallbackHandler = (context, next) => {
-  if (context.url === "/favicon.ico") {
-    context.res.statusCode = 204;
-    context.res.end();
-  } else {
-    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();
-    });
-  } else {
-    return next();
-  }
-};
-export {
-  createStaticFileHandler,
-  faviconFallbackHandler
-};