Timeout implementation

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.2.2 (August 25, 2021)
+* Added delay timer property in re-assemble action.
+
 ## 1.2.1 (July 23, 2021)
 * Implemented support of maester storage in `Re-assembled message` action (maester-client library 3.3.0)
 

README.md

@@ -90,11 +90,12 @@ and the JSONata expression `Phone.{type: number}`, an object constructor, the ac
 ```Split Property``` - use this field to choose a separator.
 
 ### Re-assemble Messages 
-**(Beta)**
 
-Inverse of the split action: Given a stream of incoming messages that which have 
-been split apart by a split action (or similar), produce one message once all 
-message parts have arrived.
+Inverse of the split action: Given a stream of incoming messages a sum message is generated.
+Has 3 different behaviour variants:
+* Only specify group size and no delay timer. A message is emitted once the group size is reached for the given group. Should less message then the given group size arrive, then the group is silently discarded.
+* Only specify delay timer and no group size. All incomming messages count towards the delay timer. Once no more message is received in this time frame there will be a emitted message for each group.
+* Specify both group size and delay timer. Groups that have reached their limit are emitted directly. Beyond that the action behaves as specifed in the line before.
 
 Supported:
 * Messages can be re-ordered in the flow
@@ -103,28 +104,29 @@ Supported:
 (e.g. Two overlapping webhook calls arrive and the flow has components where parallel processing > 1.)
 
 Limitations:
-* All groups must have one or more messages. (i.e. No groups of size 0). 
-Can't do re-grouping when a split is done on an empty array. (i.e. No empty for each pattern supported)
-* If all messages in a group fail to arrive at the re-assemble action (because one message suffered an error earlier in the flow)
-then this component will silently discard the group.
-* All messages must arrive within the same container lifetime.  
-If at any point there is more than a 15 second gap in messages, then the group will be silently discarded.  
+* All groups must have one or more messages. (i.e. No groups of size 0).
+Can't do re-grouping when a split is done on an empty array. (i.e. No empty for each pattern supported).
+* All messages must arrive within the same container lifetime.
+If at any point there is more than a 15 second gap in messages, then the group will be silently discarded.
 * The group is dropped if there are any unexpected restarts to the container.
-* Size of the group must be known by all group members.
-* Messages are only emitter when all parts arrive. Emitting a message only when the first part arrives isn't supported.
+* In case only a groupSize is given and no delay timer is specified. The size of the group must be known by all group members.
+* In case of using the delay timer. Messages are only emitted when all parts arrive. Emitting a message only when the first part arrives isn't supported.
+* The delay timer can not exceed 40,000 milliseconds. If more than this maximum is given, then this maximum will be used instead.
 
 #### List of Expected Config fields
-```groupSize``` - Number of messages in the group
-
 ```groupId``` - Globally unique id for the group to distinguish it from other groups. This value needs to be the same for all messages in a group.
 
-```messageId``` - Id for a message to distinguish it from other messages in the group. 
+```messageId``` - Id for a message to distinguish it from other messages in the group.
 Must be unique per group but does not have to be globally unique. This value needs to be different for all messages in a group.
 
-```messageData``` - object for providing some data derived from the steps between splitting and re-assembling
+```messageData``` - Data from individual messages can be inserted here in form of an object. This object is then inserted into an array which is available in the message emitted for this group.
+
+```groupSize``` - Number of messages in the group.
+
+```Delay timer (in ms)``` - Time the process waits when no incoming messages before emiting (Max 40,000 milliseconds)
 
 ## Known limitations (common for the component)
-No.
+None.
 
 ## Documentation links
 More information and some examples can be found here: [Splitter documentation](https://www.elastic.io/connectors/splitter-integration/).

component.json

@@ -50,24 +50,37 @@
           "properties": {
             "groupSize": {
               "type": "number",
-              "required": true,
-              "title": "Number of messages produced by splitter"
+              "required": false,
+              "title": "Number of messages produced by splitter",
+              "order": 3
             },
             "groupId": {
               "type": "string",
               "required": true,
-              "title": "Unique ID to describe the group"
+              "title": "Unique ID to describe the group",
+              "order": 5
             },
             "messageId": {
               "type": "string",
               "required": true,
-              "title": "Unique ID to describe this message"
+              "title": "Unique ID to describe this message",
+              "order": 4
             },
             "messageData": {
               "title": "Message Data",
               "required": false,
               "type": "object",
-              "properties": {}
+              "properties": {},
+              "order": 1
+            },
+            "timersec": {
+              "type": "number",
+              "required": false,
+              "help":{
+                "description": "Time the process waits when no incoming messages before emiting(Maximum 20,000 milliseconds)"
+              },
+              "title": "Delay timer(in ms)",
+              "order": 2
             }
           }
         }

