@nocobase/plugin-workflow 2.2.0-alpha.11 → 2.2.0-alpha.12

package/dist/server/Plugin.js

@@ -42,6 +42,7 @@ __export(Plugin_exports, {
 module.exports = __toCommonJS(Plugin_exports);
 var import_path = __toESM(require("path"));
 var import_nodejs_snowflake = require("nodejs-snowflake");
+var import_sequelize = require("sequelize");
 var import_lru_cache = require("lru-cache");
 var import_database = require("@nocobase/database");
 var import_server = require("@nocobase/server");
@@ -83,6 +84,7 @@ class PluginWorkflowServer extends import_server.Plugin {
   loggerCache;
   meter = null;
   checker = null;
+  taskStatsProviders = /* @__PURE__ */ new Map();
   onBeforeSave = async (instance, { transaction, cycling }) => {
     if (cycling) {
       return;
@@ -393,6 +395,7 @@ class PluginWorkflowServer extends import_server.Plugin {
       actions: ["workflows:list"]
     });
     this.app.acl.allow("userWorkflowTasks", "listMine", "loggedIn");
+    this.app.acl.allow("userWorkflowTaskStats", "listMine", "loggedIn");
     db.on("workflows.beforeSave", this.onBeforeSave);
     db.on("workflows.afterCreate", this.onAfterCreate);
     db.on("workflows.afterUpdate", this.onAfterUpdate);
@@ -538,12 +541,304 @@ class PluginWorkflowServer extends import_server.Plugin {
       return db.sequelize.transaction();
     }
   }
+  registerTaskStatsProvider(type, provider) {
+    this.taskStatsProviders.set(type, provider);
+  }
+  async getWorkflowIdsByKey(workflowKey, transaction) {
+    const WorkflowRepo = this.db.getRepository("workflows");
+    const workflows = await WorkflowRepo.find({
+      filter: {
+        key: workflowKey
+      },
+      fields: ["id"],
+      transaction
+    });
+    return workflows.map((workflow) => workflow.id);
+  }
+  buildTaskStatsFilter(options) {
+    var _a, _b, _c;
+    const filter = {};
+    if ((_a = options.userIds) == null ? void 0 : _a.length) {
+      filter.userId = options.userIds;
+    }
+    if ((_b = options.workflowKeys) == null ? void 0 : _b.length) {
+      filter.workflowKey = options.workflowKeys;
+    }
+    if ((_c = options.types) == null ? void 0 : _c.length) {
+      filter.type = options.types;
+    }
+    return filter;
+  }
+  normalizeTaskStats(stats = {}) {
+    return {
+      pending: Number(stats.pending) || 0,
+      all: Number(stats.all) || 0
+    };
+  }
+  async upsertTaskStatsRow(row, transaction) {
+    const repository = this.db.getRepository("userWorkflowTaskStats");
+    const values = {
+      userId: row.userId,
+      workflowKey: row.workflowKey,
+      type: row.type,
+      ...this.normalizeTaskStats(row)
+    };
+    const record = await repository.findOne({
+      filter: {
+        userId: row.userId,
+        workflowKey: row.workflowKey,
+        type: row.type
+      },
+      transaction
+    });
+    if (record) {
+      await record.update(values, { transaction });
+      return record;
+    }
+    return repository.create({
+      values,
+      transaction
+    });
+  }
+  async refreshUserWorkflowTaskTypeStats(userId, type, { transaction } = {}) {
+    const repository = this.db.getRepository("userWorkflowTaskStats");
+    const rows = await repository.find({
+      filter: {
+        userId,
+        type
+      },
+      fields: ["pending", "all"],
+      transaction
+    });
+    const stats = rows.reduce(
+      (result, row) => ({
+        pending: result.pending + (Number(row.pending) || 0),
+        all: result.all + (Number(row.all) || 0)
+      }),
+      { pending: 0, all: 0 }
+    );
+    await this.updateTasksStats(userId, type, stats, { transaction });
+    return stats;
+  }
+  async refreshUserWorkflowTaskWorkflowStats(userId, workflowKey, { transaction } = {}) {
+    const repository = this.db.getRepository("userWorkflowTaskStats");
+    const rows = await repository.find({
+      filter: {
+        userId,
+        workflowKey
+      },
+      fields: ["pending", "all"],
+      transaction
+    });
+    return rows.reduce(
+      (result, row) => ({
+        pending: result.pending + (Number(row.pending) || 0),
+        all: result.all + (Number(row.all) || 0)
+      }),
+      { pending: 0, all: 0 }
+    );
+  }
+  sendTaskWorkflowStatsUpdated(userId, workflowKey, stats) {
+    if (!userId) {
+      return;
+    }
+    this.app.emit("ws:sendToUser", {
+      userId,
+      message: {
+        type: "workflow:taskWorkflowStats:updated",
+        payload: {
+          userId,
+          workflowKey,
+          stats
+        }
+      }
+    });
+  }
+  async updateTaskStatsByWorkflow(input, { transaction } = {}) {
+    await this.upsertTaskStatsRow(
+      {
+        userId: input.userId,
+        workflowKey: input.workflowKey,
+        type: input.type,
+        ...this.normalizeTaskStats(input.stats)
+      },
+      transaction
+    );
+    await this.refreshUserWorkflowTaskTypeStats(input.userId, input.type, { transaction });
+    const workflowStats = await this.refreshUserWorkflowTaskWorkflowStats(input.userId, input.workflowKey, {
+      transaction
+    });
+    this.sendTaskWorkflowStatsUpdated(input.userId, input.workflowKey, workflowStats);
+  }
+  async repairTaskStats(options = {}) {
+    const run = async (transaction) => {
+      var _a, _b;
+      const repository = this.db.getRepository("userWorkflowTaskStats");
+      const TaskStatsModel = this.db.getModel("userWorkflowTaskStats");
+      const filter = this.buildTaskStatsFilter(options);
+      const existedRows = await repository.find({
+        filter,
+        fields: ["userId", "workflowKey", "type"],
+        transaction
+      });
+      const providers = Array.from(this.taskStatsProviders.entries()).filter(([type]) => {
+        var _a2;
+        return !((_a2 = options.types) == null ? void 0 : _a2.length) || options.types.includes(type);
+      });
+      const legacyRows = providers.length ? await this.db.getRepository("userWorkflowTasks").find({
+        filter: {
+          ...((_a = options.userIds) == null ? void 0 : _a.length) ? { userId: options.userIds } : {},
+          type: providers.map(([type]) => type)
+        },
+        fields: ["userId", "type"],
+        transaction
+      }) : [];
+      const collectedRows = (await Promise.all(
+        providers.map(([, provider]) => provider.collectTaskStats({ ...options, transaction }, { plugin: this }))
+      )).flat();
+      const rows = collectedRows.filter((row) => {
+        var _a2, _b2, _c;
+        if (((_a2 = options.userIds) == null ? void 0 : _a2.length) && !options.userIds.includes(row.userId)) {
+          return false;
+        }
+        if (((_b2 = options.workflowKeys) == null ? void 0 : _b2.length) && !options.workflowKeys.includes(row.workflowKey)) {
+          return false;
+        }
+        if (((_c = options.types) == null ? void 0 : _c.length) && !options.types.includes(row.type)) {
+          return false;
+        }
+        return true;
+      });
+      await repository.destroy({
+        filter,
+        transaction
+      });
+      const batchSize = 1e3;
+      for (let offset = 0; offset < rows.length; offset += batchSize) {
+        await TaskStatsModel.bulkCreate(rows.slice(offset, offset + batchSize), {
+          returning: false,
+          transaction
+        });
+      }
+      const typePairs = /* @__PURE__ */ new Set();
+      const workflowPairs = /* @__PURE__ */ new Set();
+      if ((_b = options.userIds) == null ? void 0 : _b.length) {
+        for (const userId of options.userIds) {
+          for (const [type] of providers) {
+            typePairs.add(`${userId}\0${type}`);
+          }
+          for (const workflowKey of options.workflowKeys ?? []) {
+            workflowPairs.add(`${userId}\0${workflowKey}`);
+          }
+        }
+      }
+      for (const row of legacyRows) {
+        typePairs.add(`${row.userId}\0${row.type}`);
+      }
+      for (const row of [...existedRows, ...rows]) {
+        typePairs.add(`${row.userId}\0${row.type}`);
+        workflowPairs.add(`${row.userId}\0${row.workflowKey}`);
+      }
+      const affectedUserIds = Array.from(typePairs, (pair) => Number(pair.slice(0, pair.indexOf("\0"))));
+      const affectedTypes = Array.from(typePairs, (pair) => pair.slice(pair.indexOf("\0") + 1));
+      const categorizedRows = typePairs.size ? await TaskStatsModel.findAll({
+        attributes: ["userId", "type", [(0, import_sequelize.fn)("SUM", (0, import_sequelize.col)("pending")), "pending"], [(0, import_sequelize.fn)("SUM", (0, import_sequelize.col)("all")), "all"]],
+        where: {
+          userId: Array.from(new Set(affectedUserIds)),
+          type: Array.from(new Set(affectedTypes))
+        },
+        group: ["userId", "type"],
+        raw: true,
+        transaction
+      }) : [];
+      const categorizedMap = new Map(
+        categorizedRows.map((row) => [
+          `${row.userId}\0${row.type}`,
+          this.normalizeTaskStats({ pending: row.pending, all: row.all })
+        ])
+      );
+      const categorizedValues = Array.from(typePairs, (pair) => {
+        const separatorIndex = pair.indexOf("\0");
+        return {
+          userId: Number(pair.slice(0, separatorIndex)),
+          type: pair.slice(separatorIndex + 1),
+          stats: categorizedMap.get(pair) ?? { pending: 0, all: 0 }
+        };
+      });
+      const categorizedUserIds = Array.from(new Set(affectedUserIds));
+      const categorizedTypes = Array.from(new Set(affectedTypes));
+      if (categorizedUserIds.length && categorizedTypes.length) {
+        await this.db.getRepository("userWorkflowTasks").destroy({
+          filter: {
+            userId: categorizedUserIds,
+            type: categorizedTypes
+          },
+          transaction
+        });
+      }
+      const UserTasksModel = this.db.getModel("userWorkflowTasks");
+      for (let offset = 0; offset < categorizedValues.length; offset += batchSize) {
+        await UserTasksModel.bulkCreate(categorizedValues.slice(offset, offset + batchSize), {
+          returning: false,
+          transaction
+        });
+      }
+      if (options.silent) {
+        return;
+      }
+      for (const value of categorizedValues) {
+        if (!value.userId) {
+          continue;
+        }
+        this.app.emit("ws:sendToUser", {
+          userId: value.userId,
+          message: { type: "workflow:tasks:updated", payload: value }
+        });
+      }
+      const affectedWorkflowUserIds = Array.from(workflowPairs, (pair) => Number(pair.slice(0, pair.indexOf("\0"))));
+      const affectedWorkflowKeys = Array.from(workflowPairs, (pair) => pair.slice(pair.indexOf("\0") + 1));
+      const workflowRows = workflowPairs.size ? await TaskStatsModel.findAll({
+        attributes: [
+          "userId",
+          "workflowKey",
+          [(0, import_sequelize.fn)("SUM", (0, import_sequelize.col)("pending")), "pending"],
+          [(0, import_sequelize.fn)("SUM", (0, import_sequelize.col)("all")), "all"]
+        ],
+        where: {
+          userId: Array.from(new Set(affectedWorkflowUserIds)),
+          workflowKey: Array.from(new Set(affectedWorkflowKeys))
+        },
+        group: ["userId", "workflowKey"],
+        raw: true,
+        transaction
+      }) : [];
+      const workflowMap = new Map(
+        workflowRows.map((row) => [
+          `${row.userId}\0${row.workflowKey}`,
+          this.normalizeTaskStats({ pending: row.pending, all: row.all })
+        ])
+      );
+      for (const pair of workflowPairs) {
+        const separatorIndex = pair.indexOf("\0");
+        const userId = Number(pair.slice(0, separatorIndex));
+        const workflowKey = pair.slice(separatorIndex + 1);
+        this.sendTaskWorkflowStatsUpdated(userId, workflowKey, workflowMap.get(pair) ?? { pending: 0, all: 0 });
+      }
+    };
+    if (options.transaction) {
+      await run(options.transaction);
+      return;
+    }
+    await this.db.sequelize.transaction(run);
+  }
   /**
    * @experimental
+   * @deprecated Use updateTaskStatsByWorkflow() when workflowKey is available.
    */
   async updateTasksStats(userId, type, stats = { pending: 0, all: 0 }, { transaction }) {
     const { db } = this.app;
     const repository = db.getRepository("userWorkflowTasks");
+    const normalizedStats = this.normalizeTaskStats(stats);
     let record = await repository.findOne({
       filter: {
         userId,
@@ -554,7 +849,7 @@ class PluginWorkflowServer extends import_server.Plugin {
     if (record) {
       await record.update(
         {
-          stats
+          stats: normalizedStats
         },
         { transaction }
       );
@@ -563,7 +858,7 @@ class PluginWorkflowServer extends import_server.Plugin {
         values: {
           userId,
           type,
-          stats
+          stats: normalizedStats
         },
         transaction
       });

package/dist/server/Processor.js

@@ -46,6 +46,7 @@ var import_utils = require("@nocobase/utils");
 var import_set = __toESM(require("lodash/set"));
 var import_constants = require("./constants");
 var import_timeout_errors = require("./timeout-errors");
+const JOB_SAVE_BATCH_SIZE = 100;
 const OPEN_SCOPE_PENDING_ERROR = "Pending jobs are not allowed inside an open transaction scope";
 class Processor {
   constructor(execution, options) {
@@ -488,14 +489,17 @@ class Processor {
       }
       if (newJobs.length) {
         const JobsModel = this.options.plugin.db.getModel("jobs");
-        await JobsModel.bulkCreate(
-          newJobs.map((job) => job.toJSON()),
-          {
-            returning: false
+        for (let offset = 0; offset < newJobs.length; offset += JOB_SAVE_BATCH_SIZE) {
+          const batch = newJobs.slice(offset, offset + JOB_SAVE_BATCH_SIZE);
+          await JobsModel.bulkCreate(
+            batch.map((job) => job.toJSON()),
+            {
+              returning: false
+            }
+          );
+          for (const job of batch) {
+            job.isNewRecord = false;
           }
-        );
-        for (const job of newJobs) {
-          job.isNewRecord = false;
         }
       }
       this.jobsToSave.clear();

package/dist/server/actions/index.js

@@ -44,6 +44,7 @@ var nodes = __toESM(require("./nodes"));
 var jobs = __toESM(require("./jobs"));
 var executions = __toESM(require("./executions"));
 var userWorkflowTasks = __toESM(require("./userWorkflowTasks"));
+var userWorkflowTaskStats = __toESM(require("./userWorkflowTaskStats"));
 function make(name, mod) {
   return Object.keys(mod).reduce(
     (result, key) => ({
@@ -69,6 +70,7 @@ function actions_default({ app }) {
     }),
     ...make("jobs", jobs),
     ...make("executions", executions),
-    ...make("userWorkflowTasks", userWorkflowTasks)
+    ...make("userWorkflowTasks", userWorkflowTasks),
+    ...make("userWorkflowTaskStats", userWorkflowTaskStats)
   });
 }

package/dist/server/actions/userWorkflowTaskStats.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 } from '@nocobase/actions';
+export declare function listMine(context: Context, next: any): Promise<void>;

package/dist/server/actions/userWorkflowTaskStats.js

@@ -0,0 +1,112 @@
+/**
+ * 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 __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 userWorkflowTaskStats_exports = {};
+__export(userWorkflowTaskStats_exports, {
+  listMine: () => listMine
+});
+module.exports = __toCommonJS(userWorkflowTaskStats_exports);
+var import_actions = require("@nocobase/actions");
+async function listMine(context, next) {
+  const { type, search } = context.action.params;
+  const normalizedSearch = typeof search === "string" ? search.trim() : "";
+  const page = Math.max(Number.parseInt(String(context.action.params.page ?? 1), 10) || 1, 1);
+  const pageSize = Math.min(
+    Math.max(Number.parseInt(String(context.action.params.pageSize ?? 200), 10) || 200, 1),
+    200
+  );
+  const pagination = import_actions.utils.pageArgsToLimitArgs(page, pageSize);
+  const repository = context.db.getRepository("userWorkflowTaskStats");
+  const rows = await repository.find({
+    filter: {
+      userId: context.state.currentUser.id,
+      ...type ? { type } : {},
+      all: {
+        $gt: 0
+      }
+    },
+    fields: ["workflowKey", "pending", "all"]
+  });
+  const statsMap = /* @__PURE__ */ new Map();
+  for (const row of rows) {
+    if (!row.workflowKey) {
+      continue;
+    }
+    const existed = statsMap.get(row.workflowKey) ?? {
+      workflowKey: row.workflowKey,
+      stats: { pending: 0, all: 0 }
+    };
+    existed.stats.pending += Number(row.pending) || 0;
+    existed.stats.all += Number(row.all) || 0;
+    statsMap.set(row.workflowKey, existed);
+  }
+  const workflowKeys = Array.from(statsMap.keys());
+  if (!workflowKeys.length) {
+    context.body = {
+      rows: [],
+      page,
+      pageSize,
+      hasNext: false
+    };
+    await next();
+    return;
+  }
+  const workflows = await context.db.getRepository("workflows").find({
+    filter: {
+      key: workflowKeys,
+      current: true,
+      ...normalizedSearch ? {
+        title: {
+          $includes: normalizedSearch
+        }
+      } : {}
+    },
+    fields: ["key", "title"],
+    sort: ["title"],
+    limit: pagination.limit + 1,
+    offset: pagination.offset
+  });
+  const hasNext = workflows.length > pageSize;
+  const data = workflows.slice(0, pageSize).map((workflow) => {
+    var _a;
+    return {
+      workflowKey: workflow.key,
+      title: workflow.title,
+      stats: ((_a = statsMap.get(workflow.key)) == null ? void 0 : _a.stats) ?? { pending: 0, all: 0 }
+    };
+  });
+  context.body = {
+    rows: data,
+    page,
+    pageSize,
+    hasNext
+  };
+  await next();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  listMine
+});

package/dist/server/actions/workflows.js

@@ -106,6 +106,7 @@ async function update(context, next) {
   return import_actions.default.update(context, next);
 }
 async function destroy(context, next) {
+  const plugin = context.app.pm.get(import_Plugin.default);
   const repository = import_actions.utils.getRepositoryFromParams(context);
   const { filterByTk, filter } = context.action.params;
   await context.db.sequelize.transaction(async (transaction) => {
@@ -116,6 +117,15 @@ async function destroy(context, next) {
       transaction
     });
     const ids = new Set(items.map((item) => item.id));
+    const affectedKeys = Array.from(new Set(items.map((item) => item.get("key"))));
+    const affectedTaskStats = affectedKeys.length ? await context.db.getRepository("userWorkflowTaskStats").find({
+      filter: {
+        workflowKey: affectedKeys
+      },
+      fields: ["userId"],
+      transaction
+    }) : [];
+    const affectedUserIds = Array.from(new Set(affectedTaskStats.map((item) => item.get("userId"))));
     const keysSet = new Set(items.filter((item) => item.current).map((item) => item.key));
     const revisions = await repository.find({
       filter: {
@@ -138,6 +148,13 @@ async function destroy(context, next) {
       },
       transaction
     });
+    if (affectedKeys.length) {
+      await plugin.repairTaskStats({
+        workflowKeys: affectedKeys,
+        ...affectedUserIds.length ? { userIds: affectedUserIds } : {},
+        transaction
+      });
+    }
     context.body = deleted;
   });
   next();

package/dist/server/collections/userWorkflowTaskStats.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.
+ */
+import { CollectionOptions } from '@nocobase/database';
+declare const _default: CollectionOptions;
+export default _default;

package/dist/server/collections/userWorkflowTaskStats.js

@@ -0,0 +1,43 @@
+/**
+ * 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 __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 userWorkflowTaskStats_exports = {};
+__export(userWorkflowTaskStats_exports, {
+  default: () => userWorkflowTaskStats_default
+});
+module.exports = __toCommonJS(userWorkflowTaskStats_exports);
+var import_userWorkflowTaskStats = __toESM(require("../../common/collections/userWorkflowTaskStats"));
+var userWorkflowTaskStats_default = import_userWorkflowTaskStats.default;

package/dist/server/index.d.ts

@@ -17,4 +17,5 @@ export type { EventOptions } from './Dispatcher';
 export { default as Processor } from './Processor';
 export type { BackgroundAbortHandle, ProcessorOptions, ScopeTransaction } from './Processor';
 export { default } from './Plugin';
+export type { RepairTaskStatsOptions, TaskStatsProvider, TaskStatsRow } from './Plugin';
 export * from './types';