@modern-js/server-core 2.52.1-alpha.0 → 2.54.0

package/dist/esm-node/base/middlewares/renderHandler/ssrCache.js

@@ -1,172 +0,0 @@
-import { Readable } from "stream";
-import { SERVER_DIR, requireExistModule } from "@modern-js/utils";
-import { createMemoryStorage } from "@modern-js/runtime-utils/storer";
-import { createTransformStream, getPathname } from "../../utils";
-import { createReadableStreamFromReadable } from "../../adapters/node/polyfills/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 {
-          data: cache.val,
-          status: "hit"
-        };
-      } else if (interval <= staleWhileRevalidate + maxAge) {
-        this.processCache(key, render, ssrContext, ttl);
-        return {
-          data: cache.val,
-          status: "stale"
-        };
-      } else {
-        return this.processCache(key, render, ssrContext, ttl, "expired");
-      }
-    } else {
-      return this.processCache(key, render, ssrContext, ttl, "miss");
-    }
-  }
-  async processCache(key, render, ssrContext, ttl, status) {
-    const renderResult = await render(ssrContext);
-    if (!renderResult) {
-      return {
-        data: ""
-      };
-    } else if (typeof renderResult === "string") {
-      const current = Date.now();
-      const cache = {
-        val: renderResult,
-        cursor: current
-      };
-      await this.container.set(key, JSON.stringify(cache), {
-        ttl
-      });
-      return {
-        data: renderResult,
-        status
-      };
-    } else {
-      const body = (
-        // TODO: remove node:stream, move it to ssr entry.
-        renderResult instanceof Readable ? createReadableStreamFromReadable(renderResult) : renderResult
-      );
-      let html = "";
-      const stream = createTransformStream((chunk) => {
-        html += chunk;
-        return chunk;
-      });
-      const reader = body.getReader();
-      const writer = stream.writable.getWriter();
-      const push = () => {
-        reader.read().then(({ done, value }) => {
-          if (done) {
-            const current = Date.now();
-            const cache = {
-              val: html,
-              cursor: current
-            };
-            this.container.set(key, JSON.stringify(cache), {
-              ttl
-            });
-            writer.close();
-            return;
-          }
-          writer.write(value);
-          push();
-        });
-      };
-      push();
-      return {
-        data: stream.readable,
-        status
-      };
-    }
-  }
-  computedKey(req, cacheControl) {
-    const pathname = getPathname(req);
-    const { customKey } = cacheControl;
-    const defaultKey = pathname.replace(/.+\/+$/, "");
-    if (customKey) {
-      if (typeof customKey === "string") {
-        return customKey;
-      } else {
-        return customKey(defaultKey);
-      }
-    } else {
-      return defaultKey;
-    }
-  }
-  constructor(container) {
-    this.container = container;
-  }
-}
-const CACHE_FILENAME = "cache";
-class ServerCache {
-  async loadCacheMod(pwd = process.cwd()) {
-    const path = await import("path").catch(() => {
-      return {};
-    });
-    const serverCacheFilepath = path.resolve(pwd, SERVER_DIR, CACHE_FILENAME);
-    const mod = requireExistModule(serverCacheFilepath, {
-      interop: false
-    });
-    this.cacheOption = mod === null || mod === void 0 ? void 0 : mod.cacheOption;
-    if (this.cacheOption && !(mod === null || mod === void 0 ? void 0 : mod.customContainer)) {
-      const cacheStorage = createMemoryStorage("__ssr__cache");
-      this.customContainer = cacheStorage;
-    } else {
-      this.customContainer = mod === null || mod === void 0 ? void 0 : mod.customContainer;
-    }
-    if (this.customContainer) {
-      this.cacheManger = new CacheManager(this.customContainer);
-    }
-  }
-  matchCacheControl(req) {
-    const { cacheOption } = this;
-    if (!cacheOption || !req) {
-      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;
-    }
-  }
-  async getCache(req, cacheControl, render, ssrContext) {
-    if (this.cacheManger) {
-      return this.cacheManger.getCacheResult(req, cacheControl, render, ssrContext);
-    } else {
-      const renderResult = await render(ssrContext);
-      return {
-        data: renderResult
-      };
-    }
-  }
-}
-const ssrCache = new ServerCache();
-export {
-  CacheManager,
-  ssrCache
-};

