@nocobase/plugin-notification-manager 2.1.0-beta.33 → 2.1.0-beta.34

package/dist/server/manager.d.ts

@@ -9,29 +9,39 @@
 import { Registry } from '@nocobase/utils';
 import PluginNotificationManagerServer from './plugin';
 import type { NotificationQueueMessage, NotificationChannelConstructor, RegisterServerTypeFnParams, ReceiversOptions, SendOptions, SendUserOptions, WriteLogOptions } from './types';
-import { Transactionable } from '@nocobase/database';
 export declare class NotificationManager implements NotificationManager {
     private static readonly SLOW_SEND_THRESHOLD_MS;
     private plugin;
     channelTypes: Registry<{
         Channel: NotificationChannelConstructor;
+        useQueue: boolean;
     }>;
     constructor({ plugin }: {
         plugin: PluginNotificationManagerServer;
     });
-    registerType({ type, Channel }: RegisterServerTypeFnParams): void;
-    createSendingRecord: (options: WriteLogOptions & Transactionable) => Promise<any>;
+    registerType({ type, Channel, useQueue }: RegisterServerTypeFnParams): void;
+    createSendingRecord: (options: WriteLogOptions) => Promise<import("@nocobase/database").Model<any, any>>;
     private toQueueMessage;
     private getQueuedResult;
+    private getDirectResult;
+    private getDeferredResult;
+    private shouldUseQueue;
     private enqueue;
+    private dispatchAfterCommit;
     findChannel(name: string): Promise<any>;
     private getReceiverMeta;
     send(params: SendOptions): Promise<{
-        status: "success";
+        status: "success" | "failure";
+        reason: string;
         triggerFrom: string;
         channelName: string;
         receivers: ReceiversOptions;
         queued: boolean;
+    } | {
+        status: "success";
+        triggerFrom: string;
+        channelName: string;
+        receivers: ReceiversOptions;
     } | {
         status: "failure";
         reason: string;
@@ -41,11 +51,17 @@ export declare class NotificationManager implements NotificationManager {
     }>;
     sendNow(params: NotificationQueueMessage): Promise<any>;
     sendToUsers(options: SendUserOptions): Promise<({
-        status: "success";
+        status: "success" | "failure";
+        reason: string;
         triggerFrom: string;
         channelName: string;
         receivers: ReceiversOptions;
         queued: boolean;
+    } | {
+        status: "success";
+        triggerFrom: string;
+        channelName: string;
+        receivers: ReceiversOptions;
     } | {
         status: "failure";
         reason: string;

package/dist/server/manager.js

@@ -31,6 +31,7 @@ __export(manager_exports, {
 });
 module.exports = __toCommonJS(manager_exports);
 var import_utils = require("@nocobase/utils");
+var import_uuid = require("uuid");
 var import_constant = require("../constant");
 var import_compile = require("./utils/compile");
 class NotificationManager {
@@ -40,13 +41,21 @@ class NotificationManager {
   constructor({ plugin }) {
     this.plugin = plugin;
   }
-  registerType({ type, Channel }) {
-    this.channelTypes.register(type, { Channel });
+  registerType({ type, Channel, useQueue = true }) {
+    this.channelTypes.register(type, { Channel, useQueue });
   }
   createSendingRecord = async (options) => {
-    const logsRepo = this.plugin.app.db.getRepository(import_constant.COLLECTION_NAME.logs);
-    const { transaction, ...values } = options;
-    return logsRepo.create({ values, transaction });
+    const LogsModel = this.plugin.app.db.getModel(import_constant.COLLECTION_NAME.logs);
+    return LogsModel.create(
+      {
+        id: (0, import_uuid.v4)(),
+        ...options
+      },
+      {
+        hooks: false,
+        validate: false
+      }
+    );
   };
   toQueueMessage(params) {
     const { transaction, ...message } = params;
@@ -61,9 +70,43 @@ class NotificationManager {
       queued: true
     };
   }
+  getDirectResult(params, result) {
+    return {
+      status: result.status,
+      reason: result.reason,
+      triggerFrom: params.triggerFrom,
+      channelName: params.channelName,
+      receivers: params.receivers,
+      queued: false
+    };
+  }
+  getDeferredResult(params) {
+    return {
+      status: "success",
+      triggerFrom: params.triggerFrom,
+      channelName: params.channelName,
+      receivers: params.receivers
+    };
+  }
+  async shouldUseQueue(channelName) {
+    const channel = await this.findChannel(channelName);
+    if (!channel) {
+      return true;
+    }
+    const channelType = this.channelTypes.get(channel.notificationType);
+    return (channelType == null ? void 0 : channelType.useQueue) ?? true;
+  }
   async enqueue(message) {
     await this.plugin.app.eventQueue.publish(this.plugin.sendQueueChannel, message);
   }
+  async dispatchAfterCommit(message) {
+    const useQueue = await this.shouldUseQueue(message.channelName);
+    if (useQueue) {
+      await this.enqueue(message);
+      return;
+    }
+    await this.sendNow(message);
+  }
   async findChannel(name) {
     return await this.plugin.getChannel(name);
   }
@@ -86,15 +129,20 @@ class NotificationManager {
     const transaction = params.transaction;
     if (transaction == null ? void 0 : transaction.afterCommit) {
       transaction.afterCommit(() => {
-        void this.enqueue(queueMessage).catch((error) => {
-          this.plugin.logger.error("notification queue publish failed after transaction committed", {
+        return this.dispatchAfterCommit(queueMessage).catch((error) => {
+          this.plugin.logger.error("notification dispatch failed after transaction committed", {
             channelName: params.channelName,
             triggerFrom: params.triggerFrom,
             reason: error instanceof Error ? `${error.name}: ${error.message}` : JSON.stringify(error)
           });
         });
       });
-      return this.getQueuedResult(params);
+      return this.getDeferredResult(params);
+    }
+    const useQueue = await this.shouldUseQueue(params.channelName);
+    if (!useQueue) {
+      const result = await this.sendNow(queueMessage);
+      return this.getDirectResult(params, result);
     }
     try {
       await this.enqueue(queueMessage);

package/dist/server/plugin.d.ts

@@ -23,14 +23,21 @@ export declare class PluginNotificationManagerServer extends Plugin {
     getChannel(name: string): Promise<any>;
     get channelTypes(): import("@nocobase/utils").Registry<{
         Channel: import("./types").NotificationChannelConstructor;
+        useQueue: boolean;
     }>;
     registerChannelType(params: RegisterServerTypeFnParams): void;
     send(options: SendOptions): Promise<{
-        status: "success";
+        status: "success" | "failure";
+        reason: string;
         triggerFrom: string;
         channelName: string;
         receivers: import("./types").ReceiversOptions;
         queued: boolean;
+    } | {
+        status: "success";
+        triggerFrom: string;
+        channelName: string;
+        receivers: import("./types").ReceiversOptions;
     } | {
         status: "failure";
         reason: string;
@@ -40,11 +47,17 @@ export declare class PluginNotificationManagerServer extends Plugin {
     }>;
     sendNow(options: SendOptions): Promise<any>;
     sendToUsers(options: SendUserOptions): Promise<({
-        status: "success";
+        status: "success" | "failure";
+        reason: string;
         triggerFrom: string;
         channelName: string;
         receivers: import("./types").ReceiversOptions;
         queued: boolean;
+    } | {
+        status: "success";
+        triggerFrom: string;
+        channelName: string;
+        receivers: import("./types").ReceiversOptions;
     } | {
         status: "failure";
         reason: string;

package/dist/server/types.d.ts

@@ -66,4 +66,5 @@ export type NotificationChannelConstructor = new (app: Application) => BaseNotif
 export type RegisterServerTypeFnParams = {
     type: string;
     Channel: NotificationChannelConstructor;
+    useQueue?: boolean;
 };

package/package.json

@@ -6,7 +6,7 @@
   "description.ru-RU": "Предоставляет единый сервис управления, включающий конфигурирование каналов, логирование и другие функции, поддерживает настройку различных каналов уведомлений, включая внутренние сообщения и электронную почту.",
   "displayName.zh-CN": "通知管理",
   "description.zh-CN": "提供统一的管理服务，涵盖渠道配置、日志记录等功能，支持多种通知渠道的配置，包括站内信和电子邮件等。",
-  "version": "2.1.0-beta.33",
+  "version": "2.1.0-beta.34",
   "homepage": "https://docs.nocobase.com/handbook/notification-manager",
   "homepage.ru-RU": "https://docs-ru.nocobase.com/handbook/notification-manager",
   "homepage.zh-CN": "https://docs-cn.nocobase.com/handbook/notification-manager",
@@ -35,5 +35,5 @@
     "Notification"
   ],
   "license": "Apache-2.0",
-  "gitHead": "4815c394e80a264fa8ed619246280923c47aeb72"
+  "gitHead": "ca804833299c547f8d49f8d58f73273a4bfcd03c"
 }