@xfe-repo/web-app 1.6.4 → 2.0.0-beta.2

package/dist/node-dev.mjs

@@ -0,0 +1,332 @@
+// src/config.ts
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+import yaml from "yaml";
+var DEFAULT_BUILD_DIRECTORY = "dist";
+var protectedDirectories = /* @__PURE__ */ new Set(["src", "types", "public", "node_modules", ".git"]);
+var configDirectory = typeof __dirname === "string" ? __dirname : path.dirname(fileURLToPath(import.meta.url));
+var loadXfeConfig = (root = process.cwd()) => {
+  const xfeConfigPath = path.join(root, "xfe.json");
+  if (!fs.existsSync(xfeConfigPath)) {
+    throw new Error("xfe.json \u914D\u7F6E\u6587\u4EF6\u4E0D\u5B58\u5728\uFF0C\u8BF7\u5728\u9879\u76EE\u6839\u76EE\u5F55\u4E0B\u521B\u5EFA\u8BE5\u6587\u4EF6\u3002");
+  }
+  const xfeConfigContent = fs.readFileSync(xfeConfigPath, "utf8");
+  const config = JSON.parse(xfeConfigContent);
+  const renderMode = config.webapp?.renderMode;
+  if (renderMode !== void 0 && renderMode !== "client" && renderMode !== "server") {
+    throw new Error("xfe.json.webapp.renderMode \u53EA\u80FD\u4E3A client \u6216 server");
+  }
+  getBuildDirectory(root, config.webapp);
+  getServerEntry(root, config.webapp);
+  return config;
+};
+var getBuildDirectory = (projectRoot2, webapp2 = {}) => {
+  const configured = webapp2?.buildDirectory === void 0 ? DEFAULT_BUILD_DIRECTORY : webapp2.buildDirectory;
+  if (typeof configured !== "string" || !configured.trim() || /[\0\r\n]/.test(configured)) {
+    throw new Error("xfe.json.webapp.buildDirectory \u5FC5\u987B\u662F\u975E\u7A7A\u7684\u5355\u884C\u5B57\u7B26\u4E32");
+  }
+  const directory = configured.trim().replaceAll("\\", "/");
+  const root = path.resolve(projectRoot2);
+  const output = path.resolve(root, directory);
+  const relative = path.relative(root, output);
+  const [firstDirectory = ""] = relative.split(path.sep);
+  const escapesProject = path.isAbsolute(directory) || Boolean(path.win32.parse(directory).root) || firstDirectory === "..";
+  const overwritesInput = !relative || protectedDirectories.has(firstDirectory.toLowerCase());
+  if (escapesProject || overwritesInput) {
+    throw new Error("xfe.json.webapp.buildDirectory \u5FC5\u987B\u662F\u9879\u76EE\u5185\u72EC\u7ACB\u7684\u8F93\u51FA\u76EE\u5F55\uFF0C\u4E0D\u80FD\u8986\u76D6\u9879\u76EE\u3001\u6E90\u7801\u6216\u4F9D\u8D56");
+  }
+  let currentDirectory = root;
+  for (const segment of relative.split(path.sep)) {
+    currentDirectory = path.join(currentDirectory, segment);
+    if (fs.lstatSync(currentDirectory, { throwIfNoEntry: false })?.isSymbolicLink()) {
+      throw new Error("xfe.json.webapp.buildDirectory \u4E0D\u80FD\u7ECF\u8FC7\u7B26\u53F7\u94FE\u63A5\uFF0C\u4EE5\u514D\u6E05\u7406\u5176\u4ED6\u76EE\u5F55");
+    }
+  }
+  return output;
+};
+var getServerEntry = (projectRoot2, webapp2 = {}) => {
+  const entry = webapp2?.serverEntry;
+  if (entry === void 0) return;
+  if (typeof entry !== "string" || !entry.trim() || /[\0\r\n]/.test(entry)) {
+    throw new Error("xfe.json.webapp.serverEntry \u5FC5\u987B\u662F\u9879\u76EE\u5185\u7684 TypeScript / JavaScript \u76F8\u5BF9\u8DEF\u5F84");
+  }
+  const normalized = entry.trim().replaceAll("\\", "/");
+  const absolute = path.resolve(projectRoot2, normalized);
+  const relative = path.relative(path.resolve(projectRoot2), absolute);
+  const outside = Boolean(path.win32.parse(normalized).root) || relative.split(path.sep)[0] === "..";
+  if (outside || !/\.(?:[jt]sx?|m[jt]s)$/.test(relative)) {
+    throw new Error("xfe.json.webapp.serverEntry \u5FC5\u987B\u662F\u9879\u76EE\u5185\u7684 TypeScript / JavaScript \u76F8\u5BF9\u8DEF\u5F84");
+  }
+  return absolute;
+};
+
+// src/node.ts
+import { once } from "events";
+import { rm } from "fs/promises";
+import { Server } from "http";
+import path3 from "path";
+import { pathToFileURL } from "url";
+import express from "express";
+
+// src/framework.ts
+import fs2 from "fs";
+import { createRequire } from "module";
+import path2 from "path";
+import { fileURLToPath as fileURLToPath2 } from "url";
+var frameworkDirectory = typeof __dirname === "string" ? __dirname : path2.dirname(fileURLToPath2(import.meta.url));
+var requireFromFramework = createRequire(path2.join(frameworkDirectory, "framework.js"));
+var extensions = [".tsx", ".ts", ".jsx", ".js"];
+var findSource = (directory, name) => extensions.map((extension) => path2.join(directory, `${name}${extension}`)).find(fs2.existsSync);
+var findValueExports = (file) => [...fs2.readFileSync(file, "utf8").matchAll(/^\s*export\s+(?:async\s+)?(?:const|let|var|function|class)\s+([A-Za-z_$][\w$]*)/gm)].map(
+  ([, name]) => name
+);
+var importPath = (from, target) => {
+  const relative = path2.relative(from, target).replace(path2.extname(target), "").replaceAll(path2.sep, "/");
+  return relative.startsWith(".") ? relative : `./${relative}`;
+};
+var writeGenerated = (file, content) => {
+  if (fs2.existsSync(file) && fs2.readFileSync(file, "utf8") === content) return;
+  fs2.writeFileSync(file, content);
+};
+var defaultRootSource = (projectRoot2, appDirectory) => {
+  const { webapp: webapp2 = {} } = loadXfeConfig(projectRoot2);
+  const layoutSource = findSource(path2.join(projectRoot2, "src"), "layout");
+  const layoutExports = layoutSource ? findValueExports(layoutSource) : [];
+  const hasErrorView = layoutExports.includes("ErrorView");
+  const layoutImport = layoutSource ? `import AppLayout${hasErrorView ? ", { ErrorView }" : ""} from ${JSON.stringify(importPath(appDirectory, layoutSource))}
+` : "";
+  return `import { createElement, type ReactNode } from 'react'
+import { Outlet } from 'react-router'
+import { Document, PageError, PageLoading } from '@xfe-repo/web-app/dist/root.mjs'
+${layoutImport}
+export const meta = () => [{ title: ${JSON.stringify(webapp2.title || "XFE App")} }]
+export const Layout = ({ children }: { children: ReactNode }) => createElement(Document, { children, lang: ${JSON.stringify(webapp2.lang || "zh-CN")}, themeColor: ${JSON.stringify(webapp2.themeColor)} })
+export default function Root() { return ${layoutSource ? "createElement(AppLayout, { children: createElement(Outlet) })" : "createElement(Outlet)"} }
+export function ErrorBoundary() { return createElement(PageError, { ${hasErrorView ? "view: ErrorView" : ""} }) }
+export function HydrateFallback() { return createElement(PageLoading) }
+`;
+};
+var getFrameworkRoot = (projectRoot2) => path2.join(projectRoot2, "node_modules/.cache/xfe-web/react-router");
+var prepareFramework = (projectRoot2 = process.cwd()) => {
+  const sourceDirectory = path2.join(projectRoot2, "src");
+  const rootSource = findSource(sourceDirectory, "root");
+  const appServerSource = findSource(sourceDirectory, "app.server");
+  const pagesSource = path2.join(sourceDirectory, "pages");
+  if (!fs2.existsSync(pagesSource)) throw new Error("\u672A\u627E\u5230 src/pages");
+  const rootDirectory = getFrameworkRoot(projectRoot2);
+  const appDirectory = path2.join(rootDirectory, "app");
+  fs2.mkdirSync(appDirectory, { recursive: true });
+  const routerDirectory = path2.dirname(requireFromFramework.resolve("react-router/package.json"));
+  const routerLink = path2.join(rootDirectory, "node_modules/react-router");
+  fs2.mkdirSync(path2.dirname(routerLink), { recursive: true });
+  if (!fs2.lstatSync(routerLink, { throwIfNoEntry: false })?.isSymbolicLink() || fs2.readlinkSync(routerLink) !== routerDirectory) {
+    fs2.rmSync(routerLink, { force: true });
+    fs2.symlinkSync(routerDirectory, routerLink, "junction");
+  }
+  const rootTarget = path2.join(appDirectory, "root.tsx");
+  const rootImport = rootSource ? importPath(appDirectory, rootSource) : "";
+  const rootExports = rootSource ? findValueExports(rootSource).filter((name) => name !== "middleware" || !appServerSource) : [];
+  const namedExports = rootExports.length ? `export { ${rootExports.join(", ")} } from ${JSON.stringify(rootImport)}
+` : "";
+  const errorBoundaryExport = rootExports.includes("ErrorBoundary") ? "" : "export { DefaultErrorBoundary as ErrorBoundary } from '@xfe-repo/web-router/errors'\n";
+  const middlewareExport = appServerSource ? `export { middleware } from ${JSON.stringify(importPath(appDirectory, appServerSource))}
+` : "";
+  writeGenerated(
+    rootTarget,
+    rootSource ? `export * from ${JSON.stringify(rootImport)}
+export { default } from ${JSON.stringify(rootImport)}
+${namedExports}${errorBoundaryExport}${middlewareExport}` : `${defaultRootSource(projectRoot2, appDirectory)}${middlewareExport}`
+  );
+  const pagesLink = path2.join(appDirectory, "pages");
+  if (!fs2.existsSync(pagesLink)) fs2.symlinkSync(path2.relative(appDirectory, pagesSource), pagesLink, "dir");
+  writeGenerated(
+    path2.join(rootDirectory, "react-router.config.js"),
+    "export { default } from '@xfe-repo/web-app/dist/react-router-config.mjs'\n"
+  );
+  writeGenerated(
+    path2.join(appDirectory, "routes.js"),
+    `import { collectPageRoutes } from '@xfe-repo/web-router/routes'
+export default collectPageRoutes(${JSON.stringify(appDirectory)})
+`
+  );
+  const defaultsDirectory = path2.join(path2.dirname(requireFromFramework.resolve("@react-router/dev/package.json")), "dist/config/defaults");
+  writeGenerated(
+    path2.join(appDirectory, "entry.server.tsx"),
+    `export { default, streamTimeout } from ${JSON.stringify(importPath(appDirectory, path2.join(defaultsDirectory, "entry.server.web.tsx")))}
+`
+  );
+  const typeScriptConfig = path2.join(rootDirectory, "tsconfig.json");
+  writeGenerated(
+    typeScriptConfig,
+    JSON.stringify(
+      {
+        extends: path2.join(projectRoot2, "tsconfig.json"),
+        compilerOptions: { rootDirs: [projectRoot2, rootDirectory, path2.join(rootDirectory, ".react-router/types")] },
+        include: [
+          path2.join(sourceDirectory, "**/*"),
+          path2.join(projectRoot2, "types/**/*"),
+          path2.join(appDirectory, "*.tsx"),
+          path2.join(rootDirectory, ".react-router/types/**/*")
+        ],
+        exclude: []
+      },
+      null,
+      2
+    )
+  );
+  return {
+    appDirectory,
+    rootDirectory,
+    viteConfig: path2.resolve(frameworkDirectory, "vite.mjs"),
+    typeScriptConfig
+  };
+};
+
+// src/node.ts
+var NODE_OUTPUT = "server/node.mjs";
+var HMR_PATH = "/_xfe/hmr";
+var SHUTDOWN_TIMEOUT = 3e4;
+async function runNode({ projectRoot: projectRoot2, webapp: webapp2, development }) {
+  const entry = development ? getServerEntry(projectRoot2, webapp2) : path3.join(getBuildDirectory(projectRoot2, webapp2), NODE_OUTPUT);
+  if (!entry) throw new Error("\u7F3A\u5C11 xfe.json.webapp.serverEntry");
+  if (development) {
+    const { loadEnv } = await import("vite");
+    Object.assign(process.env, { ...loadEnv("development", projectRoot2, ""), ...process.env });
+  } else process.env.NODE_ENV ??= "production";
+  const module = await import(pathToFileURL(entry).href);
+  if (typeof module.default !== "function") throw new Error("serverEntry \u5FC5\u987B\u9ED8\u8BA4\u5BFC\u51FA Node \u670D\u52A1\u5DE5\u5382\u51FD\u6570");
+  const frontend = express().disable("x-powered-by");
+  const application = await module.default({ frontend, mode: development ? "development" : "production" });
+  const upgrades = /* @__PURE__ */ new Set();
+  let vite;
+  let closing;
+  const close = () => closing ??= disposeApplication(application, { vite, upgrades });
+  const onSignal = async () => {
+    try {
+      await close();
+    } catch (error) {
+      console.error("XFE Node \u5173\u95ED\u5931\u8D25:", error);
+      process.exit(1);
+    } finally {
+      process.off("SIGINT", onSignal);
+      process.off("SIGTERM", onSignal);
+    }
+  };
+  try {
+    const server = application?.server;
+    if (!(server instanceof Server) || server.listening) throw new Error("Node \u5DE5\u5382\u5FC5\u987B\u8FD4\u56DE\u5C1A\u672A listen \u7684 http.Server");
+    if (server.listenerCount("upgrade")) throw new Error("\u8BF7\u901A\u8FC7\u5DE5\u5382\u8FD4\u56DE\u7684 upgrade \u5904\u7406\u5347\u7EA7\uFF0C\u4E0D\u8981\u76F4\u63A5\u6CE8\u518C server \u7684 upgrade \u4E8B\u4EF6");
+    const hmrPath = path3.posix.join(webapp2.basename || "/", HMR_PATH);
+    server.on(
+      "upgrade",
+      /** HMR 与业务互斥分流，升级连接由关闭流程统一回收。 */
+      (request, socket, head) => {
+        upgrades.add(socket);
+        socket.once(
+          "close",
+          /** 不保留已经断开的升级连接。 */
+          () => upgrades.delete(socket)
+        );
+        if (development && request.url?.split("?")[0] === hmrPath) {
+          if (!["vite-hmr", "vite-ping"].includes(String(request.headers["sec-websocket-protocol"]))) socket.destroy();
+          return;
+        }
+        if (application.upgrade) application.upgrade(request, socket, head);
+        else socket.destroy();
+      }
+    );
+    if (development) vite = await createDevelopmentServer(server, projectRoot2);
+    await mountFrontend(frontend, { projectRoot: projectRoot2, webapp: webapp2, vite });
+    const listening = once(server, "listening");
+    const host = process.env.HOST || webapp2.host || "0.0.0.0";
+    const port = Number(process.env.PORT ?? webapp2.port ?? 3e3);
+    server.listen(port, host);
+    await listening;
+    console.info(`XFE Node: http://${host}:${port}`);
+    process.on("SIGINT", onSignal);
+    process.on("SIGTERM", onSignal);
+  } catch (error) {
+    await close();
+    throw error;
+  }
+}
+async function createDevelopmentServer(server, projectRoot2) {
+  const { createServer } = await import("vite");
+  const framework = prepareFramework(projectRoot2);
+  const events = [[process, "SIGINT"], [process, "SIGTERM"], [process.stdin, "end"]];
+  const snapshots = events.map(
+    /** 只记录当前监听，恢复时保留宿主和业务原有的处理器。 */
+    ([source, event]) => ({ source, event, listeners: new Set(source.listeners(event)) })
+  );
+  try {
+    return await createServer({
+      root: framework.rootDirectory,
+      configFile: framework.viteConfig,
+      server: { middlewareMode: true, ws: { server, path: HMR_PATH } },
+      appType: "custom"
+    });
+  } finally {
+    for (const { source, event, listeners } of snapshots) {
+      for (const listener of source.listeners(event)) {
+        if (!listeners.has(listener)) source.removeListener(event, listener);
+      }
+    }
+  }
+}
+async function mountFrontend(frontend, { projectRoot: projectRoot2, webapp: webapp2, vite }) {
+  let build;
+  if (vite) {
+    const { isRunnableDevEnvironment } = await import("vite");
+    const environment = vite.environments.ssr;
+    if (!isRunnableDevEnvironment(environment)) throw new Error("React Router \u5F00\u53D1\u73AF\u5883\u672A\u5C31\u7EEA");
+    frontend.use(vite.middlewares);
+    build = async () => environment.runner.import("virtual:react-router/server-build");
+  } else {
+    const directory = getBuildDirectory(projectRoot2, webapp2);
+    const basename = webapp2.basename || "/";
+    frontend.use(path3.posix.join(basename, "assets"), express.static(path3.join(directory, "client/assets"), { immutable: true, maxAge: "1y", fallthrough: false }));
+    frontend.use(basename, express.static(path3.join(directory, "client")));
+    if (webapp2.renderMode === "client") {
+      frontend.get(
+        path3.posix.join(basename, "{*path}"),
+        /** SPA 深链接始终返回构建后的首页。 */
+        (_request, response) => response.sendFile(path3.join(directory, "client/index.html"))
+      );
+      return;
+    }
+    build = await import(pathToFileURL(path3.join(directory, "server/index.js")).href);
+  }
+  const { createRequestHandler } = await import("@react-router/express");
+  frontend.use(createRequestHandler({ build, mode: vite ? "development" : "production" }));
+}
+async function disposeApplication(application, { vite, upgrades }) {
+  const server = application?.server instanceof Server ? application.server : void 0;
+  const forced = setTimeout(
+    /** 生产关闭时中断超过等待上限的普通 HTTP 请求。 */
+    () => server?.closeAllConnections(),
+    SHUTDOWN_TIMEOUT
+  );
+  forced.unref();
+  try {
+    const drained = server?.listening ? server[Symbol.asyncDispose]() : void 0;
+    for (const socket of upgrades) socket.destroy();
+    const results = await Promise.allSettled([drained, vite?.close()]);
+    await application?.close?.();
+    const failure = results.find((result) => result.status === "rejected");
+    if (failure?.status === "rejected") throw failure.reason;
+  } finally {
+    clearTimeout(forced);
+  }
+}
+
+// src/node-dev.ts
+var projectRoot = process.cwd();
+var { webapp = {} } = loadXfeConfig(projectRoot);
+void runNode({ projectRoot, webapp, development: true }).catch(
+  /** 开发失败报告给监听器，源码修复后由 tsx 重新启动。 */
+  (error) => {
+    console.error("XFE Node \u542F\u52A8\u5931\u8D25:", error);
+    process.exit(1);
+  }
+);

