@rytass/bpm-core-nestjs-module 0.6.0 → 0.7.0

package/src/lib/workflow-engine/workflow-engine.service.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkflowEngineService = void 0;
+exports.WorkflowEngineService = exports.MANUAL_TRANSFER_DELEGATION_REASON = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@nestjs/common");
 const typeorm_1 = require("@nestjs/typeorm");
@@ -9,6 +9,7 @@ const attachment_service_1 = require("../attachment/attachment.service");
 const delegation_service_1 = require("../delegation/delegation.service");
 const form_definition_version_entity_1 = require("../form/form-definition-version.entity");
 const form_enums_1 = require("../form/form.enums");
+const sla_schedule_service_1 = require("../calendar/sla-schedule.service");
 const notification_service_1 = require("../notification/notification.service");
 const notification_entity_1 = require("../notification/notification.entity");
 const notification_enums_1 = require("../notification/notification.enums");
@@ -36,6 +37,11 @@ const workflow_token_entity_1 = require("./workflow-token.entity");
 const MAX_PROCESSING_STEPS = 500;
 const DEFAULT_APPROVAL_HISTORY_TASK_LIMIT = 50;
 const SYSTEM_DRY_RUN_INSTANCE_ID = 'dry-run-instance';
+/**
+ * Delegation-chain reason recorded for an approver-initiated transfer, as
+ * opposed to {@link SLA_ESCALATION_DELEGATION_REASON}.
+ */
+exports.MANUAL_TRANSFER_DELEGATION_REASON = 'MANUAL_TRANSFER';
 const WORKFLOW_READ_ALL_PERMISSIONS = new Set([
     'bpm:*',
     'bpm.workflow.read_all',
@@ -43,7 +49,7 @@ const WORKFLOW_READ_ALL_PERMISSIONS = new Set([
     'workflow.read_all',
 ]);
 let WorkflowEngineService = class WorkflowEngineService {
-    constructor(approvalInstanceRepository, workflowTokenRepository, taskRepository, taskCandidateRepository, taskDecisionRepository, notificationRepository, activityLogRepository, adhocDirectiveRepository, approvalTemplateRepository, approvalTemplateVersionRepository, formDefinitionVersionRepository, attachmentService, conditionService, delegationService, notificationService, signatureService, serviceTaskDispatcher = new workflow_service_task_dispatcher_token_1.DefaultWorkflowServiceTaskDispatcher()) {
+    constructor(approvalInstanceRepository, workflowTokenRepository, taskRepository, taskCandidateRepository, taskDecisionRepository, notificationRepository, activityLogRepository, adhocDirectiveRepository, approvalTemplateRepository, approvalTemplateVersionRepository, formDefinitionVersionRepository, attachmentService, conditionService, delegationService, notificationService, signatureService, slaScheduleService, serviceTaskDispatcher = new workflow_service_task_dispatcher_token_1.DefaultWorkflowServiceTaskDispatcher()) {
         this.approvalInstanceRepository = approvalInstanceRepository;
         this.workflowTokenRepository = workflowTokenRepository;
         this.taskRepository = taskRepository;
@@ -60,6 +66,7 @@ let WorkflowEngineService = class WorkflowEngineService {
         this.delegationService = delegationService;
         this.notificationService = notificationService;
         this.signatureService = signatureService;
+        this.slaScheduleService = slaScheduleService;
         this.serviceTaskDispatcher = serviceTaskDispatcher;
     }
     async submitApprovalInstance(input) {
@@ -169,7 +176,7 @@ let WorkflowEngineService = class WorkflowEngineService {
             await this.processRunningInstance(manager, instance);
         });
     }
-    async decideTask(input) {
+    async decideTask(input, options = {}) {
         return this.approvalInstanceRepository.manager.transaction(async (manager) => {
             const taskRepository = manager.getRepository(task_entity_1.TaskEntity);
             const taskCandidateRepository = manager.getRepository(task_candidate_entity_1.TaskCandidateEntity);
@@ -223,6 +230,14 @@ let WorkflowEngineService = class WorkflowEngineService {
             const returnToNodeId = input.action === workflow_engine_enums_1.TaskDecisionActionEnum.RETURNED
                 ? readReturnTargetNodeId(instance.workflowSnapshot, task.nodeId, input.returnToNodeId)
                 : null;
+            // Read from the instance snapshot, not the live template: templates
+            // that turn `requireComment` on later must not retroactively block
+            // in-flight instances started against the previous version.
+            if (input.action === workflow_engine_enums_1.TaskDecisionActionEnum.RETURNED &&
+                !decisionComment &&
+                isReturnCommentRequired(instance.workflowSnapshot, task.nodeId)) {
+                throw new common_1.BadRequestException(`Return decision comment is required by workflow node ${task.nodeId}`);
+            }
             const decidedAt = new Date();
             const claimedTask = await taskRepository.save({
                 ...task,
@@ -261,7 +276,7 @@ let WorkflowEngineService = class WorkflowEngineService {
                 transferToMemberId,
             }));
             if (input.action === workflow_engine_enums_1.TaskDecisionActionEnum.TRANSFERRED) {
-                await this.transferTask(manager, instance, claimedTask, decision, signature, transferToMemberId, decisionComment, decidedAt, claimedCandidate);
+                await this.transferTask(manager, instance, claimedTask, decision, signature, transferToMemberId, decisionComment, decidedAt, claimedCandidate, options.transferReason ?? exports.MANUAL_TRANSFER_DELEGATION_REASON);
                 await this.notificationService.resolveTaskNotifications({
                     actingMemberId: input.decidedByMemberId,
                     manager,
@@ -1895,6 +1910,10 @@ let WorkflowEngineService = class WorkflowEngineService {
         const candidates = await this.resolveRuntimeTaskCandidates(manager, instance, node);
         const primaryCandidate = candidates[0];
         const now = new Date();
+        const slaDueAt = await this.slaScheduleService.resolveTaskSlaDueAt({
+            node,
+            now,
+        });
         const task = await taskRepository.save(taskRepository.create({
             assigneeMemberId: candidates.length === 1 ? primaryCandidate.memberId : null,
             assignmentType: candidates.length === 1
@@ -1908,7 +1927,7 @@ let WorkflowEngineService = class WorkflowEngineService {
             nodeId: node.id,
             openedAt: null,
             originalAssigneeMemberId: candidates.length === 1 ? primaryCandidate.originalMemberId : null,
-            slaDueAt: (0, notification_service_1.calculateTaskSlaDueAt)({ node, now }),
+            slaDueAt,
             status: workflow_engine_enums_1.TaskStatusEnum.PENDING,
             tokenId: token.id,
         }));
@@ -2006,7 +2025,7 @@ let WorkflowEngineService = class WorkflowEngineService {
         }
         return nextCandidates;
     }
-    async transferTask(manager, instance, task, decision, signature, transferToMemberId, decisionComment, decidedAt, actorCandidate) {
+    async transferTask(manager, instance, task, decision, signature, transferToMemberId, decisionComment, decidedAt, actorCandidate, transferReason) {
         if (!transferToMemberId) {
             throw new common_1.BadRequestException('Transfer target member is required');
         }
@@ -2021,7 +2040,7 @@ let WorkflowEngineService = class WorkflowEngineService {
             ...readDelegationSteps(task.delegationChain),
             {
                 from: transferringMemberId,
-                reason: 'MANUAL_TRANSFER',
+                reason: transferReason,
                 ruleId: null,
                 to: transferToMemberId,
             },
@@ -2715,8 +2734,8 @@ exports.WorkflowEngineService = WorkflowEngineService = tslib_1.__decorate([
     tslib_1.__param(8, (0, typeorm_1.InjectRepository)(approval_template_entity_1.ApprovalTemplateEntity)),
     tslib_1.__param(9, (0, typeorm_1.InjectRepository)(approval_template_version_entity_1.ApprovalTemplateVersionEntity)),
     tslib_1.__param(10, (0, typeorm_1.InjectRepository)(form_definition_version_entity_1.FormDefinitionVersionEntity)),
-    tslib_1.__param(16, (0, common_1.Optional)()),
-    tslib_1.__param(16, (0, common_1.Inject)(workflow_service_task_dispatcher_token_1.BPM_WORKFLOW_SERVICE_TASK_DISPATCHER)),
+    tslib_1.__param(17, (0, common_1.Optional)()),
+    tslib_1.__param(17, (0, common_1.Inject)(workflow_service_task_dispatcher_token_1.BPM_WORKFLOW_SERVICE_TASK_DISPATCHER)),
     tslib_1.__metadata("design:paramtypes", [typeorm_2.Repository,
         typeorm_2.Repository,
         typeorm_2.Repository,
@@ -2732,7 +2751,8 @@ exports.WorkflowEngineService = WorkflowEngineService = tslib_1.__decorate([
         condition_service_1.ConditionService,
         delegation_service_1.DelegationService,
         notification_service_1.NotificationService,
-        signature_service_1.SignatureService, Object])
+        signature_service_1.SignatureService,
+        sla_schedule_service_1.BPMSlaScheduleService, Object])
 ], WorkflowEngineService);
 function parseJsonObject(value, label) {
     try {
@@ -2916,6 +2936,11 @@ function readDefaultReturnTargetNodeId(workflow, currentNode) {
     }
     return previousNodeId;
 }
+function isReturnCommentRequired(workflow, nodeId) {
+    const node = readWorkflowNodeOrThrow(workflow, nodeId);
+    return (node.type === 'userTask' &&
+        node.data.returnBehavior.requireComment === true);
+}
 function readReturnResubmitStrategy(task, instance) {
     const node = readWorkflowNodeOrThrow(instance.workflowSnapshot, task.nodeId);
     if (node.type !== 'userTask') {