package/dist/esm-node/base/serverBase.js

@@ -1,168 +0,0 @@
-import { INTERNAL_SERVER_PLUGINS } from "@modern-js/utils/universal/constants";
-import { Hono } from "hono";
-import { AppContext, ConfigContext, serverManager, createPlugin } from "../core";
-import { getRuntimeEnv } from "./utils";
-class ServerBase {
-  /**
-  * 初始化顺序
-  * - 获取 server runtime config
-  * - 设置 context
-  * - 创建 hooksRunner
-  * - 合并插件，内置插件和 serverConfig 中配置的插件
-  * - 执行 config hook
-  * - 获取最终的配置
-  * - 设置配置到 context
-  * - 执行 prepare hook
-  */
-  async init() {
-    const { options } = this;
-    const runtimeEnv = getRuntimeEnv();
-    runtimeEnv === "node" && await this.initServerConfig(options);
-    await this.injectContext(options);
-    this.runner = await this.createHookRunner();
-    runtimeEnv === "node" && await this.initConfig(this.runner, options);
-    await this.injectContext(options);
-    await this.runner.prepare();
-    return this;
-  }
-  async createHookRunner() {
-    serverManager.clear();
-    const runtimeEnv = getRuntimeEnv();
-    const internalPlugins = runtimeEnv === "node" ? await this.loadInternalPlugins() : [];
-    const externalPlugins = this.loadExternalPlugins();
-    const loadedPlugins = [
-      ...internalPlugins,
-      ...externalPlugins
-    ];
-    loadedPlugins.forEach((p) => {
-      serverManager.usePlugin(p);
-    });
-    const hooksRunner = await serverManager.init();
-    return hooksRunner;
-  }
-  async loadInternalPlugins() {
-    const { internalPlugins: plugins = INTERNAL_SERVER_PLUGINS, appContext, pwd } = this.options;
-    const loadPluginsModule = "../core/loadPlugins";
-    const { loadPlugins } = await import(loadPluginsModule);
-    const internalPlugins = loadPlugins(appContext.appDirectory || pwd, plugins);
-    return internalPlugins;
-  }
-  loadExternalPlugins() {
-    const { plugins = [] } = this.options;
-    const configPlugins = this.serverConfig.plugins || [];
-    const externalPlugins = [
-      ...plugins,
-      ...configPlugins
-    ];
-    return externalPlugins.map((plugin) => createPlugin(plugin.setup, plugin));
-  }
-  async initServerConfig(options) {
-    const { pwd, serverConfigFile } = options;
-    const utilsModuleName = "./utils/serverConfig";
-    const { getServerConfigPath, requireConfig } = await import(utilsModuleName);
-    const serverConfigPath = await getServerConfigPath(pwd, serverConfigFile);
-    const serverConfig = requireConfig(serverConfigPath);
-    this.serverConfig = serverConfig;
-  }
-  async injectContext(options) {
-    const appContext = await this.initAppContext();
-    const { config, pwd } = options;
-    ConfigContext.set(config);
-    AppContext.set({
-      ...appContext,
-      serverBase: this,
-      distDirectory: pwd
-    });
-  }
-  async initAppContext() {
-    const { options } = this;
-    const { pwd, plugins = [], appContext } = options;
-    const serverPlugins = plugins.map((p) => ({
-      server: p
-    }));
-    return {
-      appDirectory: (appContext === null || appContext === void 0 ? void 0 : appContext.appDirectory) || "",
-      apiDirectory: appContext === null || appContext === void 0 ? void 0 : appContext.apiDirectory,
-      lambdaDirectory: appContext === null || appContext === void 0 ? void 0 : appContext.lambdaDirectory,
-      sharedDirectory: appContext.sharedDirectory || "",
-      distDirectory: pwd,
-      plugins: serverPlugins
-    };
-  }
-  /**
-  * Execute config hooks
-  * @param runner
-  * @param options
-  */
-  runConfigHook(runner, serverConfig) {
-    const newServerConfig = runner.config(serverConfig || {});
-    return newServerConfig;
-  }
-  async initConfig(runner, options) {
-    const path = await import("path").catch((_) => {
-      return {};
-    });
-    const utilsModuleName = "@modern-js/utils";
-    const { ensureAbsolutePath, OUTPUT_CONFIG_FILE } = await import(utilsModuleName);
-    const configModuleName = "./utils/serverConfig";
-    const { loadConfig } = await import(configModuleName);
-    const { pwd, config } = options;
-    const { serverConfig } = this;
-    const finalServerConfig = this.runConfigHook(runner, serverConfig);
-    const resolvedConfigPath = ensureAbsolutePath(pwd, path.join(config.output.path || "dist", OUTPUT_CONFIG_FILE));
-    options.config = loadConfig({
-      cliConfig: config,
-      serverConfig: finalServerConfig,
-      resolvedConfigPath
-    });
-  }
-  get all() {
-    return this.app.all.bind(this.app);
-  }
-  get use() {
-    return this.app.use.bind(this.app);
-  }
-  get get() {
-    return this.app.get.bind(this.app);
-  }
-  get post() {
-    return this.app.post.bind(this.app);
-  }
-  get put() {
-    return this.app.put.bind(this.app);
-  }
-  get delete() {
-    return this.app.delete.bind(this.app);
-  }
-  get patch() {
-    return this.app.patch.bind(this.app);
-  }
-  get handle() {
-    return this.app.fetch.bind(this.app);
-  }
-  get request() {
-    return this.app.request.bind(this.app);
-  }
-  get notFound() {
-    return this.app.notFound.bind(this.app);
-  }
-  get onError() {
-    return this.app.onError.bind(this.app);
-  }
-  constructor(options) {
-    this.serverConfig = {};
-    this.options = options;
-    this.app = new Hono();
-  }
-}
-function createServerBase(options) {
-  if (options == null) {
-    throw new Error("can not start server without options");
-  }
-  const server = new ServerBase(options);
-  return server;
-}
-export {
-  ServerBase,
-  createServerBase
-};

