Merge pull request #233 from ProcessMaker/FOUR-26911

FOUR-26911 Implement Catch Event Message Mapping

Author: caleeli

src/ProcessMaker/Nayra/Bpmn/CatchEventTrait.php

@@ -30,6 +30,7 @@ protected function initCatchEventTrait()
     {
         $this->setProperty(CatchEventInterface::BPMN_PROPERTY_EVENT_DEFINITIONS, new Collection);
         $this->setProperty(CatchEventInterface::BPMN_PROPERTY_PARALLEL_MULTIPLE, false);
+        $this->setProperty(CatchEventInterface::BPMN_PROPERTY_DATA_OUTPUT_ASSOCIATION, new Collection);
     }
 
     /**
@@ -42,6 +43,11 @@ public function getEventDefinitions()
         return $this->getProperty(CatchEventInterface::BPMN_PROPERTY_EVENT_DEFINITIONS);
     }
 
+    public function getDataOutputAssociations()
+    {
+        return $this->getProperty(CatchEventInterface::BPMN_PROPERTY_DATA_OUTPUT_ASSOCIATION);
+    }
+
     /**
      * Register catch events.
      *

src/ProcessMaker/Nayra/Bpmn/DataOutputAssociation.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace ProcessMaker\Nayra\Bpmn;
+
+use ProcessMaker\Nayra\Contracts\Bpmn\DataOutputAssociationInterface;
+
+/**
+ * DataOutputAssociation class for handling data output associations in BPMN processes
+ */
+class DataOutputAssociation implements DataOutputAssociationInterface
+{
+    use BaseTrait;
+
+    protected function initDataOutputAssociation()
+    {
+        $this->properties[static::BPMN_PROPERTY_ASSIGNMENT] = new Collection;
+    }
+
+    public function getSource()
+    {
+        return $this->getProperty(static::BPMN_PROPERTY_SOURCES_REF);
+    }
+
+    public function getTarget()
+    {
+        return $this->getProperty(static::BPMN_PROPERTY_TARGET_REF);
+    }
+
+    public function getTransformation()
+    {
+        return $this->getProperty(static::BPMN_PROPERTY_TRANSFORMATION);
+    }
+
+    public function getAssignments()
+    {
+        return $this->getProperty(static::BPMN_PROPERTY_ASSIGNMENT);
+    }
+}

src/ProcessMaker/Nayra/Bpmn/DataStoreTrait.php

@@ -113,21 +113,21 @@ public function getDotData($path, $default = null)
     {
         $keys = explode('.', $path);
         $current = $this->data;
-        
+
         // Navigate through the path
         foreach ($keys as $key) {
             // Handle numeric keys for arrays
             if (is_numeric($key)) {
                 $key = (int) $key;
             }
-            
+
             if (!isset($current[$key])) {
                 return $default;
             }
-            
+
             $current = $current[$key];
         }
-        
+
         return $current;
     }
 
@@ -142,31 +142,34 @@ public function getDotData($path, $default = null)
     public function setDotData($path, $value)
     {
         $keys = explode('.', $path);
+        $firstKey = $keys[0];
         $current = &$this->data;
-        
+
         // Navigate to the parent of the target key
         for ($i = 0; $i < count($keys) - 1; $i++) {
             $key = $keys[$i];
-            
+
             // Handle numeric keys for arrays
             if (is_numeric($key)) {
                 $key = (int) $key;
             }
-            
+
             if (!isset($current[$key]) || !is_array($current[$key])) {
                 $current[$key] = [];
             }
             $current = &$current[$key];
         }
-        
+
         // Set the final value
         $finalKey = $keys[count($keys) - 1];
         if (is_numeric($finalKey)) {
             $finalKey = (int) $finalKey;
         }
-        
+
         $current[$finalKey] = $value;
-        
+        // Keep compatibility with putData method (required by PM Core)
+        $this->putData($firstKey, $this->data[$firstKey]);
+
         return $this;
     }
 }

src/ProcessMaker/Nayra/Bpmn/Models/MessageEventDefinition.php

@@ -3,6 +3,9 @@
 namespace ProcessMaker\Nayra\Bpmn\Models;
 
 use ProcessMaker\Nayra\Bpmn\EventDefinitionTrait;
