@nocobase/plugin-notification-in-app-message 2.1.0-beta.9 → 2.1.0

package/dist/server/InAppNotificationChannel.js

@@ -40,11 +40,103 @@ __export(InAppNotificationChannel_exports, {
 });
 module.exports = __toCommonJS(InAppNotificationChannel_exports);
 var import_plugin_notification_manager = require("@nocobase/plugin-notification-manager");
+var import_uuid = require("uuid");
 var import_types2 = require("../types");
 var import_parseUserSelectionConf = require("./parseUserSelectionConf");
 var import_defineMyInAppMessages = __toESM(require("./defineMyInAppMessages"));
 var import_defineMyInAppChannels = __toESM(require("./defineMyInAppChannels"));
 class InAppNotificationChannel extends import_plugin_notification_manager.BaseNotificationChannel {
+  static SLOW_SEND_THRESHOLD_MS = 200;
+  static MESSAGE_BATCH_SIZE = 100;
+  getMessagePayload(message) {
+    return typeof (message == null ? void 0 : message.toJSON) === "function" ? message.toJSON() : message;
+  }
+  emitMessageEventsAsync(type, messages) {
+    setImmediate(() => {
+      try {
+        const startedAt = Date.now();
+        this.emitMessageEvents(type, messages);
+        const elapsed = Date.now() - startedAt;
+        if (elapsed >= InAppNotificationChannel.SLOW_SEND_THRESHOLD_MS) {
+          this.app.logger.warn("in-app notification websocket dispatch is slow", {
+            type,
+            count: messages.length,
+            elapsed
+          });
+        }
+      } catch (error) {
+        this.app.logger.error(`failed to emit in-app message events: ${error.message}`, {
+          error,
+          type,
+          count: messages.length
+        });
+      }
+    });
+  }
+  scheduleMessageEvents(type, messages, transaction) {
+    if (!messages.length) {
+      return;
+    }
+    if (transaction == null ? void 0 : transaction.afterCommit) {
+      transaction.afterCommit(() => {
+        this.emitMessageEventsAsync(type, messages);
+      });
+      return;
+    }
+    this.emitMessageEventsAsync(type, messages);
+  }
+  emitMessageEvents(type, messages) {
+    for (const message of messages) {
+      this.app.emit("ws:sendToUser", {
+        userId: message.userId,
+        message: {
+          type: `in-app-message:${type}`,
+          payload: message
+        }
+      });
+    }
+  }
+  async persistMessagesInBatches(options) {
+    const { userIds, title, content, channelName, receiveTimestamp, messageOptions, transaction } = options;
+    const MessageModel = this.app.db.getModel(import_types2.InAppMessagesDefinition.name);
+    const persist = async (activeTransaction) => {
+      let persistedCount = 0;
+      for (let index = 0; index < userIds.length; index += InAppNotificationChannel.MESSAGE_BATCH_SIZE) {
+        const batchUserIds = userIds.slice(index, index + InAppNotificationChannel.MESSAGE_BATCH_SIZE);
+        const messageBatch = batchUserIds.map((userId) => ({
+          id: (0, import_uuid.v4)(),
+          title,
+          content,
+          status: "unread",
+          userId,
+          channelName,
+          receiveTimestamp,
+          options: messageOptions
+        }));
+        await MessageModel.bulkCreate(messageBatch, {
+          hooks: false,
+          transaction: activeTransaction,
+          validate: false,
+          returning: false
+        });
+        persistedCount += messageBatch.length;
+        this.scheduleMessageEvents("created", messageBatch, activeTransaction);
+      }
+      return persistedCount;
+    };
+    if (transaction) {
+      return persist(transaction);
+    }
+    const internalTransaction = await this.app.db.sequelize.transaction();
+    try {
+      const persistedCount = await persist(internalTransaction);
+      await internalTransaction.commit();
+      return persistedCount;
+    } catch (error) {
+      await internalTransaction.rollback();
+      throw error;
+    }
+  }
   async load() {
     this.app.db.on(`${import_types2.InAppMessagesDefinition.name}.afterCreate`, this.onMessageCreated);
     this.app.db.on(`${import_types2.InAppMessagesDefinition.name}.afterBulkCreate`, this.onMessageCreated);
@@ -53,53 +145,53 @@ class InAppNotificationChannel extends import_plugin_notification_manager.BaseNo
     this.defineActions();
   }
   onMessageCreated = async (model, options) => {
-    const models = Array.isArray(model) ? model : [model];
-    for (const m of models) {
-      const userId = m.userId;
-      this.app.emit("ws:sendToUser", {
-        userId,
-        message: {
-          type: "in-app-message:created",
-          payload: m.toJSON()
-        }
-      });
-    }
+    const messages = (Array.isArray(model) ? model : [model]).map((item) => this.getMessagePayload(item));
+    this.scheduleMessageEvents("created", messages, options == null ? void 0 : options.transaction);
   };
   onMessageUpdated = async (model, options) => {
-    const models = Array.isArray(model) ? model : [model];
-    for (const m of models) {
-      const userId = m.userId;
-      this.app.emit("ws:sendToUser", {
-        userId,
-        message: {
-          type: "in-app-message:updated",
-          payload: m.toJSON()
-        }
-      });
-    }
+    const messages = (Array.isArray(model) ? model : [model]).map((item) => this.getMessagePayload(item));
+    this.scheduleMessageEvents("updated", messages, options == null ? void 0 : options.transaction);
   };
   send = async (params) => {
-    const { channel, message, receivers } = params;
+    const startedAt = Date.now();
+    const { channel, message, receivers, transaction } = params;
     let userIds;
     const { content, title, options = {} } = message;
     const userRepo = this.app.db.getRepository("users");
+    const resolveReceiversStartedAt = Date.now();
     if ((receivers == null ? void 0 : receivers.type) === "userId") {
       userIds = receivers.value;
     } else {
-      userIds = (await (0, import_parseUserSelectionConf.parseUserSelectionConf)(message.receivers, userRepo)).map((i) => parseInt(i));
+      userIds = (await (0, import_parseUserSelectionConf.parseUserSelectionConf)(message.receivers, userRepo, { transaction })).map((i) => parseInt(i));
     }
-    const MessageModel = this.app.db.getModel(import_types2.InAppMessagesDefinition.name);
-    await MessageModel.bulkCreate(
-      userIds.map((userId) => ({
-        title,
-        content,
-        status: "unread",
-        userId,
+    const resolveReceiversMs = Date.now() - resolveReceiversStartedAt;
+    const uniqueUserIds = [...new Set(userIds)];
+    if (!uniqueUserIds.length) {
+      return { status: "success", message };
+    }
+    const receiveTimestamp = Date.now();
+    const persistStartedAt = Date.now();
+    const persistedCount = await this.persistMessagesInBatches({
+      userIds: uniqueUserIds,
+      title,
+      content,
+      channelName: channel.name,
+      receiveTimestamp,
+      messageOptions: options,
+      transaction
+    });
+    const persistMs = Date.now() - persistStartedAt;
+    const totalMs = Date.now() - startedAt;
+    if (totalMs >= InAppNotificationChannel.SLOW_SEND_THRESHOLD_MS) {
+      this.app.logger.warn("in-app notification send is slow", {
         channelName: channel.name,
-        receiveTimestamp: Date.now(),
-        options
-      }))
-    );
+        userCount: persistedCount,
+        batchSize: InAppNotificationChannel.MESSAGE_BATCH_SIZE,
+        resolveReceiversMs,
+        persistMs,
+        totalMs
+      });
+    }
     return { status: "success", message };
   };
   defineActions() {
@@ -107,6 +199,6 @@ class InAppNotificationChannel extends import_plugin_notification_manager.BaseNo
     (0, import_defineMyInAppChannels.default)(this.app);
     this.app.acl.allow("myInAppMessages", "*", "loggedIn");
     this.app.acl.allow("myInAppChannels", "*", "loggedIn");
-    this.app.acl.allow("notificationInAppMessages", "*", "loggedIn");
+    this.app.acl.allow("notificationInAppMessages", "updateMyOwn", "loggedIn");
   }
 }

