@onlineapps/conn-orch-orchestrator 2.0.0 → 2.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onlineapps/conn-orch-orchestrator",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Workflow orchestration connector for OA Drive - handles message routing and workflow execution",
   "main": "src/index.js",
   "scripts": {

package/src/WorkflowOrchestrator.js

@@ -73,6 +73,35 @@ class WorkflowOrchestrator {
     }
   }
 
+  /**
+   * Extract correlation_id from an inbound MQ message envelope.
+   * Accepts the canonical body-level `correlation_id` and also a few known
+   * legacy placements from transports that move AMQP headers onto the
+   * parsed message object. Returns undefined if none are set - the caller
+   * is responsible for fail-fast.
+   * @private
+   * @param {Object} message - Inbound workflow message
+   * @returns {string|undefined}
+   */
+  _extractCorrelationId(message) {
+    if (!message || typeof message !== 'object') return undefined;
+    if (typeof message.correlation_id === 'string' && message.correlation_id.length > 0) {
+      return message.correlation_id;
+    }
+    if (message.envelope && typeof message.envelope.correlation_id === 'string' && message.envelope.correlation_id.length > 0) {
+      return message.envelope.correlation_id;
+    }
+    if (message.headers) {
+      if (typeof message.headers.correlation_id === 'string' && message.headers.correlation_id.length > 0) {
+        return message.headers.correlation_id;
+      }
+      if (typeof message.headers.correlationId === 'string' && message.headers.correlationId.length > 0) {
+        return message.headers.correlationId;
+      }
+    }
+    return undefined;
+  }
+
   /**
    * Get step identifier (V2.1 only: step_id)
    * @private
@@ -144,8 +173,29 @@ class WorkflowOrchestrator {
   async processWorkflowMessage(message, serviceName) {
     const { workflow_id, cookbook: cookbookDef, current_step } = message;
     const startTime = Date.now();
+    // correlation_id is required by RFC §5.8 — validated below inside the
+    // try block so malformed messages flow through the retry/DLQ pipeline
+    // and a `failed` monitoring event is emitted (no silent redelivery).
+    const correlationId = this._extractCorrelationId(message);
 
     try {
+      // Fail-fast: correlation_id MUST be present on every workflow message.
+      // (ContextBuilder._validateMqMessage rejects empty strings too.)
+      // Gateway is expected to publish it; if it does not, that is a gateway
+      // bug we want to surface loudly rather than silently produce 500s
+      // inside invokeOperation's ContextBuilder.
+      if (typeof correlationId !== 'string' || correlationId.length === 0) {
+        const err = new Error(
+          '[WorkflowOrchestrator] message.correlation_id is required - ' +
+          `Expected non-empty string on inbound workflow message (workflow_id='${workflow_id}', step='${current_step}'). ` +
+          'Fix: ensure publisher (gateway / router) sets correlation_id on message body per RFC §5.8.'
+        );
+        err.errorCode = 'MISSING_CORRELATION_ID';
+        err.statusCode = 400;
+        err.type = 'VALIDATION';
+        throw err;
+      }
+
       // Validate cookbook structure
       this.cookbook.validateCookbook(cookbookDef);
 
@@ -199,9 +249,24 @@ class WorkflowOrchestrator {
           stepsMap[id] = s;
         }
       });
+      // Extract tenant/workspace/person context.
+      // Canonical source is cookbook._system (set by gateway); top-level
+      // message fields are accepted as an override for direct publishers
+      // that do not carry a _system block.
+      const sys = cookbookDef._system || {};
+      const tenantId = message.tenant_id !== undefined ? message.tenant_id : sys.tenant_id;
+      const workspaceId = message.workspace_id !== undefined
+        ? message.workspace_id
+        : (sys.workspace_id !== undefined ? sys.workspace_id : sys.default_workspace_id);
+      const personId = message.person_id !== undefined ? message.person_id : sys.person_id;
+
       const stepContext = {
         workflow_id: workflow_id,
         step_id: current_step,
+        correlation_id: correlationId,
+        tenant_id: tenantId,
+        workspace_id: workspaceId,
+        person_id: personId,
         api_input: cookbookDef.api_input || {},
         steps: stepsArrayCtx,       // array (legacy consumers expect .map)
         steps_by_id: stepsMap,      // fast lookup by step_id for templating
@@ -274,9 +339,16 @@ class WorkflowOrchestrator {
         });
       }
 
-      // Route to next step or complete workflow
+      // Route to next step or complete workflow.
+      // Propagate correlation_id + tenancy so the next consumer can validate
+      // the envelope (RFC §5.8).
       if (nextStep) {
-        await this._routeToNextStep(nextStep, updatedCookbook, workflow_id);
+        await this._routeToNextStep(nextStep, updatedCookbook, workflow_id, {
+          correlation_id: correlationId,
+          tenant_id: tenantId,
+          workspace_id: workspaceId,
+          person_id: personId
+        });
       } else {
         await this._completeWorkflow(workflow_id, updatedCookbook, serviceName, current_step, currentIndex);
       }
@@ -417,10 +489,19 @@ class WorkflowOrchestrator {
 
         await new Promise(resolve => setTimeout(resolve, delay));
 
-        // Republish with UNIFIED cookbook
+        // Republish with UNIFIED cookbook.
+        // Propagate correlation_id + tenancy so the retry consumer passes
+        // ContextBuilder validation on the next attempt (RFC §5.8).
         const serviceQueue = `${serviceName}.workflow`;
+        const sysRetry = updatedCookbook?._system || {};
         await this.mqClient.publish(serviceQueue, {
           workflow_id,
+          correlation_id: correlationId,
+          tenant_id: message.tenant_id !== undefined ? message.tenant_id : sysRetry.tenant_id,
+          workspace_id: message.workspace_id !== undefined
+            ? message.workspace_id
+            : (sysRetry.workspace_id !== undefined ? sysRetry.workspace_id : sysRetry.default_workspace_id),
+          person_id: message.person_id !== undefined ? message.person_id : sysRetry.person_id,
           cookbook: updatedCookbook,
           current_step
         });
@@ -1084,13 +1165,20 @@ class WorkflowOrchestrator {
    * @param {Object} nextStep - Next step to execute
    * @param {Object} cookbook - UNIFIED cookbook (contains everything)
    * @param {string} workflow_id - Workflow ID
+   * @param {Object} envelope - envelope to propagate (correlation_id, tenant_id, workspace_id, person_id)
    */
-  async _routeToNextStep(nextStep, cookbook, workflow_id) {
+  async _routeToNextStep(nextStep, cookbook, workflow_id, envelope = {}) {
     const nextStepId = this._getStepId(nextStep);
-    
-    // UNIFIED COOKBOOK: no separate context, everything is in cookbook
+
+    // UNIFIED COOKBOOK: no separate context, everything is in cookbook.
+    // correlation_id + tenancy are propagated on the message envelope so
+    // the next consumer's ContextBuilder validation succeeds (RFC §5.8).
     const message = {
       workflow_id,
+      correlation_id: envelope.correlation_id,
+      tenant_id: envelope.tenant_id,
+      workspace_id: envelope.workspace_id,
+      person_id: envelope.person_id,
       cookbook: cookbook,
       current_step: nextStepId
     };