@nocobase/server 1.6.0-alpha.3 → 1.6.0-alpha.30

package/lib/gateway/ws-server.js

@@ -46,16 +46,18 @@ var import_nanoid = require("nanoid");
 var import_app_supervisor = require("../app-supervisor");
 var import_errors = require("./errors");
 var import_lodash = __toESM(require("lodash"));
+var import_events = __toESM(require("events"));
 function getPayloadByErrorCode(code, options) {
   const error = (0, import_errors.getErrorWithCode)(code);
   return import_lodash.default.omit((0, import_errors.applyErrorWithArgs)(error, options), ["status", "maintaining"]);
 }
 __name(getPayloadByErrorCode, "getPayloadByErrorCode");
-const _WSServer = class _WSServer {
+const _WSServer = class _WSServer extends import_events.default {
   wss;
   webSocketClients = /* @__PURE__ */ new Map();
   logger;
   constructor() {
+    super();
     this.wss = new import_ws.WebSocketServer({ noServer: true });
     this.wss.on("connection", (ws, request) => {
       const client = this.addNewConnection(ws, request);
@@ -66,6 +68,15 @@ const _WSServer = class _WSServer {
       ws.on("close", () => {
         this.removeConnection(ws.id);
       });
+      ws.on("message", (message) => {
+        if (message.toString() === "ping") {
+          return;
+        }
+        this.emit("message", {
+          client,
+          message
+        });
+      });
     });
     import_gateway.Gateway.getInstance().on("appSelectorChanged", () => {
       this.loopThroughConnections(async (client) => {
@@ -73,8 +84,12 @@ const _WSServer = class _WSServer {
           url: client.url,
           headers: client.headers
         });
-        client.tags = client.tags.filter((tag) => !tag.startsWith("app#"));
-        client.tags.push(`app#${handleAppName}`);
+        for (const tag of client.tags) {
+          if (tag.startsWith("app#")) {
+            client.tags.delete(tag);
+          }
+        }
+        client.tags.add(`app#${handleAppName}`);
         import_app_supervisor.AppSupervisor.getInstance().bootStrapApp(handleAppName);
       });
     });
@@ -118,19 +133,87 @@ const _WSServer = class _WSServer {
         }
       });
     });
+    import_app_supervisor.AppSupervisor.getInstance().on("afterAppAdded", (app) => {
+      this.bindAppWSEvents(app);
+    });
+    this.on("message", async ({ client, message }) => {
+      const app = await import_app_supervisor.AppSupervisor.getInstance().getApp(client.app);
+      if (!app) {
+        return;
+      }
+      const parsedMessage = JSON.parse(message.toString());
+      if (!parsedMessage.type) {
+        return;
+      }
+      const eventName = `ws:message:${parsedMessage.type}`;
+      app.emit(eventName, {
+        clientId: client.id,
+        tags: [...client.tags],
+        payload: parsedMessage.payload
+      });
+    });
+  }
+  bindAppWSEvents(app) {
+    if (app.listenerCount("ws:setTag") > 0) {
+      return;
+    }
+    app.on("ws:setTag", ({ clientId, tagKey, tagValue }) => {
+      this.setClientTag(clientId, tagKey, tagValue);
+    });
+    app.on("ws:removeTag", ({ clientId, tagKey }) => {
+      this.removeClientTag(clientId, tagKey);
+    });
+    app.on("ws:sendToTag", ({ tagKey, tagValue, message }) => {
+      this.sendToConnectionsByTags(
+        [
+          { tagName: tagKey, tagValue },
+          { tagName: "app", tagValue: app.name }
+        ],
+        message
+      );
+    });
+    app.on("ws:sendToClient", ({ clientId, message }) => {
+      this.sendToClient(clientId, message);
+    });
+    app.on("ws:sendToCurrentApp", ({ message }) => {
+      this.sendToConnectionsByTag("app", app.name, message);
+    });
+    app.on("ws:sendToTags", ({ tags, message }) => {
+      this.sendToConnectionsByTags(tags, message);
+    });
+    app.on("ws:authorized", ({ clientId, userId }) => {
+      this.sendToClient(clientId, { type: "authorized" });
+    });
   }
   addNewConnection(ws, request) {
     const id = (0, import_nanoid.nanoid)();
     ws.id = id;
     this.webSocketClients.set(id, {
       ws,
-      tags: [],
+      tags: /* @__PURE__ */ new Set(),
       url: request.url,
-      headers: request.headers
+      headers: request.headers,
+      id
     });
     this.setClientApp(this.webSocketClients.get(id));
     return this.webSocketClients.get(id);
   }
