@modern-js/prod-server 2.42.2 → 2.44.0

package/dist/esm-node/libs/render/ssrCache/index.js

@@ -0,0 +1,57 @@
+import { Transform } from "stream";
+import { createMemoryStorage } from "@modern-js/runtime-utils/storer";
+import { cacheMod } from "./cacheMod";
+import { CacheManager } from "./manager";
+const cacheStorage = createMemoryStorage("__ssr__cache");
+async function ssrCache(req, render, ssrContext) {
+  const { customContainer, cacheOption } = cacheMod;
+  const cacheControl = await matchCacheControl(req, cacheOption);
+  const cacheManager = new CacheManager(customContainer ? customContainer : cacheStorage);
+  if (cacheControl) {
+    return cacheManager.getCacheResult(req, cacheControl, render, ssrContext);
+  } else {
+    const renderResult = await render(ssrContext);
+    if (typeof renderResult === "string") {
+      return renderResult;
+    } else {
+      const stream = new Transform({
+        write(chunk, _, callback) {
+          this.push(chunk);
+          callback();
+        }
+      });
+      return renderResult(stream);
+    }
+  }
+}
+async function matchCacheControl(req, cacheOption) {
+  if (!cacheOption) {
+    return void 0;
+  } else if (isCacheControl(cacheOption)) {
+    return cacheOption;
+  } else if (isCacheOptionProvider(cacheOption)) {
+    return cacheOption(req);
+  } else {
+    const url = req.url;
+    const options = Object.entries(cacheOption);
+    for (const [key, option] of options) {
+      if (key === "*" || new RegExp(key).test(url)) {
+        if (typeof option === "function") {
+          return option(req);
+        } else {
+          return option;
+        }
+      }
+    }
+    return void 0;
+  }
+  function isCacheOptionProvider(option) {
+    return typeof option === "function";
+  }
+  function isCacheControl(option) {
+    return typeof option === "object" && option !== null && "maxAge" in option;
+  }
+}
+export {
+  ssrCache
+};

package/dist/esm-node/libs/render/ssrCache/manager.js

@@ -0,0 +1,80 @@
+import { _ as _define_property } from "@swc/helpers/_/_define_property";
+import { Transform } from "stream";
+class CacheManager {
+  async getCacheResult(req, cacheControl, render, ssrContext) {
+    const key = this.computedKey(req, cacheControl);
+    const value = await this.container.get(key);
+    const { maxAge, staleWhileRevalidate } = cacheControl;
+    const ttl = maxAge + staleWhileRevalidate;
+    if (value) {
+      const cache = JSON.parse(value);
+      const interval = Date.now() - cache.cursor;
+      if (interval <= maxAge) {
+        return cache.val;
+      } else if (interval <= staleWhileRevalidate + maxAge) {
+        this.processCache(key, render, ssrContext, ttl);
+        return cache.val;
+      } else {
+        return this.processCache(key, render, ssrContext, ttl);
+      }
+    } else {
+      return this.processCache(key, render, ssrContext, ttl);
+    }
+  }
+  async processCache(key, render, ssrContext, ttl) {
+    const renderResult = await render(ssrContext);
+    if (typeof renderResult === "string") {
+      const current = Date.now();
+      const cache = {
+        val: renderResult,
+        cursor: current
+      };
+      await this.container.set(key, JSON.stringify(cache), {
+        ttl
+      });
+      return renderResult;
+    } else {
+      let html;
+      const stream = new Transform({
+        write(chunk, _, callback) {
+          html += chunk.toString();
+          this.push(chunk);
+          callback();
+        }
+      });
+      stream.on("close", () => {
+        const current = Date.now();
+        const cache = {
+          val: html,
+          cursor: current
+        };
+        this.container.set(key, JSON.stringify(cache), {
+          ttl
+        });
+      });
+      return renderResult(stream);
+    }
+  }
+  computedKey(req, cacheControl) {
+    const { url } = req;
+    const [pathname] = url.split("?");
+    const { customKey } = cacheControl;
+    const defaultKey = pathname.replace(/.+\/+$/, "");
+    if (customKey) {
+      if (typeof customKey === "string") {
+        return customKey;
+      } else {
+        return customKey(defaultKey);
+      }
+    } else {
+      return defaultKey;
+    }
+  }
+  constructor(container) {
+    _define_property(this, "container", void 0);
+    this.container = container;
+  }
+}
+export {
+  CacheManager
+};

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

