@nocobase/plugin-workflow 1.2.13-alpha → 1.3.0-alpha.20240710084543

package/dist/server/Processor.d.ts

@@ -1,115 +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.
- */
-import { Transaction, Transactionable } from '@nocobase/database';
-import { Logger } from '@nocobase/logger';
-import type Plugin from './Plugin';
-import type { ExecutionModel, FlowNodeModel, JobModel } from './types';
-export interface ProcessorOptions extends Transactionable {
-    plugin: Plugin;
-    [key: string]: any;
-}
-export default class Processor {
-    execution: ExecutionModel;
-    options: ProcessorOptions;
-    static StatusMap: {
-        0: 0;
-        1: 1;
-        [-1]: -1;
-        [-2]: -2;
-        [-3]: -3;
-        [-4]: -4;
-        [-5]: -5;
-        [-6]: -6;
-    };
-    logger: Logger;
-    /**
-     * @experimental
-     */
-    transaction: Transaction;
-    /**
-     * @experimental
-     */
-    nodes: FlowNodeModel[];
-    /**
-     * @experimental
-     */
-    nodesMap: Map<number, FlowNodeModel>;
-    /**
-     * @experimental
-     */
-    jobsMap: Map<number, JobModel>;
-    /**
-     * @experimental
-     */
-    jobsMapByNodeKey: {
-        [key: string]: any;
-    };
-    /**
-     * @experimental
-     */
-    lastSavedJob: JobModel | null;
-    constructor(execution: ExecutionModel, options: ProcessorOptions);
-    private makeNodes;
-    private makeJobs;
-    prepare(): Promise<void>;
-    start(): Promise<void>;
-    resume(job: JobModel): Promise<void>;
-    private exec;
-    run(node: any, input?: any): any;
-    end(node: any, job: JobModel): Promise<any>;
-    private recall;
-    exit(s?: number): Promise<any>;
-    /**
-     * @experimental
-     * @param {JobModel | Record<string, any>} payload
-     * @returns {JobModel}
-     */
-    saveJob(payload: any): Promise<any>;
-    /**
-     * @experimental
-     */
-    getBranches(node: FlowNodeModel): FlowNodeModel[];
-    /**
-     * @experimental
-     * find the first node in current branch
-     */
-    findBranchStartNode(node: FlowNodeModel, parent?: FlowNodeModel): FlowNodeModel | null;
-    /**
-     * @experimental
-     * find the node start current branch
-     */
-    findBranchParentNode(node: FlowNodeModel): FlowNodeModel | null;
-    /**
-     * @experimental
-     */
-    findBranchEndNode(node: FlowNodeModel): FlowNodeModel | null;
-    /**
-     * @experimental
-     */
-    findBranchParentJob(job: JobModel, node: FlowNodeModel): JobModel | null;
-    /**
-     * @experimental
-     */
-    findBranchLastJob(node: FlowNodeModel, job: JobModel): JobModel | null;
-    /**
-     * @experimental
-     */
-    getScope(sourceNodeId: number): {
-        $context: any;
-        $jobsMapByNodeKey: {
-            [key: string]: any;
-        };
-        $system: {};
-        $scopes: {};
-    };
-    /**
-     * @experimental
-     */
-    getParsedValue(value: any, sourceNodeId: number, additionalScope?: object): any;
-}

package/dist/server/Processor.js