+use ProcessMaker\Nayra\Contracts\Bpmn\CatchEventInterface;
+use ProcessMaker\Nayra\Contracts\Bpmn\CollectionInterface;
+use ProcessMaker\Nayra\Contracts\Bpmn\DataStoreInterface;
 use ProcessMaker\Nayra\Contracts\Bpmn\EventDefinitionInterface;
 use ProcessMaker\Nayra\Contracts\Bpmn\FlowNodeInterface;
 use ProcessMaker\Nayra\Contracts\Bpmn\MessageEventDefinitionInterface;
@@ -90,47 +93,78 @@ public function assertsRule(EventDefinitionInterface $event, FlowNodeInterface $
     public function execute(EventDefinitionInterface $event, FlowNodeInterface $target, ExecutionInstanceInterface $instance = null, TokenInterface $token = null)
     {
         $throwEvent = $token->getOwnerElement();
-        $this->evaluateMessagePayload($throwEvent, $token, $instance);
+        $this->executeMessageMapping($throwEvent, $target, $instance, $token);
         return $this;
     }
 
     /**
-     * Evaluate the message payload
+     * Map a message payload from a ThrowEvent through an optional CatchEvent mapping
+     * into the instance data store.
      *
      * @param ThrowEventInterface $throwEvent
+     * @param CatchEventInterface $catchEvent
+     * @param ExecutionInstanceInterface $instance
      * @param TokenInterface $token
-     * @param ExecutionInstanceInterface $targetInstance
+     *
+     * @return void
+     */
+    private function executeMessageMapping(ThrowEventInterface $throwEvent, CatchEventInterface $catchEvent, ExecutionInstanceInterface $instance, TokenInterface $token): void
+    {
+        $sourceMaps = $throwEvent->getDataInputAssociations();
+        $targetMaps = $catchEvent->getDataOutputAssociations();
+        $targetStore = $instance->getDataStore();
+
+        // Source of data is the token's instance store if present; otherwise a fresh store.
+        $sourceStore = $token->getInstance()?->getDataStore() ?? new DataStore();
+
+        // If target mappings exist we stage into a buffer; otherwise write straight to the instance store.
+        $bufferStore = !count($targetMaps) ? $targetStore : new DataStore();
+
+        // 1) Source mappings: source → buffer/instance
+        $this->evaluateMessagePayload($sourceMaps, $sourceStore, $bufferStore);
+
+        // 2) Optional target mappings: buffer → instance
+        if (count($targetMaps)) {
+            $this->evaluateMessagePayload($targetMaps, $bufferStore, $targetStore);
+        }
+    }
+
+    /**
+     * Evaluate the message payload
+     *
+     * @param CollectionInterface $associations
+     * @param DataStoreInterface $sourceStore
+     * @param DataStoreInterface $targetStore
+     *
      * @return void
      */
-    private function evaluateMessagePayload(ThrowEventInterface $throwEvent, TokenInterface $token, ExecutionInstanceInterface $targetInstance)
+    private function evaluateMessagePayload(CollectionInterface $associations, DataStoreInterface $sourceStore, DataStoreInterface $targetStore): void
     {
-        // Initialize message payload
-        $payload = [];
-        $associations = $throwEvent->getDataInputAssociations();
-        // Get data from source token instance or empty one if not found
-        $sourceDataStore = $token->getInstance()?->getDataStore() ?? new DataStore();
+        $assignments = [];
 
-        // Associate data inputs to message payload
         foreach ($associations as $association) {
-            $data = $sourceDataStore->getData();
             $source = $association->getSource();
             $target = $association->getTarget();
 
-            // Add reference to source
             $hasSource = $source && $source->getName();
             $hasTarget = $target && $target->getName();
-            $data['sourceRef'] = $hasSource ? $sourceDataStore->getDotData($source->getName()) : null;
 
-            // Apply transformation
-            $this->applyTransformation($association, $data, $payload, $hasTarget, $hasSource);
+            // Base data always starts from full source store
+            $data = $sourceStore->getData();
+
+            // Optionally add a direct reference to the source value
+            if ($hasSource) {
+                $data['sourceRef'] = $sourceStore->getDotData($source->getName());
+            }
 
-            // Evaluate assignments
-            $this->evaluateAssignments($association, $data, $payload);
+            // Transformation and assignments build up the assignments list
+            $this->applyTransformation($association, $data, $assignments, $hasTarget, $hasSource);
+            $this->evaluateAssignments($association, $data, $assignments);
         }
-        // Update data into target $instance
-        $dataStore = $targetInstance->getDataStore();
-        foreach ($payload as $load) {
-            $dataStore->setDotData($load['key'], $load['value']);
+
+        // Flush all assignments into target store
+        foreach ($assignments as $assignment) {
+            $targetStore->setDotData($assignment['key'], $assignment['value']);
         }
     }
 

src/ProcessMaker/Nayra/Contracts/Bpmn/CatchEventInterface.php

@@ -16,6 +16,12 @@ interface CatchEventInterface extends EventInterface
 
     const EVENT_CATCH_TOKEN_ARRIVES = 'CatchEventTokenArrives';
 
+    const BPMN_PROPERTY_DATA_OUTPUT = 'dataOutput';
+
+    const BPMN_PROPERTY_DATA_OUTPUT_SET = 'outputSet';
+
+    const BPMN_PROPERTY_DATA_OUTPUT_ASSOCIATION = 'dataOutputAssociation';
+
     /**
      * Get EventDefinitions that are triggers expected for a catch Event.
      *
@@ -57,4 +63,11 @@ public function execute(EventDefinitionInterface $event, ExecutionInstanceInterf
      * @return StateInterface
      */
     public function getActiveState();
+
+    /**
+     * Get the data output associations.
+     *
+     * @return DataOutputAssociationInterface[]
+     */
+    public function getDataOutputAssociations();
 }

src/ProcessMaker/Nayra/Contracts/Bpmn/CollectionInterface.php

@@ -3,11 +3,12 @@
 namespace ProcessMaker\Nayra\Contracts\Bpmn;
 
 use SeekableIterator;
+use Countable;
 
 /**
  * CollectionInterface
  */
-interface CollectionInterface extends SeekableIterator
+interface CollectionInterface extends SeekableIterator, Countable
 {
     /**
      * Count the elements of the collection.

src/ProcessMaker/Nayra/Contracts/Bpmn/DataAssociationInterface.php

@@ -7,6 +7,11 @@
  */
 interface DataAssociationInterface extends EntityInterface
 {
+    const BPMN_PROPERTY_ASSIGNMENT = 'assignment';
+    const BPMN_PROPERTY_SOURCES_REF = 'sourceRef';
+    const BPMN_PROPERTY_TARGET_REF = 'targetRef';
+    const BPMN_PROPERTY_TRANSFORMATION = 'transformation';
+
     /**
      * Get the source of the data association.
      *

src/ProcessMaker/Nayra/Contracts/Bpmn/DataOutputAssociationInterface.php

@@ -7,4 +7,5 @@
  */
 interface DataOutputAssociationInterface extends DataAssociationInterface
 {
+    
 }

src/ProcessMaker/Nayra/Contracts/Bpmn/ThrowEventInterface.php

@@ -18,6 +18,12 @@ interface ThrowEventInterface extends EventInterface
 
     const EVENT_THROW_TOKEN_CONSUMED = 'ThrowEventTokenConsumed';
 
+    const BPMN_PROPERTY_DATA_INPUT = 'dataInput';
+
+    const BPMN_PROPERTY_DATA_INPUT_SET = 'inputSet';
+
+    const BPMN_PROPERTY_DATA_INPUT_ASSOCIATION = 'dataInputAssociation';
+
     /**
      * Get Data Inputs for the throw Event.
      *

src/ProcessMaker/Nayra/RepositoryTrait.php

@@ -5,6 +5,7 @@
 use InvalidArgumentException;
 use ProcessMaker\Nayra\Bpmn\Assignment;
 use ProcessMaker\Nayra\Bpmn\DataInputAssociation;
+use ProcessMaker\Nayra\Bpmn\DataOutputAssociation;
 use ProcessMaker\Nayra\Bpmn\Lane;
 use ProcessMaker\Nayra\Bpmn\LaneSet;
 use ProcessMaker\Nayra\Bpmn\Models\Activity;
@@ -493,4 +494,9 @@ public function createAssignment()
     {
         return new Assignment();
     }
+
+    public function createDataOutputAssociation()
+    {
+        return new DataOutputAssociation();
+    }
 }