@@ -1,18 +1,18 @@
 import path from "path";
 import { mime } from "@modern-js/utils";
-import { readFile } from "./reader";
+import { fileReader } from "@modern-js/runtime-utils/fileReader";
 async function handleDirectory(ctx, entryPath, urlPath) {
   const { path: pathname } = ctx;
   const filepath = path.join(entryPath, trimLeft(pathname, urlPath));
-  let content = await readFile(filepath);
+  let content = await fileReader.readFile(filepath);
   let contentType = mime.contentType(path.extname(filepath) || "");
   if (!content) {
     if (pathname.endsWith("/")) {
-      content = await readFile(`${filepath}index.html`);
+      content = await fileReader.readFile(`${filepath}index.html`);
     } else if (!pathname.includes(".")) {
-      content = await readFile(`${filepath}.html`);
+      content = await fileReader.readFile(`${filepath}.html`);
       if (!content) {
-        content = await readFile(`${filepath}/index.html`);
+        content = await fileReader.readFile(`${filepath}/index.html`);
       }
     }
     if (content) {

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

@@ -88,6 +88,8 @@ class Server {
     });
   }
   async close() {
+    var _this_server_close, _this_server;
+    await ((_this_server_close = (_this_server = this.server).close) === null || _this_server_close === void 0 ? void 0 : _this_server_close.call(_this_server));
     this.app.close();
   }
   listen(options, listener) {

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

@@ -7,11 +7,11 @@ import { RouteMatchManager } from "../libs/route";
 import { createRenderHandler } from "../libs/render";
 import { createStaticFileHandler, faviconFallbackHandler } from "../libs/serveFile";
 import { createErrorDocument, createMiddlewareCollecter, getStaticReg, mergeExtension, noop, debug, isRedirect } from "../utils";
-import * as reader from "../libs/render/reader";
 import { createProxyHandler } from "../libs/proxy";
 import { createContext } from "../libs/context";
 import { AGGRED_DIR, ERROR_DIGEST, ERROR_PAGE_TEXT, RUN_MODE, ServerReportTimings } from "../constants";
 import { createAfterMatchContext, createAfterRenderContext, createMiddlewareContext } from "../libs/hook-api";
+import { cacheMod } from "../libs/render/ssrCache/cacheMod";
 const SERVER_DIR = "./server";
 class ModernServer {
   // server prepare
@@ -19,7 +19,6 @@ class ModernServer {
     var _conf_bff, _this_conf_output;
     this.runner = runner;
     const { distDir, conf } = this;
-    this.initReader();
     debug("final server conf", this.conf);
     if ((_conf_bff = conf.bff) === null || _conf_bff === void 0 ? void 0 : _conf_bff.proxy) {
       const { handlers, handleUpgrade } = createProxyHandler(conf.bff.proxy);
@@ -28,12 +27,10 @@ class ModernServer {
         this.addHandler(handler);
       });
     }
-    app === null || app === void 0 ? void 0 : app.on("close", () => {
-      this.reader.close();
-    });
     const usageRoutes = this.filterRoutes(this.getRoutes());
     this.router.reset(usageRoutes);
     this.warmupSSRBundle();
+    cacheMod.loadServerCacheMod(this.pwd);
     await this.prepareFrameHandler();
     await this.prepareLoaderHandler(usageRoutes, distDir);
     this.routeRenderHandler = this.getRenderHandler();
@@ -89,9 +86,6 @@ class ModernServer {
     return createServer(handler);
   }
   /* —————————————————————— function will be overwrite —————————————————————— */
-  initReader() {
-    this.reader.init();
-  }
   async onServerChange({ filepath }) {
     const { pwd } = this;
     const { api, server } = AGGRED_DIR;
@@ -475,7 +469,6 @@ class ModernServer {
     _define_property(this, "logger", void 0);
     _define_property(this, "metrics", void 0);
     _define_property(this, "runMode", void 0);
-    _define_property(this, "reader", reader);
     _define_property(this, "proxyTarget", void 0);
     _define_property(this, "routeRenderHandler", void 0);
     _define_property(this, "staticGenerate", void 0);

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

@@ -1,3 +1,5 @@
+/// <reference path="../../type.d.ts" />
+/// <reference types="node/http" />
 import { IncomingMessage, ServerResponse } from 'http';
 import { ModernServerContext, ContextOptions } from './context';
 export declare const createContext: (req: IncomingMessage, res: ServerResponse, options?: ContextOptions) => ModernServerContext;

package/dist/types/libs/hook-api/afterRenderForStream.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import { Transform } from 'stream';
+import { MaybeAsync } from '@modern-js/plugin';
+export declare const afterRenderInjectableStream: (fn: (content: string) => MaybeAsync<string>) => Transform;

package/dist/types/libs/hook-api/index.d.ts

@@ -1,5 +1,6 @@
-import type { ModernServerContext, HookContext, AfterMatchContext, AfterRenderContext, MiddlewareContext, ServerRoute } from '@modern-js/types';
+import type { ModernServerContext, HookContext, AfterMatchContext, AfterRenderContext, MiddlewareContext, ServerRoute, AfterStreamingRenderContext } from '@modern-js/types';
 export declare const base: (context: ModernServerContext) => HookContext;
 export declare const createAfterMatchContext: (context: ModernServerContext, entryName: string) => AfterMatchContext;
 export declare const createAfterRenderContext: (context: ModernServerContext, route: Partial<ServerRoute>, content: string) => AfterRenderContext;
+export declare const createAfterStreamingRenderContext: (context: ModernServerContext, route: Partial<ServerRoute>) => (chunk: string) => AfterStreamingRenderContext;
 export declare const createMiddlewareContext: (context: ModernServerContext) => MiddlewareContext;

package/dist/types/libs/preload/flushServerHeader.d.ts

@@ -1,4 +1,6 @@
+/// <reference path="../../type.d.ts" />
 /// <reference types="node" />
+/// <reference types="node/http" />
 import { OutgoingHttpHeaders } from 'http';
 import { ServerOptions } from '@modern-js/server-core';
 import { ModernServerContext } from '@modern-js/types';

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

@@ -1,3 +1,5 @@
+/// <reference path="../type.d.ts" />
+/// <reference types="node/http" />
 import http from 'http';
 import { RequestHandler } from 'http-proxy-middleware';
 import { ProxyDetail, BffProxyOptions } from '@modern-js/types';

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

@@ -1,12 +1,12 @@
 import type { ModernServerContext } from '@modern-js/types';
 import { RenderResult, ServerHookRunner } from '../../type';
-export declare const render: (ctx: ModernServerContext, renderOptions: {
+import type { ModernRoute } from '../route';
+export type SSRRenderOptions = {
     distDir: string;
-    bundle: string;
-    urlPath: string;
     template: string;
-    entryName: string;
+    route: ModernRoute;
     staticGenerate: boolean;
     enableUnsafeCtx?: boolean;
     nonce?: string;
-}, runner: ServerHookRunner) => Promise<RenderResult>;
+};
+export declare const render: (ctx: ModernServerContext, renderOptions: SSRRenderOptions, runner: ServerHookRunner) => Promise<RenderResult>;

package/dist/types/libs/render/ssrCache/cacheMod.d.ts

@@ -0,0 +1,8 @@
+import type { CacheOption, Container } from '@modern-js/types';
+declare class ServerCacheMod {
+    customContainer?: Container;
+    cacheOption?: CacheOption;
+    loadServerCacheMod(pwd?: string): void;
+}
+export declare const cacheMod: ServerCacheMod;
+export {};

package/dist/types/libs/render/ssrCache/index.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+/// <reference types="node/http" />
+/// <reference types="dist/types/type" />
+import { IncomingMessage } from 'http';
+import { type Readable } from 'stream';
+import { RenderFunction, SSRServerContext } from '../type';
+export declare function ssrCache(req: IncomingMessage, render: RenderFunction, ssrContext: SSRServerContext): Promise<string | Readable>;

package/dist/types/libs/render/ssrCache/manager.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+/// <reference types="node/http" />
+/// <reference types="dist/types/type" />
+import { IncomingMessage } from 'http';
+import { Readable } from 'stream';
+import { CacheControl, Container } from '@modern-js/types';
+import { RenderFunction, SSRServerContext } from '../type';
+export declare class CacheManager {
+    private container;
+    constructor(container: Container<string, string>);
+    getCacheResult(req: IncomingMessage, cacheControl: CacheControl, render: RenderFunction, ssrContext: SSRServerContext): Promise<string | Readable>;
+    private processCache;
+    private computedKey;
+}

package/dist/types/renderHtml.d.ts

@@ -1,4 +1,6 @@
+/// <reference path="type.d.ts" />
 /// <reference types="node" />
+/// <reference types="node/http" />
 import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
 import { ModernServerOptions } from './type';
 export interface RenderHtmlOptions {

package/dist/types/server/index.d.ts

@@ -1,6 +1,8 @@
+/// <reference path="../type.d.ts" />
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node/http" />
 import { IncomingMessage, ServerResponse } from 'http';
 import type { ListenOptions } from 'net';
 import { ModernServerOptions, ServerConstructor } from '../type';

package/dist/types/server/modernServer.d.ts

@@ -1,5 +1,7 @@
+/// <reference path="../type.d.ts" />
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node/http" />
 import { IncomingMessage, ServerResponse, Server } from 'http';
 import { Adapter, WebAdapter, APIServerStartInput, ServerOptions } from '@modern-js/server-core';
 import { type ModernServerContext, type ServerRoute } from '@modern-js/types';
@@ -8,7 +10,6 @@ import { ModernServerOptions, NextFunction, ServerHookRunner, Metrics, Logger, M
 import { RouteMatchManager, ModernRouteInterface, ModernRoute } from '../libs/route';
 import { RenderHandler } from '../libs/render';
 import { mergeExtension } from '../utils';
-import * as reader from '../libs/render/reader';
 type ModernServerAsyncHandler = (context: ModernServerContext, next: NextFunction) => Promise<void>;
 export declare class ModernServer implements ModernServerInterface {
     pwd: string;
@@ -22,7 +23,6 @@ export declare class ModernServer implements ModernServerInterface {
     protected readonly logger: Logger;
     protected readonly metrics: Metrics;
     protected readonly runMode: string;
-    protected reader: typeof reader;
     protected readonly proxyTarget: ModernServerOptions['proxyTarget'];
     protected routeRenderHandler: RenderHandler;
     protected readonly staticGenerate: boolean;
@@ -38,7 +38,6 @@ export declare class ModernServer implements ModernServerInterface {
     getRequestHandler(): (req: IncomingMessage, res: ServerResponse, next?: () => void) => void | ServerResponse;
     render(req: IncomingMessage, res: ServerResponse, url?: string): Promise<string | import("stream").Readable | null>;
     createHTTPServer(handler: (req: IncomingMessage, res: ServerResponse, next?: () => void) => void): Promise<Server<typeof IncomingMessage, typeof ServerResponse>>;
-    protected initReader(): void;
     protected onServerChange({ filepath }: {
         filepath: string;
     }): Promise<void>;

package/dist/types/type.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node/http" />
 import { IncomingMessage, Server, ServerResponse } from 'http';
 import { Readable } from 'stream';
 import { serverManager, ServerOptions } from '@modern-js/server-core';
@@ -69,6 +70,7 @@ export interface ModernServerInterface {
     getRequestHandler: () => (req: IncomingMessage, res: ServerResponse, next?: () => void) => void;
     createHTTPServer: (handler: (req: IncomingMessage, res: ServerResponse, next?: () => void) => void) => Promise<Server>;
     render: (req: IncomingMessage, res: ServerResponse, url?: string) => Promise<string | Readable | null>;
+    close?: () => Promise<void>;
 }
 export type ServerConstructor = (options: ModernServerOptions) => ModernServerInterface;
 export type ModernServerHandler = (context: ModernServerContext, next: NextFunction) => Promise<void> | void;

package/package.json

@@ -15,7 +15,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.42.2",
+  "version": "2.44.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -69,22 +69,20 @@
     "fresh": "^0.5.2",
     "http-proxy-middleware": "^2.0.4",
     "ignore-styles": "^5.0.1",
-    "lru-cache": "^6.0.0",
     "merge-deep": "^3.0.3",
     "node-html-parser": "^6.1.5",
     "path-to-regexp": "^6.2.0",
     "serve-static": "^1.14.1",
-    "@modern-js/plugin": "2.42.2",
-    "@modern-js/server-core": "2.42.2",
-    "@modern-js/utils": "2.42.2",
-    "@modern-js/runtime-utils": "2.42.2"
+    "@modern-js/plugin": "2.44.0",
+    "@modern-js/server-core": "2.44.0",
+    "@modern-js/utils": "2.44.0",
+    "@modern-js/runtime-utils": "2.44.0"
   },
   "devDependencies": {
     "@types/cookie": "0.5.1",
     "@types/etag": "^1.8.1",
     "@types/fresh": "^0.5.0",
     "@types/jest": "^29",
-    "@types/lru-cache": "^5.1.1",
     "@types/merge-deep": "^3.0.0",
     "@types/node": "^14",
     "@types/serve-static": "^1.13.10",
@@ -96,10 +94,9 @@
     "portfinder": "^1.0.28",
     "typescript": "^5",
     "ws": "^8.13.0",
-    "@modern-js/server-core": "2.42.2",
-    "@modern-js/types": "2.42.2",
-    "@scripts/build": "2.42.2",
-    "@scripts/jest-config": "2.42.2"
+    "@modern-js/types": "2.44.0",
+    "@scripts/build": "2.44.0",
+    "@scripts/jest-config": "2.44.0"
   },
   "sideEffects": false,
   "publishConfig": {

package/dist/cjs/libs/render/cache/__tests__/cache.fun.test.js

@@ -1,95 +0,0 @@
-"use strict";
-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 __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(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var import_url = __toESM(require("url"));
-var import_spr = require("../spr");
-var import_util = require("../util");
-describe("test spr util functions", () => {
-  it("should return value correctly", () => {
-    expect((0, import_util.connectFactor)("bar", "foo")).toBe("bar-foo");
-    expect((0, import_util.fname)(1)).toBe("f1");
-    expect((0, import_util.namespaceHash)("modern", "!@#$%^&")).toBe("modern/!@#$%^&");
-  });
-  it("should create or destroy instance correctly", () => {
-    const ins1 = (0, import_spr.createCache)();
-    const ins2 = (0, import_spr.createCache)();
-    expect(ins1 === ins2).toBe(true);
-    (0, import_spr.destroyCache)();
-    const ins3 = (0, import_spr.createCache)();
-    expect(ins1 === ins3).toBe(false);
-    expect(ins2 === ins3).toBe(false);
-  });
-  it("should return function correctly", () => {
-    const urlParams = (() => new import_url.default.URLSearchParams())();
-    urlParams.set("name", "modern");
-    const getParam = (0, import_util.valueFactory)(urlParams);
-    expect(getParam("name")).toBe("modern");
-    const headers = {
-      age: "12345"
-    };
-    const getHeader = (0, import_util.valueFactory)(headers);
-    expect(getHeader("age")).toBe("12345");
-  });
-  it("should add target html content", () => {
-    const contentNoHead = "<div>123</div>";
-    const html = (0, import_util.cacheAddition)(contentNoHead, Math.random().toString());
-    expect(html).toBe(contentNoHead);
-    const contentWithHead = "<head></head><div>123</div>";
-    const hash = Math.random().toString();
-    const htmlWithHead = (0, import_util.cacheAddition)(contentWithHead, hash);
-    expect(htmlWithHead).toBe(`<head><meta name="x-moden-spr" content="${hash}"></head><div>123</div>`);
-  });
-  it("should only invoke func one time", async () => {
-    let index = 0;
-    const fn = (0, import_util.withCoalescedInvoke)(async () => new Promise((resolve) => {
-      setTimeout(() => {
-        index += 1;
-        resolve(index);
-      }, 500);
-    }));
-    const key = "test";
-    const [res1, res2] = await Promise.all([
-      fn(key, []),
-      fn(key, [])
-    ]);
-    expect(res1.isOrigin && res2.isOrigin).toBe(false);
-    expect(res1.isOrigin || res2.isOrigin).toBe(true);
-    expect(res1.value).toBe(1);
-    expect(res2.value).toBe(1);
-  });
-  it("should invoke sync or async", async () => {
-    const foo = "";
-    const async = await (0, import_util.maybeSync)(() => new Promise((resolve) => {
-      setTimeout(() => {
-        resolve(foo);
-      }, 100);
-    }))(false);
-    expect(async).toBeUndefined();
-    const sync = await (0, import_util.maybeSync)(() => new Promise((resolve) => {
-      setTimeout(() => {
-        resolve(foo);
-      }, 100);
-    }))(true);
-    expect(sync).toBe(foo);
-  });
-});