package/dist/esm-node/base/utils/debug.js

@@ -1,5 +0,0 @@
-import { createDebugger } from "@modern-js/utils";
-const debug = createDebugger("prod-server");
-export {
-  debug
-};

package/dist/esm-node/base/utils/serverConfig.js

@@ -1,34 +0,0 @@
-import { compatRequire, fs, DEFAULT_SERVER_CONFIG } from "@modern-js/utils";
-import mergeDeep from "merge-deep";
-const getServerConfigPath = async (distDirectory, serverConfigFile = DEFAULT_SERVER_CONFIG) => {
-  const path = await import("path");
-  const serverConfigPath = path.join(distDirectory, serverConfigFile);
-  return `${serverConfigPath}.js`;
-};
-const requireConfig = (serverConfigPath) => {
-  if (fs.pathExistsSync(serverConfigPath)) {
-    return compatRequire(serverConfigPath);
-  }
-  return {};
-};
-const loadConfig = ({ cliConfig, serverConfig, resolvedConfigPath }) => {
-  let config = null;
-  if (process.env.NODE_ENV === "production") {
-    const resolvedConfig = requireConfig(resolvedConfigPath);
-    config = mergeDeep({
-      ...resolvedConfig,
-      plugins: []
-    }, serverConfig, cliConfig);
-  } else {
-    config = mergeDeep({
-      ...cliConfig,
-      plugins: []
-    }, serverConfig);
-  }
-  return config;
-};
-export {
-  getServerConfigPath,
-  loadConfig,
-  requireConfig
-};

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

