@nocobase/server 2.1.0-alpha.2 → 2.1.0-alpha.21

package/lib/gateway/index.js

@@ -39,7 +39,9 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 var gateway_exports = {};
 __export(gateway_exports, {
-  Gateway: () => Gateway
+  Gateway: () => Gateway,
+  getHost: () => import_utils4.getHost,
+  getHostname: () => import_utils4.getHostname
 });
 module.exports = __toCommonJS(gateway_exports);
 var import_logger = require("@nocobase/logger");
@@ -54,6 +56,7 @@ var import_fs = __toESM(require("fs"));
 var import_http = __toESM(require("http"));
 var import_koa_compose = __toESM(require("koa-compose"));
 var import_node_util = require("node:util");
+var import_node_os = require("node:os");
 var import_path = require("path");
 var import_qs = __toESM(require("qs"));
 var import_serve_handler = __toESM(require("serve-handler"));
@@ -63,16 +66,26 @@ var import_plugin_manager = require("../plugin-manager");
 var import_errors = require("./errors");
 var import_ipc_socket_client = require("./ipc-socket-client");
 var import_ipc_socket_server = require("./ipc-socket-server");
+var import_utils3 = require("./utils");
 var import_ws_server = require("./ws-server");
 var import_node_worker_threads = require("node:worker_threads");
 var import_node_process = __toESM(require("node:process"));
+var import_utils4 = require("./utils");
 const compress = (0, import_node_util.promisify)((0, import_compression.default)());