+  setClientTag(clientId, tagKey, tagValue) {
+    const client = this.webSocketClients.get(clientId);
+    if (!client) {
+      return;
+    }
+    client.tags.add(`${tagKey}#${tagValue}`);
+    console.log(`client tags: ${Array.from(client.tags)}`);
+  }
+  removeClientTag(clientId, tagKey) {
+    const client = this.webSocketClients.get(clientId);
+    client.tags.forEach((tag) => {
+      if (tag.startsWith(tagKey)) {
+        client.tags.delete(tag);
+      }
+    });
+  }
   async setClientApp(client) {
     const req = {
       url: client.url,
@@ -139,31 +222,11 @@ const _WSServer = class _WSServer {
     const handleAppName = await import_gateway.Gateway.getInstance().getRequestHandleAppName(req);
     client.app = handleAppName;
     console.log(`client tags: app#${handleAppName}`);
-    client.tags.push(`app#${handleAppName}`);
+    client.tags.add(`app#${handleAppName}`);
     const hasApp = import_app_supervisor.AppSupervisor.getInstance().hasApp(handleAppName);
     if (!hasApp) {
       import_app_supervisor.AppSupervisor.getInstance().bootStrapApp(handleAppName);
     }
-    const appStatus = import_app_supervisor.AppSupervisor.getInstance().getAppStatus(handleAppName, "initializing");
-    if (appStatus === "not_found") {
-      this.sendMessageToConnection(client, {
-        type: "maintaining",
-        payload: getPayloadByErrorCode("APP_NOT_FOUND", { appName: handleAppName })
-      });
-      return;
-    }
-    if (appStatus === "initializing") {
-      this.sendMessageToConnection(client, {
-        type: "maintaining",
-        payload: getPayloadByErrorCode("APP_INITIALIZING", { appName: handleAppName })
-      });
-      return;
-    }
-    const app = await import_app_supervisor.AppSupervisor.getInstance().getApp(handleAppName);
-    this.sendMessageToConnection(client, {
-      type: "maintaining",
-      payload: getPayloadByErrorCode(appStatus, { app })
-    });
   }
   removeConnection(id) {
     console.log(`client disconnected ${id}`);
@@ -173,12 +236,27 @@ const _WSServer = class _WSServer {
     client.ws.send(JSON.stringify(sendMessage));
   }
   sendToConnectionsByTag(tagName, tagValue, sendMessage) {
+    this.sendToConnectionsByTags([{ tagName, tagValue }], sendMessage);
+  }
+  /**
+   * Send message to clients that match all the given tag conditions
+   * @param tags Array of tag conditions, each condition is an object with tagName and tagValue
+   * @param sendMessage Message to be sent
+   */
+  sendToConnectionsByTags(tags, sendMessage) {
     this.loopThroughConnections((client) => {
-      if (client.tags.includes(`${tagName}#${tagValue}`)) {
+      const allTagsMatch = tags.every(({ tagName, tagValue }) => client.tags.has(`${tagName}#${tagValue}`));
+      if (allTagsMatch) {
         this.sendMessageToConnection(client, sendMessage);
       }
     });
   }
+  sendToClient(clientId, sendMessage) {
+    const client = this.webSocketClients.get(clientId);
+    if (client) {
+      this.sendMessageToConnection(client, sendMessage);
+    }
+  }
   loopThroughConnections(callback) {
     this.webSocketClients.forEach((client) => {
       callback(client);

package/lib/helper.js

@@ -56,6 +56,7 @@ var import_i18next = __toESM(require("i18next"));
 var import_koa_bodyparser = __toESM(require("koa-bodyparser"));
 var import_perf_hooks = require("perf_hooks");
 var import_data_wrapping = require("./middlewares/data-wrapping");
+var import_extract_client_ip = require("./middlewares/extract-client-ip");
 var import_i18n = require("./middlewares/i18n");
 function createI18n(options) {
   const instance = import_i18next.default.createInstance();
@@ -87,6 +88,9 @@ function registerMiddlewares(app, options) {
   app.use(
     (0, import_cors.default)({
       exposeHeaders: ["content-disposition"],
+      origin(ctx) {
+        return ctx.get("origin");
+      },
       ...options.cors
     }),
     {
@@ -121,6 +125,7 @@ function registerMiddlewares(app, options) {
     app.use((0, import_data_wrapping.dataWrapping)(), { tag: "dataWrapping", after: "cors" });
   }
   app.use(app.dataSourceManager.middleware(), { tag: "dataSource", after: "dataWrapping" });
+  app.use((0, import_extract_client_ip.extractClientIp)(), { tag: "extractClientIp", before: "cors" });
 }
 __name(registerMiddlewares, "registerMiddlewares");
 const createAppProxy = /* @__PURE__ */ __name((app) => {

package/lib/helpers/application-version.js

@@ -49,6 +49,7 @@ const _ApplicationVersion = class _ApplicationVersion {
     app.db.collection({
       origin: "@nocobase/server",
       name: "applicationVersion",
+      migrationRules: ["schema-only"],
       dataType: "meta",
       timestamps: false,
       dumpRules: "required",

package/lib/index.d.ts

@@ -6,15 +6,16 @@
  * 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 * from './aes-encryptor';
 export * from './app-supervisor';
 export * from './application';
 export { Application as default } from './application';
+export * from './audit-manager';
 export * from './gateway';
 export * as middlewares from './middlewares';
 export * from './migration';
 export * from './plugin';
 export * from './plugin-manager';
-export * from './audit-manager';
 export * from './pub-sub-manager';
 export declare const OFFICIAL_PLUGIN_PREFIX = "@nocobase/plugin-";
 export { appendToBuiltInPlugins, findAllPlugins, findBuiltInPlugins, findLocalPlugins, packageNameTrim, } from './plugin-manager/findPackageNames';

package/lib/index.js

@@ -48,15 +48,16 @@ __export(src_exports, {
   runPluginStaticImports: () => import_run_plugin_static_imports.runPluginStaticImports
 });
 module.exports = __toCommonJS(src_exports);
+__reExport(src_exports, require("./aes-encryptor"), module.exports);
 __reExport(src_exports, require("./app-supervisor"), module.exports);
 __reExport(src_exports, require("./application"), module.exports);
 var import_application = require("./application");
+__reExport(src_exports, require("./audit-manager"), module.exports);
 __reExport(src_exports, require("./gateway"), module.exports);
 var middlewares = __toESM(require("./middlewares"));
 __reExport(src_exports, require("./migration"), module.exports);
 __reExport(src_exports, require("./plugin"), module.exports);
 __reExport(src_exports, require("./plugin-manager"), module.exports);
-__reExport(src_exports, require("./audit-manager"), module.exports);
 __reExport(src_exports, require("./pub-sub-manager"), module.exports);
 var import_findPackageNames = require("./plugin-manager/findPackageNames");
 var import_run_plugin_static_imports = require("./run-plugin-static-imports");
@@ -71,12 +72,13 @@ const OFFICIAL_PLUGIN_PREFIX = "@nocobase/plugin-";
   middlewares,
   packageNameTrim,
   runPluginStaticImports,
+  ...require("./aes-encryptor"),
   ...require("./app-supervisor"),
   ...require("./application"),
+  ...require("./audit-manager"),
   ...require("./gateway"),
   ...require("./migration"),
   ...require("./plugin"),
   ...require("./plugin-manager"),
-  ...require("./audit-manager"),
   ...require("./pub-sub-manager")
 });

package/lib/middlewares/data-template.js

@@ -32,12 +32,12 @@ __export(data_template_exports, {
 module.exports = __toCommonJS(data_template_exports);
 async function dataTemplate(ctx, next) {
   const { resourceName, actionName } = ctx.action;
-  const { isTemplate, fields } = ctx.action.params;
+  const { isTemplate, fields, appends } = ctx.action.params;
   await next();
-  if (isTemplate && actionName === "get" && fields.length > 0) {
+  if (isTemplate && actionName === "get") {
     ctx.body = traverseJSON(JSON.parse(JSON.stringify(ctx.body)), {
-      collection: ctx.db.getCollection(resourceName),
-      include: fields
+      collection: ctx.getCurrentRepository().collection,
+      include: [...fields || [], ...appends || []]
     });
   }
 }
@@ -101,7 +101,7 @@ const traverseJSON = /* @__PURE__ */ __name((data, options) => {
       result[key] = data[key];
       continue;
     }
-    if (field.options.primaryKey && excludePk) {
+    if (field.options.primaryKey && excludePk && !collection.isMultiFilterTargetKey()) {
       continue;
     }
     if (field.options.isForeignKey) {

package/lib/middlewares/extract-client-ip.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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.
+ */
+import { Context, Next } from '@nocobase/actions';
+export declare function extractClientIp(): (ctx: Context, next: Next) => Promise<void>;

package/lib/middlewares/extract-client-ip.js

@@ -0,0 +1,46 @@
+/**
+ * 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 extract_client_ip_exports = {};
+__export(extract_client_ip_exports, {
+  extractClientIp: () => extractClientIp
+});
+module.exports = __toCommonJS(extract_client_ip_exports);
+function extractClientIp() {
+  return /* @__PURE__ */ __name(async function extractClientIp2(ctx, next) {
+    const forwardedFor = ctx.get("X-Forwarded-For");
+    const ipArray = forwardedFor ? forwardedFor.split(",") : [];
+    const clientIp = ipArray.length > 0 ? ipArray[0].trim() : ctx.request.ip;
+    ctx.state.clientIp = clientIp;
+    await next();
+  }, "extractClientIp");
+}
+__name(extractClientIp, "extractClientIp");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  extractClientIp
+});

package/lib/middlewares/index.d.ts

@@ -7,4 +7,5 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 export * from './data-wrapping';
+export * from './extract-client-ip';
 export { parseVariables } from './parse-variables';

package/lib/middlewares/index.js

@@ -31,9 +31,11 @@ __export(middlewares_exports, {
 });
 module.exports = __toCommonJS(middlewares_exports);
 __reExport(middlewares_exports, require("./data-wrapping"), module.exports);
+__reExport(middlewares_exports, require("./extract-client-ip"), module.exports);
 var import_parse_variables = require("./parse-variables");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   parseVariables,
-  ...require("./data-wrapping")
+  ...require("./data-wrapping"),
+  ...require("./extract-client-ip")
 });

package/lib/plugin-manager/deps.js

@@ -45,7 +45,7 @@ const deps = {
   winston: "3.x",
   "winston-daily-rotate-file": "4.x",
   koa: "2.x",
-  "@koa/cors": "3.x",
+  "@koa/cors": "5.x",
   "@koa/router": "9.x",
   multer: "1.x",
   "@koa/multer": "3.x",

package/lib/plugin-manager/options/collection.js

@@ -33,6 +33,7 @@ var import_database = require("@nocobase/database");
 var collection_default = (0, import_database.defineCollection)({
   name: "applicationPlugins",
   dumpRules: "required",
+  migrationRules: ["overwrite", "schema-only"],
   repository: "PluginManagerRepository",
   origin: "@nocobase/server",
   fields: [

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

@@ -67,7 +67,7 @@ export declare class PluginManager {
     /**
      * @internal
      */
-    static getPackageName(name: string): Promise<string>;
+    static getPackageName(name: string): Promise<any>;
     /**
      * @internal
      */
@@ -75,7 +75,7 @@ export declare class PluginManager {
     /**
      * @internal
      */
-    static findPackage(name: string): Promise<string>;
+    static findPackage(name: string): Promise<any>;
     /**
      * @internal
      */
@@ -89,9 +89,9 @@ export declare class PluginManager {
     addPreset(plugin: string | typeof Plugin, options?: any): void;
     getPlugins(): Map<typeof Plugin, Plugin<any>>;
     getAliases(): IterableIterator<string>;
-    get(name: string | typeof Plugin): Plugin<any>;
+    get<T extends Plugin>(name: string | typeof Plugin | (new () => T)): T;
     has(name: string | typeof Plugin): boolean;
-    del(name: string | typeof Plugin): void;
+    del(name: any): void;
     create(pluginName: string, options?: {
         forceRecreate?: boolean;
     }): Promise<void>;

package/lib/plugin-manager/plugin-manager.js

@@ -139,15 +139,12 @@ const _PluginManager = class _PluginManager {
    * @internal
    */
   static async getPackageName(name) {
-    const prefixes = this.getPluginPkgPrefix();
-    for (const prefix of prefixes) {
-      const pkg = (0, import_path.resolve)(process.env.NODE_MODULES_PATH, `${prefix}${name}`, "package.json");
-      const exists = await import_fs_extra.default.exists(pkg);
-      if (exists) {
-        return `${prefix}${name}`;
-      }
+    const { packageName } = await this.parseName(name);
+    const packageFile = (0, import_path.resolve)(process.env.NODE_MODULES_PATH, packageName, "package.json");
+    if (!await import_fs_extra.default.exists(packageFile)) {
+      return null;
     }
-    throw new Error(`${name} plugin does not exist`);
+    return packageName;
   }
   /**
    * @internal
@@ -312,7 +309,9 @@ const _PluginManager = class _PluginManager {
     try {
       if (typeof plugin === "string" && options.name && !options.packageName) {
         const packageName = await _PluginManager.getPackageName(options.name);
-        options["packageName"] = packageName;
+        if (packageName) {
+          options["packageName"] = packageName;
+        }
       }
       if (options.packageName) {
         const packageJson = await _PluginManager.getPackageJson(options.packageName);
@@ -320,12 +319,14 @@ const _PluginManager = class _PluginManager {
         options["version"] = packageJson.version;
       }
     } catch (error) {
+      this.app.log.error(error);
       console.error(error);
     }
-    this.app.log.trace(`add plugin [${options.name}]`, {
+    this.app.log.trace(`adding plugin [${options.name}]`, {
       method: "add",
       submodule: "plugin-manager",
-      name: options.name
+      name: options.name,
+      options
     });
     let P;
     try {
@@ -343,6 +344,12 @@ const _PluginManager = class _PluginManager {
       this.pluginAliases.set(options.packageName, instance);
     }
     await instance.afterAdd();
+    this.app.log.trace(`added plugin [${options.name}]`, {
+      method: "add",
+      submodule: "plugin-manager",
+      name: instance.name,
+      options: instance.options
+    });
   }
   /**
    * @internal
@@ -364,15 +371,20 @@ const _PluginManager = class _PluginManager {
     const packageNames = items.map((item) => item.packageName);
     const source = [];
     for (const packageName of packageNames) {
-      const dirname = await (0, import_utils2.getPluginBasePath)(packageName);
-      const directory = (0, import_path.join)(dirname, "server/commands/*." + ((0, import_path.basename)(dirname) === "src" ? "ts" : "js"));
-      source.push(directory.replaceAll(import_path.sep, "/"));
+      try {
+        const dirname = await (0, import_utils2.getPluginBasePath)(packageName);
+        const directory = (0, import_path.join)(dirname, "server/commands/*." + ((0, import_path.basename)(dirname) === "src" ? "{ts,js}" : "js"));
+        source.push(directory.replaceAll(import_path.sep, "/"));
+      } catch (error) {
+        this.app.log.error(error);
+        continue;
+      }
     }
     for (const plugin of this.options.plugins || []) {
       if (typeof plugin === "string") {
         const { packageName } = await _PluginManager.parseName(plugin);
         const dirname = await (0, import_utils2.getPluginBasePath)(packageName);
-        const directory = (0, import_path.join)(dirname, "server/commands/*." + ((0, import_path.basename)(dirname) === "src" ? "ts" : "js"));
+        const directory = (0, import_path.join)(dirname, "server/commands/*." + ((0, import_path.basename)(dirname) === "src" ? "{ts,js}" : "js"));
         source.push(directory.replaceAll(import_path.sep, "/"));
       }
     }

package/lib/service-container.d.ts

@@ -0,0 +1,5 @@
+export declare class ServiceContainer {
+    private services;
+    register<T>(name: string, service: T): void;
+    get<T>(name: string): T;
+}

package/lib/service-container.js

@@ -0,0 +1,50 @@
+/**
+ * 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 service_container_exports = {};
+__export(service_container_exports, {
+  ServiceContainer: () => ServiceContainer
+});
+module.exports = __toCommonJS(service_container_exports);
+const _ServiceContainer = class _ServiceContainer {
+  services = /* @__PURE__ */ new Map();
+  register(name, service) {
+    if (typeof service === "function") {
+      service = service();
+    }
+    this.services.set(name, service);
+  }
+  get(name) {
+    return this.services.get(name);
+  }
+};
+__name(_ServiceContainer, "ServiceContainer");
+let ServiceContainer = _ServiceContainer;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ServiceContainer
+});