@@ -1,363 +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.
- */
-
-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 Processor_exports = {};
-__export(Processor_exports, {
-  default: () => Processor
-});
-module.exports = __toCommonJS(Processor_exports);
-var import_database = require("@nocobase/database");
-var import_evaluators = require("@nocobase/evaluators");
-var import_utils = require("@nocobase/utils");
-var import_constants = require("./constants");
-class Processor {
-  constructor(execution, options) {
-    this.execution = execution;
-    this.options = options;
-    this.logger = options.plugin.getLogger(execution.workflowId);
-    this.transaction = options.transaction;
-  }
-  static StatusMap = {
-    [import_constants.JOB_STATUS.PENDING]: import_constants.EXECUTION_STATUS.STARTED,
-    [import_constants.JOB_STATUS.RESOLVED]: import_constants.EXECUTION_STATUS.RESOLVED,
-    [import_constants.JOB_STATUS.FAILED]: import_constants.EXECUTION_STATUS.FAILED,
-    [import_constants.JOB_STATUS.ERROR]: import_constants.EXECUTION_STATUS.ERROR,
-    [import_constants.JOB_STATUS.ABORTED]: import_constants.EXECUTION_STATUS.ABORTED,
-    [import_constants.JOB_STATUS.CANCELED]: import_constants.EXECUTION_STATUS.CANCELED,
-    [import_constants.JOB_STATUS.REJECTED]: import_constants.EXECUTION_STATUS.REJECTED,
-    [import_constants.JOB_STATUS.RETRY_NEEDED]: import_constants.EXECUTION_STATUS.RETRY_NEEDED
-  };
-  logger;
-  /**
-   * @experimental
-   */
-  transaction;
-  /**
-   * @experimental
-   */
-  nodes = [];
-  /**
-   * @experimental
-   */
-  nodesMap = /* @__PURE__ */ new Map();
-  /**
-   * @experimental
-   */
-  jobsMap = /* @__PURE__ */ new Map();
-  /**
-   * @experimental
-   */
-  jobsMapByNodeKey = {};
-  /**
-   * @experimental
-   */
-  lastSavedJob = null;
-  // make dual linked nodes list then cache
-  makeNodes(nodes = []) {
-    this.nodes = nodes;
-    nodes.forEach((node) => {
-      this.nodesMap.set(node.id, node);
-    });
-    nodes.forEach((node) => {
-      if (node.upstreamId) {
-        node.upstream = this.nodesMap.get(node.upstreamId);
-      }
-      if (node.downstreamId) {
-        node.downstream = this.nodesMap.get(node.downstreamId);
-      }
-    });
-  }
-  makeJobs(jobs) {
-    jobs.forEach((job) => {
-      this.jobsMap.set(job.id, job);
-      const node = this.nodesMap.get(job.nodeId);
-      this.jobsMapByNodeKey[node.key] = job.result;
-    });
-  }
-  async prepare() {
-    const {
-      execution,
-      transaction,
-      options: { plugin }
-    } = this;
-    if (!execution.workflow) {
-      execution.workflow = plugin.enabledCache.get(execution.workflowId);
-    }
-    const nodes = await execution.workflow.getNodes({ transaction });
-    this.makeNodes(nodes);
-    const jobs = await execution.getJobs({
-      order: [["id", "ASC"]],
-      transaction
-    });
-    this.makeJobs(jobs);
-  }
-  async start() {
-    const { execution } = this;
-    if (execution.status !== import_constants.EXECUTION_STATUS.STARTED) {
-      throw new Error(`execution was ended with status ${execution.status} before, could not be started again`);
-    }
-    await this.prepare();
-    if (this.nodes.length) {
-      const head = this.nodes.find((item) => !item.upstream);
-      await this.run(head, { result: execution.context });
-    } else {
-      await this.exit(import_constants.JOB_STATUS.RESOLVED);
-    }
-  }
-  async resume(job) {
-    const { execution } = this;
-    if (execution.status !== import_constants.EXECUTION_STATUS.STARTED) {
-      throw new Error(`execution was ended with status ${execution.status} before, could not be resumed`);
-    }
-    await this.prepare();
-    const node = this.nodesMap.get(job.nodeId);
-    await this.recall(node, job);
-  }
-  async exec(instruction, node, prevJob) {
-    let job;
-    try {
-      this.logger.info(`execution (${this.execution.id}) run instruction [${node.type}] for node (${node.id})`);
-      this.logger.debug(`config of node`, { data: node.config });
-      job = await instruction(node, prevJob, this);
-      if (!job) {
-        return null;
-      }
-    } catch (err) {
-      this.logger.error(
-        `execution (${this.execution.id}) run instruction [${node.type}] for node (${node.id}) failed: `,
-        { error: err }
-      );
-      job = {
-        result: err instanceof Error ? {
-          message: err.message,
-          ...err
-        } : err,
-        status: import_constants.JOB_STATUS.ERROR
-      };
-      if (prevJob && prevJob.nodeId === node.id) {
-        prevJob.set(job);
-        job = prevJob;
-      }
-    }
-    if (!(job instanceof import_database.Model)) {
-      job.upstreamId = prevJob instanceof import_database.Model ? prevJob.get("id") : null;
-      job.nodeId = node.id;
-      job.nodeKey = node.key;
-    }
-    const savedJob = await this.saveJob(job);
-    this.logger.info(
-      `execution (${this.execution.id}) run instruction [${node.type}] for node (${node.id}) finished as status: ${savedJob.status}`
-    );
-    this.logger.debug(`result of node`, { data: savedJob.result });
-    if (savedJob.status === import_constants.JOB_STATUS.RESOLVED && node.downstream) {
-      this.logger.debug(`run next node (${node.downstreamId})`);
-      return this.run(node.downstream, savedJob);
-    }
-    return this.end(node, savedJob);
-  }
-  async run(node, input) {
-    const { instructions } = this.options.plugin;
-    const instruction = instructions.get(node.type);
-    if (typeof instruction.run !== "function") {
-      return Promise.reject(new Error("`run` should be implemented for customized execution of the node"));
-    }
-    return this.exec(instruction.run.bind(instruction), node, input);
-  }
-  // parent node should take over the control
-  async end(node, job) {
-    this.logger.debug(`branch ended at node (${node.id})`);
-    const parentNode = this.findBranchParentNode(node);
-    if (parentNode) {
-      this.logger.debug(`not on main, recall to parent entry node (${node.id})})`);
-      await this.recall(parentNode, job);
-      return job;
-    }
-    return this.exit(job.status);
-  }
-  async recall(node, job) {
-    const { instructions } = this.options.plugin;
-    const instruction = instructions.get(node.type);
-    if (typeof instruction.resume !== "function") {
-      return Promise.reject(
-        new Error(`"resume" method should be implemented for [${node.type}] instruction of node (#${node.id})`)
-      );
-    }
-    return this.exec(instruction.resume.bind(instruction), node, job);
-  }
-  async exit(s) {
-    if (typeof s === "number") {
-      const status = this.constructor.StatusMap[s] ?? Math.sign(s);
-      await this.execution.update({ status }, { transaction: this.transaction });
-    }
-    this.logger.info(`execution (${this.execution.id}) exiting with status ${this.execution.status}`);
-    return null;
-  }
-  // TODO(optimize)
-  /**
-   * @experimental
-   * @param {JobModel | Record<string, any>} payload
-   * @returns {JobModel}
-   */
-  async saveJob(payload) {
-    const { database } = this.execution.constructor;
-    const { transaction } = this;
-    const { model } = database.getCollection("jobs");
-    let job;
-    if (payload instanceof model) {
-      job = await payload.save({ transaction });
-    } else if (payload.id) {
-      job = await model.findByPk(payload.id, { transaction });
-      await job.update(payload, { transaction });
-    } else {
-      job = await model.create(
-        {
-          ...payload,
-          executionId: this.execution.id
-        },
-        { transaction }
-      );
-    }
-    this.jobsMap.set(job.id, job);
-    this.lastSavedJob = job;
-    this.jobsMapByNodeKey[job.nodeKey] = job.result;
-    return job;
-  }
-  /**
-   * @experimental
-   */
-  getBranches(node) {
-    return this.nodes.filter((item) => item.upstream === node && item.branchIndex !== null).sort((a, b) => Number(a.branchIndex) - Number(b.branchIndex));
-  }
-  /**
-   * @experimental
-   * find the first node in current branch
-   */
-  findBranchStartNode(node, parent) {
-    for (let n = node; n; n = n.upstream) {
-      if (!parent) {
-        if (n.branchIndex !== null) {
-          return n;
-        }
-      } else {
-        if (n.upstream === parent) {
-          return n;
-        }
-      }
-    }
-    return null;
-  }
-  /**
-   * @experimental
-   * find the node start current branch
-   */
-  findBranchParentNode(node) {
-    for (let n = node; n; n = n.upstream) {
-      if (n.branchIndex !== null) {
-        return n.upstream;
-      }
-    }
-    return null;
-  }
-  /**
-   * @experimental
-   */
-  findBranchEndNode(node) {
-    for (let n = node; n; n = n.downstream) {
-      if (!n.downstream) {
-        return n;
-      }
-    }
-    return null;
-  }
-  /**
-   * @experimental
-   */
-  findBranchParentJob(job, node) {
-    for (let j = job; j; j = this.jobsMap.get(j.upstreamId)) {
-      if (j.nodeId === node.id) {
-        return j;
-      }
-    }
-    return null;
-  }
-  /**
-   * @experimental
-   */
-  findBranchLastJob(node, job) {
-    const allJobs = Array.from(this.jobsMap.values());
-    const branchJobs = [];
-    for (let n = this.findBranchEndNode(node); n && n !== node.upstream; n = n.upstream) {
-      branchJobs.push(...allJobs.filter((item) => item.nodeId === n.id));
-    }
-    branchJobs.sort((a, b) => a.createdAt.getTime() - b.createdAt.getTime());
-    for (let i = branchJobs.length - 1; i >= 0; i -= 1) {
-      for (let j = branchJobs[i]; j && j.id !== job.id; j = this.jobsMap.get(j.upstreamId)) {
-        if (j.upstreamId === job.id) {
-          return branchJobs[i];
-        }
-      }
-    }
-    return null;
-  }
-  /**
-   * @experimental
-   */
-  getScope(sourceNodeId) {
-    const node = this.nodesMap.get(sourceNodeId);
-    const systemFns = {};
-    const scope = {
-      execution: this.execution,
-      node
-    };
-    for (const [name, fn] of this.options.plugin.functions.getEntities()) {
-      systemFns[name] = fn.bind(scope);
-    }
-    const $scopes = {};
-    for (let n = this.findBranchParentNode(node); n; n = this.findBranchParentNode(n)) {
-      const instruction = this.options.plugin.instructions.get(n.type);
-      if (typeof instruction.getScope === "function") {
-        $scopes[n.id] = $scopes[n.key] = instruction.getScope(n, this.jobsMapByNodeKey[n.key], this);
-      }
-    }
-    return {
-      $context: this.execution.context,
-      $jobsMapByNodeKey: this.jobsMapByNodeKey,
-      $system: systemFns,
-      $scopes
-    };
-  }
-  /**
-   * @experimental
-   */
-  getParsedValue(value, sourceNodeId, additionalScope) {
-    const template = (0, import_utils.parse)(value);
-    const scope = Object.assign(this.getScope(sourceNodeId), additionalScope);
-    template.parameters.forEach(({ key }) => {
-      (0, import_evaluators.appendArrayColumn)(scope, key);
-    });
-    return template(scope);
-  }
-}

