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

package/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+    "singleQuote": true,
+    "printWidth": 120,
+    "arrowParens": "always",
+    "tabWidth": 4
+}

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,17 +5,12 @@ 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
@@ -24,16 +19,9 @@ 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/externaltask-error.html

@@ -1,45 +1,31 @@
 <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/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>
+<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>

package/externaltask-error.js

@@ -1,32 +1,33 @@
-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) {
+        node.on('input', function (msg) {
+            const externalTaskId = msg.externalTaskId;
 
-            const flowNodeInstanceId = msg.flowNodeInstanceId;
+            let error = msg.error;
 
-            let msgError = msg.error;
-
-            if (msgError === undefined) {
-                msgError.message = "An error occurred";
+            if (error === undefined) {
+                error.message = 'An error occurred';
+                error.source = msg.payload;
             }
 
-            const error = new Error(msgError.message);
-            error.errorCode = config.error;
-            error.errorDetails = RED.util.encodeObject(msg);
+            msg.payload = {
+                error: {
+                    errorCode: config.error,
+                    errorMessage: error.message,
+                    errorDetails: error.source,
+                },
+            };
 
-            msg.errorCode = config.error;
-            msg.errorMessage = msgError.message;
+            eventEmitter.emit(`error-${externalTaskId}`, msg.payload);
 
-            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,53 +1,36 @@
 <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/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>
+<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>

package/externaltask-input.js

@@ -1,24 +1,44 @@
+const process = require('process');
 const EventEmitter = require('node:events');
 
+const engine_client = require('@5minds/processcube_engine_client');
+
 function showStatus(node, msgCounter) {
     if (msgCounter >= 1) {
-        node.status({fill: "blue", shape: "dot", text: `handling tasks ${msgCounter}.`});
+        node.status({ fill: 'blue', shape: 'dot', text: `handling tasks ${msgCounter}` });
     } else {
-        node.status({fill: "blue", shape: "ring", text: `subcribed.`});
+        node.status({ fill: 'blue', shape: 'ring', text: `subcribed ${msgCounter}` });
     }
 }
 
-const started_external_tasks = {};
+function decrCounter(msgCounter) {
+    msgCounter--;
+
+    if (msgCounter < 0) {
+        msgCounter = 0;
+    }
 
-module.exports = function(RED) {
+    return msgCounter;
+}
+
+module.exports = function (RED) {
     function ExternalTaskInput(config) {
-        RED.nodes.createNode(this,config);
+        RED.nodes.createNode(this, config);
         var node = this;
+        var msgCounter = 0;
         var flowContext = node.context().flow;
-      
+        var nodeContext = node.context();
+
         this.engine = this.server = RED.nodes.getNode(config.engine);
 
-        const client = this.engine.getEngineClient();
+        const engineUrl = this.engine?.url || process.env.ENGINE_URL || 'http://engine:8000';
+
+        var client = nodeContext.get('client');
+
+        if (!client) {
+            nodeContext.set('client', new engine_client.EngineClient(engineUrl));
+            client = nodeContext.get('client');
+        }
 
         var eventEmitter = flowContext.get('emitter');
 
@@ -27,126 +47,54 @@ module.exports = function(RED) {
             eventEmitter = flowContext.get('emitter');
         }
 
-        client.externalTasks.subscribeToExternalTaskTopic(
-            config.topic,
-            async (payload, externalTask) => {
+        client.externalTasks
+            .subscribeToExternalTaskTopic(config.topic, async (payload, externalTask) => {
+                msgCounter++;
 
-                const saveHandleCallback = (data, callback) => {
-                    try {
-                        callback(data);
-                    } catch (error) {
-                        node.error(`Error in callback 'saveHandleCallback': ${error.message}`);
-                    }
-                };
-                
                 return await new Promise((resolve, reject) => {
+                    // TODO: once ist 2x gebunden
+                    eventEmitter.once(`finish-${externalTask.flowNodeInstanceId}`, (result) => {
+                        msgCounter = decrCounter(msgCounter);
 
-                    const handleFinishTask = (msg) => {
-                        let result = RED.util.encodeObject(msg.payload);
-
-                        node.log(`handle event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* ${externalTask.processInstanceId} with result ${result} on msg._msgid ${msg._msgid}.`);
-
-                        if (externalTask.flowNodeInstanceId) {
-                            delete started_external_tasks[externalTask.flowNodeInstanceId];
-                        }
-
-                        showStatus(node, Object.keys(started_external_tasks).length);
-
-
-                        //resolve(result);
-                        saveHandleCallback(result, resolve)
-                    };
-
-                    const handleErrorTask = (msg) => {
-
-                        node.log(`handle error event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' on *msg._msgid* '${msg._msgid}'.`);
-
-                        if (externalTask.flowNodeInstanceId) {
-                            delete started_external_tasks[externalTask.flowNodeInstanceId];
-                        }
-
-                        showStatus(node, Object.keys(started_external_tasks).length);
-
+                        showStatus(node, msgCounter);
+                        resolve(result);
+                    });
 
-                        // TODO: with reject, the default error handling is proceed 
-                        // SEE: https://github.com/5minds/ProcessCube.Engine.Client.ts/blob/develop/src/ExternalTaskWorker.ts#L180
-                        // reject(result);
-                        //resolve(msg);
-                        saveHandleCallback(msg, resolve);
-                    };
+                    eventEmitter.once(`error-${externalTask.flowNodeInstanceId}`, (msg) => {
+                        msgCounter = decrCounter(msgCounter);
+                        showStatus(node, msgCounter);
 
-                    eventEmitter.once(`handle-${externalTask.flowNodeInstanceId}`, (msg, isError = false) => {
-                        node.log(`handle event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' with *msg._msgid* '${msg._msgid}' and *isError* '${isError}'`);
+                        var result = msg.payload ? msg.payload : msg;
 
-                        if (isError) {
-                            handleErrorTask(msg);
-                        } else {
-                            handleFinishTask(msg);
-                        }
+                        reject(result);
                     });
 
-                    started_external_tasks[externalTask.flowNodeInstanceId] = externalTask;
-
-                    showStatus(node, Object.keys(started_external_tasks).length);
+                    showStatus(node, msgCounter);
 
-                    let msg = {
-                        _msgid: RED.util.generateId(),
-                        task: RED.util.encodeObject(externalTask),
+                    node.send({
+                        topic: externalTask.topic,
                         payload: payload,
-                        flowNodeInstanceId: externalTask.flowNodeInstanceId
-                    };
-                    
-                    node.log(`Received *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' with *msg._msgid* '${msg._msgid}'`);
-                    
-                    node.send(msg);
+                        externalTaskId: externalTask.flowNodeInstanceId,
+                    });
                 });
-            },
-            ).then(async externalTaskWorker => {
-                node.status({fill: "blue", shape: "ring", text: "subcribed"});
+            })
+            .then(async (externalTaskWorker) => {
+                node.status({ fill: 'blue', shape: 'ring', text: 'subcribed' });
 
                 externalTaskWorker.identity = node.server.identity;
                 node.server.registerOnIdentityChanged((identity) => {
                     externalTaskWorker.identity = identity;
-                }); 
-
-                // export type WorkerErrorHandler = (errorType: 'fetchAndLock' | 'extendLock' | 'processExternalTask' | 'finishExternalTask', error: Error, externalTask?: ExternalTask<any>) => void;
-                externalTaskWorker.onWorkerError((errorType, error, externalTask) => {
-                    switch (errorType) {
-                        case 'extendLock':
-                        case 'finishExternalTask':
-                        case 'processExternalTask':
-                            node.error(`Worker error ${errorType} for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}': ${error.message}`);
-                    
-                            if (externalTask) {
-                                delete started_external_tasks[externalTask.flowNodeInstanceId];
-                            }
-
-                            showStatus(node, Object.keys(started_external_tasks).length);
-                            break;
-                        default:
-                            node.error(`Worker error ${errorType}: ${error.message}`);
-                            break;
-                    }
                 });
+                await externalTaskWorker.start();
 
-                try {
-                    externalTaskWorker.start();
-                } catch (error) {
-                    node.error(`Worker start 'externalTaskWorker.start' failed: ${error.message}`);
-                }
-
-                node.on("close", () => {
+                node.on('close', async () => {
                     try {
                         externalTaskWorker.stop();
                     } catch {
-                        node.error('Client close failed');
+                        console.warn('Client close failed');
                     }
                 });
-            }
-        ).catch((error) => {
-            node.error(`Error in subscribeToExternalTaskTopic: ${error.message}`);
-        });
+            });
     }
-
-    RED.nodes.registerType("externaltask-input", ExternalTaskInput);
-}
+    RED.nodes.registerType('externaltask-input', ExternalTaskInput);
+};

package/externaltask-output.html

@@ -1,36 +1,26 @@
 <script type="text/javascript">
-    RED.nodes.registerType('externaltask-output',{
+    RED.nodes.registerType('externaltask-output', {
         category: 'ProcessCube',
         color: '#02AFD6',
         defaults: {
-            name: {value:""}
+            name: { value: '' },
         },
         inputs: 1,
         outputs: 0,
-        icon: "font-awesome/fa-envelope",
-        label: function() {
-            return this.name||"externaltask-output";
-        }
+        icon: 'font-awesome/fa-envelope',
+        label: function () {
+            return this.name || 'externaltask-output';
+        },
     });
 </script>
 
 <script type="text/html" data-template-name="externaltask-output">
     <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>
 </script>
 
-<script type="text/markdown" data-help-name="externaltask-output">
-Used to complete the external task. The `msg.payload` is returned to the ProcessCube 
-engine as the result of the external task.
-
-## Inputs
-
-: payload (Object) : Returned to the ProcessCube engine as the result of the external task
-
-### 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>
+<script type="text/html" data-help-name="externaltask-output">
+    <p>A node which response to an External Task of https://processcube.io</p>
+</script>

package/externaltask-output.js

@@ -1,21 +1,20 @@
-module.exports = function(RED) {
+module.exports = function (RED) {
     function ExternalTaskOutput(config) {
-        RED.nodes.createNode(this,config);
+        RED.nodes.createNode(this, config);
         var node = this;
 
         var flowContext = node.context().flow;
         var eventEmitter = flowContext.get('emitter');
 
-        node.on('input', function(msg) {
-            
-            const flowNodeInstanceId = msg.flowNodeInstanceId;
+        node.on('input', function (msg) {
+            const externalTaskId = msg.externalTaskId;
 
-            if (!flowNodeInstanceId) {
-               node.error('Error: The message did not contain the required external task id.', msg);
-            }  
+            if (!externalTaskId) {
+                node.error('Error: The message did not contain the required external task id.', msg);
+            }
 
-            eventEmitter.emit(`handle-${flowNodeInstanceId}`, msg, false);
-        });     
+            eventEmitter.emit(`finish-${externalTaskId}`, msg.payload);
+        });
     }
-    RED.nodes.registerType("externaltask-output", ExternalTaskOutput);
-}
+    RED.nodes.registerType('externaltask-output', ExternalTaskOutput);
+};

package/message-event-trigger.html

@@ -1,41 +1,41 @@
 <script type="text/javascript">
-    RED.nodes.registerType('message-event-trigger',{
+    RED.nodes.registerType('message-event-trigger', {
         category: 'ProcessCube',
         color: '#02AFD6',
         defaults: {
-            name: {value: ""},
-            engine: {value: "", type: "processcube-engine-config"},
-            messagename: {value: "", required: true},
-            processInstanceId: {value:""}
+            name: { value: '' },
+            engine: { value: '', type: 'processcube-engine-config' },
+            messagename: { value: '', required: true },
+            processInstanceId: { value: '' },
         },
         inputs: 1,
         outputs: 1,
-        icon: "font-awesome/fa-envelope-open",
-        label: function() {
-            return this.name||"message-event-trigger";
-        }
+        icon: 'font-awesome/fa-envelope-open',
+        label: function () {
+            return this.name || 'message-event-trigger';
+        },
     });
 </script>
 
 <script type="text/html" data-template-name="message-event-trigger">
     <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-messagename"><i class="fa fa-tag"></i> Message Name</label>
-        <input type="text" id="node-input-messagename" placeholder="Name of the Message-Event">
+        <input type="text" id="node-input-messagename" placeholder="Name of the Message-Event" />
     </div>
     <div class="form-row">
         <label for="node-input-processinstanceid"><i class="fa fa-tag"></i> Process Instance Id</label>
-        <input type="text" id="node-input-processinstanceid" placeholder="Id of the recipient process instance">
+        <input type="text" id="node-input-processinstanceid" placeholder="Id of the recipient process instance" />
     </div>
 </script>
 
 <script type="text/html" data-help-name="externaltask-input">
     <p>A node which emmits an message event to the Engine.</p>
-</script>
+</script>

package/message-event-trigger.js

@@ -2,7 +2,7 @@ const process = require('process');
 
 const engine_client = require('@5minds/processcube_engine_client');
 
-module.exports = function(RED) {
+module.exports = function (RED) {
     function MessageEventTrigger(config) {
         RED.nodes.createNode(this, config);
         var node = this;
@@ -17,29 +17,25 @@ module.exports = function(RED) {
         if (!client) {
             nodeContext.set('client', new engine_client.EngineClient(engineUrl));
             client = nodeContext.get('client');
-        } 
-
-        node.on('input', function(msg) {
-
-            client.events.triggerMessageEvent(
-                config.messagename,
-                {
-                  processInstanceId: config.processinstanceid,
-                  payload: msg.payload,
-                  identity: node.server.identity
-                }
-            
-            ).then((result) => {
-
-                msg.payload = result;
-            
-                node.send(msg);
-                node.status({fill: "blue", shape: "dot", text: `message event triggered`});
-            
-            }).catch((error) => {
-                node.error(error);
-            });
+        }
+
+        node.on('input', function (msg) {
+            client.events
+                .triggerMessageEvent(config.messagename, {
+                    processInstanceId: config.processinstanceid,
+                    payload: msg.payload,
+                    identity: node.server.identity,
+                })
+                .then((result) => {
+                    msg.payload = result;
+
+                    node.send(msg);
+                    node.status({ fill: 'blue', shape: 'dot', text: `message event triggered` });
+                })
+                .catch((error) => {
+                    node.error(error);
+                });
         });
     }
-    RED.nodes.registerType("message-event-trigger", MessageEventTrigger);
-}
+    RED.nodes.registerType('message-event-trigger', MessageEventTrigger);
+};