Added delay timer property

Author: FranckTala

README.md

@@ -92,39 +92,34 @@ and the JSONata expression `Phone.{type: number}`, an object constructor, the ac
 ### 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
 * If messages are re-delivered as a result of the platform's at once delivery guarantee, does not trigger false positives
 * Messages from one original message can be interleaved with messages from another original message
 (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). 
+* 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 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
 ```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 40000 miliseconds)
+```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.

component.json

@@ -77,7 +77,7 @@
               "type": "number",
               "required": false,
               "help":{
-                "description": "Time the process waits when no incoming messages before emiting(Default 20000 miliseconds)"
+                "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

@@ -27,12 +27,6 @@ async function processAction(msg) {
     messageData,
   };
 
-  // in case no delay was defined  
-  var delay = msg.body.timersec ?  msg.body.timersec : '40000'
-  if(delay >= 40000){delay == 40000}
-  clearTimeout(timeHandle);
-  timeHandle = setTimeout(timer, delay, this); 
-
   if (!messageData) {
     incomingData[messageId] = undefined;
   }
@@ -68,14 +62,13 @@ async function processAction(msg) {
     `Saw message ${messageId} of group ${groupId}. 
     Currently the group has ${messagesNumberSeen} of ${messageGroupSize} message(s).`,
   );
-  if(messageGroupSize !== '' && messageGroupSize !== undefined ){
-    clearTimeout(timeHandle);
 
+  // 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
@@ -87,10 +80,8 @@ async function processAction(msg) {
       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) => {
@@ -107,17 +98,20 @@ async function processAction(msg) {
       groupList = groupList.filter(def => def != groupId);
       groupElements = groupElements.filter(def => def.groupId != groupId);
     }
-    else{
-      timeHandle = setTimeout(timer, delay, this); 
-    }
   }
-  else{
+  // When delay timer is defined and no group size defined 
+  if(messageGroupSize === undefined && msg.body.timersec !== undefined){
+
+    // 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
@@ -126,16 +120,16 @@ async function processAction(msg) {
       }
     }
     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');
+  }
 }
 
 exports.process = processAction;

spec/reassemble.spec.js

@@ -14,6 +14,10 @@ process.env.ELASTICIO_STEP_ID = 'step_id';
 const { expect } = chai;
 chai.use(require('chai-as-promised'));
 
+function sleep(ms) {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+
 describe('Split on JSONata ', () => {
   let self;
 
@@ -232,4 +236,54 @@ describe('Split on JSONata ', () => {
     expect(putMessageGroup1.isDone()).to.equal(true);
     expect(deleteMessageGroup.isDone()).to.equal(true);
   });
+
+  it('Base Case: No group Group Size, emit after 1000 miliseconds if no incoming message', async () => {
+    const msg = {
+      body: {
+        groupId: 'group123',
+        messageId: 'msg123',
+        groupSize : undefined,
+        timersec: 1000
+      },
+    };
+
+    const getMessageGroups = nock('https://ma.estr').get('/objects?query[externalid]=group123').reply(200, []);
+    const postMessageGroup = nock('https://ma.estr')
+      .post('/objects', { messages: [], messageIdsSeen: {} })
+      .matchHeader('x-query-externalid', 'group123')
+      .reply(200, { objectId: 'group123' });
+    const getMessageGroup = nock('https://ma.estr')
+      .get('/objects/group123')
+      .reply(200, { messages: [], messageIdsSeen: {} });
+    const putMessageGroup = nock('https://ma.estr').put('/objects/group123').reply(200, {});
+    const getMessageGroup1 = nock('https://ma.estr')
+      .get('/objects/group123')
+      .reply(200, { messages: [{ msg123: undefined }], messageIdsSeen: { msg123: 'msg123' } })
+     
+    const putMessageGroup1 = nock('https://ma.estr').put('/objects/group123').reply(200, {});
+
+    await reassemble.process.call(self, msg, {});
+
+    // timersec + 0,5 second
+    await sleep(1500);
+ 
+
+    expect(self.emit.calledOnce).to.be.true;
+    expect(self.emit.lastCall.args[1].body).to.deep.equal({
+      groupSize: 1,
+      groupId: 'group123',
+      messageData: {
+        msg123: undefined,
+        undefined,
+      },
+    });
+
+    expect(getMessageGroups.isDone()).to.equal(true);
+    expect(postMessageGroup.isDone()).to.equal(true);
+    expect(getMessageGroup.isDone()).to.equal(true);
+    expect(putMessageGroup.isDone()).to.equal(true);
+    expect(getMessageGroup1.isDone()).to.equal(true);
+    expect(putMessageGroup1.isDone()).to.equal(true);
+  });
+
 });