package/dist/server/actions/executions.d.ts

@@ -1,11 +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.
- */
-import { Context } from '@nocobase/actions';
-export declare function destroy(context: Context, next: any): Promise<void>;
-export declare function cancel(context: Context, next: any): Promise<never>;

package/dist/server/actions/executions.js

@@ -1,96 +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.
- */
-
-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 executions_exports = {};
-__export(executions_exports, {
-  cancel: () => cancel,
-  destroy: () => destroy
-});
-module.exports = __toCommonJS(executions_exports);
-var import_actions = __toESM(require("@nocobase/actions"));
-var import_database = require("@nocobase/database");
-var import_constants = require("../constants");
-async function destroy(context, next) {
-  context.action.mergeParams({
-    filter: {
-      status: {
-        [import_database.Op.ne]: import_constants.EXECUTION_STATUS.STARTED
-      }
-    }
-  });
-  await import_actions.default.destroy(context, next);
-}
-async function cancel(context, next) {
-  const { filterByTk } = context.action.params;
-  const ExecutionRepo = context.db.getRepository("executions");
-  const JobRepo = context.db.getRepository("jobs");
-  const execution = await ExecutionRepo.findOne({
-    filterByTk,
-    appends: ["jobs"]
-  });
-  if (!execution) {
-    return context.throw(404);
-  }
-  if (execution.status) {
-    return context.throw(400);
-  }
-  await context.db.sequelize.transaction(async (transaction) => {
-    await execution.update(
-      {
-        status: import_constants.EXECUTION_STATUS.CANCELED
-      },
-      { transaction }
-    );
-    const pendingJobs = execution.jobs.filter((job) => job.status === import_constants.JOB_STATUS.PENDING);
-    await JobRepo.update({
-      values: {
-        status: import_constants.JOB_STATUS.CANCELED
-      },
-      filter: {
-        id: pendingJobs.map((job) => job.id)
-      },
-      individualHooks: false,
-      transaction
-    });
-  });
-  context.body = execution;
-  await next();
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  cancel,
-  destroy
-});

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