lib/actions/reassemble.js

@@ -2,6 +2,16 @@
 const { messages } = require('elasticio-node');
 const ObjectStorageWrapperExtended = require('./utils-wrapper/ObjectStorageWrapperExtended');
 
+let timeHandle;
+var groupList = [];
+var groupElements = [{groupSize: undefined, groupId: undefined, messageData:undefined}];
+
+async function timer(this_) {
+  for(var i = 1; i < groupElements.length; i++){
+    await this_.emit('data', messages.newMessageWithBody( groupElements[i] ))  
+  }
+}
+
 async function processAction(msg) {
   const storage = new ObjectStorageWrapperExtended(this);
   const {
@@ -17,13 +27,12 @@ async function processAction(msg) {
     messageData,
   };
 
-  if (groupSize <= 0) {
-    throw new Error('Size must be a positive integer.');
-  }
   if (!messageData) {
     incomingData[messageId] = undefined;
   }
-
+  if (groupSize <= 0) {
+    throw new Error('Size must be a positive integer.');
+  }
   const {
     messageGroup,
     messageGroupId,
@@ -54,18 +63,72 @@ async function processAction(msg) {
     Currently the group has ${messagesNumberSeen} of ${messageGroupSize} message(s).`,
   );
 
-  if (messagesNumberSeen >= messageGroupSize) {
-    parsedMessageGroup.messages.forEach((message) => {
-      incomingData[message.messageId] = message.messageData;
-    });
+  // when group sized is defined || when both group size and delay timer are defined
+  if(messageGroupSize !== '' && messageGroupSize !== undefined){
+    if(groupList.includes(groupId)){
+      parsedMessageGroup.messages.forEach((message) => {
+        incomingData[message.messageId] = message.messageData;
+      });
+      for(var key in groupElements){  
+        if(groupElements[key].groupId === groupId){
+          groupElements[key].groupSize == messagesNumberSeen
+          groupElements[key].messageData == incomingData
+        }
+      }
+    }
+    else{
+      parsedMessageGroup.messages.forEach((message) => {
+        incomingData[message.messageId] = message.messageData;
+      });
+      groupList.push(groupId)
+      groupElements.push({groupSize: messagesNumberSeen, groupId: groupId, messageData:incomingData})
+    }
+    if (messagesNumberSeen >= messageGroupSize) {
+      parsedMessageGroup.messages.forEach((message) => {
+        incomingData[message.messageId] = message.messageData;
+      });
+
+      await this.emit('data', messages.newMessageWithBody({
+        groupSize,
+        groupId,
+        messageData: incomingData,
+      }));
+      await storage.deleteObjectById(messageGroupId);
+      this.logger.info(`Message group with id ${messageGroupId} has been deleted`);
+      groupList = groupList.filter(def => def != groupId);
+      groupElements = groupElements.filter(def => def.groupId != groupId);
+    }
+  }
+  // When delay timer is defined and no group size defined 
+  if(messageGroupSize === undefined && msg.body.timersec !== undefined){
 
-    await this.emit('data', messages.newMessageWithBody({
-      groupSize,
-      groupId,
-      messageData: incomingData,
-    }));
-    await storage.deleteObjectById(messageGroupId);
-    this.logger.info(`Message group with id ${messageGroupId} has been deleted`);
+    // in case no delay was defined  
+    var delay = msg.body.timersec
+    if(delay >= 40000){delay == 40000}
+    clearTimeout(timeHandle);
+    timeHandle = setTimeout(timer, delay, this); 
+
+    if(groupList.includes(groupId)){
+      parsedMessageGroup.messages.forEach((message) => {
+        incomingData[message.messageId] = message.messageData;
+      });
+      for(var key in groupElements){   
+        if(groupElements[key].groupId === groupId){
+          groupElements[key].groupSize == messagesNumberSeen
+          groupElements[key].messageData == incomingData
+        }
+      }
+    }
+    else{
+      parsedMessageGroup.messages.forEach((message) => {
+        incomingData[message.messageId] = message.messageData;
+      });
+      groupList.push(groupId)
+      groupElements.push({groupSize: messagesNumberSeen, groupId: groupId, messageData:incomingData})
+    }
+  }
+  if(messageGroupSize === undefined && msg.body.timersec === undefined){
+    throw new Error('Either group size or delay timer need to be defined');
   }
 }