@@ -1 +0,0 @@
-export * from "./plugin";

package/dist/esm-node/core/loadPlugins.js

@@ -1,26 +0,0 @@
-import { compatRequire, getInternalPlugins, tryResolve } from "@modern-js/utils";
-import { createPlugin } from "../core/plugin";
-const resolvePlugin = (p, appDirectory) => {
-  const isPluginInstance = typeof p !== "string";
-  if (isPluginInstance) {
-    return {
-      module: createPlugin(p.setup, p)
-    };
-  }
-  const pluginPath = tryResolve(p, appDirectory);
-  const module = compatRequire(pluginPath);
-  const pluginInstance = module();
-  return {
-    module: createPlugin(pluginInstance.setup, pluginInstance)
-  };
-};
-const loadPlugins = (appDirectory, internalPlugins) => {
-  const loadedPlugins = getInternalPlugins(appDirectory, internalPlugins);
-  return loadedPlugins.map((plugin) => {
-    const { module } = resolvePlugin(plugin, appDirectory);
-    return module;
-  });
-};
-export {
-  loadPlugins
-};

package/dist/esm-node/core/plugin.js

@@ -1,53 +0,0 @@
-import { createContext, createAsyncManager, createAsyncPipeline, createAsyncWaterfall, createParallelWorkflow, createWaterfall } from "@modern-js/plugin";
-const gather = createParallelWorkflow();
-const config = createWaterfall();
-const prepare = createWaterfall();
-const prepareWebServer = createAsyncPipeline();
-const fallback = createParallelWorkflow();
-const prepareApiServer = createAsyncPipeline();
-const onApiChange = createAsyncWaterfall();
-const repack = createWaterfall();
-const beforeServerInit = createAsyncWaterfall();
-const afterMatch = createAsyncPipeline();
-const afterRender = createAsyncPipeline();
-const afterStreamingRender = createAsyncPipeline();
-const reset = createParallelWorkflow();
-const AppContext = createContext({});
-const setAppContext = (value) => AppContext.set(value);
-const ConfigContext = createContext({});
-const useConfigContext = () => ConfigContext.use().value;
-const useAppContext = () => AppContext.use().value;
-const pluginAPI = {
-  useAppContext,
-  useConfigContext,
-  setAppContext
-};
-const serverHooks = {
-  // server hook
-  gather,
-  config,
-  prepare,
-  fallback,
-  prepareWebServer,
-  prepareApiServer,
-  repack,
-  onApiChange,
-  beforeServerInit,
-  afterMatch,
-  afterRender,
-  afterStreamingRender,
-  reset
-};
-const createServerManager = () => createAsyncManager(serverHooks, pluginAPI);
-const serverManager = createServerManager();
-const { createPlugin } = serverManager;
-export {
-  AppContext,
-  ConfigContext,
-  createPlugin,
-  createServerManager,
-  serverManager,
-  setAppContext,
-  useAppContext,
-  useConfigContext
-};

package/dist/types/base/adapters/node/bff.d.ts

@@ -1,3 +0,0 @@
-import { BindRenderHandleOptions } from '../../../base/middlewares';
-import { ServerBase, type ServerBaseOptions } from '../../serverBase';
-export declare const bindBFFHandler: (server: ServerBase, options: ServerBaseOptions & BindRenderHandleOptions) => Promise<void>;

package/dist/types/base/adapters/node/middlewares/index.d.ts

@@ -1,4 +0,0 @@
-export * from './mock';
-export * from './serverStatic';
-export * from './templates';
-export * from './serverManifest';

package/dist/types/base/adapters/node/middlewares/mock.d.ts

