@5minds/node-red-contrib-processcube 0.11.0-feature-1a3680-lyc1y00u → 0.11.0

package/nodered/node-red-contrib-processcube-flows_cred.json

@@ -0,0 +1,3 @@
+{
+    "$": "4d3947a7155e180f5e1361182578e6ca2miDlL35ToUWYsN6HIEZN1KBk9Ec3/4="
+}

package/nodered/package.json

@@ -2,11 +2,8 @@
   "name": "node-red-contrib-processcube-sample",
   "version": "1.0.0",
   "description": "A sample for the processcube node-red contrib package",
-  "scripts": {
-    "start": "./node_modules/.bin/node-red --settings=./settings.js node-red-contrib-processcube-flows.json"
-  },
   "dependencies": {
-    "@5minds/node-red-contrib-processcube": "file:..",
+    "@5minds/node-red-contrib-processcube": "file:/src/node-red-contrib-processcube/",
     "@5minds/node-red-dashboard-2-processcube-dynamic-form": "^1.0.4",
     "@5minds/node-red-dashboard-2-processcube-usertask-table": "^1.0.7",
     "@flowfuse/node-red-dashboard": "^1.11.1",

package/nodered/settings.js

@@ -41,7 +41,7 @@ module.exports = {
      * node-red from being able to decrypt your existing credentials and they will be
      * lost.
      */
-    //credentialSecret: "a-secret-key",
+    credentialSecret: "a-secret-key",
 
     /** By default, the flow JSON will be formatted over multiple lines making
      * it easier to compare changes when using version control.
@@ -53,7 +53,7 @@ module.exports = {
      * the user's home directory. To use a different location, the following
      * property can be used
      */
-    //userDir: '/home/nol/.node-red/',
+    userDir: '/nodered/',
 
     /** Node-RED scans the `nodes` directory in the userDir to find local node files.
      * The following property can be used to specify an additional directory to scan.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@5minds/node-red-contrib-processcube",
-    "version": "0.11.0-feature-1a3680-lyc1y00u",
+    "version": "0.11.0",
     "license": "MIT",
     "description": "Node-RED nodes for ProcessCube",
     "authors": [
@@ -44,12 +44,13 @@
             "UserTaskNewListener": "usertask-new-listener.js",
             "UserTaskFinishedListener": "usertask-finished-listener.js",
             "UserTaskInput": "usertask-input.js",
-            "UserTaskOutput": "usertask-output.js",
-            "WaitForUsertask": "wait_for_usertask.js"
+            "UserTaskOutput": "usertask-output.js"
         }
     },
     "dependencies": {
-        "@5minds/processcube_engine_client": "^5.0.0"
+        "@5minds/processcube_engine_client": "^5.0.0",
+        "jwt-decode": "^4.0.0",
+        "openid-client": "^5.5.0"
     },
     "keywords": [
         "node-red",

package/process-start.js

@@ -27,7 +27,7 @@ module.exports = function(RED) {
                 initialToken: msg.payload
             };
 
-            client.processDefinitions.startProcessInstance(startParameters).then((result) => {
+            client.processDefinitions.startProcessInstance(startParameters, node.engine.identity).then((result) => {
 
                 msg.payload = result;
             

package/processcube-engine-config.html

@@ -6,6 +6,10 @@
         },
         label: function() {
             return this.url;
+        },
+        credentials: {
+            clientId: { type: "text" },
+            clientSecret: { type: "password" }
         }
     });
 </script>
@@ -15,4 +19,12 @@
         <label for="node-config-input-url"><i class="fa fa-bookmark"></i> Url</label>
         <input type="text" id="node-config-input-url">
     </div>
+    <div class="form-row">
+        <label for="node-config-input-clientId"><i class="fa fa-bookmark"></i> Client id</label>
+        <input type="text" id="node-config-input-clientId">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-clientSecret"><i class="fa fa-bookmark"></i> Client secret</label>
+        <input type="password" id="node-config-input-clientSecret">
+    </div>
 </script>

package/processcube-engine-config.js

@@ -1,7 +1,121 @@
+const engine_client = require('@5minds/processcube_engine_client');
+const jwt = require('jwt-decode');
+const oidc = require('openid-client');
+
+const DELAY_FACTOR = 0.85;
+
 module.exports = function(RED) {
     function ProcessCubeEngineNode(n) {
         RED.nodes.createNode(this, n);
+        const identityChangedCallbacks = [];
         this.url = n.url;
+        this.identity = null;
+        this.registerOnIdentityChanged = function (callback) {
+            identityChangedCallbacks.push(callback);
+        }
+        this.setIdentity = (identity)  => {
+            this.identity = identity;
+
+            for (const callback of identityChangedCallbacks) {
+                callback(identity);
+            }
+        }
+
+        if (this.credentials.clientId && this.credentials.clientSecret) {
+            const engineClient = new engine_client.EngineClient(this.url);
+
+            engineClient.applicationInfo.getAuthorityAddress().then(authorityUrl => {
+                startRefreshingIdentityCycle(this.credentials.clientId, this.credentials.clientSecret, authorityUrl, this);
+            });
+        }
     }
-    RED.nodes.registerType("processcube-engine-config", ProcessCubeEngineNode);
+    RED.nodes.registerType("processcube-engine-config", ProcessCubeEngineNode, {
+        credentials: {
+            clientId: { type: "text" },
+            clientSecret: { type: "password" }
+        }
+    });
+}
+
+async function getFreshTokenSet(clientId, clientSecret, authorityUrl) {
+    const issuer = await oidc.Issuer.discover(authorityUrl);
+
+    const client = new issuer.Client({
+        client_id: clientId,
+        client_secret: clientSecret,
+    });
+
+    const tokenSet = await client.grant({
+        grant_type: 'client_credentials',
+        scope: 'engine_etw engine_read engine_write',
+    });
+
+    return tokenSet;
+}
+
+function getIdentityForExternalTaskWorkers(tokenSet) {
+
+    const accessToken = tokenSet.access_token;
+    const decodedToken = jwt.jwtDecode(accessToken);
+
+    return {
+        token: tokenSet.access_token,
+        userId: decodedToken.sub,
+    };
+}
+
+async function getExpiresInForExternalTaskWorkers(tokenSet) {
+    let expiresIn = tokenSet.expires_in;
+
+    if (!expiresIn && tokenSet.expires_at) {
+        expiresIn = Math.floor(tokenSet.expires_at - Date.now() / 1000);
+    }
+
+    if (expiresIn === undefined) {
+        throw new Error('Could not determine the time until the access token for external task workers expires');
+    }
+
+    return expiresIn;
+}
+
+/**
+ * Start refreshing the identity in regular intervals.
+ * @param {TokenSet | null} tokenSet The token set to refresh the identity for
+ * @returns {Promise<void>} A promise that resolves when the timer for refreshing the identity is initialized
+ * */
+async function startRefreshingIdentityCycle(clientId, clientSecret, authorityUrl, configNode) {
+    let retries = 5;
+
+    const refresh = async () => {
+        try {
+            const newTokenSet = await getFreshTokenSet(clientId, clientSecret, authorityUrl);
+            const expiresIn = await getExpiresInForExternalTaskWorkers(newTokenSet);
+            const delay = expiresIn * DELAY_FACTOR * 1000;
+
+            freshIdentity = getIdentityForExternalTaskWorkers(newTokenSet);
+
+            configNode.setIdentity(freshIdentity);
+
+            retries = 5;
+            setTimeout(refresh, delay);
+        } catch (error) {
+            if (retries === 0) {
+                console.error(
+                    'Could not refresh identity for external task worker processes. Stopping all external task workers.',
+                    { error },
+                );
+                return;
+            }
+            console.error('Could not refresh identity for external task worker processes.', {
+                error,
+                retryCount: retries,
+            });
+            retries--;
+
+            const delay = 2 * 1000;
+            setTimeout(refresh, delay);
+        }
+    };
+
+    await refresh();
 }

package/processdefinition-query.js

@@ -34,8 +34,12 @@ module.exports = function(RED) {
         });
 
         node.on('input', function(msg) {
-            const query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg)
-
+            let query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg)
+            query = {
+                ...query,
+                identity: node.server.identity
+            };
+            
             client.processDefinitions.getAll(query).then((matchingProcessDefinitions) => {
 
     

package/processes/NodeRedExternalTask.bpmn

@@ -8,9 +8,8 @@
       <bpmn:lane id="Lane_1xzf0d3">
         <bpmn:flowNodeRef>StartEvent_1</bpmn:flowNodeRef>
         <bpmn:flowNodeRef>Activity_1h843f0</bpmn:flowNodeRef>
-        <bpmn:flowNodeRef>Event_0z1wtnd</bpmn:flowNodeRef>
-        <bpmn:flowNodeRef>Activity_1y52hvq</bpmn:flowNodeRef>
         <bpmn:flowNodeRef>Activity_1duxvq1</bpmn:flowNodeRef>
+        <bpmn:flowNodeRef>Event_0z1wtnd</bpmn:flowNodeRef>
       </bpmn:lane>
     </bpmn:laneSet>
     <bpmn:startEvent id="StartEvent_1" name="Start">
@@ -27,27 +26,22 @@
       <bpmn:outgoing>Flow_110cohh</bpmn:outgoing>
     </bpmn:serviceTask>
     <bpmn:sequenceFlow id="Flow_110cohh" sourceRef="Activity_1h843f0" targetRef="Activity_1duxvq1" />
-    <bpmn:sequenceFlow id="Flow_1u1afua" sourceRef="Activity_1duxvq1" targetRef="Activity_1y52hvq" />
-    <bpmn:endEvent id="Event_0z1wtnd">
-      <bpmn:incoming>Flow_1oiihw7</bpmn:incoming>
-    </bpmn:endEvent>
-    <bpmn:task id="Activity_1y52hvq" name="do wait">
-      <bpmn:incoming>Flow_1u1afua</bpmn:incoming>
-      <bpmn:outgoing>Flow_1oiihw7</bpmn:outgoing>
-    </bpmn:task>
-    <bpmn:sequenceFlow id="Flow_1oiihw7" sourceRef="Activity_1y52hvq" targetRef="Event_0z1wtnd" />
-    <bpmn:serviceTask id="Activity_1duxvq1" name="get process models" camunda:type="external" camunda:topic="processmodels">
+    <bpmn:serviceTask id="Activity_1duxvq1" name="SampleError" camunda:type="external" camunda:topic="SampleError">
       <bpmn:incoming>Flow_110cohh</bpmn:incoming>
       <bpmn:outgoing>Flow_1u1afua</bpmn:outgoing>
     </bpmn:serviceTask>
+    <bpmn:sequenceFlow id="Flow_1u1afua" sourceRef="Activity_1duxvq1" targetRef="Event_0z1wtnd" />
+    <bpmn:endEvent id="Event_0z1wtnd">
+      <bpmn:incoming>Flow_1u1afua</bpmn:incoming>
+    </bpmn:endEvent>
   </bpmn:process>
   <bpmndi:BPMNDiagram id="BPMNDiagram_1">
     <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Collaboration_1cidyxu">
       <bpmndi:BPMNShape id="Participant_0px403d_di" bpmnElement="Participant_0px403d" isHorizontal="true">
-        <dc:Bounds x="5" y="4" width="885" height="346" />
+        <dc:Bounds x="5" y="4" width="695" height="346" />
       </bpmndi:BPMNShape>
       <bpmndi:BPMNShape id="Lane_1xzf0d3_di" bpmnElement="Lane_1xzf0d3" isHorizontal="true">
-        <dc:Bounds x="35" y="4" width="855" height="346" />
+        <dc:Bounds x="35" y="4" width="665" height="346" />
       </bpmndi:BPMNShape>
       <bpmndi:BPMNShape id="StartEvent_1_di" bpmnElement="StartEvent_1">
         <dc:Bounds x="92" y="152" width="36" height="36" />
@@ -59,17 +53,13 @@
         <dc:Bounds x="180" y="130" width="100" height="80" />
         <bpmndi:BPMNLabel />
       </bpmndi:BPMNShape>
-      <bpmndi:BPMNShape id="Event_0z1wtnd_di" bpmnElement="Event_0z1wtnd">
-        <dc:Bounds x="692" y="152" width="36" height="36" />
-      </bpmndi:BPMNShape>
-      <bpmndi:BPMNShape id="Activity_1y52hvq_di" bpmnElement="Activity_1y52hvq">
-        <dc:Bounds x="540" y="130" width="100" height="80" />
-        <bpmndi:BPMNLabel />
-      </bpmndi:BPMNShape>
       <bpmndi:BPMNShape id="Activity_1ohliek_di" bpmnElement="Activity_1duxvq1">
         <dc:Bounds x="370" y="130" width="100" height="80" />
         <bpmndi:BPMNLabel />
       </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Event_0z1wtnd_di" bpmnElement="Event_0z1wtnd">
+        <dc:Bounds x="562" y="152" width="36" height="36" />
+      </bpmndi:BPMNShape>
       <bpmndi:BPMNEdge id="Flow_1xfzejj_di" bpmnElement="Flow_1xfzejj">
         <di:waypoint x="128" y="170" />
         <di:waypoint x="180" y="170" />
@@ -80,11 +70,7 @@
       </bpmndi:BPMNEdge>
       <bpmndi:BPMNEdge id="Flow_1u1afua_di" bpmnElement="Flow_1u1afua">
         <di:waypoint x="470" y="170" />
-        <di:waypoint x="540" y="170" />
-      </bpmndi:BPMNEdge>
-      <bpmndi:BPMNEdge id="Flow_1oiihw7_di" bpmnElement="Flow_1oiihw7">
-        <di:waypoint x="640" y="170" />
-        <di:waypoint x="692" y="170" />
+        <di:waypoint x="562" y="170" />
       </bpmndi:BPMNEdge>
     </bpmndi:BPMNPlane>
   </bpmndi:BPMNDiagram>

package/processinstance-query.js

@@ -34,9 +34,9 @@ module.exports = function(RED) {
         });
 
         node.on('input', function(msg) {
-            const query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg)
+            let query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg)
 
-            client.processInstances.query(query).then((matchingInstances) => {
+            client.processInstances.query(query, { identity: node.server.identity }).then((matchingInstances) => {
 
                 msg.payload = matchingInstances;
 

package/signal-event-trigger.js

@@ -25,7 +25,8 @@ module.exports = function(RED) {
                 config.signalname,
                 {
                   processInstanceId: config.processinstanceid,
-                  payload: msg.payload
+                  payload: msg.payload,
+                  identity: node.server.identity
                 }
             
             ).then((result) => {

package/usertask-finished-listener.js

@@ -28,14 +28,29 @@ module.exports = function(RED) {
             eventEmitter = flowContext.get('emitter');
         }
 
-        node.on("close", async () => {
-            client.dispose();
-            client = null;
-        });
-
-        client.userTasks.onUserTaskFinished((userTaskFinishedNotification) => {
-            node.send({ payload: { flowNodeInstanceId: userTaskFinishedNotification.flowNodeInstanceId, action: "finished", type: "usertask" } });
-        });
+        const register = async () => {
+            let currentIdentity = node.server.identity;
+            let subscription = await client.userTasks.onUserTaskFinished((userTaskFinishedNotification) => {
+                node.send({ payload: { flowNodeInstanceId: userTaskFinishedNotification.flowNodeInstanceId, action: "finished", type: "usertask" } });
+            }, { identity: currentIdentity });
+            
+            node.server.registerOnIdentityChanged(async (identity) => {  
+                client.userTasks.removeSubscription(subscription, currentIdentity);
+                currentIdentity = identity;
+    
+                subscription = await client.userTasks.onUserTaskFinished((userTaskFinishedNotification) => {
+                    node.send({ payload: { flowNodeInstanceId: userTaskFinishedNotification.flowNodeInstanceId, action: "finished", type: "usertask" } });
+                }, { identity: currentIdentity });
+            });
+    
+            node.on("close", async () => {
+                client.userTasks.removeSubscription(subscription, currentIdentity);
+                client.dispose();
+                client = null;
+            });
+        } 
+
+        register();
     }
     RED.nodes.registerType("usertask-finished-listener", UserTaskFinishedListener);
 }

package/usertask-input.js

@@ -15,6 +15,7 @@ module.exports = function(RED) {
     function UserTaskInput(config) {
         RED.nodes.createNode(this,config);
         var node = this;
+        var msgCounter = 0;
         var flowContext = node.context().flow;
         var nodeContext = node.context();
 
@@ -42,8 +43,11 @@ module.exports = function(RED) {
         });
 
         node.on('input', function(msg) {
-            const query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg)
-
+            let query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg)
+            query = {
+                ...query,
+                identity: node.server.identity
+            }
             client.userTasks.query(query).then((matchingFlowNodes) => {
 
                 if (!config.force_send_array && matchingFlowNodes && matchingFlowNodes.userTasks && matchingFlowNodes.userTasks.length == 1) {

package/usertask-new-listener.js

@@ -27,15 +27,31 @@ module.exports = function(RED) {
             flowContext.set('emitter', new EventEmitter());
             eventEmitter = flowContext.get('emitter');
         }
+        
+        const register = async () => {
+            let currentIdentity = node.server.identity;
+            let subscription = await client.userTasks.onUserTaskWaiting((userTaskWaitingNotification) => {
+                node.send({ payload: { flowNodeInstanceId: userTaskWaitingNotification.flowNodeInstanceId, action: "new", type: "usertask"  } });
+            }, { identity: currentIdentity });
+            
+            node.server.registerOnIdentityChanged(async (identity) => {  
+                client.userTasks.removeSubscription(subscription, currentIdentity);
+                currentIdentity = identity;
+    
+                subscription = await client.userTasks.onUserTaskWaiting((userTaskWaitingNotification) => {
+                    node.send({ payload: { flowNodeInstanceId: userTaskWaitingNotification.flowNodeInstanceId, action: "new", type: "usertask"  } });
+                }, { identity: currentIdentity });
+            });
+    
+            node.on("close", async () => {
+                client.userTasks.removeSubscription(subscription, currentIdentity);
+                client.dispose();
+                client = null;
+            });
+        } 
+
+        register();
 
-        node.on("close", async () => {
-            client.dispose();
-            client = null;
-        });
-
-        client.userTasks.onUserTaskWaiting((userTaskWaitingNotification) => {
-            node.send({ payload: { flowNodeInstanceId: userTaskWaitingNotification.flowNodeInstanceIdaction, action: "new", type: "usertask"  } });
-        });
     }
     RED.nodes.registerType("usertask-new-listener", UserTaskNewListener);
 }

package/usertask-output.js

@@ -37,7 +37,7 @@ module.exports = function(RED) {
 
                 const userTaskResult = RED.util.evaluateNodeProperty(config.result, config.result_type, node, msg);
 
-                client.userTasks.finishUserTask(flowNodeInstanceId, userTaskResult).then(() => {
+                client.userTasks.finishUserTask(flowNodeInstanceId, userTaskResult, node.server.identity).then(() => {
 
                     node.send(msg);
                 }).catch(error => {

package/wait_for_usertask.html

@@ -1,67 +0,0 @@
-<script type="text/javascript">
-    RED.nodes.registerType('wait-for-usertask',{
-        category: 'ProcessCube',
-        color: '#02AFD6',
-        defaults: {
-            name: {value: ""},
-            engine: {value: "", type: "processcube-engine-config"},
-            query: {value: "payload"},
-            query_type: {value: "msg"}
-        },
-        inputs: 1,
-        outputs: 1,
-        icon: "font-awesome/fa-envelope-open",
-        label: function() {
-            return this.name || "wait-for-usertask";
-        },
-        oneditprepare: function() {
-            $("#node-input-query").typedInput({
-                default: 'msg',
-                types: ['msg', 'json']
-            });
-
-            $("#node-input-query").typedInput('value', this.query);
-            $("#node-input-query").typedInput('type', this.query_type);
-        },
-        oneditsave: function() {
-            this.query = $("#node-input-query").typedInput('value'),
-            this.query_type = $("#node-input-query").typedInput('type')
-
-        }
-    });
-</script>
-
-<script type="text/html" data-template-name="wait-for-usertask">
-    <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">
-    </div>
-    <div class="form-row">
-        <label for="node-input-engine"><i class="fa fa-tag"></i> Engine-URL</label>
-        <input type="text" id="node-input-engine" placeholder="http://engine:8000">
-    </div>
-    <div class="form-row">
-        <label for="node-input-query"><i class="fa fa-tag"></i> Query</label>
-        <input type="text" id="node-input-query">
-    </div>
-</script>
-
-<script type="text/markdown" data-help-name="wait-for-usertask">
-Waiting for Usertasks of the connected ProcessCube Engine.
-
-### Inputs
-
-: payload (json)            :  the query to filter the usertasks.
-
-## Outputs
-
-: payload.userTask (string) : The filtered UserTask
-
-### Details
-
-`msg.payload` or a constant json to filter the UserTasks for Waiting for
-
-### References
-
- - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; Plattform
-</script>

package/wait_for_usertask.js

@@ -1,52 +0,0 @@
-const process = require('process');
-
-const engine_client = require('@5minds/processcube_engine_client');
-
-module.exports = function (RED) {
-    function WaitForUsertask(config) {
-        RED.nodes.createNode(this, config);
-        var node = this;
-        let client = null;
-        
-        this.engine = this.server = RED.nodes.getNode(config.engine);
-
-        const engineUrl = this.engine?.url || process.env.ENGINE_URL || 'http://engine:8000';
-
-        node.on("close", async () => {
-            if (client != null) {
-                client.dispose();
-                client = null;    
-            }
-        });
-
-        node.on('input', function (msg) {
-            
-            const query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg)
-
-            client = new engine_client.EngineClient(engineUrl);
-            client.userTasks.onUserTaskWaiting((userTaskWaitingNotification) => {
-
-                query['flowNodeInstanceId'] = userTaskWaitingNotification.flowNodeInstanceId;
-
-                client.userTasks.query(query).then((matchingFlowNodes) => {
-
-                    if (matchingFlowNodes.userTasks && matchingFlowNodes.userTasks.length == 1) {
-                        userTask = matchingFlowNodes.userTasks[0];
-
-                        msg.payload = { userTask: userTask };
-                        node.send(msg);
-                    } else {
-                        // do nothing, cause we are waiting for a specific user task
-                    }
-
-                    // dispose the client
-                    if (client != null) {
-                        client.dispose();
-                        client = null;    
-                    }
-                });
-            });
-        });
-    }
-    RED.nodes.registerType("wait-for-usertask", WaitForUsertask);
-}