@5minds/node-red-contrib-processcube 0.14.0-fix-error-in-process-instance-query-9aeac9-lyzi0gix → 0.14.0

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:20 as builder
+FROM node:20 AS builder
 
 COPY ./ /src/node-red-contrib-processcube
 

package/docker-compose.yml

@@ -5,12 +5,17 @@ services:
       context: .
     ports:
       - "1880:1880"
+      - "9229:9229"
     environment:
       - TZ=Europe/Berlin
       - ENGINE_URL=http://engine:8000
       - FLOWS=/nodered/node-red-contrib-processcube-flows.json
     volumes:
       - ./nodered/:/nodered/
+      - ./examples/:/examples/
+    depends_on:
+      - engine
+      - authority
   
   engine:
     image: 5minds/processcube_engine:2024-1
@@ -19,9 +24,16 @@ services:
     volumes:
       - ./processes:/processes:ro
     environment:
+      application__name: Engine for Node-RED contrib
       iam__baseUrl: http://authority:11560
       iam__allowAnonymousRootAccess: true
     command: --seed-dir=/processes --port 8000
+    depends_on:
+      - authority
+    healthcheck:
+      test: bash -c "[ -f /tmp/healthy ]"
+      timeout: 1s
+      retries: 20      
 
   authority:
     image: 5minds/processcube_authority:3.0.4

package/examples/External-Task-Sample.json

@@ -0,0 +1,252 @@
+[
+    {
+        "id": "a23d2e782beb66f4",
+        "type": "tab",
+        "label": "External Task Sample",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
+    {
+        "id": "70d7a70e375b162a",
+        "type": "group",
+        "z": "a23d2e782beb66f4",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "2991a5e6df2b87d2",
+            "911fde53bcbb7e3f",
+            "d56bb7cd73fd220c",
+            "15a5f64b9e2e05fc"
+        ],
+        "x": 34,
+        "y": 79,
+        "w": 512,
+        "h": 142
+    },
+    {
+        "id": "31cb6729aac0ba46",
+        "type": "group",
+        "z": "a23d2e782beb66f4",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "18e05d562d48f32d",
+            "49aee03a7885fae8",
+            "e4555d9019cd3f47",
+            "bd68c4bdc53b8f80",
+            "fb87f79852b22e4a",
+            "1ba1e62c9935255f",
+            "b49f226ba865e164"
+        ],
+        "x": 34,
+        "y": 259,
+        "w": 812,
+        "h": 202
+    },
+    {
+        "id": "2991a5e6df2b87d2",
+        "type": "externaltask-input",
+        "z": "a23d2e782beb66f4",
+        "g": "70d7a70e375b162a",
+        "name": "Test",
+        "engine": "42e6796dddd9d4db",
+        "topic": "Test",
+        "x": 110,
+        "y": 180,
+        "wires": [
+            [
+                "d56bb7cd73fd220c"
+            ]
+        ]
+    },
+    {
+        "id": "911fde53bcbb7e3f",
+        "type": "externaltask-output",
+        "z": "a23d2e782beb66f4",
+        "g": "70d7a70e375b162a",
+        "name": "Test Ende",
+        "x": 460,
+        "y": 180,
+        "wires": []
+    },
+    {
+        "id": "d56bb7cd73fd220c",
+        "type": "delay",
+        "z": "a23d2e782beb66f4",
+        "g": "70d7a70e375b162a",
+        "name": "",
+        "pauseType": "delay",
+        "timeout": "1",
+        "timeoutUnits": "seconds",
+        "rate": "1",
+        "nbRateUnits": "1",
+        "rateUnits": "second",
+        "randomFirst": "1",
+        "randomLast": "5",
+        "randomUnits": "seconds",
+        "drop": false,
+        "allowrate": false,
+        "outputs": 1,
+        "x": 280,
+        "y": 180,
+        "wires": [
+            [
+                "911fde53bcbb7e3f"
+            ]
+        ]
+    },
+    {
+        "id": "18e05d562d48f32d",
+        "type": "externaltask-input",
+        "z": "a23d2e782beb66f4",
+        "g": "31cb6729aac0ba46",
+        "name": "SampleError",
+        "engine": "42e6796dddd9d4db",
+        "topic": "SampleError",
+        "x": 130,
+        "y": 360,
+        "wires": [
+            [
+                "49aee03a7885fae8"
+            ]
+        ]
+    },
+    {
+        "id": "49aee03a7885fae8",
+        "type": "delay",
+        "z": "a23d2e782beb66f4",
+        "g": "31cb6729aac0ba46",
+        "name": "",
+        "pauseType": "delay",
+        "timeout": "5",
+        "timeoutUnits": "seconds",
+        "rate": "1",
+        "nbRateUnits": "1",
+        "rateUnits": "second",
+        "randomFirst": "1",
+        "randomLast": "5",
+        "randomUnits": "seconds",
+        "drop": false,
+        "allowrate": false,
+        "outputs": 1,
+        "x": 320,
+        "y": 360,
+        "wires": [
+            [
+                "bd68c4bdc53b8f80"
+            ]
+        ]
+    },
+    {
+        "id": "e4555d9019cd3f47",
+        "type": "catch",
+        "z": "a23d2e782beb66f4",
+        "g": "31cb6729aac0ba46",
+        "name": "",
+        "scope": "group",
+        "uncaught": false,
+        "x": 510,
+        "y": 420,
+        "wires": [
+            [
+                "fb87f79852b22e4a"
+            ]
+        ]
+    },
+    {
+        "id": "bd68c4bdc53b8f80",
+        "type": "function",
+        "z": "a23d2e782beb66f4",
+        "g": "31cb6729aac0ba46",
+        "name": "raise Error",
+        "func": "throw Error(\"hello error\");\n\nreturn msg;",
+        "outputs": 1,
+        "timeout": 0,
+        "noerr": 0,
+        "initialize": "",
+        "finalize": "",
+        "libs": [],
+        "x": 510,
+        "y": 360,
+        "wires": [
+            [
+                "1ba1e62c9935255f"
+            ]
+        ]
+    },
+    {
+        "id": "fb87f79852b22e4a",
+        "type": "externaltask-error",
+        "z": "a23d2e782beb66f4",
+        "g": "31cb6729aac0ba46",
+        "name": "Send Error to Engine",
+        "error": "MyErrorCode",
+        "x": 720,
+        "y": 420,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "1ba1e62c9935255f",
+        "type": "externaltask-output",
+        "z": "a23d2e782beb66f4",
+        "g": "31cb6729aac0ba46",
+        "name": "",
+        "x": 710,
+        "y": 360,
+        "wires": []
+    },
+    {
+        "id": "15a5f64b9e2e05fc",
+        "type": "comment",
+        "z": "a23d2e782beb66f4",
+        "g": "70d7a70e375b162a",
+        "name": "Simple External Task handling",
+        "info": "",
+        "x": 180,
+        "y": 120,
+        "wires": []
+    },
+    {
+        "id": "b49f226ba865e164",
+        "type": "comment",
+        "z": "a23d2e782beb66f4",
+        "g": "31cb6729aac0ba46",
+        "name": "Error handling with external tasks",
+        "info": "",
+        "x": 190,
+        "y": 300,
+        "wires": []
+    },
+    {
+        "id": "799125e21de02f13",
+        "type": "comment",
+        "z": "a23d2e782beb66f4",
+        "name": "For Testing, deploy \"External-Task-Sample.bpmn\" and start the process.",
+        "info": "",
+        "x": 300,
+        "y": 40,
+        "wires": []
+    },
+    {
+        "id": "42e6796dddd9d4db",
+        "type": "processcube-engine-config",
+        "url": "http://engine:8000"
+    }
+]

