@nocobase/server 1.2.14-alpha → 1.3.0-alpha.20240710141659

package/lib/application.d.ts

@@ -28,6 +28,7 @@ import { Locale } from './locale';
 import { Plugin } from './plugin';
 import { InstallOptions, PluginManager } from './plugin-manager';
 import { DataSourceManager, SequelizeDataSource } from '@nocobase/data-source-manager';
+import { SyncManager } from './sync-manager';
 export type PluginType = string | typeof Plugin;
 export type PluginConfiguration = PluginType | [PluginType, any];
 export interface ResourceManagerOptions {
@@ -149,7 +150,7 @@ export declare class Application<StateT = DefaultState, ContextT = DefaultContex
     perfHistograms: Map<string, RecordableHistogram>;
     protected plugins: Map<string, Plugin<any>>;
     protected _appSupervisor: AppSupervisor;
-    protected _started: boolean;
+    protected _started: Date | null;
     private _authenticated;
     private _maintaining;
     private _maintainingCommandStatus;
@@ -158,10 +159,15 @@ export declare class Application<StateT = DefaultState, ContextT = DefaultContex
     /**
      * @internal
      */
+    syncManager: SyncManager;
     requestLogger: Logger;
     private sqlLogger;
     protected _logger: SystemLogger;
     constructor(options: ApplicationOptions);
+    /**
+     * @experimental
+     */
+    get started(): Date;
     get logger(): SystemLogger;
     get log(): SystemLogger;
     protected _loaded: boolean;

package/lib/application.js

@@ -72,6 +72,7 @@ var import_validate_filter_params = __toESM(require("./middlewares/validate-filt
 var import_path2 = __toESM(require("path"));
 var import_middlewares = require("./middlewares");
 var import_data_template = require("./middlewares/data-template");
+var import_sync_manager = require("./sync-manager");
 const _Application = class _Application extends import_koa.default {
   constructor(options) {
     super();
@@ -107,7 +108,7 @@ const _Application = class _Application extends import_koa.default {
   perfHistograms = /* @__PURE__ */ new Map();
   plugins = /* @__PURE__ */ new Map();
   _appSupervisor = import_app_supervisor.AppSupervisor.getInstance();
-  _started;
+  _started = null;
   _authenticated = false;
   _maintaining = false;
   _maintainingCommandStatus;
@@ -116,9 +117,16 @@ const _Application = class _Application extends import_koa.default {
   /**
    * @internal
    */
+  syncManager;
   requestLogger;
   sqlLogger;
   _logger;
+  /**
+   * @experimental
+   */
+  get started() {
+    return this._started;
+  }
   get logger() {
     return this._logger;
   }
@@ -536,7 +544,7 @@ const _Application = class _Application extends import_koa.default {
     if (this._started) {
       return;
     }
-    this._started = true;
+    this._started = /* @__PURE__ */ new Date();
     if (options.checkInstall && !await this.isInstalled()) {
       throw new import_application_not_install.ApplicationNotInstall(
         `Application ${this.name} is not installed, Please run 'yarn nocobase install' command first`
@@ -564,7 +572,7 @@ const _Application = class _Application extends import_koa.default {
     });
   }
   async isStarted() {
-    return this._started;
+    return Boolean(this._started);
   }
   /**
    * @internal
@@ -581,7 +589,7 @@ const _Application = class _Application extends import_koa.default {
       return;
     }
     this.log.info("restarting...");
-    this._started = false;
+    this._started = null;
     await this.emitAsync("beforeStop");
     await this.reload(options);
     await this.start(options);
@@ -622,7 +630,7 @@ const _Application = class _Application extends import_koa.default {
     await this.emitAsync("afterStop", this, options);
     this.stopped = true;
     log.info(`app has stopped`, { method: "stop" });
-    this._started = false;
+    this._started = null;
   }
   async destroy(options = {}) {
     this.log.debug("start destroy app", { method: "destory" });
@@ -791,6 +799,7 @@ 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.context.db = this.db;
     this.context.resourcer = this.resourceManager;
     this.context.resourceManager = this.resourceManager;

package/lib/commands/start.js

@@ -62,13 +62,13 @@ var start_default = /* @__PURE__ */ __name((app) => {
       } else {
         await app.install();
       }
-      app["_started"] = true;
+      app["_started"] = /* @__PURE__ */ new Date();
       await app.restart();
       app.log.info("app has been started");
       return;
     }
     if (!await app.isInstalled()) {
-      app["_started"] = true;
+      app["_started"] = /* @__PURE__ */ new Date();
       throw new import_application_not_install.ApplicationNotInstall(
         `Application ${app.name} is not installed, Please run 'yarn nocobase install' command first`
       );

package/lib/index.d.ts

@@ -14,4 +14,5 @@ export * from './plugin';
 export * from './plugin-manager';
 export * from './gateway';
 export * from './app-supervisor';
+export * from './sync-manager';
 export declare const OFFICIAL_PLUGIN_PREFIX = "@nocobase/plugin-";

package/lib/index.js

@@ -50,6 +50,7 @@ __reExport(src_exports, require("./plugin"), module.exports);
 __reExport(src_exports, require("./plugin-manager"), module.exports);
 __reExport(src_exports, require("./gateway"), module.exports);
 __reExport(src_exports, require("./app-supervisor"), module.exports);
+__reExport(src_exports, require("./sync-manager"), module.exports);
 const OFFICIAL_PLUGIN_PREFIX = "@nocobase/plugin-";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -60,5 +61,6 @@ const OFFICIAL_PLUGIN_PREFIX = "@nocobase/plugin-";
   ...require("./plugin"),
   ...require("./plugin-manager"),
   ...require("./gateway"),
-  ...require("./app-supervisor")
+  ...require("./app-supervisor"),
+  ...require("./sync-manager")
 });

package/lib/sync-manager.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 nodeId;
+    private app;
+    private eventEmitter;
+    private adapter;
+    private incomingBuffer;
+    private outgoingBuffer;
+    private flushTimer;
+    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): any;
+}

package/lib/sync-manager.js

@@ -0,0 +1,129 @@
+/**
+ * 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 {
+  nodeId;
+  app;
+  eventEmitter = new import_node_events.default();
+  adapter = null;
+  incomingBuffer = [];
+  outgoingBuffer = [];
+  flushTimer = null;
+  onSync = (messages) => {
+    this.app.logger.info("sync messages received 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.app.logger.info(`emit sync event in namespace ${namespace}`);
+        this.eventEmitter.emit(namespace, message);
+      });
+    }, 1e3);
+  };
+  onReady = () => {
+    while (this.outgoingBuffer.length) {
+      const [namespace, data] = this.outgoingBuffer.shift();
+      this.publish(namespace, data);
+    }
+  };
+  constructor(app) {
+    this.app = app;
+    this.nodeId = `${process.env.NODE_ID || (0, import_node_crypto.randomUUID)()}-${process.pid}`;
+  }
+  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
+});

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nocobase/server",
-    "version": "1.2.14-alpha",
+    "version": "1.3.0-alpha.20240710141659",
     "main": "lib/index.js",
     "types": "./lib/index.d.ts",
     "license": "AGPL-3.0",
@@ -10,18 +10,18 @@
         "@koa/cors": "^3.1.0",
         "@koa/multer": "^3.0.2",
         "@koa/router": "^9.4.0",
-        "@nocobase/acl": "1.2.14-alpha",
-        "@nocobase/actions": "1.2.14-alpha",
-        "@nocobase/auth": "1.2.14-alpha",
-        "@nocobase/cache": "1.2.14-alpha",
-        "@nocobase/data-source-manager": "1.2.14-alpha",
-        "@nocobase/database": "1.2.14-alpha",
-        "@nocobase/evaluators": "1.2.14-alpha",
-        "@nocobase/logger": "1.2.14-alpha",
-        "@nocobase/resourcer": "1.2.14-alpha",
-        "@nocobase/sdk": "1.2.14-alpha",
-        "@nocobase/telemetry": "1.2.14-alpha",
-        "@nocobase/utils": "1.2.14-alpha",
+        "@nocobase/acl": "1.3.0-alpha.20240710141659",
+        "@nocobase/actions": "1.3.0-alpha.20240710141659",
+        "@nocobase/auth": "1.3.0-alpha.20240710141659",
+        "@nocobase/cache": "1.3.0-alpha.20240710141659",
+        "@nocobase/data-source-manager": "1.3.0-alpha.20240710141659",
+        "@nocobase/database": "1.3.0-alpha.20240710141659",
+        "@nocobase/evaluators": "1.3.0-alpha.20240710141659",
+        "@nocobase/logger": "1.3.0-alpha.20240710141659",
+        "@nocobase/resourcer": "1.3.0-alpha.20240710141659",
+        "@nocobase/sdk": "1.3.0-alpha.20240710141659",
+        "@nocobase/telemetry": "1.3.0-alpha.20240710141659",
+        "@nocobase/utils": "1.3.0-alpha.20240710141659",
         "@types/decompress": "4.2.4",
         "@types/ini": "^1.3.31",
         "@types/koa-send": "^4.1.3",
@@ -54,5 +54,5 @@
         "@types/serve-handler": "^6.1.1",
         "@types/ws": "^8.5.5"
     },
-    "gitHead": "717c71eee8cec8d230f1856759d97d6a843f8be6"
+    "gitHead": "cb8b234443034da0dfa57dd5d6cca1f3b3db6f08"
 }