+function normalizeBasePath(path = "") {
+  const normalized = path.replace(/\/+/g, "/").replace(/\/$/, "");
+  return normalized || "/";
+}
+__name(normalizeBasePath, "normalizeBasePath");
 function getSocketPath() {
-  const { SOCKET_PATH } = import_node_process.default.env;
-  if ((0, import_path.isAbsolute)(SOCKET_PATH)) {
-    return SOCKET_PATH;
+  const socketPath = import_node_process.default.env.SOCKET_PATH;
+  if (socketPath) {
+    return (0, import_path.isAbsolute)(socketPath) ? socketPath : (0, import_path.resolve)(import_node_process.default.cwd(), socketPath);
+  }
+  if (import_node_process.default.env.NOCOBASE_RUNNING_IN_DOCKER === "true") {
+    return (0, import_path.resolve)((0, import_node_os.homedir)(), ".nocobase", "gateway.sock");
   }
-  return (0, import_path.resolve)(import_node_process.default.cwd(), SOCKET_PATH);
+  return (0, import_utils.storagePathJoin)("gateway.sock");
 }
 __name(getSocketPath, "getSocketPath");
 const _Gateway = class _Gateway extends import_events.EventEmitter {
@@ -87,7 +100,8 @@ const _Gateway = class _Gateway extends import_events.EventEmitter {
   loggers = new import_utils.Registry();
   port = import_node_process.default.env.APP_PORT ? parseInt(import_node_process.default.env.APP_PORT) : null;
   host = "0.0.0.0";
-  socketPath = (0, import_path.resolve)(import_node_process.default.cwd(), "storage", "gateway.sock");
+  socketPath = getSocketPath();
+  v2IndexTemplateCache = null;
   terminating = false;
   onTerminate = /* @__PURE__ */ __name(async (signal) => {
     var _a;
@@ -119,7 +133,6 @@ const _Gateway = class _Gateway extends import_events.EventEmitter {
   constructor() {
     super();
     this.reset();
-    this.socketPath = getSocketPath();
     import_node_process.default.once("SIGTERM", this.onTerminate);
     import_node_process.default.once("SIGINT", this.onTerminate);
   }
@@ -151,14 +164,30 @@ const _Gateway = class _Gateway extends import_events.EventEmitter {
     this.selectorMiddlewares = new import_utils.Toposort();
     this.addAppSelectorMiddleware(
       async (ctx, next) => {
-        var _a;
+        var _a, _b;
         const { req } = ctx;
-        const appName = (_a = import_qs.default.parse((0, import_url.parse)(req.url).query)) == null ? void 0 : _a.__appName;
+        const parsedUrl = (0, import_url.parse)(req.url);
+        const appName = (_a = import_qs.default.parse(parsedUrl.query)) == null ? void 0 : _a.__appName;
+        const apiBasePath = normalizeBasePath(import_node_process.default.env.API_BASE_PATH || "/api");
+        const appPathPrefix = `${apiBasePath}/__app/`;
+        if (req.headers["x-app"]) {
+          ctx.resolvedAppName = req.headers["x-app"];
+        }
         if (appName) {
           ctx.resolvedAppName = appName;
         }
-        if (req.headers["x-app"]) {
-          ctx.resolvedAppName = req.headers["x-app"];
+        if ((_b = parsedUrl.pathname) == null ? void 0 : _b.startsWith(appPathPrefix)) {
+          const restPath = parsedUrl.pathname.slice(appPathPrefix.length);
+          const [pathAppName, ...segments] = restPath.split("/");
+          if (pathAppName) {
+            ctx.resolvedAppName = pathAppName;
+            const rewrittenPath = `${apiBasePath}${segments.length ? `/${segments.join("/")}` : ""}`;
+            const rewrittenUrl = `${rewrittenPath}${parsedUrl.search || ""}`;
+            if (!req.originalUrl) {
+              req.originalUrl = req.url;
+            }
+            req.url = rewrittenUrl;
+          }
         }
         await next();
       },
@@ -222,9 +251,79 @@ const _Gateway = class _Gateway extends import_events.EventEmitter {
     });
     this.responseError(res, error);
   }
+  getV2PublicPath() {
+    return (0, import_utils3.resolveV2PublicPath)(import_node_process.default.env.APP_PUBLIC_PATH || "/");
+  }
+  getAppPublicPath() {
+    return (0, import_utils3.resolvePublicPath)(import_node_process.default.env.APP_PUBLIC_PATH || "/");
+  }
+  isV2Request(pathname) {
+    const v2PublicPath = this.getV2PublicPath();
+    return pathname === v2PublicPath.slice(0, -1) || pathname.startsWith(v2PublicPath);
+  }
+  isV2IndexRequest(pathname) {
+    if (!this.isV2Request(pathname)) {
+      return false;
+    }
+    const v2PublicPath = this.getV2PublicPath();
+    if (pathname === v2PublicPath || pathname === v2PublicPath.slice(0, -1) || pathname === `${v2PublicPath}index.html`) {
+      return true;
+    }
+    return !(0, import_path.extname)(pathname);
+  }
+  getV2RuntimeConfig() {
+    return {
+      __nocobase_public_path__: this.getV2PublicPath(),
+      __nocobase_api_base_url__: import_node_process.default.env.API_BASE_URL || import_node_process.default.env.API_BASE_PATH,
+      __nocobase_api_client_storage_prefix__: import_node_process.default.env.API_CLIENT_STORAGE_PREFIX,
+      __nocobase_api_client_storage_type__: import_node_process.default.env.API_CLIENT_STORAGE_TYPE,
+      __nocobase_api_client_share_token__: import_node_process.default.env.API_CLIENT_SHARE_TOKEN === "true",
+      __nocobase_ws_url__: import_node_process.default.env.WEBSOCKET_URL || "",
+      __nocobase_ws_path__: import_node_process.default.env.WS_PATH,
+      __esm_cdn_base_url__: import_node_process.default.env.ESM_CDN_BASE_URL || "https://esm.sh",
+      __esm_cdn_suffix__: import_node_process.default.env.ESM_CDN_SUFFIX || ""
+    };
+  }
+  getV2RuntimeConfigScript() {
+    const runtimeConfig = this.getV2RuntimeConfig();
+    const scriptContent = Object.entries(runtimeConfig).map(([key, value]) => `window['${key}'] = ${JSON.stringify(value)};`).join("\n");
+    return `<script>${scriptContent}</script>`;
+  }
+  getV2AssetPublicPath() {
+    if (import_node_process.default.env.CDN_BASE_URL) {
+      return `${import_node_process.default.env.CDN_BASE_URL.replace(/\/+$/, "")}/v2/`;
+    }
+    return this.getV2PublicPath();
+  }
+  getV2IndexTemplate() {
+    const file = `${import_node_process.default.env.APP_PACKAGE_ROOT}/dist/client/v2/index.html`;
+    if (!import_fs.default.existsSync(file)) {
+      return null;
+    }
+    const stat = import_fs.default.statSync(file);
+    if (this.v2IndexTemplateCache && this.v2IndexTemplateCache.file === file && this.v2IndexTemplateCache.mtimeMs === stat.mtimeMs) {
+      return this.v2IndexTemplateCache.html;
+    }
+    const html = import_fs.default.readFileSync(file, "utf-8");
+    this.v2IndexTemplateCache = {
+      file,
+      mtimeMs: stat.mtimeMs,
+      html
+    };
+    return html;
+  }
+  renderV2IndexHtml() {
+    const template = this.getV2IndexTemplate();
+    if (!template) {
+      return null;
+    }
+    const html = (0, import_utils3.rewriteV2AssetPublicPath)(template, this.getV2AssetPublicPath());
+    return (0, import_utils3.injectRuntimeScript)(html, this.getV2RuntimeConfigScript());
+  }
   async requestHandler(req, res) {
     const { pathname } = (0, import_url.parse)(req.url);
-    const { PLUGIN_STATICS_PATH, APP_PUBLIC_PATH } = import_node_process.default.env;
+    const { PLUGIN_STATICS_PATH } = import_node_process.default.env;
+    const APP_PUBLIC_PATH = this.getAppPublicPath();
     if (pathname.endsWith("/__umi/api/bundle-status")) {
       res.statusCode = 200;
       res.end("ok");
@@ -246,10 +345,10 @@ const _Gateway = class _Gateway extends import_events.EventEmitter {
           return;
         }
       }
-      req.url = req.url.substring(APP_PUBLIC_PATH.length - 1);
+      req.url = req.url.substring(APP_PUBLIC_PATH.length + "storage".length);
       await compress(req, res);
       return (0, import_serve_handler.default)(req, res, {
-        public: (0, import_path.resolve)(import_node_process.default.cwd()),
+        public: (0, import_utils.resolveStorageRoot)(),
         directoryListing: false
       });
     }
@@ -275,6 +374,27 @@ const _Gateway = class _Gateway extends import_events.EventEmitter {
       });
     }
     if (!pathname.startsWith(import_node_process.default.env.API_BASE_PATH)) {
+      if (this.isV2Request(pathname)) {
+        if (handleApp !== "main") {
+          const isProxy = await supervisor.proxyWeb(handleApp, req, res);
+          if (isProxy) {
+            return;
+          }
+        }
+        if (this.isV2IndexRequest(pathname)) {
+          const v2Html = this.renderV2IndexHtml();
+          if (v2Html) {
+            res.setHeader("Content-Type", "text/html; charset=utf-8");
+            res.end(v2Html);
+            return;
+          }
+        }
+        req.url = req.url.substring(APP_PUBLIC_PATH.length - 1);
+        await compress(req, res);
+        return (0, import_serve_handler.default)(req, res, {
+          public: `${import_node_process.default.env.APP_PACKAGE_ROOT}/dist/client`
+        });
+      }
       if (handleApp !== "main") {
         const isProxy = await supervisor.proxyWeb(handleApp, req, res);
         if (isProxy) {
@@ -541,5 +661,7 @@ __publicField(_Gateway, "wsServers", []);
 let Gateway = _Gateway;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  Gateway
+  Gateway,
+  getHost,
+  getHostname
 });

package/lib/gateway/utils.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+/// <reference types="node" />
+import { IncomingMessage } from 'http';
+import { IncomingRequest } from '.';
+export declare function resolvePublicPath(appPublicPath?: string): string;
+export declare function resolveV2PublicPath(appPublicPath?: string): string;
+export declare function rewriteV2AssetPublicPath(html: string, assetPublicPath: string): string;
+export declare function injectRuntimeScript(html: string, runtimeScript: string): string;
+export declare function getHost(req: IncomingMessage | IncomingRequest): any;
+export declare function getHostname(req: IncomingMessage | IncomingRequest): any;

package/lib/gateway/utils.js

@@ -0,0 +1,115 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+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, {
+  getHost: () => getHost,
+  getHostname: () => getHostname,
+  injectRuntimeScript: () => injectRuntimeScript,
+  resolvePublicPath: () => resolvePublicPath,
+  resolveV2PublicPath: () => resolveV2PublicPath,
+  rewriteV2AssetPublicPath: () => rewriteV2AssetPublicPath
+});
+module.exports = __toCommonJS(utils_exports);
+function resolvePublicPath(appPublicPath = "/") {
+  const normalized = String(appPublicPath || "/").trim() || "/";
+  const withLeadingSlash = normalized.startsWith("/") ? normalized : `/${normalized}`;
+  return withLeadingSlash.endsWith("/") ? withLeadingSlash : `${withLeadingSlash}/`;
+}
+__name(resolvePublicPath, "resolvePublicPath");
+function resolveV2PublicPath(appPublicPath = "/") {
+  const publicPath = resolvePublicPath(appPublicPath);
+  return `${publicPath.replace(/\/$/, "")}/v2/`;
+}
+__name(resolveV2PublicPath, "resolveV2PublicPath");
+function ensureTrailingSlash(value) {
+  return value.endsWith("/") ? value : `${value}/`;
+}
+__name(ensureTrailingSlash, "ensureTrailingSlash");
+function rewriteV2AssetPublicPath(html, assetPublicPath) {
+  const normalizedAssetPublicPath = ensureTrailingSlash(assetPublicPath);
+  if (normalizedAssetPublicPath === "/v2/") {
+    return html;
+  }
+  return html.replace(/((?:src|href)=["'])\/v2\//g, `$1${normalizedAssetPublicPath}`);
+}
+__name(rewriteV2AssetPublicPath, "rewriteV2AssetPublicPath");
+function injectRuntimeScript(html, runtimeScript) {
+  const browserCheckerScriptMatch = html.match(/<script\b[^>]*browser-checker\.js[^>]*><\/script>/i);
+  if (browserCheckerScriptMatch == null ? void 0 : browserCheckerScriptMatch[0]) {
+    return html.replace(browserCheckerScriptMatch[0], `${runtimeScript}
+${browserCheckerScriptMatch[0]}`);
+  }
+  const moduleScriptMatch = html.match(/<script\b[^>]*type=["']module["'][^>]*>/i);
+  if (moduleScriptMatch == null ? void 0 : moduleScriptMatch[0]) {
+    return html.replace(moduleScriptMatch[0], `${runtimeScript}
+${moduleScriptMatch[0]}`);
+  }
+  if (html.includes("</head>")) {
+    return html.replace("</head>", `${runtimeScript}
+</head>`);
+  }
+  return `${runtimeScript}
+${html}`;
+}
+__name(injectRuntimeScript, "injectRuntimeScript");
+function splitCommaSeparatedValues(value, limit) {
+  return value.split(",", limit).map((v) => v.trim());
+}
+__name(splitCommaSeparatedValues, "splitCommaSeparatedValues");
+function getHost(req) {
+  let host = req.headers["x-forwarded-host"];
+  if (!host) {
+    host = req.headers[":authority"] || req.headers["host"];
+  }
+  if (!host) return "";
+  host = splitCommaSeparatedValues(host, 1)[0];
+  if (host.includes("@")) {
+    try {
+      host = new URL(`http://${host}`).host;
+    } catch (e) {
+      return "";
+    }
+  }
+  return host;
+}
+__name(getHost, "getHost");
+function getHostname(req) {
+  const host = getHost(req);
+  if (!host) return "";
+  return host.split(":", 1)[0];
+}
+__name(getHostname, "getHostname");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getHost,
+  getHostname,
+  injectRuntimeScript,
+  resolvePublicPath,
+  resolveV2PublicPath,
+  rewriteV2AssetPublicPath
+});

package/lib/helper.js

@@ -239,14 +239,46 @@ function isNumeric(str) {
   return !isNaN(str) && !isNaN(parseFloat(str));
 }
 __name(isNumeric, "isNumeric");
+function getFieldFromCollectionManager(ctx, resourceName, fieldPath) {
+  var _a;
+  const collectionManager = (_a = ctx.dataSource) == null ? void 0 : _a.collectionManager;
+  if (!(collectionManager == null ? void 0 : collectionManager.getCollection)) {
+    return;
+  }
+  const collection = collectionManager.getCollection(resourceName);
+  if (!(collection == null ? void 0 : collection.getField)) {
+    return;
+  }
+  const [firstName, ...others] = fieldPath.split(".");
+  let field = collection.getField(firstName);
+  if (!field || !others.length) {
+    return field;
+  }
+  let currentCollection = typeof field.targetCollection === "function" ? field.targetCollection() : field.targetCollection;
+  for (const name of others) {
+    if (!(currentCollection == null ? void 0 : currentCollection.getField)) {
+      return;
+    }
+    field = currentCollection.getField(name);
+    if (!field) {
+      return;
+    }
+    currentCollection = typeof field.targetCollection === "function" ? field.targetCollection() : field.targetCollection;
+  }
+  return field;
+}
+__name(getFieldFromCollectionManager, "getFieldFromCollectionManager");
 function createContextVariablesScope(ctx) {
   const state = JSON.parse(JSON.stringify(ctx.state));
   return {
     timezone: ctx.get("x-timezone"),
     now: (/* @__PURE__ */ new Date()).toISOString(),
     getField: /* @__PURE__ */ __name((path) => {
-      const fieldPath = path.split(".").filter((p) => !p.startsWith("$") && !isNumeric(p)).join(".");
       const { resourceName } = ctx.action;
+      const fieldPath = path.split(".").filter((p) => !p.startsWith("$") && !isNumeric(p)).join(".");
+      if (!ctx.database) {
+        return getFieldFromCollectionManager(ctx, resourceName, fieldPath);
+      }
       return ctx.database.getFieldByPath(`${resourceName}.${fieldPath}`);
     }, "getField"),
     vars: {

package/lib/index.d.ts

@@ -20,6 +20,7 @@ export * from './plugin-manager';
 export * from './pub-sub-manager';
 export * from './event-queue';
 export * from './worker-id-allocator';
+export * from './worker-mode';
 export * from './redis-connection-manager';
 export * from './main-data-source';
 export declare const OFFICIAL_PLUGIN_PREFIX = "@nocobase/plugin-";

package/lib/index.js

@@ -63,6 +63,7 @@ __reExport(src_exports, require("./plugin-manager"), module.exports);
 __reExport(src_exports, require("./pub-sub-manager"), module.exports);
 __reExport(src_exports, require("./event-queue"), module.exports);
 __reExport(src_exports, require("./worker-id-allocator"), module.exports);
+__reExport(src_exports, require("./worker-mode"), module.exports);
 __reExport(src_exports, require("./redis-connection-manager"), module.exports);
 __reExport(src_exports, require("./main-data-source"), module.exports);
 var import_findPackageNames = require("./plugin-manager/findPackageNames");
@@ -92,6 +93,7 @@ const OFFICIAL_PLUGIN_PREFIX = "@nocobase/plugin-";
   ...require("./pub-sub-manager"),
   ...require("./event-queue"),
   ...require("./worker-id-allocator"),
+  ...require("./worker-mode"),
   ...require("./redis-connection-manager"),
   ...require("./main-data-source")
 });

package/lib/main-data-source.js

@@ -122,7 +122,7 @@ const _MainDataSource = class _MainDataSource extends import_data_source_manager
     const loadedData = {};
     for (const collection of collections) {
       const c = db.getCollection(collection.name);
-      loadedData[c.tableName()] = {
+      loadedData[c.model.tableName] = {
         ...collection.toJSON(),
         fields: collection.fields.map((field) => {
           const f = c.getField(field.name);

package/lib/plugin-manager/deps.js

@@ -76,6 +76,7 @@ const deps = {
   lodash: "4.x",
   "china-division": "2.x",
   cronstrue: "2.x",
-  "@nocobase/license-kit": "0.3.x"
+  "@nocobase/license-kit": "0.3.x",
+  joi: "17.x"
 };
 var deps_default = deps;

package/lib/plugin-manager/options/resource.d.ts

@@ -6,6 +6,15 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
+export type PluginClientLane = 'client' | 'client-v2';
+export declare class PackageUrls {
+    static items: Record<string, string | undefined>;
+    static clear(): void;
+    static getCacheKey(packageName: string, lane: PluginClientLane): string;
+    static get(packageName: string, lane?: PluginClientLane): Promise<string>;
+    static hasClientEntry(packageName: string, lane: PluginClientLane): Promise<boolean>;
+    static fetch(packageName: string, lane?: PluginClientLane): Promise<string>;
+}
 declare const _default: {
     name: string;
     actions: {
@@ -15,8 +24,9 @@ declare const _default: {
         enable(ctx: any, next: any): Promise<void>;
         disable(ctx: any, next: any): Promise<void>;
         remove(ctx: any, next: any): Promise<void>;
-        list(ctx: any, next: any): Promise<void>;
+        list(ctx: any, next: any): Promise<any>;
         listEnabled(ctx: any, next: any): Promise<void>;
+        listEnabledV2(ctx: any, next: any): Promise<void>;
         get(ctx: any, next: any): Promise<void>;
     };
 };