@@ -1,5 +0,0 @@
-import type { ServerBase } from '../../../serverBase';
-export declare const registerMockHandlers: ({ pwd, server, }: {
-    pwd: string;
-    server: ServerBase;
-}) => Promise<null | undefined>;

package/dist/types/base/adapters/node/middlewares/serverManifest.d.ts

@@ -1,4 +0,0 @@
-import type { ServerRoute, Logger } from '@modern-js/types';
-import { Middleware, ServerEnv, ServerManifest } from '../../../../core/server';
-export declare function getServerManifest(pwd: string, routes: ServerRoute[], logger: Logger): Promise<ServerManifest>;
-export declare function injectServerManifest(pwd: string, routes?: ServerRoute[]): Middleware<ServerEnv>;

package/dist/types/base/adapters/node/middlewares/serverPublic.d.ts

@@ -1,7 +0,0 @@
-import { ServerRoute } from '@modern-js/types';
-import { Middleware } from '../../../../core/server';
-export type PublicMiddlwareOptions = {
-    pwd: string;
-    routes: ServerRoute[];
-};
-export declare function createPublicMiddleware({ pwd, routes, }: PublicMiddlwareOptions): Middleware;

package/dist/types/base/adapters/node/middlewares/serverStatic.d.ts

@@ -1,11 +0,0 @@
-import { ServerRoute } from '@modern-js/types';
-import type { OutputNormalizedConfig, HtmlNormalizedConfig } from '../../../../types/config';
-import { Middleware } from '../../../../core/server';
-interface ServerStaticOptions {
-    pwd: string;
-    output: OutputNormalizedConfig;
-    html: HtmlNormalizedConfig;
-    routes?: ServerRoute[];
-}
-export declare function createStaticMiddleware(options: ServerStaticOptions): Middleware;
-export {};

package/dist/types/base/adapters/node/middlewares/templates.d.ts

@@ -1,4 +0,0 @@
-import { ServerRoute } from '@modern-js/types';
-import { Middleware, ServerEnv } from '../../../../core/server';
-export declare function getHtmlTemplates(pwd: string, routes: ServerRoute[]): Promise<Record<string, string>>;
-export declare function injectTemplates(pwd: string, routes?: ServerRoute[]): Middleware<ServerEnv>;

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

@@ -1,7 +0,0 @@
-export { createErrorHtml, onError, ErrorDigest } from './utils';
-export { AGGRED_DIR } from './constants';
-export { favionFallbackMiddleware, injectReporter, injectLogger, getRenderHandler, bindRenderHandler, logHandler, processedBy, getLoaderCtx, } from './middlewares';
-export type { BindRenderHandleOptions } from './middlewares';
-export type { ServerBase, ServerBaseOptions } from './serverBase';
-export { createServerBase } from './serverBase';
-export type { Middleware, Context, Next, HonoRequest, ServerEnv, ServerManifest, } from '../core/server';

package/dist/types/base/middlewares/faviconFallback.d.ts

@@ -1,2 +0,0 @@
-import { Middleware } from '../../core/server';
-export declare const favionFallbackMiddleware: Middleware;

package/dist/types/base/middlewares/frameworkHeader.d.ts

@@ -1,2 +0,0 @@
-import { Middleware } from '../../core/server';
-export declare const processedBy: Middleware;

package/dist/types/base/middlewares/index.d.ts

@@ -1,6 +0,0 @@
-export * from './faviconFallback';
-export * from './monitor';
-export * from './renderHandler';
-export * from './logger';
-export * from './frameworkHeader';
-export { getLoaderCtx } from './customServer';

package/dist/types/base/middlewares/logger.d.ts

@@ -1,2 +0,0 @@
-import type { Middleware, ServerEnv } from '../../core/server';
-export declare function logHandler(): Middleware<ServerEnv>;

package/dist/types/base/middlewares/monitor.d.ts

