@5minds/node-red-contrib-processcube 1.5.10-feature-c578ab-m4jpoj9a → 1.5.10-feature-70f7fe-m4jq28wc

package/endevent-finished-listener.js

@@ -6,6 +6,17 @@ module.exports = function (RED) {
 
         let subscription = null;
 
+        const eventEmitter = node.engine.eventEmitter;
+
+        eventEmitter.on('engine-client-dispose', () => {
+            node.engine.engineClient.events.removeSubscription(subscription, node.engine.identity);
+        });
+
+        eventEmitter.on('engine-client-changed', () => {
+            node.log('new engineClient received');
+            register();
+        });
+
         const register = async () => {
             const client = node.engine.engineClient;
 

package/externaltask-event-listener.js

@@ -6,6 +6,17 @@ module.exports = function (RED) {
 
         let subscription;
 
+        const eventEmitter = node.engine.eventEmitter;
+
+        eventEmitter.on('engine-client-dispose', () => {
+            node.engine.engineClient.notification.removeSubscription(subscription, node.engine.identity);
+        });
+
+        eventEmitter.on('engine-client-changed', () => {
+            node.log('new engineClient received');
+            register();
+        });
+
         const register = async () => {
             let currentIdentity = node.engine.identity;
 

package/externaltask-input.js

@@ -16,7 +16,7 @@ module.exports = function (RED) {
         var node = this;
         var flowContext = node.context().flow;
 
-        node.engine = RED.nodes.getNode(config.engine);
+        const engine = RED.nodes.getNode(config.engine);
 
         var eventEmitter = flowContext.get('emitter');
 
@@ -25,6 +25,13 @@ module.exports = function (RED) {
             eventEmitter = flowContext.get('emitter');
         }
 
+        const engineEventEmitter = engine.eventEmitter;
+
+        engineEventEmitter.on('engine-client-changed', () => {
+            node.log('new engineClient received');
+            register();
+        });
+
         const register = async () => {
             if (node.etw) {
                 try {
@@ -34,7 +41,7 @@ module.exports = function (RED) {
                     node.log(`cant close etw: ${JSON.stringify(node.etw)}`);
                 }
             }
-            const client = node.engine.engineClient;
+            const client = engine.engineClient;
 
             if (!client) {
                 node.error('No engine configured.');
@@ -126,8 +133,8 @@ module.exports = function (RED) {
 
                     node.etw = externalTaskWorker;
 
-                    externalTaskWorker.identity = node.engine.identity;
-                    node.engine.registerOnIdentityChanged((identity) => {
+                    externalTaskWorker.identity = engine.identity;
+                    engine.registerOnIdentityChanged((identity) => {
                         externalTaskWorker.identity = identity;
                     });
 
@@ -178,7 +185,7 @@ module.exports = function (RED) {
                 });
         };
 
-        if (node.engine) {
+        if (engine) {
             register();
         }
     }

package/message-event-trigger.js

@@ -5,19 +5,19 @@ module.exports = function (RED) {
 
         node.on('input', function (msg) {
 
-            node.engine = RED.nodes.getNode(config.engine);
-            const client = node.engine.engineClient;
+            const engine = RED.nodes.getNode(config.engine);
+            const client = engine.engineClient;
 
             if (!client) {
                 node.error('No engine configured.');
                 return;
             }
 
-            node.engine.engineClient.events
+            engine.engineClient.events
                 .triggerMessageEvent(config.messagename, {
                     processInstanceId: msg.processinstanceid,
                     payload: msg.payload,
-                    identity: node.engine.identity,
+                    identity: engine.identity,
                 })
                 .then((result) => {
                     msg.payload = result;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@5minds/node-red-contrib-processcube",
-    "version": "1.5.10-feature-c578ab-m4jpoj9a",
+    "version": "1.5.10-feature-70f7fe-m4jq28wc",
     "license": "MIT",
     "description": "Node-RED nodes for ProcessCube",
     "scripts": {

package/process-event-listener.js

@@ -6,6 +6,17 @@ module.exports = function (RED) {
 
         let subscription;
 
+        const engineEventEmitter = node.engine.eventEmitter;
+
+        engineEventEmitter.on('engine-client-dispose', () => {
+            node.engine.engineClient.notification.removeSubscription(subscription, node.engine.identity);
+        });
+
+        engineEventEmitter.on('engine-client-changed', () => {
+            node.log('new engineClient received');
+            register();
+        });
+
         const register = async () => {
             const client = node.engine.engineClient;
 

package/process-start.js

@@ -22,8 +22,8 @@ module.exports = function (RED) {
                 return;
             }
 
-            node.engine = RED.nodes.getNode(config.engine);
-            const client = node.engine.engineClient;
+            const engine = RED.nodes.getNode(config.engine);
+            const client = engine.engineClient;
 
             if (!client) {
                 node.error('No engine configured.');
@@ -31,7 +31,7 @@ module.exports = function (RED) {
             }
 
             client.processDefinitions
-                .startProcessInstance(startParameters, node.engine.identity)
+                .startProcessInstance(startParameters, engine.identity)
                 .then((result) => {
                     msg.payload = result;
 

package/process-terminate.js

@@ -4,8 +4,8 @@ module.exports = function (RED) {
         var node = this;
 
         node.on('input', function (msg) {
-            node.engine = RED.nodes.getNode(config.engine);
-            const client = node.engine.engineClient;
+            const engine = RED.nodes.getNode(config.engine);
+            const client = engine.engineClient;
 
             if (!client) {
                 node.error('No engine configured.');
@@ -13,7 +13,7 @@ module.exports = function (RED) {
             }
 
             client.processInstances
-                .terminateProcessInstance(msg.payload, node.engine.identity)
+                .terminateProcessInstance(msg.payload, engine.identity)
                 .then(() => {
                     node.send(msg);
                 })

package/processcube-engine-config.html

@@ -4,7 +4,7 @@
         defaults: {
             name: { value: '' },
             url: { value: 'http://engine:8000', required: true },
-            urlType: { type: 'str' },
+            urlType: { type: 'str'},
             clientId: { value: '' },
             clientIdType: { type: 'str' },
             clientSecret: { value: '' },
@@ -16,17 +16,17 @@
         oneditprepare: function () {
             $('#node-config-input-url').typedInput({
                 default: 'str',
-                types: ['str', 'env', 'cred'],
+                types: ['str', 'global', 'flow', 'env', 'msg', 'cred'],
             });
 
             $('#node-config-input-clientId').typedInput({
                 default: 'str',
-                types: ['str', 'env', 'cred'],
+                types: ['str', 'global', 'flow', 'env', 'msg', 'cred'],
             });
 
             $('#node-config-input-clientSecret').typedInput({
                 default: 'str',
-                types: ['str', 'env', 'cred'],
+                types: ['str', 'global', 'flow', 'env', 'msg', 'cred'],
             });
 
             $('#node-config-input-url').typedInput('value', this.url);
@@ -66,21 +66,21 @@
     </div>
     <div class="form-row">
         <label for="node-config-input-clientSecret"><i class="fa fa-bookmark"></i> Client secret</label>
-        <input type="text" id="node-config-input-clientSecret" />
+        <input type="password" id="node-config-input-clientSecret" />
     </div>
 </script>
 
 <script type="text/markdown" data-help-name="processcube-engine-config">
-    The configuration for the ProcessCube engine.
+The configuration for the ProcessCube engine.
 
-    ## Inputs
+## Inputs
 
-    : url (String) : The URL of the ProcessCube engine.
-    : clientId (String) : The client id for the ProcessCube engine.
-    : clientSecret (String) : The client secret for the ProcessCube engine.
+: url (String) : The URL of the ProcessCube engine.
+: clientId (String) : The client id for the ProcessCube engine.
+: clientSecret (String) : The client secret for the ProcessCube engine.
 
-    ### References
+### References
 
-    -   [The ProcessCube&copy; Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
-    -   [ProcessCube&copy; LowCode Integration](https://processcube.io/docs/node-red) - LowCode integration in ProcessCube&copy;
+-  [The ProcessCube&copy; Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
+-  [ProcessCube&copy; LowCode Integration](https://processcube.io/docs/node-red) - LowCode integration in ProcessCube&copy;
 </script>

package/processcube-engine-config.js

@@ -1,3 +1,4 @@
+const EventEmitter = require('node:events');
 const engine_client = require('@5minds/processcube_engine_client');
 const jwt = require('jwt-decode');
 const oidc = require('openid-client');
@@ -7,92 +8,134 @@ module.exports = function (RED) {
         RED.nodes.createNode(this, n);
         const node = this;
         const identityChangedCallbacks = [];
-        node.identity = null;
+        this.identity = null;
 
-        node.credentials.clientId = RED.util.evaluateNodeProperty(n.clientId, n.clientIdType, node);
-        node.credentials.clientSecret = RED.util.evaluateNodeProperty(n.clientSecret, n.clientSecretType, node);
+        this.credentials.clientId = RED.util.evaluateNodeProperty(n.clientId, n.clientIdType, node);
+        this.credentials.clientSecret = RED.util.evaluateNodeProperty(n.clientSecret, n.clientSecretType, node);
 
-        node.registerOnIdentityChanged = function (callback) {
+        node.eventEmitter = new EventEmitter();
+
+        // set the engine url
+        const stopRefreshing = periodicallyRefreshEngineClient(this, n, 10000);
+
+        this.registerOnIdentityChanged = function (callback) {
             identityChangedCallbacks.push(callback);
         };
 
-        node.isIdentityReady = function () {
-            if (node.credentials.clientId && node.credentials.clientSecret) {
-                return node.identity != null;
+        this.isIdentityReady = function () {
+            if (this.credentials.clientId && this.credentials.clientSecret) {
+                return this.identity != null;
             } else {
                 return true;
             }
         };
 
-        node.setIdentity = (identity) => {
+        this.setIdentity = (identity) => {
             node.log(`setIdentity: ${JSON.stringify(identity)}`);
-            node.identity = identity;
+            this.identity = identity;
 
             for (const callback of identityChangedCallbacks) {
                 callback(identity);
             }
         };
 
-        if (node.credentials.clientId && node.credentials.clientSecret) {
-            node.engineClient = new engine_client.EngineClient(node.url, {
-                clientId: node.credentials.clientId,
-                clientSecret: node.credentials.clientSecret,
-            });
-        } else {
-            node.engineClient = new engine_client.EngineClient(node.url);
+        function periodicallyRefreshEngineClient(node, n, intervalMs) {
+            function refreshUrl() {
+                const newUrl = RED.util.evaluateNodeProperty(n.url, n.urlType, node);
+                const newClientId = RED.util.evaluateNodeProperty(n.clientId, n.clientIdType, node);
+                const newClientSecret = RED.util.evaluateNodeProperty(n.clientSecret, n.clientSecretType, node);
+
+                if (
+                    node.url === newUrl &&
+                    node.credentials.clientId === newClientId &&
+                    node.credentials.clientSecret === newClientSecret
+                ) {
+                    return;
+                }
+
+                node.url = newUrl;
+                node.credentials.clientId = newClientId;
+                node.credentials.clientSecret = newClientSecret;
+
+                if (node.credentials.clientId && node.credentials.clientSecret) {
+                    if (node.engineClient) {
+                        node.eventEmitter.emit('engine-client-dispose');
+                        node.engineClient.dispose();
+                    }
+                    node.engineClient = new engine_client.EngineClient(node.url, () =>
+                        getFreshIdentity(node.url, node)
+                    );
+
+                    node.eventEmitter.emit('engine-client-changed');
+                } else {
+                    if (node.engineClient) {
+                        node.eventEmitter.emit('engine-client-dispose');
+                        node.engineClient.dispose();
+                    }
+                    node.engineClient = new engine_client.EngineClient(node.url);
+
+                    node.eventEmitter.emit('engine-client-changed');
+                }
+            }
+
+            refreshUrl();
+            const intervalId = setInterval(refreshUrl, intervalMs);
+
+            return () => clearInterval(intervalId);
         }
 
-        // async function getFreshIdentity(url, node) {
-        //     try {
-        //         if (
-        //             !RED.util.evaluateNodeProperty(n.clientId, n.clientIdType, node) ||
-        //             !RED.util.evaluateNodeProperty(n.clientSecret, n.clientSecretType, node)
-        //         ) {
-        //             return null;
-        //         }
-
-        //         const res = await fetch(url + '/atlas_engine/api/v1/authority', {
-        //             method: 'GET',
-        //             headers: {
-        //                 Authorization: `Bearer ZHVtbXlfdG9rZW4=`,
-        //                 'Content-Type': 'application/json',
-        //             },
-        //         });
-
-        //         const body = await res.json();
-
-        //         const issuer = await oidc.Issuer.discover(body);
-
-        //         const client = new issuer.Client({
-        //             client_id: RED.util.evaluateNodeProperty(n.clientId, n.clientIdType, node),
-        //             client_secret: RED.util.evaluateNodeProperty(n.clientSecret, n.clientSecretType, node),
-        //         });
-
-        //         const tokenSet = await client.grant({
-        //             grant_type: 'client_credentials',
-        //             scope: 'engine_etw engine_read engine_write',
-        //         });
-
-        //         const accessToken = tokenSet.access_token;
-        //         const decodedToken = jwt.jwtDecode(accessToken);
-
-        //         const freshIdentity = {
-        //             token: tokenSet.access_token,
-        //             userId: decodedToken.sub,
-        //         };
-
-        //         node.setIdentity(freshIdentity);
-
-        //         return freshIdentity;
-        //     } catch (e) {
-        //         node.error(`Could not get fresh identity: ${e}`);
-        //     }
-        // }
+        async function getFreshIdentity(url, node) {
+            try {
+                if (
+                    !RED.util.evaluateNodeProperty(n.clientId, n.clientIdType, node) ||
+                    !RED.util.evaluateNodeProperty(n.clientSecret, n.clientSecretType, node)
+                ) {
+                    return null;
+                }
+
+                const res = await fetch(url + '/atlas_engine/api/v1/authority', {
+                    method: 'GET',
+                    headers: {
+                        Authorization: `Bearer ZHVtbXlfdG9rZW4=`,
+                        'Content-Type': 'application/json',
+                    },
+                });
+
+                const body = await res.json();
+
+                const issuer = await oidc.Issuer.discover(body);
+
+                const client = new issuer.Client({
+                    client_id: RED.util.evaluateNodeProperty(n.clientId, n.clientIdType, node),
+                    client_secret: RED.util.evaluateNodeProperty(n.clientSecret, n.clientSecretType, node),
+                });
+
+                const tokenSet = await client.grant({
+                    grant_type: 'client_credentials',
+                    scope: 'engine_etw engine_read engine_write',
+                });
+
+                const accessToken = tokenSet.access_token;
+                const decodedToken = jwt.jwtDecode(accessToken);
+
+                const freshIdentity = {
+                    token: tokenSet.access_token,
+                    userId: decodedToken.sub,
+                };
+
+                node.setIdentity(freshIdentity);
+
+                return freshIdentity;
+            } catch (e) {
+                node.error(`Could not get fresh identity: ${e}`);
+            }
+        }
 
         node.on('close', async () => {
-            if (node.engineClient) {
-                node.engineClient.dispose();
-                node.engineClient = null;
+            if (this.engineClient) {
+                stopRefreshing();
+                this.engineClient.dispose();
+                this.engineClient = null;
             }
         });
     }

package/processdefinition-query.js

@@ -5,7 +5,7 @@ module.exports = function (RED) {
 
         node.on('input', function (msg) {
 
-            node.engine = RED.nodes.getNode(config.engine);
+            const engine = RED.nodes.getNode(config.engine);
             const client = engine.engineClient;
 
             if (!client) {
@@ -17,7 +17,7 @@ module.exports = function (RED) {
             
             query = {
                 ...query,
-                identity: node.engine.identity,
+                identity: engine.identity,
             };
 
             node.log(`Querying process definitions with query: ${JSON.stringify(query)}`);

package/processinstance-delete.html

@@ -6,8 +6,8 @@
             name: { value: '' },
             engine: { value: '', type: 'processcube-engine-config' },
             modelid: { value: '' },
-            time: { value: '', type: 'number' },
-            time_type: { value: 'hours' },
+            duration: { value: '', type: 'number' },
+            time_unit: { value: 'hours' },
         },
         inputs: 1,
         outputs: 1,
@@ -32,12 +32,12 @@
         <input type="text" id="node-input-modelid" />
     </div>
     <div class="form-row">
-        <label for="node-input-time"><i class="fa fa-tag"></i> Duration</label>
+        <label for="node-input-duration"><i class="fa fa-tag"></i> Duration</label>
         <input type="text" id="node-input-time" />
     </div>
     <div class="form-row">
-        <label for="node-input-time_type"><i class="fa fa-sliders"></i> Time Unit</label>
-        <select id="node-input-time_type" style="width: 70%;">
+        <label for="node-input-time_unit"><i class="fa fa-sliders"></i> Time Unit</label>
+        <select id="node-input-time_unit" style="width: 70%;">
             <option value="hours">Hours</option>
             <option value="days">Days</option>
         </select>

package/processinstance-delete.js

@@ -4,21 +4,21 @@ module.exports = function (RED) {
         var node = this;
 
         node.on('input', async function (msg) {
-            node.engine = RED.nodes.getNode(config.engine);
-            const client = node.engine.engineClient;
+            const engine = RED.nodes.getNode(config.engine);
+            const client = engine.engineClient;
 
             if (!client) {
                 node.error('No engine configured.');
                 return;
             }
             let timeMultiplier;
-            if (msg.payload.time_type) {
-                timeMultiplier = msg.payload.time_type == 'hours' ? 1 : 24;
+            if (msg.payload.time_unit) {
+                timeMultiplier = msg.payload.time_unit == 'hours' ? 1 : 24;
             } else {
-                timeMultiplier = config.time_type == 'hours' ? 1 : 24;
+                timeMultiplier = config.time_unit == 'hours' ? 1 : 24;
             }
 
-            const timeToUse = msg.payload.time ? msg.payload.time : config.time;
+            const timeToUse = msg.payload.duration ? msg.payload.duration : config.duration;
             const modelId = msg.payload.processModelId
                 ? msg.payload.processModelId != ''
                     ? msg.payload.processModelId
@@ -30,7 +30,7 @@ module.exports = function (RED) {
             try {
                 const result = await client.processInstances.query({
                     processModelId: modelId
-                }, { identity: node.engine.identity });
+                }, { identity: engine.identity });
 
                 let allInstances = result.processInstances.filter((instance) => instance.state != 'suspended');
 
@@ -45,7 +45,7 @@ module.exports = function (RED) {
                 const ids = oldTasks.map((obj) => obj.processInstanceId);
                 msg.payload = ids;
 
-                await client.processInstances.deleteProcessInstances(ids, true, node.engine.identity);
+                await client.processInstances.deleteProcessInstances(ids, true, engine.identity);
                 node.send(msg);
             } catch (error) {
                 node.error(error);

package/processinstance-query.js

@@ -6,8 +6,8 @@ module.exports = function (RED) {
         node.on('input', function (msg) {
             let query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg);
 
-            node.engine =  RED.nodes.getNode(config.engine);
-            const client = node.engine.engineClient;
+            const engine =  RED.nodes.getNode(config.engine);
+            const client = engine.engineClient;
 
             if (!client) {
                 node.error('No engine configured.');
@@ -15,7 +15,7 @@ module.exports = function (RED) {
             }
 
             client.processInstances
-                .query(query, { identity: node.engine.identity })
+                .query(query, { identity: engine.identity })
                 .then((matchingInstances) => {
                     msg.payload = matchingInstances;
 

package/signal-event-trigger.js

@@ -4,9 +4,9 @@ module.exports = function (RED) {
         var node = this;
 
         node.on('input', function (msg) {
-            node.engine = RED.nodes.getNode(config.engine);
+            const engine = RED.nodes.getNode(config.engine);
 
-            const client = node.engine.engineClient;
+            const client = engine.engineClient;
 
             if (!client) {
                 node.error('No engine configured.');
@@ -17,7 +17,7 @@ module.exports = function (RED) {
                 .triggerSignalEvent(config.signalname, {
                     processInstanceId: msg.processinstanceid,
                     payload: msg.payload,
-                    identity: node.engine.identity,
+                    identity: engine.identity,
                 })
                 .then((result) => {
                     msg.payload = result;

package/usertask-event-listener.js

@@ -6,6 +6,17 @@ module.exports = function (RED) {
 
         let subscription;
 
+        const eventEmitter = node.engine.eventEmitter;
+
+        eventEmitter.on('engine-client-dispose', () => {
+            node.engine.engineClient.userTasks.removeSubscription(subscription, node.engine.identity);
+        });
+
+        eventEmitter.on('engine-client-changed', () => {
+            node.log('new engineClient received');
+            register();
+        });
+
         const register = async () => {
             let currentIdentity = node.engine.identity;
 

package/usertask-input.js

@@ -4,9 +4,9 @@ module.exports = function (RED) {
         var node = this;
 
         node.on('input', function (msg) {
-            node.engine = RED.nodes.getNode(config.engine);
+            const engine = RED.nodes.getNode(config.engine);
 
-            const client = node.engine.engineClient;
+            const client = engine.engineClient;
 
             if (!client) {
                 node.error('No engine configured.');
@@ -20,7 +20,7 @@ module.exports = function (RED) {
             };
 
             client.userTasks
-                .query(query, { identity: node.engine.identity })
+                .query(query, { identity: engine.identity })
                 .then((matchingFlowNodes) => {
                     if (config.sendtype === 'array') {
                         msg.payload = { userTasks: matchingFlowNodes.userTasks || [] };

package/usertask-output.js

@@ -9,9 +9,9 @@ module.exports = function (RED) {
 
                 const userTaskResult = RED.util.evaluateNodeProperty(config.result, config.result_type, node, msg);
 
-                node.engine = RED.nodes.getNode(config.engine);
+                const engine = RED.nodes.getNode(config.engine);
 
-                const client = node.engine.engineClient;
+                const client = engine.engineClient;
 
                 if (!client) {
                     node.error('No engine configured.');
@@ -19,7 +19,7 @@ module.exports = function (RED) {
                 }
         
                 client.userTasks
-                    .finishUserTask(flowNodeInstanceId, userTaskResult, node.engine.identity)
+                    .finishUserTask(flowNodeInstanceId, userTaskResult, engine.identity)
                     .then(() => {
                         node.send(msg);
                     })