Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add eslint to build. Update all dependencies. #73

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## 1.2.1 (July 23, 2021)
## 1.3.1 (July 23, 2021)
* Implemented support of maester storage in `Re-assembled message` action (maester-client library 3.3.0)

## 1.2.0 (July 9, 2021)
Expand Down
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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(options):
* Use Group Size: A message is emitted once the group size is reached for the given group. If arriving messages for a particular group are less than the defined group size then the group is silently discarded.
* Use Timeout: 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.
* Use Group Size and Timeout: 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
Expand All @@ -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 all the messages in the group do not arrive, 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/).
23 changes: 18 additions & 5 deletions component.json
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
}
Expand Down
Loading