@@ -1,11 +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.
- */
-export default function ({ app }: {
-    app: any;
-}): void;

package/dist/server/actions/index.js

@@ -1,66 +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.
- */
-
-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 actions_exports = {};
-__export(actions_exports, {
-  default: () => actions_default
-});
-module.exports = __toCommonJS(actions_exports);
-var workflows = __toESM(require("./workflows"));
-var nodes = __toESM(require("./nodes"));
-var executions = __toESM(require("./executions"));
-function make(name, mod) {
-  return Object.keys(mod).reduce(
-    (result, key) => ({
-      ...result,
-      [`${name}:${key}`]: mod[key]
-    }),
-    {}
-  );
-}
-function actions_default({ app }) {
-  app.actions({
-    ...make("workflows", workflows),
-    ...make("workflows.nodes", {
-      create: nodes.create
-    }),
-    ...make("flow_nodes", {
-      update: nodes.update,
-      destroy: nodes.destroy
-    }),
-    ...make("executions", executions)
-  });
-}

package/dist/server/actions/nodes.d.ts

@@ -1,12 +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.
- */
-import { Context } from '@nocobase/actions';
-export declare function create(context: Context, next: any): Promise<void>;
-export declare function destroy(context: Context, next: any): Promise<void>;
-export declare function update(context: Context, next: any): Promise<void>;