package/dist/server/defineMyInAppChannels.js

@@ -32,14 +32,38 @@ module.exports = __toCommonJS(defineMyInAppChannels_exports);
 var import_sequelize = require("sequelize");
 var import_plugin_notification_manager = require("@nocobase/plugin-notification-manager");
 var import_types = require("../types");
+function parseLatestMsgReceiveTimestampLt(filter) {
+  const latestMsgReceiveTimestamp = typeof filter === "object" && filter !== null ? filter.latestMsgReceiveTimestamp : null;
+  if (typeof latestMsgReceiveTimestamp !== "object" || latestMsgReceiveTimestamp === null || !Object.prototype.hasOwnProperty.call(latestMsgReceiveTimestamp, "$lt")) {
+    return null;
+  }
+  const value = latestMsgReceiveTimestamp.$lt;
+  if (typeof value === "string" && value.trim() === "") {
+    throw new Error("Invalid latest message receive timestamp filter");
+  }
+  if (typeof value !== "number" && typeof value !== "string") {
+    throw new Error("Invalid latest message receive timestamp filter");
+  }
+  const timestamp = Number(value);
+  if (!Number.isFinite(timestamp)) {
+    throw new Error("Invalid latest message receive timestamp filter");
+  }
+  return timestamp;
+}
 function defineMyInAppChannels(app) {
   app.resourceManager.define({
     name: "myInAppChannels",
     actions: {
       list: {
         handler: async (ctx) => {
-          var _a, _b;
+          var _a;
           const { filter = {}, limit = 30 } = ((_a = ctx.action) == null ? void 0 : _a.params) ?? {};
+          let latestMsgReceiveTimestampLt;
+          try {
+            latestMsgReceiveTimestampLt = parseLatestMsgReceiveTimestampLt(filter);
+          } catch (error) {
+            return ctx.throw(400, error.message);
+          }
           const messagesCollection = app.db.getCollection(import_types.InAppMessagesDefinition.name);
           const messagesTableName = messagesCollection.getRealTableName(true);
           const channelsCollection = app.db.getCollection(import_plugin_notification_manager.ChannelsCollectionDefinition.name);
@@ -77,8 +101,9 @@ function defineMyInAppChannels(app) {
                                 ORDER BY messages.${messagesFieldName.receiveTimestamp} DESC
                                 LIMIT 1
                             )`;
-          const latestMsgReceiveTSFilter = ((_b = filter == null ? void 0 : filter.latestMsgReceiveTimestamp) == null ? void 0 : _b.$lt) ? import_sequelize.Sequelize.literal(`${latestMsgReceiveTimestampSQL} < ${filter.latestMsgReceiveTimestamp.$lt}`) : null;
+          const latestMsgReceiveTSFilter = latestMsgReceiveTimestampLt !== null ? import_sequelize.Sequelize.where(import_sequelize.Sequelize.literal(latestMsgReceiveTimestampSQL), import_sequelize.Op.lt, latestMsgReceiveTimestampLt) : null;
           const channelIdFilter = (filter == null ? void 0 : filter.id) ? { id: filter.id } : null;
+          const channelNameFilter = (filter == null ? void 0 : filter.name) ? { name: filter.name } : null;
           const statusMap = {
             all: "read|unread",
             unread: "unread",
@@ -98,21 +123,22 @@ function defineMyInAppChannels(app) {
           try {
             const channelsRes = channelsRepo.find({
               limit,
-              attributes: {
-                include: [
-                  [
-                    import_sequelize.Sequelize.literal(`(
+              attributes: [
+                "name",
+                "title",
+                [
+                  import_sequelize.Sequelize.literal(`(
                                 SELECT COUNT(*)
                                 FROM ${messagesTableName} AS messages
                                 WHERE
                                     messages.${messagesFieldName.channelName} = ${channelsTableAliasName}.${channelsFieldName.name}
                                     AND messages.${messagesFieldName.userId} = ${userId}
                             )`),
-                    "totalMsgCnt"
-                  ],
-                  [import_sequelize.Sequelize.literal(`'${userId}'`), "userId"],
-                  [
-                    import_sequelize.Sequelize.literal(`(
+                  "totalMsgCnt"
+                ],
+                [import_sequelize.Sequelize.literal(`'${userId}'`), "userId"],
+                [
+                  import_sequelize.Sequelize.literal(`(
                                 SELECT COUNT(*)
                                 FROM ${messagesTableName} AS messages
                                 WHERE
@@ -120,11 +146,11 @@ function defineMyInAppChannels(app) {
                                     AND messages.${messagesFieldName.status} = 'unread'
                                     AND messages.${messagesFieldName.userId} = ${userId}
                             )`),
-                    "unreadMsgCnt"
-                  ],
-                  [import_sequelize.Sequelize.literal(latestMsgReceiveTimestampSQL), "latestMsgReceiveTimestamp"],
-                  [
-                    import_sequelize.Sequelize.literal(`(
+                  "unreadMsgCnt"
+                ],
+                [import_sequelize.Sequelize.literal(latestMsgReceiveTimestampSQL), "latestMsgReceiveTimestamp"],
+                [
+                  import_sequelize.Sequelize.literal(`(
                       SELECT messages.${messagesFieldName.title}
                               FROM ${messagesTableName} AS messages
                               WHERE
@@ -133,20 +159,25 @@ function defineMyInAppChannels(app) {
                               ORDER BY messages.${messagesFieldName.receiveTimestamp} DESC
                               LIMIT 1
                   )`),
-                    "latestMsgTitle"
-                  ]
+                  "latestMsgTitle"
                 ]
-              },
+              ],
               //@ts-ignore
               where: {
-                [import_sequelize.Op.and]: [userFilter, latestMsgReceiveTSFilter, channelIdFilter, channelStatusFilter].filter(Boolean)
+                [import_sequelize.Op.and]: [
+                  userFilter,
+                  latestMsgReceiveTSFilter,
+                  channelIdFilter,
+                  channelNameFilter,
+                  channelStatusFilter
+                ].filter(Boolean)
               },
               sort: ["-latestMsgReceiveTimestamp"]
             });
             const countRes = channelsRepo.count({
               //@ts-ignore
               where: {
-                [import_sequelize.Op.and]: [userFilter, channelStatusFilter].filter(Boolean)
+                [import_sequelize.Op.and]: [userFilter, channelNameFilter, channelStatusFilter].filter(Boolean)
               }
             });
             const [channels, count] = await Promise.all([channelsRes, countRes]);

package/dist/server/defineMyInAppMessages.js

@@ -136,7 +136,8 @@ function defineMyInAppMessages(app) {
             ctx.action.mergeParams({
               filter: {
                 userId
-              }
+              },
+              whitelist: ["status"]
             });
             return import_actions.default.update(ctx, next);
           }

package/dist/server/parseUserSelectionConf.d.ts

@@ -6,5 +6,6 @@
  * 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 { Repository } from '@nocobase/database';
-export declare function parseUserSelectionConf(userSelectionConfig: Array<Record<any, any> | string>, UserRepo: Repository): Promise<string[]>;
+export declare function parseUserSelectionConf(userSelectionConfig: Array<Record<any, any> | string>, UserRepo: Repository, options?: Transactionable): Promise<string[]>;

package/dist/server/parseUserSelectionConf.js

@@ -30,7 +30,7 @@ __export(parseUserSelectionConf_exports, {
 });
 module.exports = __toCommonJS(parseUserSelectionConf_exports);
 var import_utils = require("@nocobase/utils");
-async function parseUserSelectionConf(userSelectionConfig, UserRepo) {
+async function parseUserSelectionConf(userSelectionConfig, UserRepo, options = {}) {
   const SelectionConfigs = userSelectionConfig.flat().filter(Boolean);
   const users = /* @__PURE__ */ new Set();
   for (const item of SelectionConfigs) {
@@ -40,7 +40,8 @@ async function parseUserSelectionConf(userSelectionConfig, UserRepo) {
       }
       const result = await UserRepo.find({
         ...item,
-        fields: ["id"]
+        fields: ["id"],
+        transaction: options.transaction
       });
       result.forEach((item2) => users.add(item2.id));
     } else {

package/dist/server/plugin.js

@@ -54,7 +54,7 @@ class PluginNotificationInAppServer extends import_server.Plugin {
     const notificationServer = this.pm.get(import_plugin_notification_manager.default);
     const instance = new import_InAppNotificationChannel.default(this.app);
     instance.load();
-    notificationServer.registerChannelType({ type: import_types.inAppTypeName, Channel: import_InAppNotificationChannel.default });
+    notificationServer.registerChannelType({ type: import_types.inAppTypeName, Channel: import_InAppNotificationChannel.default, useQueue: false });
   }
   async install() {
   }

package/dist/types/messages.js

@@ -32,6 +32,7 @@ module.exports = __toCommonJS(messages_exports);
 var import_index = require("./index");
 const messageCollection = {
   name: import_index.InAppMessagesDefinition.name,
+  dataCategory: "business",
   title: "in-app messages",
   migrationRules: ["schema-only"],
   fields: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/plugin-notification-in-app-message",
-  "version": "2.1.0-beta.9",
+  "version": "2.1.0",
   "displayName": "Notification: In-app message",
   "displayName.ru-RU": "Уведомления: Всплывающие сообщения внутри приложения",
   "displayName.zh-CN": "通知：站内信",
@@ -24,11 +24,14 @@
     "@formily/reactive": "2.x",
     "@formily/reactive-react": "^2",
     "@nocobase/client": "2.x",
+    "@nocobase/client-v2": "2.x",
+    "@nocobase/plugin-mobile": "2.x",
     "@nocobase/plugin-notification-manager": "2.x",
+    "@nocobase/plugin-workflow": "2.x",
     "@nocobase/server": "2.x",
     "@nocobase/test": "2.x",
     "react-router-dom": "^6.x"
   },
   "license": "Apache-2.0",
-  "gitHead": "c3a2875e4cbbb43b1f2361e6f9f5f84a7d3f3c3c"
+  "gitHead": "9373212dd0f22cd985be1e23674d6b454944b9ee"
 }

package/dist/client/components/UsersSelect.d.ts

@@ -1,18 +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.
- */
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This program is offered under a commercial license.
- * For more information, see <https://www.nocobase.com/agreement>
- */
-import React from 'react';
-export declare function UsersSelect(props: any): React.JSX.Element;