@modern-js/prod-server 2.4.1-beta.0 → 2.5.1-alpha.0

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

@@ -0,0 +1,491 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var modern_server_exports = {};
+__export(modern_server_exports, {
+  ModernServer: () => ModernServer
+});
+module.exports = __toCommonJS(modern_server_exports);
+var import_http = require("http");
+var import_path = __toESM(require("path"));
+var import_utils = require("@modern-js/utils");
+var import_route = require("../libs/route");
+var import_render = require("../libs/render");
+var import_serve_file = require("../libs/serve-file");
+var import_utils2 = require("../utils");
+var reader = __toESM(require("../libs/render/reader"));
+var import_proxy = require("../libs/proxy");
+var import_context = require("../libs/context");
+var import_template = require("../libs/hook-api/template");
+var import_constants = require("../constants");
+var import_hook_api = require("../libs/hook-api");
+const API_DIR = "./api";
+const SERVER_DIR = "./server";
+class ModernServer {
+  constructor({
+    pwd,
+    config,
+    routes,
+    staticGenerate,
+    logger,
+    metrics,
+    runMode,
+    proxyTarget
+  }) {
+    this.handlers = [];
+    this.reader = reader;
+    this.beforeRouteHandler = null;
+    this.frameWebHandler = null;
+    this.frameAPIHandler = null;
+    this.proxyHandler = null;
+    require("ignore-styles");
+    this.pwd = pwd;
+    this.distDir = import_path.default.join(pwd, config.output.path || "dist");
+    this.workDir = this.distDir;
+    this.conf = config;
+    (0, import_utils2.debug)("server conf", this.conf);
+    this.logger = logger;
+    this.metrics = metrics;
+    this.router = new import_route.RouteMatchManager();
+    this.presetRoutes = routes;
+    this.proxyTarget = proxyTarget;
+    this.staticGenerate = staticGenerate || false;
+    this.runMode = runMode || import_constants.RUN_MODE.FULL;
+  }
+  async onInit(runner, app) {
+    var _a, _b;
+    this.runner = runner;
+    const { distDir, staticGenerate, conf } = this;
+    (0, import_utils2.debug)("final server conf", this.conf);
+    this.proxyHandler = (0, import_proxy.createProxyHandler)((_a = conf.bff) == null ? void 0 : _a.proxy);
+    if (this.proxyHandler) {
+      this.proxyHandler.forEach((handler) => {
+        this.addHandler(handler);
+      });
+    }
+    this.reader.init();
+    app.on("close", () => {
+      this.reader.close();
+    });
+    const usageRoutes = this.filterRoutes(this.getRoutes());
+    this.router.reset(usageRoutes);
+    this.warmupSSRBundle();
+    await this.prepareFrameHandler();
+    await this.prepareBeforeRouteHandler(usageRoutes, distDir);
+    const staticPathRegExp = (0, import_utils2.getStaticReg)(
+      this.conf.output || {},
+      this.conf.html
+    );
+    this.staticFileHandler = (0, import_serve_file.createStaticFileHandler)(
+      [
+        {
+          path: staticPathRegExp,
+          target: distDir
+        }
+      ],
+      this.conf.output
+    );
+    const ssrConfig = (_b = this.conf.server) == null ? void 0 : _b.ssr;
+    const forceCSR = typeof ssrConfig === "object" ? ssrConfig.forceCSR : false;
+    this.routeRenderHandler = (0, import_render.createRenderHandler)({
+      distDir,
+      staticGenerate,
+      forceCSR
+    });
+    await this.setupBeforeProdMiddleware();
+    this.addHandler(this.staticFileHandler);
+    this.addHandler(import_serve_file.faviconFallbackHandler);
+    this.addBeforeRouteHandler();
+    this.addHandler(this.routeHandler.bind(this));
+    this.compose();
+  }
+  onRepack(_) {
+  }
+  addBeforeRouteHandler() {
+    this.addHandler(async (context, next) => {
+      if (this.beforeRouteHandler) {
+        await this.beforeRouteHandler(context);
+        if (this.isSend(context.res)) {
+          return;
+        }
+      }
+      return next();
+    });
+  }
+  onServerChange({ filepath }) {
+    const { pwd } = this;
+    const { api, server } = import_constants.AGGRED_DIR;
+    const apiPath = import_path.default.normalize(import_path.default.join(pwd, api));
+    const serverPath = import_path.default.normalize(import_path.default.join(pwd, server));
+    const onlyApi = filepath.startsWith(apiPath);
+    const onlyWeb = filepath.startsWith(serverPath);
+    this.prepareFrameHandler({ onlyWeb, onlyApi });
+  }
+  getRequestHandler() {
+    return this.requestHandler.bind(this);
+  }
+  async render(req, res, url) {
+    req.logger = req.logger || this.logger;
+    req.metrics = req.metrics || this.metrics;
+    const context = (0, import_context.createContext)(req, res);
+    const matched = this.router.match(url || context.path);
+    if (!matched) {
+      return null;
+    }
+    const route = matched.generate(context.url);
+    const result = await this.handleWeb(context, route);
+    if (!result) {
+      return null;
+    }
+    return result.content.toString();
+  }
+  async createHTTPServer(handler) {
+    return (0, import_http.createServer)(handler);
+  }
+  getRoutes() {
+    if (this.presetRoutes) {
+      return this.presetRoutes;
+    }
+    const file = import_path.default.join(this.distDir, import_utils.ROUTE_SPEC_FILE);
+    if (import_utils.fs.existsSync(file)) {
+      const content = import_utils.fs.readJSONSync(file);
+      return content.routes;
+    }
+    return [];
+  }
+  addHandler(handler) {
+    this.handlers.push(handler);
+  }
+  render404(context) {
+    context.error(import_constants.ERROR_DIGEST.ENOTF, "404 Not Found");
+    this.renderErrorPage(context, 404);
+  }
+  async prepareBeforeRouteHandler(specs, distDir) {
+    const { runner } = this;
+    const handler = await runner.preparebeforeRouteHandler(
+      {
+        serverRoutes: specs,
+        distDir
+      },
+      {
+        onLast: () => null
+      }
+    );
+    this.beforeRouteHandler = handler;
+  }
+  async prepareFrameHandler(options) {
+    const { workDir, runner } = this;
+    const { onlyApi, onlyWeb } = options || {};
+    const { getMiddlewares, ...collector } = (0, import_utils2.createMiddlewareCollecter)();
+    await runner.gather(collector);
+    const { api: pluginAPIExt, web: pluginWebExt } = getMiddlewares();
+    const apiDir = import_path.default.join(workDir, API_DIR);
+    const serverDir = import_path.default.join(workDir, SERVER_DIR);
+    if (await import_utils.fs.pathExists(import_path.default.join(serverDir)) && !onlyApi) {
+      const webExtension = (0, import_utils2.mergeExtension)(pluginWebExt);
+      this.frameWebHandler = await this.prepareWebHandler(webExtension);
+    }
+    if (import_utils.fs.existsSync(apiDir) && !onlyWeb) {
+      const apiExtension = (0, import_utils2.mergeExtension)(pluginAPIExt);
+      this.frameAPIHandler = await this.prepareAPIHandler(apiExtension);
+    }
+  }
+  async prepareWebHandler(extension) {
+    const { workDir, runner } = this;
+    const handler = await runner.prepareWebServer(
+      {
+        pwd: workDir,
+        config: extension
+      },
+      { onLast: () => null }
+    );
+    return handler;
+  }
+  async prepareAPIHandler(extension) {
+    const { workDir, runner, conf } = this;
+    const { bff } = conf;
+    const prefix = (bff == null ? void 0 : bff.prefix) || "/api";
+    return runner.prepareApiServer(
+      {
+        pwd: workDir,
+        config: extension,
+        prefix: Array.isArray(prefix) ? prefix[0] : prefix,
+        httpMethodDecider: bff == null ? void 0 : bff.httpMethodDecider,
+        render: this.render.bind(this)
+      },
+      { onLast: () => null }
+    );
+  }
+  filterRoutes(routes) {
+    return routes;
+  }
+  async setupBeforeProdMiddleware() {
+    const { conf, runner } = this;
+    const preMiddleware = await runner.beforeProdServer(conf);
+    preMiddleware.flat().forEach((mid) => {
+      this.addHandler(mid);
+    });
+  }
+  async handleAPI(context) {
+    const { req, res } = context;
+    if (!this.frameAPIHandler) {
+      throw new Error("can not found api handler");
+    }
+    await this.frameAPIHandler(req, res);
+  }
+  async handleWeb(context, route) {
+    return this.routeRenderHandler({
+      ctx: context,
+      route,
+      runner: this.runner
+    });
+  }
+  async proxy() {
+    return null;
+  }
+  warmupSSRBundle() {
+    const { distDir } = this;
+    const bundles = this.router.getBundles();
+    bundles.forEach((bundle) => {
+      const filepath = import_path.default.join(distDir, bundle);
+      if (import_utils.fs.existsSync(filepath)) {
+        require(filepath);
+      }
+    });
+  }
+  createContext(req, res, options = {}) {
+    return (0, import_context.createContext)(req, res, options);
+  }
+  async routeHandler(context) {
+    const { res } = context;
+    const matched = this.router.match(context.path);
+    if (!matched) {
+      this.render404(context);
+      return;
+    }
+    let route = matched.generate(context.url);
+    if (route.isApi) {
+      await this.handleAPI(context);
+      return;
+    }
+    const afterMatchContext = (0, import_hook_api.createAfterMatchContext)(context, route.entryName);
+    if (this.runMode === import_constants.RUN_MODE.FULL) {
+      await this.runner.afterMatch(afterMatchContext, { onLast: import_utils2.noop });
+    }
+    if (this.isSend(res)) {
+      return;
+    }
+    const { current, url, status } = afterMatchContext.router;
+    if (url) {
+      this.redirect(res, url, status);
+      return;
+    }
+    if (route.entryName !== current) {
+      const matched2 = this.router.matchEntry(current);
+      if (!matched2) {
+        this.render404(context);
+        return;
+      }
+      route = matched2.generate(context.url);
+    }
+    context.setParams(route.params);
+    context.setServerData("router", {
+      baseUrl: route.urlPath,
+      params: route.params
+    });
+    if (this.frameWebHandler) {
+      res.locals = res.locals || {};
+      const middlewareContext = (0, import_hook_api.createMiddlewareContext)(context);
+      await this.frameWebHandler(middlewareContext);
+      res.locals = {
+        ...res.locals,
+        ...middlewareContext.response.locals
+      };
+    }
+    if (this.isSend(res)) {
+      return;
+    }
+    if (route.responseHeaders) {
+      Object.keys(route.responseHeaders).forEach((key) => {
+        const value = route.responseHeaders[key];
+        if (value) {
+          context.res.setHeader(key, value);
+        }
+      });
+    }
+    const renderResult = await this.handleWeb(context, route);
+    if (!renderResult) {
+      this.render404(context);
+      return;
+    }
+    if (renderResult.redirect) {
+      this.redirect(
+        res,
+        renderResult.content,
+        renderResult.statusCode
+      );
+      return;
+    }
+    if (this.isSend(res)) {
+      return;
+    }
+    res.setHeader("content-type", renderResult.contentType);
+    const { contentStream } = renderResult;
+    if (contentStream) {
+      contentStream.pipe(
+        (0, import_template.templateInjectableStream)({
+          prependHead: route.entryName ? `<script>window._SERVER_DATA=${JSON.stringify(
+            context.serverData
+          )}<\/script>` : void 0
+        })
+      ).pipe(res);
+      return;
+    }
+    let response = renderResult.content;
+    if (route.entryName) {
+      const afterRenderContext = (0, import_hook_api.createAfterRenderContext)(
+        context,
+        response.toString()
+      );
+      if (this.runMode === import_constants.RUN_MODE.FULL) {
+        await this.runner.afterRender(afterRenderContext, { onLast: import_utils2.noop });
+      }
+      if (this.isSend(res)) {
+        return;
+      }
+      afterRenderContext.template.prependHead(
+        `<script>window._SERVER_DATA=${JSON.stringify(
+          context.serverData
+        )}<\/script>`
+      );
+      response = afterRenderContext.template.get();
+    }
+    res.end(response);
+  }
+  isSend(res) {
+    if (res.headersSent) {
+      return true;
+    }
+    if (res.getHeader("Location") && (0, import_utils2.isRedirect)(res.statusCode)) {
+      res.end();
+      return true;
+    }
+    return false;
+  }
+  compose() {
+    const { handlers } = this;
+    if (!Array.isArray(handlers)) {
+      throw new TypeError("Middleware stack must be an array!");
+    }
+    for (const fn of handlers) {
+      if (typeof fn !== "function") {
+        throw new TypeError("Middleware must be composed of functions!");
+      }
+    }
+    this._handler = (context, next) => {
+      let i = 0;
+      const dispatch = (error) => {
+        if (error) {
+          return this.onError(context, error);
+        }
+        const handler = handlers[i++];
+        if (!handler) {
+          return next();
+        }
+        try {
+          const result = handler(context, dispatch);
+          if ((0, import_utils.isPromise)(result)) {
+            return result.catch(onError);
+          }
+        } catch (e) {
+          return onError(e);
+        }
+      };
+      const onError = (err) => {
+        this.onError(context, err);
+      };
+      return dispatch();
+    };
+  }
+  requestHandler(req, res, next = () => {
+  }) {
+    res.statusCode = 200;
+    req.logger = req.logger || this.logger;
+    req.metrics = req.metrics || this.metrics;
+    let context;
+    try {
+      context = this.createContext(req, res);
+    } catch (e) {
+      this.logger.error(e);
+      res.statusCode = 500;
+      res.setHeader("content-type", import_utils.mime.contentType("html"));
+      return res.end((0, import_utils2.createErrorDocument)(500, import_constants.ERROR_PAGE_TEXT[500]));
+    }
+    try {
+      return this._handler(context, next);
+    } catch (err) {
+      return this.onError(context, err);
+    }
+  }
+  redirect(res, url, status = 302) {
+    res.setHeader("Location", url);
+    res.statusCode = status;
+    res.end();
+  }
+  onError(context, err) {
+    context.error(import_constants.ERROR_DIGEST.EINTER, err);
+    this.renderErrorPage(context, 500);
+  }
+  async renderErrorPage(context, status) {
+    const { res } = context;
+    context.status = status;
+    res.setHeader("content-type", import_utils.mime.contentType("html"));
+    const statusPage = `/${status}`;
+    const customErrorPage = `/_error`;
+    const matched = this.router.match(statusPage) || this.router.match(customErrorPage);
+    if (matched) {
+      const route = matched.generate(context.url);
+      const { entryName } = route;
+      if (entryName === status.toString() || entryName === "_error") {
+        try {
+          const file = await this.routeRenderHandler({
+            route,
+            ctx: context,
+            runner: this.runner
+          });
+          if (file) {
+            context.res.end(file.content);
+            return;
+          }
+        } catch (e) {
+        }
+      }
+    }
+    const text = import_constants.ERROR_PAGE_TEXT[status] || import_constants.ERROR_PAGE_TEXT[500];
+    context.res.end((0, import_utils2.createErrorDocument)(status, text));
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ModernServer
+});

