@nocobase/plugin-workflow 2.2.0-beta.8 → 2.2.0

package/dist/server/actions/executions.js

@@ -98,12 +98,9 @@ async function rerun(context, next) {
   if (execution.status !== import_constants.EXECUTION_STATUS.STARTED) {
     return context.throw(400, "Only started executions can be rerun");
   }
-  await workflowPlugin.run({
-    execution,
-    rerun: {
-      nodeId,
-      overwrite: overwrite === true
-    }
+  await workflowPlugin.rerun(execution, {
+    nodeId,
+    overwrite: overwrite === true
   });
   context.body = execution;
   context.status = 202;

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/jobs.js

@@ -82,8 +82,7 @@ async function resume(context, next) {
   context.body = job;
   context.status = 202;
   await next();
-  job.execution = execution;
-  workflowPlugin.resume(job);
+  await workflowPlugin.resume(job);
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

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.d.ts

@@ -12,6 +12,7 @@ export declare class WorkflowValidationError extends Error {
     errors: Record<string, string>;
     constructor(errors: Record<string, string>);
 }
+export declare function list(context: Context, next: any): Promise<void>;
 export declare function create(context: Context, next: any): Promise<void>;
 export declare function update(context: Context, next: any): Promise<void>;
 export declare function destroy(context: Context, next: any): Promise<void>;

package/dist/server/actions/workflows.js

@@ -40,6 +40,7 @@ __export(workflows_exports, {
   create: () => create,
   destroy: () => destroy,
   execute: () => execute,
+  list: () => list,
   revision: () => revision,
   sync: () => sync,
   update: () => update
@@ -72,9 +73,14 @@ function validateWorkflow(context, plugin, { type, config }) {
     }
   }
 }
+async function list(context, next) {
+  return import_actions.default.list(context, next);
+}
 async function create(context, next) {
   const plugin = context.app.pm.get(import_Plugin.default);
-  const { values } = context.action.params;
+  const values = { ...context.action.params.values || {} };
+  delete values.invalid;
+  context.action.mergeParams({ values }, { values: "overwrite" });
   validateWorkflow(context, plugin, values);
   return import_actions.default.create(context, next);
 }
@@ -100,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) => {
@@ -110,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: {
@@ -132,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();
@@ -139,10 +162,12 @@ async function destroy(context, next) {
 async function revision(context, next) {
   const repository = import_actions.utils.getRepositoryFromParams(context);
   const { filterByTk, filter = {}, values = {} } = context.action.params;
+  const revisionValues = { ...values };
+  delete revisionValues.invalid;
   context.body = await repository.revision({
     filterByTk,
     filter,
-    values,
+    values: revisionValues,
     context
   });
   await next();
@@ -184,6 +209,12 @@ async function execute(context, next) {
   let processor;
   try {
     processor = await plugin.execute(workflow, values, { manually: true });
+    if (processor === null) {
+      context.body = {
+        execution: null
+      };
+      return next();
+    }
     if (!processor) {
       return context.throw(400, "workflow not triggered");
     }
@@ -194,7 +225,7 @@ async function execute(context, next) {
     filter: { key: workflow.key }
   });
   let newVersion;
-  if (executed == 0 && autoRevision) {
+  if (executed === 0 && Number(autoRevision) === 1) {
     newVersion = await repository.revision({
       filterByTk: workflow.id,
       filter: { key: workflow.key },
@@ -220,6 +251,7 @@ async function execute(context, next) {
   create,
   destroy,
   execute,
+  list,
   revision,
   sync,
   update

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';

package/dist/server/triggers/CollectionTrigger.d.ts

@@ -30,7 +30,7 @@ export default class CollectionTrigger extends Trigger {
         code?: string;
     };
     prepare(workflow: WorkflowModel, data: Model | Record<string, any> | string | number, options: any): Promise<{
-        data: any;
+        data: string | number | Record<string, any> | Model<any, any>;
     }>;
     on(workflow: WorkflowModel): void;
     off(workflow: WorkflowModel): void;

package/dist/server/triggers/CollectionTrigger.js

@@ -305,6 +305,9 @@ class CollectionTrigger extends import__.default {
   // }
   async execute(workflow, values, options) {
     const ctx = await this.prepare(workflow, values == null ? void 0 : values.data, options);
+    if (!ctx) {
+      return null;
+    }
     const [dataSourceName] = (0, import_data_source_manager.parseCollectionName)(workflow.config.collection);
     const { transaction } = options;
     return this.workflow.trigger(workflow, ctx, {

package/dist/server/triggers/ScheduleTrigger/StaticScheduleTrigger.d.ts

@@ -20,5 +20,5 @@ export default class StaticScheduleTrigger {
     trigger(workflow: WorkflowModel, time: number): Promise<void>;
     on(workflow: any): void;
     off(workflow: any): void;
-    execute(workflow: any, values: any, options: any): void | Promise<import("../..").Processor>;
+    execute(workflow: any, values: any, options: any): void | Promise<void | import("../..").Processor>;
 }

package/dist/server/triggers/index.d.ts

@@ -26,6 +26,6 @@ export declare abstract class Trigger {
         [key: string]: string;
     };
     sync?: boolean;
-    execute?(workflow: WorkflowModel, values: any, options: Transactionable): void | Processor | Promise<void | Processor>;
+    execute?(workflow: WorkflowModel, values: any, options: Transactionable): void | Processor | null | Promise<void | Processor | null>;
 }
 export default Trigger;

package/dist/server/types/Execution.d.ts

@@ -12,11 +12,13 @@ import WorkflowModel from './Workflow';
 export default class ExecutionModel extends Model {
     static readonly database: Database;
     id: number;
+    workflowId: number;
     title: string;
     context: any;
     status: number;
     reason?: string | null;
     dispatched: boolean;
+    manually?: boolean | null;
     parentExecutionId?: number | null;
     stack?: Array<number | string>;
     startedAt?: Date | null;

package/dist/server/types/Job.d.ts

@@ -8,11 +8,15 @@
  */
 import { BelongsToGetAssociationMixin, Model } from '@nocobase/database';
 import FlowNodeModel from './FlowNode';
+import ExecutionModel from './Execution';
 export default class JobModel extends Model {
     id: number;
+    executionId: number;
+    workflowId?: number;
     status: number;
     result?: any;
     meta?: any;
+    startedAt?: Date | null;
     createdAt: Date;
     updatedAt: Date;
     upstreamId: number;
@@ -20,4 +24,6 @@ export default class JobModel extends Model {
     nodeId: number;
     node?: FlowNodeModel;
     getNode: BelongsToGetAssociationMixin<FlowNodeModel>;
+    execution?: ExecutionModel;
+    getExecution: BelongsToGetAssociationMixin<ExecutionModel>;
 }

package/dist/server/types/Workflow.d.ts

@@ -19,6 +19,7 @@ export default class WorkflowModel extends Model {
     description?: string;
     type: string;
     config: any;
+    invalid: boolean;
     options: {
         timeout?: number;
         stackLimit?: number;

package/dist/server/utils.d.ts

@@ -16,6 +16,7 @@ type AbortOptions = Transactionable & {
     reason?: (typeof EXECUTION_REASON)[keyof typeof EXECUTION_REASON];
 };
 export declare function getExecutionLockKey(executionId: number | string): string;
+export declare function getJobLockKey(jobId: number | string): string;
 export declare function isLockAcquireError(error: unknown): boolean;
 export declare function validateCollectionField(collection: string, dataSourceManager: DataSourceManager): Record<string, string> | null;
 export declare function getExecutionStatusName(status: number | null | undefined): string;
@@ -32,5 +33,5 @@ export declare function getWorkflowExecutionLogMeta(workflow: WorkflowModel, pro
     lastJobStatus: number;
 };
 export declare function abortExecution(plugin: PluginWorkflowServer, execution: ExecutionModel, options?: AbortOptions): Promise<boolean>;
-export declare function toJSON(data: any): any;
+export declare function toJSON<T>(data: T): T;
 export {};

package/dist/server/utils.js

@@ -29,6 +29,7 @@ __export(utils_exports, {
   abortExecution: () => abortExecution,
   getExecutionLockKey: () => getExecutionLockKey,
   getExecutionStatusName: () => getExecutionStatusName,
+  getJobLockKey: () => getJobLockKey,
   getWorkflowExecutionLogMeta: () => getWorkflowExecutionLogMeta,
   isLockAcquireError: () => isLockAcquireError,
   toJSON: () => toJSON,
@@ -41,6 +42,9 @@ var import_constants = require("./constants");
 function getExecutionLockKey(executionId) {
   return `workflow:execution:${executionId}`;
 }
+function getJobLockKey(jobId) {
+  return `workflow:job:${jobId}`;
+}
 function isLockAcquireError(error) {
   return error instanceof Error && error.constructor.name === "LockAcquireError";
 }
@@ -164,6 +168,16 @@ async function abortExecution(plugin, execution, options = {}) {
     throw error;
   }
 }
+function getHiddenFieldNames(model) {
+  const { collection } = model.constructor;
+  if (!(collection == null ? void 0 : collection.fields)) {
+    return [];
+  }
+  return Array.from(collection.fields.values()).filter((field) => {
+    var _a;
+    return (_a = field == null ? void 0 : field.options) == null ? void 0 : _a.hidden;
+  }).map((field) => field.options.name).filter((name) => typeof name === "string");
+}
 function toJSON(data) {
   if (Array.isArray(data)) {
     return data.map(toJSON);
@@ -171,7 +185,10 @@ function toJSON(data) {
   if (!(data instanceof import_database.Model) || !data) {
     return data;
   }
-  const result = data.get();
+  const result = { ...data.get() };
+  for (const fieldName of getHiddenFieldNames(data)) {
+    delete result[fieldName];
+  }
   Object.keys(data.constructor.associations).forEach((key) => {
     if (result[key] != null && typeof result[key] === "object") {
       result[key] = toJSON(result[key]);
@@ -184,6 +201,7 @@ function toJSON(data) {
   abortExecution,
   getExecutionLockKey,
   getExecutionStatusName,
+  getJobLockKey,
   getWorkflowExecutionLogMeta,
   isLockAcquireError,
   toJSON,

package/dist/shared/WorkflowTaskNavigation.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 React from 'react';
+export interface WorkflowTaskStatsItem {
+    workflowKey: string;
+    title: string;
+    stats: {
+        pending: number;
+        all: number;
+    };
+}
+export interface WorkflowTaskNavigationType {
+    count: number;
+    key: string;
+    title: React.ReactNode;
+}
+interface WorkflowTaskStatsListParams {
+    page: number;
+    pageSize: number;
+    search?: string;
+    type: string;
+}
+export type LoadWorkflowTaskStats = (params: WorkflowTaskStatsListParams) => Promise<unknown>;
+export interface WorkflowTaskFilterContextValue {
+    selectedWorkflow: WorkflowTaskStatsItem | null;
+    selectWorkflow: (workflow: WorkflowTaskStatsItem | null) => void;
+    workflows: WorkflowTaskStatsItem[];
+    loading: boolean;
+    loadingMore: boolean;
+    hasNext: boolean;
+    error: boolean;
+    search: string;
+    setSearch: (search: string) => void;
+    loadMore: () => void;
+    reload: () => void;
+}
+export declare function useWorkflowTaskFilterContext(): WorkflowTaskFilterContextValue;
+export declare function WorkflowTaskFilterProvider(props: React.PropsWithChildren<{
+    eventBus?: EventTarget;
+    loadWorkflowTaskStats: LoadWorkflowTaskStats;
+    typeKey?: string;
+}>): React.JSX.Element;
+export declare function WorkflowTaskNavigation(props: {
+    currentTypeKey?: string;
+    mobile: boolean;
+    onTaskTypeSelect: (typeKey: string) => void;
+    taskTypes: WorkflowTaskNavigationType[];
+    t: (key: string) => string;
+}): React.JSX.Element;
+export {};