package/externaltask-error.html

@@ -1,31 +1,45 @@
 <script type="text/javascript">
-    RED.nodes.registerType('externaltask-error', {
+    RED.nodes.registerType('externaltask-error',{
         category: 'ProcessCube',
         color: '#F6A923',
         defaults: {
-            name: { value: '' },
-            error: { value: '' },
+            name: {value:""},
+            error: {value:""}
         },
         inputs: 1,
         outputs: 1,
-        icon: 'font-awesome/fa-exclamation-triangle',
-        label: function () {
-            return this.name || 'externaltask-error';
-        },
+        icon: "font-awesome/fa-exclamation-triangle",
+        label: function() {
+            return this.name || "externaltask-error";
+        }
     });
 </script>
 
 <script type="text/html" data-template-name="externaltask-error">
     <div class="form-row">
         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
-        <input type="text" id="node-input-name" placeholder="Name" />
+        <input type="text" id="node-input-name" placeholder="Name">
     </div>
     <div class="form-row">
         <label for="node-input-error"><i class="fa fa-tag"></i> Error Code</label>
-        <input type="text" id="node-input-error" placeholder="Error Code of ExternalTask" />
+        <input type="text" id="node-input-error" placeholder="Error Code of ExternalTask">
     </div>
 </script>
 
-<script type="text/html" data-help-name="externaltask-error">
-    <p>A node which error response to an External Task of https://processcube.io</p>
-</script>
+<script type="text/markdown" data-help-name="externaltask-error">
+Used for reporting errors in the processing of external tasks. The error 
+code `Error` in the configuration is forwarded to the ProcessCube engine for 
+handling within *Error-Boundary-Events*.
+
+## Inputs
+
+: msg (Object)        : Passed as `ErrorDetails` to the engine
+: Error (string)      : From the configuration
+: Message (string)    : The caught exception message
+: StackTrace (string) : The stack trace of the exception
+
+### References
+
+- [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
+- [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
+</script>

package/externaltask-error.js

@@ -1,33 +1,32 @@
-module.exports = function (RED) {
+module.exports = function(RED) {
     function ExternalTaskError(config) {
-        RED.nodes.createNode(this, config);
+        RED.nodes.createNode(this,config);
         var node = this;
 
         var flowContext = node.context().flow;
-        var eventEmitter = flowContext.get('emitter');
+        var eventEmitter = flowContext.get('emitter');       
 
-        node.on('input', function (msg) {
-            const externalTaskId = msg.externalTaskId;
+        node.on('input', function(msg) {
 
-            let error = msg.error;
+            const flowNodeInstanceId = msg.flowNodeInstanceId;
 
-            if (error === undefined) {
-                error.message = 'An error occurred';
-                error.source = msg.payload;
+            let msgError = msg.error;
+
+            if (msgError === undefined) {
+                msgError.message = "An error occurred";
             }
 
-            msg.payload = {
-                error: {
-                    errorCode: config.error,
-                    errorMessage: error.message,
-                    errorDetails: error.source,
-                },
-            };
+            const error = new Error(msgError.message);
+            error.errorCode = config.error;
+            error.errorDetails = RED.util.encodeObject(msg);
 
-            eventEmitter.emit(`error-${externalTaskId}`, msg.payload);
+            msg.errorCode = config.error;
+            msg.errorMessage = msgError.message;
 
+            eventEmitter.emit(`handle-${flowNodeInstanceId}`, error, true);
+            
             node.send(msg);
-        });
+        });     
     }
-    RED.nodes.registerType('externaltask-error', ExternalTaskError);
-};
+    RED.nodes.registerType("externaltask-error", ExternalTaskError);
+}

package/externaltask-input.html

@@ -1,36 +1,53 @@
 <script type="text/javascript">
-    RED.nodes.registerType('externaltask-input', {
+    RED.nodes.registerType('externaltask-input',{
         category: 'ProcessCube',
         color: '#02AFD6',
         defaults: {
-            name: { value: '' },
-            engine: { value: '', type: 'processcube-engine-config' },
-            topic: { value: '' },
+            name: {value: ""},
+            engine: {value: "", type: "processcube-engine-config"},
+            topic: {value: ""}
         },
         inputs: 0,
         outputs: 1,
-        icon: 'font-awesome/fa-envelope-open',
-        label: function () {
-            return this.name || 'externaltask-input';
-        },
+        icon: "font-awesome/fa-envelope-open",
+        label: function() {
+            return this.name||"externaltask-input";
+        }
     });
 </script>
 
 <script type="text/html" data-template-name="externaltask-input">
     <div class="form-row">
         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
-        <input type="text" id="node-input-name" placeholder="Name" />
+        <input type="text" id="node-input-name" placeholder="Name">
     </div>
     <div class="form-row">
         <label for="node-input-engine"><i class="fa fa-tag"></i> Engine</label>
-        <input type="text" id="node-input-engine" placeholder="Engine" />
+        <input type="text" id="node-input-engine" placeholder="Engine">
     </div>
     <div class="form-row">
         <label for="node-input-topic"><i class="fa fa-tag"></i> Topic</label>
-        <input type="text" id="node-input-topic" placeholder="Topic of ExternalTask" />
+        <input type="text" id="node-input-topic" placeholder="Topic of ExternalTask">
     </div>
 </script>
 
-<script type="text/html" data-help-name="externaltask-input">
-    <p>A node which subscribes to an External Task Topic of https://processcube.io</p>
-</script>
+<script type="text/markdown" data-help-name="externaltask-input">
+Waiting for external tasks that correspond to the `Topic` configured in 
+the connected ProcessCube Engine for processing.
+
+## Outputs
+
+: payload (string)   : Defines the input of the external task token
+: task (object)      : The external task object
+: flowNodeInstanceId : The Id of the external task, which is needed to complete the task
+
+### Details
+
+- To finish the external task the `externaltask-output` node is required.
+- For handling a error while executing a flow as external task the `externaltask-error` node is required.
+
+### References
+
+- [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; Plattform
+- [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED Integration in ProcessCube&copy;
+</script>