package/dist/cjs/type.js

@@ -0,0 +1,15 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var type_exports = {};
+module.exports = __toCommonJS(type_exports);

package/dist/cjs/utils.js

@@ -0,0 +1,152 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var utils_exports = {};
+__export(utils_exports, {
+  createErrorDocument: () => createErrorDocument,
+  createMiddlewareCollecter: () => createMiddlewareCollecter,
+  debug: () => debug,
+  getStaticReg: () => getStaticReg,
+  headersWithoutCookie: () => headersWithoutCookie,
+  isRedirect: () => isRedirect,
+  mergeExtension: () => mergeExtension,
+  noop: () => noop,
+  prepareFavicons: () => prepareFavicons,
+  useLocalPrefix: () => useLocalPrefix
+});
+module.exports = __toCommonJS(utils_exports);
+var import_utils = require("@modern-js/utils");
+const debug = (0, import_utils.createDebugger)("prod-server");
+const mergeExtension = (users) => {
+  const output = [];
+  return { middleware: output.concat(users) };
+};
+const noop = () => {
+};
+const createErrorDocument = (status, text) => {
+  const title = `${status}: ${text}`;
+  return `<!DOCTYPE html>
+  <html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width">
+    <title>${title}</title>
+    <style>
+      html,body {
+        margin: 0;
+      }
+
+      .page-container {
+        color: #000;
+        background: #fff;
+        height: 100vh;
+        text-align: center;
+        display: flex;
+        flex-direction: column;
+        align-items: center;
+        justify-content: center;
+      }
+    </style>
+  </head>
+  <body>
+    <div class="page-container">
+    <h1>${status}</h1>
+    <div>${text}</div>
+  </body>
+  </html>
+  `;
+};
+const createMiddlewareCollecter = () => {
+  const webMiddlewares = [];
+  const apiMiddlewares = [];
+  const addWebMiddleware = (input) => {
+    webMiddlewares.push(input);
+  };
+  const addAPIMiddleware = (input) => {
+    apiMiddlewares.push(input);
+  };
+  const getMiddlewares = () => ({
+    web: webMiddlewares,
+    api: apiMiddlewares
+  });
+  return {
+    getMiddlewares,
+    addWebMiddleware,
+    addAPIMiddleware
+  };
+};
+const useLocalPrefix = (url) => {
+  return (0, import_utils.isProd)() && !url.includes(".");
+};
+const getStaticReg = (output = {}, html = {}) => {
+  const {
+    distPath: { css: cssPath, js: jsPath, media: mediaPath } = {},
+    assetPrefix = "/"
+  } = output;
+  const { favicon, faviconByEntries } = html;
+  const prefix = useLocalPrefix(assetPrefix) ? assetPrefix : "";
+  const favicons = prepareFavicons(favicon, faviconByEntries);
+  const staticFiles = [cssPath, jsPath, mediaPath].filter((v) => Boolean(v));
+  const staticReg = ["static/", "upload/", ...staticFiles];
+  const iconReg = ["favicon.ico", "icon.png", ...favicons];
+  const regPrefix = prefix.endsWith("/") ? prefix : `${prefix}/`;
+  const staticPathRegExp = new RegExp(
+    `^${regPrefix}(${[...staticReg, ...iconReg].join("|")})`
+  );
+  return staticPathRegExp;
+};
+const prepareFavicons = (favicon, faviconByEntries) => {
+  const faviconNames = [];
+  if (favicon) {
+    faviconNames.push(favicon.substring(favicon.lastIndexOf("/") + 1));
+  }
+  if (faviconByEntries) {
+    Object.keys(faviconByEntries).forEach((f) => {
+      const curFavicon = faviconByEntries[f];
+      if (curFavicon) {
+        faviconNames.push(
+          curFavicon.substring(curFavicon.lastIndexOf("/") + 1)
+        );
+      }
+    });
+  }
+  return faviconNames;
+};
+const headersWithoutCookie = (headers) => {
+  if (typeof headers.cookie !== "undefined") {
+    const safeHeaders = { ...headers };
+    delete safeHeaders.cookie;
+    return safeHeaders;
+  }
+  return headers;
+};
+const isRedirect = (code) => {
+  return [301, 302, 307, 308].includes(code);
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createErrorDocument,
+  createMiddlewareCollecter,
+  debug,
+  getStaticReg,
+  headersWithoutCookie,
+  isRedirect,
+  mergeExtension,
+  noop,
+  prepareFavicons,
+  useLocalPrefix
+});