package/dist/node.d.mts

@@ -0,0 +1,27 @@
+import { Server, IncomingMessage, RequestListener } from 'node:http';
+import { Duplex } from 'node:stream';
+import { WebAppConfig } from './config.mjs';
+
+interface NodeServerContext {
+    readonly frontend: RequestListener;
+    readonly mode: 'development' | 'production';
+}
+interface NodeServerApplication {
+    readonly server: Server;
+    /** 只处理业务升级；开发 HMR 的升级由框架分流。 */
+    readonly upgrade?: (request: IncomingMessage, socket: Duplex, head: Buffer) => void;
+    /** HTTP 排空及升级连接断开后，释放数据库等业务资源。 */
+    readonly close?: () => void | Promise<void>;
+}
+type NodeServerFactory = (context: NodeServerContext) => NodeServerApplication | Promise<NodeServerApplication>;
+type NodeOptions = {
+    projectRoot: string;
+    webapp: WebAppConfig;
+    development?: boolean;
+};
+/** 前端构建结束后编译独立 Node 工厂，外部依赖由 Node 原生加载。 */
+declare function buildNode({ projectRoot, webapp }: NodeOptions): Promise<void>;
+/** 只编排工厂创建、前端接入和监听；启动失败与退出共用一次清理。 */
+declare function runNode({ projectRoot, webapp, development }: NodeOptions): Promise<void>;
+
+export { type NodeServerApplication, type NodeServerContext, type NodeServerFactory, buildNode, runNode };

