@nocobase/server 1.4.0-alpha.9 → 1.5.0-alpha.1

package/lib/application.d.ts

@@ -16,6 +16,7 @@ import { Logger, LoggerOptions, RequestLoggerOptions, SystemLogger, SystemLogger
 import { ResourceOptions, Resourcer } from '@nocobase/resourcer';
 import { Telemetry, TelemetryOptions } from '@nocobase/telemetry';
 import { AsyncEmitter, ToposortOptions } from '@nocobase/utils';
+import { LockManager, LockManagerOptions } from '@nocobase/lock-manager';
 import { Command, CommandOptions, ParseOptions } from 'commander';
 import { IncomingMessage, ServerResponse } from 'http';
 import { i18n, InitOptions } from 'i18next';
@@ -28,7 +29,8 @@ import { ApplicationVersion } from './helpers/application-version';
 import { Locale } from './locale';
 import { Plugin } from './plugin';
 import { InstallOptions, PluginManager } from './plugin-manager';
-import { SyncManager } from './sync-manager';
+import { PubSubManager, PubSubManagerOptions } from './pub-sub-manager';
+import { SyncMessageManager } from './sync-message-manager';
 export type PluginType = string | typeof Plugin;
 export type PluginConfiguration = PluginType | [PluginType, any];
 export interface ResourceManagerOptions {
@@ -58,6 +60,8 @@ export interface ApplicationOptions {
      */
     resourcer?: ResourceManagerOptions;
     resourceManager?: ResourceManagerOptions;
+    pubSubManager?: PubSubManagerOptions;
+    syncMessageManager?: any;
     bodyParser?: any;
     cors?: any;
     dataWrapping?: boolean;
@@ -72,6 +76,7 @@ export interface ApplicationOptions {
     pmSock?: string;
     name?: string;
     authManager?: AuthManagerOptions;
+    lockManager?: LockManagerOptions;
     /**
      * @internal
      */
@@ -152,7 +157,8 @@ export declare class Application<StateT = DefaultState, ContextT = DefaultContex
     /**
      * @internal
      */
-    syncManager: SyncManager;
+    pubSubManager: PubSubManager;
+    syncMessageManager: SyncMessageManager;
     requestLogger: Logger;
     protected plugins: Map<string, Plugin<any>>;
     protected _appSupervisor: AppSupervisor;
@@ -161,6 +167,7 @@ export declare class Application<StateT = DefaultState, ContextT = DefaultContex
     private _maintainingCommandStatus;
     private _maintainingStatusBeforeCommand;
     private _actionCommand;
+    lockManager: LockManager;
     constructor(options: ApplicationOptions);
     private static staticCommands;
     static addCommand(callback: (app: Application) => void): void;

package/lib/application.js

@@ -50,6 +50,7 @@ var import_database = __toESM(require("@nocobase/database"));
 var import_logger = require("@nocobase/logger");
 var import_telemetry = require("@nocobase/telemetry");
 var import_utils = require("@nocobase/utils");
+var import_lock_manager = require("@nocobase/lock-manager");
 var import_crypto = require("crypto");
 var import_glob = __toESM(require("glob"));
 var import_koa = __toESM(require("koa"));
@@ -72,7 +73,8 @@ var import_middlewares = require("./middlewares");
 var import_data_template = require("./middlewares/data-template");
 var import_validate_filter_params = __toESM(require("./middlewares/validate-filter-params"));
 var import_plugin_manager = require("./plugin-manager");
-var import_sync_manager = require("./sync-manager");
+var import_pub_sub_manager = require("./pub-sub-manager");
+var import_sync_message_manager = require("./sync-message-manager");
 var import_package = __toESM(require("../package.json"));
 const _Application = class _Application extends import_koa.default {
   constructor(options) {
@@ -112,7 +114,8 @@ const _Application = class _Application extends import_koa.default {
   /**
    * @internal
    */
-  syncManager;
+  pubSubManager;
+  syncMessageManager;
   requestLogger;
   plugins = /* @__PURE__ */ new Map();
   _appSupervisor = import_app_supervisor.AppSupervisor.getInstance();
@@ -121,6 +124,7 @@ const _Application = class _Application extends import_koa.default {
   _maintainingCommandStatus;
   _maintainingStatusBeforeCommand;
   _actionCommand;
+  lockManager;
   static addCommand(callback) {
     this.staticCommands.push(callback);
   }
@@ -346,6 +350,9 @@ const _Application = class _Application extends import_koa.default {
     if (this.cacheManager) {
       await this.cacheManager.close();
     }
+    if (this.pubSubManager) {
+      await this.pubSubManager.close();
+    }
     if (this.telemetry.started) {
       await this.telemetry.shutdown();
     }
@@ -820,7 +827,12 @@ const _Application = class _Application extends import_koa.default {
     this._cronJobManager = new import_cron_job_manager.CronJobManager(this);
     this._cli = this.createCLI();
     this._i18n = (0, import_helper.createI18n)(options);
-    this.syncManager = new import_sync_manager.SyncManager(this);
+    this.pubSubManager = (0, import_pub_sub_manager.createPubSubManager)(this, options.pubSubManager);
+    this.syncMessageManager = new import_sync_message_manager.SyncMessageManager(this, options.syncMessageManager);
+    this.lockManager = new import_lock_manager.LockManager({
+      defaultAdapter: process.env.LOCK_ADAPTER_DEFAULT,
+      ...options.lockManager
+    });
     this.context.db = this.db;
     this.context.resourcer = this.resourceManager;
     this.context.resourceManager = this.resourceManager;

package/lib/index.d.ts

@@ -14,7 +14,7 @@ export * as middlewares from './middlewares';
 export * from './migration';
 export * from './plugin';
 export * from './plugin-manager';
-export * from './sync-manager';
+export * from './pub-sub-manager';
 export declare const OFFICIAL_PLUGIN_PREFIX = "@nocobase/plugin-";
 export { appendToBuiltInPlugins, findAllPlugins, findBuiltInPlugins, findLocalPlugins, packageNameTrim, } from './plugin-manager/findPackageNames';
 export { runPluginStaticImports } from './run-plugin-static-imports';

package/lib/index.js

@@ -56,7 +56,7 @@ 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("./sync-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");
 const OFFICIAL_PLUGIN_PREFIX = "@nocobase/plugin-";
@@ -76,5 +76,5 @@ const OFFICIAL_PLUGIN_PREFIX = "@nocobase/plugin-";
   ...require("./migration"),
   ...require("./plugin"),
   ...require("./plugin-manager"),
-  ...require("./sync-manager")
+  ...require("./pub-sub-manager")
 });

package/lib/locale/locale.d.ts

@@ -25,6 +25,7 @@ export declare class Locale {
     resourceStorers: Registry<ResourceStorer>;
     constructor(app: Application);
     load(): Promise<void>;
+    reset(): Promise<void>;
     reload(): Promise<void>;
     setLocaleFn(name: string, fn: (lang: string) => Promise<any>): void;
     registerResourceStorer(name: string, storer: ResourceStorer): void;

package/lib/locale/locale.js

@@ -61,6 +61,13 @@ const _Locale = class _Locale {
       this.app.log.debug("locale resource loaded", { submodule: "locale", method: "onAfterLoad" });
       this.app.setMaintainingMessage("locale resource loaded");
     });
+    this.app.syncMessageManager.subscribe("localeManager", async (message) => {
+      switch (message.type) {
+        case "reload":
+          await this.reset();
+          return;
+      }
+    });
   }
   async load() {
     this.cache = await this.app.cacheManager.createCache({
@@ -70,11 +77,15 @@ const _Locale = class _Locale {
     });
     await this.get(this.defaultLang);
   }
-  async reload() {
+  async reset() {
     const storers = Array.from(this.resourceStorers.getValues());
     const promises = storers.map((storer) => storer.reset());
     await Promise.all([this.cache.reset(), ...promises]);
   }
+  async reload() {
+    await this.reset();
+    this.app.syncMessageManager.publish("localeManager", { type: "reload" });
+  }
   setLocaleFn(name, fn) {
     this.localeFn.set(name, fn);
   }

package/lib/plugin-manager/deps.js

@@ -39,7 +39,7 @@ const deps = {
   "cache-manager": "5.x",
   sequelize: "6.x",
   umzug: "3.x",
-  "async-mutex": "0.3.x",
+  "async-mutex": "0.5.x",
   "@formulajs/formulajs": "4.x",
   mathjs: "10.x",
   winston: "3.x",

package/lib/plugin.d.ts

@@ -6,12 +6,11 @@
  * 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 { Model } from '@nocobase/database';
+import { Model, Transactionable } from '@nocobase/database';
 import { LoggerOptions } from '@nocobase/logger';
 import type { TFuncKey, TOptions } from 'i18next';
 import { Application } from './application';
 import { InstallOptions } from './plugin-manager';
-import { SyncMessageData } from './sync-manager';
 export interface PluginInterface {
     beforeLoad?: () => void;
     load(): any;
@@ -66,16 +65,8 @@ export declare abstract class Plugin<O = any> implements PluginInterface {
     afterDisable(): Promise<void>;
     beforeRemove(): Promise<void>;
     afterRemove(): Promise<void>;
-    /**
-     * Fired when a sync message is received.
-     * @experimental
-     */
-    onSync(message?: SyncMessageData): Promise<void> | void;
-    /**
-     * Publish a sync message.
-     * @experimental
-     */
-    sync(message?: SyncMessageData): void;
+    handleSyncMessage(message: any): Promise<void>;
+    sendSyncMessage(message: any, options?: Transactionable): Promise<void>;
     /**
      * @deprecated
      */
@@ -92,7 +83,6 @@ export declare abstract class Plugin<O = any> implements PluginInterface {
         afterSync: any[];
         afterLoad: any[];
     }>;
-    private getPluginBasePath;
     /**
      * @internal
      */
@@ -106,5 +96,6 @@ export declare abstract class Plugin<O = any> implements PluginInterface {
      * @experimental
      */
     toJSON(options?: any): Promise<any>;
+    private getPluginBasePath;
 }
 export default Plugin;

package/lib/plugin.js

@@ -124,18 +124,13 @@ const _Plugin = class _Plugin {
   }
   async afterRemove() {
   }
-  /**
-   * Fired when a sync message is received.
-   * @experimental
-   */
-  onSync(message = {}) {
+  async handleSyncMessage(message) {
   }
-  /**
-   * Publish a sync message.
-   * @experimental
-   */
-  sync(message) {
-    this.app.syncManager.publish(this.name, message);
+  async sendSyncMessage(message, options) {
+    if (!this.name) {
+      throw new Error(`plugin name invalid`);
+    }
+    await this.app.syncMessageManager.publish(this.name, message, options);
   }
   /**
    * @deprecated
@@ -166,12 +161,6 @@ const _Plugin = class _Plugin {
       }
     });
   }
-  async getPluginBasePath() {
-    if (!this.options.packageName) {
-      return;
-    }
-    return (0, import_utils2.getPluginBasePath)(this.options.packageName);
-  }
   /**
    * @internal
    */
@@ -231,6 +220,12 @@ const _Plugin = class _Plugin {
     }
     return results;
   }
+  async getPluginBasePath() {
+    if (!this.options.packageName) {
+      return;
+    }
+    return (0, import_utils2.getPluginBasePath)(this.options.packageName);
+  }
 };
 __name(_Plugin, "Plugin");
 let Plugin = _Plugin;

package/lib/pub-sub-manager/handler-manager.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { type PubSubManagerSubscribeOptions } from './types';
+export declare class HandlerManager {
+    protected publisherId: string;
+    handlers: Map<any, any>;
+    uniqueMessageHandlers: Map<any, any>;
+    constructor(publisherId: string);
+    protected getMessageHash(message: any): Promise<string>;
+    protected verifyMessage({ onlySelf, skipSelf, publisherId }: {
+        onlySelf: any;
+        skipSelf: any;
+        publisherId: any;
+    }): boolean;
+    protected debounce(func: any, wait: number): any;
+    handleMessage({ channel, message, callback, debounce }: {
+        channel: any;
+        message: any;
+        callback: any;
+        debounce: any;
+    }): Promise<void>;
+    wrapper(channel: any, callback: any, options: any): (wrappedMessage: any) => Promise<void>;
+    set(channel: string, callback: any, options: PubSubManagerSubscribeOptions): (wrappedMessage: any) => Promise<void>;
+    get(channel: string, callback: any): any;
+    delete(channel: string, callback: any): any;
+    reset(): void;
+    each(callback: any): Promise<void>;
+}

package/lib/pub-sub-manager/handler-manager.js

@@ -0,0 +1,149 @@
+/**
+ * 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 __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 __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 __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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var handler_manager_exports = {};
+__export(handler_manager_exports, {
+  HandlerManager: () => HandlerManager
+});
+module.exports = __toCommonJS(handler_manager_exports);
+var import_node_crypto = __toESM(require("node:crypto"));
+var import_lodash = __toESM(require("lodash"));
+const _HandlerManager = class _HandlerManager {
+  constructor(publisherId) {
+    this.publisherId = publisherId;
+    this.reset();
+  }
+  handlers;
+  uniqueMessageHandlers;
+  async getMessageHash(message) {
+    const encoder = new TextEncoder();
+    const data = encoder.encode(JSON.stringify(message));
+    const hashBuffer = await import_node_crypto.default.subtle.digest("SHA-256", data);
+    const hashArray = Array.from(new Uint8Array(hashBuffer));
+    const hashHex = hashArray.map((b) => b.toString(16).padStart(2, "0")).join("");
+    return hashHex;
+  }
+  verifyMessage({ onlySelf, skipSelf, publisherId }) {
+    if (onlySelf && publisherId !== this.publisherId) {
+      return;
+    } else if (!onlySelf && skipSelf && publisherId === this.publisherId) {
+      return;
+    }
+    return true;
+  }
+  debounce(func, wait) {
+    if (wait) {
+      return import_lodash.default.debounce(func, wait);
+    }
+    return func;
+  }
+  async handleMessage({ channel, message, callback, debounce }) {
+    if (!debounce) {
+      await callback(message);
+      return;
+    }
+    const messageHash = channel + await this.getMessageHash(message);
+    if (!this.uniqueMessageHandlers.has(messageHash)) {
+      this.uniqueMessageHandlers.set(messageHash, this.debounce(callback, debounce));
+    }
+    const handler = this.uniqueMessageHandlers.get(messageHash);
+    try {
+      await handler(message);
+      setTimeout(() => {
+        this.uniqueMessageHandlers.delete(messageHash);
+      }, debounce);
+    } catch (error) {
+      this.uniqueMessageHandlers.delete(messageHash);
+      throw error;
+    }
+  }
+  wrapper(channel, callback, options) {
+    const { debounce = 0 } = options;
+    return async (wrappedMessage) => {
+      const json = JSON.parse(wrappedMessage);
+      if (!this.verifyMessage(json)) {
+        return;
+      }
+      await this.handleMessage({ channel, message: json.message, debounce, callback });
+    };
+  }
+  set(channel, callback, options) {
+    if (!this.handlers.has(channel)) {
+      this.handlers.set(channel, /* @__PURE__ */ new Map());
+    }
+    const headlerMap = this.handlers.get(channel);
+    const headler = this.wrapper(channel, callback, options);
+    headlerMap.set(callback, headler);
+    return headler;
+  }
+  get(channel, callback) {
+    const headlerMap = this.handlers.get(channel);
+    if (!headlerMap) {
+      return;
+    }
+    return headlerMap.get(callback);
+  }
+  delete(channel, callback) {
+    if (!callback) {
+      return;
+    }
+    const headlerMap = this.handlers.get(channel);
+    if (!headlerMap) {
+      return;
+    }
+    const headler = headlerMap.get(callback);
+    headlerMap.delete(callback);
+    return headler;
+  }
+  reset() {
+    this.handlers = /* @__PURE__ */ new Map();
+    this.uniqueMessageHandlers = /* @__PURE__ */ new Map();
+  }
+  async each(callback) {
+    for (const [channel, headlerMap] of this.handlers) {
+      for (const headler of headlerMap.values()) {
+        await callback(channel, headler);
+      }
+    }
+  }
+};
+__name(_HandlerManager, "HandlerManager");
+let HandlerManager = _HandlerManager;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  HandlerManager
+});

package/lib/pub-sub-manager/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ */
+export * from './handler-manager';
+export * from './pub-sub-manager';
+export * from './types';

package/lib/pub-sub-manager/index.js

@@ -0,0 +1,34 @@
+/**
+ * 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 __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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var pub_sub_manager_exports = {};
+module.exports = __toCommonJS(pub_sub_manager_exports);
+__reExport(pub_sub_manager_exports, require("./handler-manager"), module.exports);
+__reExport(pub_sub_manager_exports, require("./pub-sub-manager"), module.exports);
+__reExport(pub_sub_manager_exports, require("./types"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./handler-manager"),
+  ...require("./pub-sub-manager"),
+  ...require("./types")
+});

package/lib/pub-sub-manager/pub-sub-manager.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 Application from '../application';
+import { HandlerManager } from './handler-manager';
+import { PubSubCallback, type IPubSubAdapter, type PubSubManagerOptions, type PubSubManagerPublishOptions, type PubSubManagerSubscribeOptions } from './types';
+export declare const createPubSubManager: (app: Application, options: PubSubManagerOptions) => PubSubManager;
+export declare class PubSubManager {
+    protected options: PubSubManagerOptions;
+    protected publisherId: string;
+    protected adapter: IPubSubAdapter;
+    protected handlerManager: HandlerManager;
+    constructor(options?: PubSubManagerOptions);
+    get channelPrefix(): string;
+    setAdapter(adapter: IPubSubAdapter): void;
+    isConnected(): Promise<boolean>;
+    connect(): Promise<void>;
+    close(): Promise<any>;
+    subscribe(channel: string, callback: PubSubCallback, options?: PubSubManagerSubscribeOptions): Promise<void>;
+    unsubscribe(channel: string, callback: PubSubCallback): Promise<any>;
+    publish(channel: string, message: any, options?: PubSubManagerPublishOptions): Promise<any>;
+}

package/lib/pub-sub-manager/pub-sub-manager.js

@@ -0,0 +1,116 @@
+/**
+ * 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 pub_sub_manager_exports = {};
+__export(pub_sub_manager_exports, {
+  PubSubManager: () => PubSubManager,
+  createPubSubManager: () => createPubSubManager
+});
+module.exports = __toCommonJS(pub_sub_manager_exports);
+var import_utils = require("@nocobase/utils");
+var import_handler_manager = require("./handler-manager");
+const createPubSubManager = /* @__PURE__ */ __name((app, options) => {
+  const pubSubManager = new PubSubManager(options);
+  app.on("afterStart", async () => {
+    await pubSubManager.connect();
+  });
+  app.on("afterStop", async () => {
+    await pubSubManager.close();
+  });
+  return pubSubManager;
+}, "createPubSubManager");
+const _PubSubManager = class _PubSubManager {
+  constructor(options = {}) {
+    this.options = options;
+    this.publisherId = (0, import_utils.uid)();
+    this.handlerManager = new import_handler_manager.HandlerManager(this.publisherId);
+  }
+  publisherId;
+  adapter;
+  handlerManager;
+  get channelPrefix() {
+    var _a;
+    return ((_a = this.options) == null ? void 0 : _a.channelPrefix) ? `${this.options.channelPrefix}.` : "";
+  }
+  setAdapter(adapter) {
+    this.adapter = adapter;
+  }
+  async isConnected() {
+    if (this.adapter) {
+      return this.adapter.isConnected();
+    }
+    return false;
+  }
+  async connect() {
+    if (!this.adapter) {
+      return;
+    }
+    await this.adapter.connect();
+    await this.handlerManager.each(async (channel, headler) => {
+      await this.adapter.subscribe(`${this.channelPrefix}${channel}`, headler);
+    });
+  }
+  async close() {
+    if (!this.adapter) {
+      return;
+    }
+    return await this.adapter.close();
+  }
+  async subscribe(channel, callback, options = {}) {
+    await this.unsubscribe(channel, callback);
+    const handler = this.handlerManager.set(channel, callback, options);
+    if (await this.isConnected()) {
+      await this.adapter.subscribe(`${this.channelPrefix}${channel}`, handler);
+    }
+  }
+  async unsubscribe(channel, callback) {
+    const handler = this.handlerManager.delete(channel, callback);
+    if (!this.adapter || !handler) {
+      return;
+    }
+    return this.adapter.unsubscribe(`${this.channelPrefix}${channel}`, handler);
+  }
+  async publish(channel, message, options) {
+    var _a;
+    if (!((_a = this.adapter) == null ? void 0 : _a.isConnected())) {
+      return;
+    }
+    const wrappedMessage = JSON.stringify({
+      publisherId: this.publisherId,
+      ...options,
+      message
+    });
+    return this.adapter.publish(`${this.channelPrefix}${channel}`, wrappedMessage);
+  }
+};
+__name(_PubSubManager, "PubSubManager");
+let PubSubManager = _PubSubManager;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PubSubManager,
+  createPubSubManager
+});

package/lib/pub-sub-manager/types.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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.
+ */
+export interface PubSubManagerOptions {
+    channelPrefix?: string;
+}
+export interface PubSubManagerPublishOptions {
+    skipSelf?: boolean;
+    onlySelf?: boolean;
+}
+export interface PubSubManagerSubscribeOptions {
+    debounce?: number;
+}
+export type PubSubCallback = (message: any) => Promise<void>;
+export interface IPubSubAdapter {
+    isConnected(): Promise<boolean> | boolean;
+    connect(): Promise<any>;
+    close(): Promise<any>;
+    subscribe(channel: string, callback: PubSubCallback): Promise<any>;
+    unsubscribe(channel: string, callback: PubSubCallback): Promise<any>;
+    publish(channel: string, message: string): Promise<any>;
+}

package/lib/pub-sub-manager/types.js

@@ -0,0 +1,24 @@
+/**
+ * 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 __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 types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/lib/sync-message-manager.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { Transactionable } from '@nocobase/database';
+import Application from './application';
+import { PubSubCallback, PubSubManager, PubSubManagerPublishOptions } from './pub-sub-manager';
+export declare class SyncMessageManager {
+    protected app: Application;
+    protected options: any;
+    protected versionManager: SyncMessageVersionManager;
+    protected pubSubManager: PubSubManager;
+    constructor(app: Application, options?: any);
+    get debounce(): any;
+    publish(channel: string, message: any, options?: PubSubManagerPublishOptions & Transactionable): Promise<any>;
+    subscribe(channel: string, callback: PubSubCallback): Promise<void>;
+    unsubscribe(channel: string, callback: PubSubCallback): Promise<any>;
+    sync(): Promise<void>;
+}
+export declare class SyncMessageVersionManager {
+}

package/lib/sync-message-manager.js

@@ -0,0 +1,105 @@
+/**
+ * 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 sync_message_manager_exports = {};
+__export(sync_message_manager_exports, {
+  SyncMessageManager: () => SyncMessageManager,
+  SyncMessageVersionManager: () => SyncMessageVersionManager
+});
+module.exports = __toCommonJS(sync_message_manager_exports);
+const _SyncMessageManager = class _SyncMessageManager {
+  constructor(app, options = {}) {
+    this.app = app;
+    this.options = options;
+    this.versionManager = new SyncMessageVersionManager();
+    app.on("beforeLoadPlugin", async (plugin) => {
+      if (!plugin.name) {
+        return;
+      }
+      await this.subscribe(plugin.name, plugin.handleSyncMessage.bind(plugin));
+    });
+  }
+  versionManager;
+  pubSubManager;
+  get debounce() {
+    return this.options.debounce || 1e3;
+  }
+  async publish(channel, message, options) {
+    const { transaction, ...others } = options || {};
+    if (transaction) {
+      return await new Promise((resolve, reject) => {
+        const timer = setTimeout(() => {
+          reject(
+            new Error(
+              `Publish message to ${channel} timeout, channel: ${channel}, message: ${JSON.stringify(message)}`
+            )
+          );
+        }, 5e4);
+        transaction.afterCommit(async () => {
+          try {
+            const r = await this.app.pubSubManager.publish(`${this.app.name}.sync.${channel}`, message, {
+              skipSelf: true,
+              ...others
+            });
+            resolve(r);
+          } catch (error) {
+            reject(error);
+          } finally {
+            clearTimeout(timer);
+          }
+        });
+      });
+    } else {
+      return await this.app.pubSubManager.publish(`${this.app.name}.sync.${channel}`, message, {
+        skipSelf: true,
+        ...options
+      });
+    }
+  }
+  async subscribe(channel, callback) {
+    return await this.app.pubSubManager.subscribe(`${this.app.name}.sync.${channel}`, callback, {
+      debounce: this.debounce
+    });
+  }
+  async unsubscribe(channel, callback) {
+    return this.app.pubSubManager.unsubscribe(`${this.app.name}.sync.${channel}`, callback);
+  }
+  async sync() {
+  }
+};
+__name(_SyncMessageManager, "SyncMessageManager");
+let SyncMessageManager = _SyncMessageManager;
+const _SyncMessageVersionManager = class _SyncMessageVersionManager {
+  // TODO
+};
+__name(_SyncMessageVersionManager, "SyncMessageVersionManager");
+let SyncMessageVersionManager = _SyncMessageVersionManager;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SyncMessageManager,
+  SyncMessageVersionManager
+});

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nocobase/server",
-    "version": "1.4.0-alpha.9",
+    "version": "1.5.0-alpha.1",
     "main": "lib/index.js",
     "types": "./lib/index.d.ts",
     "license": "AGPL-3.0",
@@ -10,22 +10,23 @@
         "@koa/cors": "^3.1.0",
         "@koa/multer": "^3.0.2",
         "@koa/router": "^9.4.0",
-        "@nocobase/acl": "1.4.0-alpha.9",
-        "@nocobase/actions": "1.4.0-alpha.9",
-        "@nocobase/auth": "1.4.0-alpha.9",
-        "@nocobase/cache": "1.4.0-alpha.9",
-        "@nocobase/data-source-manager": "1.4.0-alpha.9",
-        "@nocobase/database": "1.4.0-alpha.9",
-        "@nocobase/evaluators": "1.4.0-alpha.9",
-        "@nocobase/logger": "1.4.0-alpha.9",
-        "@nocobase/resourcer": "1.4.0-alpha.9",
-        "@nocobase/sdk": "1.4.0-alpha.9",
-        "@nocobase/telemetry": "1.4.0-alpha.9",
-        "@nocobase/utils": "1.4.0-alpha.9",
+        "@nocobase/acl": "1.5.0-alpha.1",
+        "@nocobase/actions": "1.5.0-alpha.1",
+        "@nocobase/auth": "1.5.0-alpha.1",
+        "@nocobase/cache": "1.5.0-alpha.1",
+        "@nocobase/data-source-manager": "1.5.0-alpha.1",
+        "@nocobase/database": "1.5.0-alpha.1",
+        "@nocobase/evaluators": "1.5.0-alpha.1",
+        "@nocobase/logger": "1.5.0-alpha.1",
+        "@nocobase/resourcer": "1.5.0-alpha.1",
+        "@nocobase/sdk": "1.5.0-alpha.1",
+        "@nocobase/telemetry": "1.5.0-alpha.1",
+        "@nocobase/utils": "1.5.0-alpha.1",
         "@types/decompress": "4.2.7",
         "@types/ini": "^1.3.31",
         "@types/koa-send": "^4.1.3",
         "@types/multer": "^1.4.5",
+        "async-mutex": "^0.5.0",
         "axios": "^1.7.0",
         "chalk": "^4.1.1",
         "commander": "^9.2.0",
@@ -54,5 +55,5 @@
         "@types/serve-handler": "^6.1.1",
         "@types/ws": "^8.5.5"
     },
-    "gitHead": "af26b630a5b590f986e21231f0db289c65dd7f70"
+    "gitHead": "abe58fad69534a13c2502a47da86425a597c3ba3"
 }

package/lib/sync-manager.d.ts

@@ -1,46 +0,0 @@
-/**
- * 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 EventEmitter from 'node:events';
-import Application from './application';
-export declare abstract class SyncAdapter extends EventEmitter {
-    abstract get ready(): boolean;
-    abstract publish(data: SyncMessage): void | Promise<void>;
-}
-export type SyncMessageData = Record<string, string>;
-export type SyncEventCallback = (message: SyncMessageData) => void;
-export type SyncMessage = {
-    namespace: string;
-    nodeId: string;
-    appName: string;
-} & SyncMessageData;
-/**
- * @experimental
- */
-export declare class SyncManager {
-    private app;
-    private nodeId;
-    private eventEmitter;
-    private adapter;
-    private incomingBuffer;
-    private outgoingBuffer;
-    private flushTimer;
-    get available(): boolean;
-    private onMessage;
-    private onSync;
-    private onReady;
-    constructor(app: Application);
-    init(adapter: SyncAdapter): void;
-    subscribe(namespace: string, callback: SyncEventCallback): void;
-    unsubscribe(namespace: string, callback: SyncEventCallback): void;
-    /**
-     * Publish a message to the sync manager
-     */
-    publish(namespace: string, data?: SyncMessageData): void | Promise<void>;
-}

package/lib/sync-manager.js

@@ -1,137 +0,0 @@
-/**
- * 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 __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 __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 __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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var sync_manager_exports = {};
-__export(sync_manager_exports, {
-  SyncAdapter: () => SyncAdapter,
-  SyncManager: () => SyncManager
-});
-module.exports = __toCommonJS(sync_manager_exports);
-var import_node_crypto = require("node:crypto");
-var import_node_events = __toESM(require("node:events"));
-var import_lodash = require("lodash");
-const _SyncAdapter = class _SyncAdapter extends import_node_events.default {
-};
-__name(_SyncAdapter, "SyncAdapter");
-let SyncAdapter = _SyncAdapter;
-const _SyncManager = class _SyncManager {
-  constructor(app) {
-    this.app = app;
-    this.nodeId = `${process.env.NODE_ID || (0, import_node_crypto.randomUUID)()}-${process.pid}`;
-  }
-  nodeId;
-  eventEmitter = new import_node_events.default();
-  adapter = null;
-  incomingBuffer = [];
-  outgoingBuffer = [];
-  flushTimer = null;
-  get available() {
-    return this.adapter ? this.adapter.ready : false;
-  }
-  onMessage(namespace, message) {
-    this.app.logger.info(`emit sync event in namespace ${namespace}`);
-    this.eventEmitter.emit(namespace, message);
-    const pluginInstance = this.app.pm.get(namespace);
-    pluginInstance.onSync(message);
-  }
-  onSync = /* @__PURE__ */ __name((messages) => {
-    this.app.logger.info("sync messages received, save into buffer:", messages);
-    if (this.flushTimer) {
-      clearTimeout(this.flushTimer);
-      this.flushTimer = null;
-    }
-    this.incomingBuffer = (0, import_lodash.uniqWith)(
-      this.incomingBuffer.concat(
-        messages.filter((item) => item.nodeId !== this.nodeId && item.appName === this.app.name).map(({ nodeId, appName, ...message }) => message)
-      ),
-      import_lodash.isEqual
-    );
-    this.flushTimer = setTimeout(() => {
-      this.incomingBuffer.forEach(({ namespace, ...message }) => {
-        this.onMessage(namespace, message);
-      });
-      this.incomingBuffer = [];
-    }, 1e3);
-  }, "onSync");
-  onReady = /* @__PURE__ */ __name(() => {
-    while (this.outgoingBuffer.length) {
-      const [namespace, data] = this.outgoingBuffer.shift();
-      this.publish(namespace, data);
-    }
-  }, "onReady");
-  init(adapter) {
-    if (this.adapter) {
-      throw new Error("sync adapter is already exists");
-    }
-    if (!adapter) {
-      return;
-    }
-    this.adapter = adapter;
-    this.adapter.on("message", this.onSync);
-    this.adapter.on("ready", this.onReady);
-  }
-  subscribe(namespace, callback) {
-    this.eventEmitter.on(namespace, callback);
-  }
-  unsubscribe(namespace, callback) {
-    this.eventEmitter.off(namespace, callback);
-  }
-  /**
-   * Publish a message to the sync manager
-   */
-  publish(namespace, data = {}) {
-    if (!this.adapter) {
-      return;
-    }
-    if (!this.adapter.ready) {
-      this.outgoingBuffer.push([namespace, data]);
-      this.app.logger.warn(`sync adapter is not ready for now, message will be send when it is ready`);
-      return;
-    }
-    this.app.logger.info(`publishing sync message from #${this.nodeId} (${this.app.name}) in namespace ${namespace}:`, {
-      data
-    });
-    return this.adapter.publish({ ...data, nodeId: this.nodeId, appName: this.app.name, namespace });
-  }
-};
-__name(_SyncManager, "SyncManager");
-let SyncManager = _SyncManager;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  SyncAdapter,
-  SyncManager
-});