@@ -1,6 +0,0 @@
-import type { Logger, Metrics } from '@modern-js/types';
-import type { Context, Next, ServerEnv } from '../../core/server';
-export declare function injectReporter(): (c: Context<ServerEnv>, next: Next) => Promise<void>;
-export declare function initReporter(entryName: string): (c: Context<ServerEnv>, next: Next) => Promise<void>;
-export declare function injectLogger(inputLogger: Logger): (c: Context<ServerEnv>, next: Next) => Promise<void>;
-export declare function injectMetrics(inputMetrics: Metrics): (c: Context<ServerEnv>, next: Next) => Promise<void>;

package/dist/types/base/middlewares/renderHandler/index.d.ts

@@ -1,9 +0,0 @@
-import { Render } from '../../../core/render';
-import { ServerBase, type ServerBaseOptions } from '../../serverBase';
-export type BindRenderHandleOptions = {
-    metaName?: string;
-    staticGenerate?: boolean;
-    disableCustomHook?: boolean;
-};
-export declare function getRenderHandler(options: ServerBaseOptions & BindRenderHandleOptions, serverBase?: ServerBase): Promise<Render | null>;
-export declare function bindRenderHandler(server: ServerBase, options: ServerBaseOptions & BindRenderHandleOptions): Promise<void>;

package/dist/types/base/middlewares/renderHandler/ssrCache.d.ts

@@ -1,28 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import type { IncomingMessage } from 'http';
-import { Readable } from 'stream';
-import type { CacheControl, CacheOption, Container } from '@modern-js/types';
-import type { SSRServerContext, ServerRender } from '../../../core/server';
-export type CacheStatus = 'hit' | 'stale' | 'expired' | 'miss';
-export type CacheResult = {
-    data: string | Readable | ReadableStream;
-    status?: CacheStatus;
-};
-export declare class CacheManager {
-    private container;
-    constructor(container: Container<string, string>);
-    getCacheResult(req: Request, cacheControl: CacheControl, render: ServerRender, ssrContext: SSRServerContext): Promise<CacheResult>;
-    private processCache;
-    private computedKey;
-}
-declare class ServerCache {
-    customContainer?: Container;
-    cacheOption?: CacheOption;
-    private cacheManger?;
-    loadCacheMod(pwd?: string): Promise<void>;
-    matchCacheControl(req?: IncomingMessage): CacheControl | Promise<CacheControl> | undefined;
-    getCache(req: Request, cacheControl: CacheControl, render: ServerRender, ssrContext: SSRServerContext): Promise<CacheResult>;
-}
-export declare const ssrCache: ServerCache;
-export {};

package/dist/types/base/utils/debug.d.ts

@@ -1 +0,0 @@
-export declare const debug: import("@modern-js/utils/compiled/debug").Debugger;

package/dist/types/base/utils/serverConfig.d.ts

@@ -1,14 +0,0 @@
-import { ServerConfig } from '../../core/plugin';
-import { ServerOptions } from '../../types/config';
-export declare const getServerConfigPath: (distDirectory: string, serverConfigFile?: string) => Promise<string>;
-export declare const requireConfig: (serverConfigPath: string) => any;
-/**
- * 对配置进行合并，开发环境下，cliConfig 与 serverConfig 进行深合并
- * 生产环境下，resolvedConfig 与 serverConfig 进行深合并
- * resolvedConfigPath: 构建序列化后的 modern.config.js 文件路径
- */
-export declare const loadConfig: ({ cliConfig, serverConfig, resolvedConfigPath, }: {
-    cliConfig: ServerOptions;
-    serverConfig: ServerConfig;
-    resolvedConfigPath: string;
-}) => any;

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

@@ -1 +0,0 @@
-export * from './plugin';

package/dist/types/core/loadPlugins.d.ts

@@ -1,3 +0,0 @@
-import { InternalPlugins } from '@modern-js/types';
-import { createPlugin } from '../core/plugin';
-export declare const loadPlugins: (appDirectory: string, internalPlugins: InternalPlugins) => ReturnType<typeof createPlugin>[];