package/dist/node.d.ts

@@ -0,0 +1,27 @@
+import { Server, IncomingMessage, RequestListener } from 'node:http';
+import { Duplex } from 'node:stream';
+import { WebAppConfig } from './config.js';
+
+interface NodeServerContext {
+    readonly frontend: RequestListener;
+    readonly mode: 'development' | 'production';
+}
+interface NodeServerApplication {
+    readonly server: Server;
+    /** 只处理业务升级；开发 HMR 的升级由框架分流。 */
+    readonly upgrade?: (request: IncomingMessage, socket: Duplex, head: Buffer) => void;
+    /** HTTP 排空及升级连接断开后，释放数据库等业务资源。 */
+    readonly close?: () => void | Promise<void>;
+}
+type NodeServerFactory = (context: NodeServerContext) => NodeServerApplication | Promise<NodeServerApplication>;
+type NodeOptions = {
+    projectRoot: string;
+    webapp: WebAppConfig;
+    development?: boolean;
+};
+/** 前端构建结束后编译独立 Node 工厂，外部依赖由 Node 原生加载。 */
+declare function buildNode({ projectRoot, webapp }: NodeOptions): Promise<void>;
+/** 只编排工厂创建、前端接入和监听；启动失败与退出共用一次清理。 */
+declare function runNode({ projectRoot, webapp, development }: NodeOptions): Promise<void>;
+
+export { type NodeServerApplication, type NodeServerContext, type NodeServerFactory, buildNode, runNode };