@5minds/node-red-contrib-processcube 1.5.10 → 1.5.11-develop-034baa-m4sa5pvu

package/process-start.js

@@ -4,7 +4,6 @@ module.exports = function (RED) {
         var node = this;
 
         node.on('input', function (msg) {
-
             const initialToken = RED.util.encodeObject(msg.payload);
 
             const startParameters = {
@@ -13,8 +12,18 @@ module.exports = function (RED) {
                 initialToken: initialToken,
             };
 
-            const engine = RED.nodes.getNode(config.engine);
-            const client = engine.engineClient;
+            if (!startParameters.processModelId) {
+                node.error('No processModelId configured.');
+                return;
+            }
+
+            if (!startParameters.startEventId) {
+                node.error('No startEventId configured.');
+                return;
+            }
+
+            node.engine = RED.nodes.getNode(config.engine);
+            const client = node.engine.engineClient;
 
             if (!client) {
                 node.error('No engine configured.');
@@ -22,7 +31,7 @@ module.exports = function (RED) {
             }
 
             client.processDefinitions
-                .startProcessInstance(startParameters, engine.identity)
+                .startProcessInstance(startParameters)
                 .then((result) => {
                     msg.payload = result;
 
@@ -34,7 +43,7 @@ module.exports = function (RED) {
                     });
                 })
                 .catch((error) => {
-                    node.error(error);
+                    node.error(JSON.stringify(error));
                 });
         });
     }

package/process-terminate.js

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

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', 'global', 'flow', 'env', 'msg', 'cred'],
+                types: ['str', 'env', 'cred'],
             });
 
             $('#node-config-input-clientId').typedInput({
                 default: 'str',
-                types: ['str', 'global', 'flow', 'env', 'msg', 'cred'],
+                types: ['str', 'env', 'cred'],
             });
 
             $('#node-config-input-clientSecret').typedInput({
                 default: 'str',
-                types: ['str', 'global', 'flow', 'env', 'msg', 'cred'],
+                types: ['str', 'env', 'cred'],
             });
 
             $('#node-config-input-url').typedInput('value', this.url);
@@ -66,7 +66,7 @@
     </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" />
+        <input type="text" id="node-config-input-clientSecret" />
     </div>
 </script>
 
@@ -81,6 +81,6 @@ The configuration for the ProcessCube engine.
 
 ### 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,4 +1,3 @@
-const EventEmitter = require('node:events');
 const engine_client = require('@5minds/processcube_engine_client');
 const jwt = require('jwt-decode');
 const oidc = require('openid-client');
@@ -7,138 +6,33 @@ module.exports = function (RED) {
     function ProcessCubeEngineNode(n) {
         RED.nodes.createNode(this, n);
         const node = this;
-        const identityChangedCallbacks = [];
-        this.identity = null;
 
-        this.credentials.clientId = RED.util.evaluateNodeProperty(n.clientId, n.clientIdType, node);
-        this.credentials.clientSecret = RED.util.evaluateNodeProperty(n.clientSecret, n.clientSecretType, node);
+        node.url = RED.util.evaluateNodeProperty(n.url, n.urlType, node);
+        node.credentials.clientId = RED.util.evaluateNodeProperty(n.clientId, n.clientIdType, node);
+        node.credentials.clientSecret = RED.util.evaluateNodeProperty(n.clientSecret, n.clientSecretType, node);
 
-        node.eventEmitter = new EventEmitter();
-
-        // set the engine url
-        const stopRefreshing = periodicallyRefreshEngineClient(this, n, 10000);
-
-        this.registerOnIdentityChanged = function (callback) {
-            identityChangedCallbacks.push(callback);
-        };
-
-        this.isIdentityReady = function () {
-            if (this.credentials.clientId && this.credentials.clientSecret) {
-                return this.identity != null;
-            } else {
-                return true;
-            }
-        };
-
-        this.setIdentity = (identity) => {
-            node.log(`setIdentity: ${JSON.stringify(identity)}`);
-            this.identity = identity;
-
-            for (const callback of identityChangedCallbacks) {
-                callback(identity);
-            }
-        };
-
-        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',
+        try {
+            if (node.credentials.clientId && node.credentials.clientSecret) {
+                node.engineClient = new engine_client.EngineClient(node.url, {
+                    clientId: node.credentials.clientId,
+                    clientSecret: node.credentials.clientSecret,
                     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}`);
+            } else {
+                node.engineClient = new engine_client.EngineClient(node.url);
             }
+        } catch (error) {
+            node.error(JSON.stringify(error));
         }
 
         node.on('close', async () => {
-            if (this.engineClient) {
-                stopRefreshing();
-                this.engineClient.dispose();
-                this.engineClient = null;
+            if (node.engineClient) {
+                node.engineClient.dispose();
+                node.engineClient = null;
             }
         });
     }
+
     RED.nodes.registerType('processcube-engine-config', ProcessCubeEngineNode, {
         credentials: {
             clientId: { type: 'text' },

package/processdefinition-query.js

@@ -4,8 +4,7 @@ module.exports = function (RED) {
         var node = this;
 
         node.on('input', function (msg) {
-
-            const engine = RED.nodes.getNode(config.engine);
+            node.engine = RED.nodes.getNode(config.engine);
             const client = engine.engineClient;
 
             if (!client) {
@@ -14,37 +13,34 @@ module.exports = function (RED) {
             }
 
             let query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg);
-            
-            query = {
-                ...query,
-                identity: engine.identity,
-            };
 
             node.log(`Querying process definitions with query: ${JSON.stringify(query)}`);
-            
-            client.processDefinitions.getAll(query).then((matchingProcessDefinitions) => {
 
-                if (config.models_only && matchingProcessDefinitions.totalCount > 0) {
-                    let models = [];
+            client.processDefinitions
+                .getAll(query)
+                .then((matchingProcessDefinitions) => {
+                    if (config.models_only && matchingProcessDefinitions.totalCount > 0) {
+                        let models = [];
 
-                    matchingProcessDefinitions.processDefinitions.forEach((processDefinition) => {
-                        processDefinition.processModels.forEach((model) => {
-                            models.push(model);
+                        matchingProcessDefinitions.processDefinitions.forEach((processDefinition) => {
+                            processDefinition.processModels.forEach((model) => {
+                                models.push(model);
+                            });
                         });
-                    });
-
-                    msg.payload = {
-                        models: models,
-                        totalCount: models.length,
-                    };
-                } else {
-                    msg.payload = matchingProcessDefinitions;
-                }
-
-                node.send(msg);
-            }).catch((error) => {
-                node.error(error);
-            });
+
+                        msg.payload = {
+                            models: models,
+                            totalCount: models.length,
+                        };
+                    } else {
+                        msg.payload = matchingProcessDefinitions;
+                    }
+
+                    node.send(msg);
+                })
+                .catch((error) => {
+                    node.error(JSON.stringify(error));
+                });
         });
     }
     RED.nodes.registerType('processdefinition-query', ProcessdefinitionQuery);

package/processinstance-delete.html

@@ -6,8 +6,9 @@
             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' },
+            batch_size: { value: '100', type: 'number' },
         },
         inputs: 1,
         outputs: 1,
@@ -32,16 +33,20 @@
         <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>
-        <input type="text" id="node-input-time" />
+        <label for="node-input-duration"><i class="fa fa-tag"></i> Duration</label>
+        <input type="text" id="node-input-duration" />
     </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>
     </div>
+    <div class="form-row">
+        <label for="node-input-batch-size"><i class="fa fa-tag"></i> Batch Size</label>
+        <input type="text" id="node-input-batch_size" />
+    </div>
 </script>
 
 <script type="text/markdown" data-help-name="processinstance-delete">
@@ -49,12 +54,54 @@ Delete old instances of a process model in the ProcessCube.
 
 ## Inputs
 
-: payload.time (number): The number of given time periods.
-: payload.time_type ('hours' | 'days'): The type of time period to use.
+: payload.duration (number): The number of given time periods.
+: payload.time_unit ('hours' | 'days'): The type of time period to use.
+: payload.batch_size (number): The number of instances to be deleted simultaneously. (default 100)
 
 ## Outputs
 
-: payload (string[]): The ids of the processinstances that were deleted.
+: Explanation of the payload:
+
+Object
+{
+    successfulDeletions: [Array of strings],
+    failedDeletions: [Array of objects]
+}
+
+- successfulDeletions:
+    - Type: Array<String>
+    - Content: A list of successfully deleted process instance IDs.
+
+    - excample:
+        successfulDeletions: [
+        "instanceId1",
+        "instanceId2",
+        "instanceId3"
+       ]
+
+- failedDeletions:
+    - Type: Array<Object>
+    - Content: A list of objects containing details of the failed deletions.
+    - Each object has the following fields:
+        - id: The ID of the process instance that could not be deleted.
+        - error: The error message or the reason for the error.
+
+- Example of a complete output:
+    {
+        successfulDeletions: [
+            "instanceId1",
+            "instanceId2",
+            "instanceId3"
+        ],
+        failedDeletions: [
+            { id: "instanceId4", error: "Permission denied" },
+            { id: "instanceId5", error: "Instance not found" }
+        ]
+    }
+
+The node processes the IDs in configurable batches (default value: 100) and inserts successfully deleted or failed instances into the arrays accordingly.
+As processing is currently forced to batch, a detailed error output is not possible. 
+If an error occurs during the processing of a batch, all Id's of this batch are marked as faulty.
 
 ### References
 

package/processinstance-delete.js

@@ -4,21 +4,22 @@ module.exports = function (RED) {
         var node = this;
 
         node.on('input', async function (msg) {
-            const engine = RED.nodes.getNode(config.engine);
-            const client = engine.engineClient;
+            node.engine = RED.nodes.getNode(config.engine);
+            const client = node.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
@@ -27,12 +28,14 @@ module.exports = function (RED) {
                 ? config.modelid
                 : undefined;
 
+            const batchSize = config.batch_size || 100; // Konfigurierbare Batchgröße, Standardwert 100
+
             try {
                 const result = await client.processInstances.query({
                     processModelId: modelId
-                }, { identity: engine.identity });
+                }, { identity: node.engine.identity });
 
-                let allInstances = result.processInstances.filter((instance) => instance.state != 'suspended');
+                let allInstances = result.processInstances.filter((instance) => instance.state != 'suspended' && instance.state != 'running');
 
                 const today = new Date();
 
@@ -43,12 +46,27 @@ module.exports = function (RED) {
                 });
 
                 const ids = oldTasks.map((obj) => obj.processInstanceId);
-                msg.payload = ids;
 
-                await client.processInstances.deleteProcessInstances(ids, true, engine.identity);
+                msg.payload = {
+                    successfulDeletions: [],
+                    failedDeletions: []
+                };
+
+                for (let i = 0; i < ids.length; i += batchSize) {
+                    const batch = ids.slice(i, i + batchSize);
+                    try {
+                        await client.processInstances.deleteProcessInstances(batch, true, engine.identity);
+                        msg.payload.successfulDeletions.push(...batch); // Erfolgreiche IDs hinzufügen
+                    } catch (deleteError) {
+                        batch.forEach(id => {
+                            msg.payload.failedDeletions.push({ id, error: deleteError.message }); // Fehler protokollieren
+                        });
+                        node.warn(`Failed to delete process instances in batch: ${batch.join(', ')}. Error: ${deleteError.message}`);
+                    }
+                }
                 node.send(msg);
-            } catch (error) {
-                node.error(error);
+            } catch (queryError) {
+                node.error(`Failed to query process instances: ${queryError.message}`);
             }
         });
     }

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);
 
-            const engine =  RED.nodes.getNode(config.engine);
-            const client = engine.engineClient;
+            node.engine = RED.nodes.getNode(config.engine);
+            const client = node.engine.engineClient;
 
             if (!client) {
                 node.error('No engine configured.');
@@ -15,7 +15,7 @@ module.exports = function (RED) {
             }
 
             client.processInstances
-                .query(query, { identity: engine.identity })
+                .query(query)
                 .then((matchingInstances) => {
                     msg.payload = matchingInstances;
 

package/signal-event-trigger.js

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

package/usertask-event-listener.js

@@ -6,20 +6,7 @@ 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;
-
             const client = node.engine.engineClient;
 
             if (!client) {
@@ -39,9 +26,7 @@ module.exports = function (RED) {
                     };
 
                     try {
-                        const matchingFlowNodes = await client.userTasks.query(newQuery, {
-                            identity: currentIdentity,
-                        });
+                        const matchingFlowNodes = await client.userTasks.query(newQuery);
 
                         if (matchingFlowNodes.userTasks && matchingFlowNodes.userTasks.length == 1) {
                             const userTask = matchingFlowNodes.userTasks[0];
@@ -57,7 +42,7 @@ module.exports = function (RED) {
                             });
                         }
                     } catch (error) {
-                        node.error(error);
+                        node.error(JSON.stringify(error));
                     }
                 };
             }
@@ -65,42 +50,23 @@ module.exports = function (RED) {
             async function subscribe() {
                 switch (config.eventtype) {
                     case 'new':
-                        return await client.userTasks.onUserTaskWaiting(userTaskCallback(), {
-                            identity: currentIdentity,
-                        });
+                        return await client.userTasks.onUserTaskWaiting(userTaskCallback());
                     case 'finished':
-                        return await client.userTasks.onUserTaskFinished(userTaskCallback(), {
-                            identity: currentIdentity,
-                        });
+                        return await client.userTasks.onUserTaskFinished(userTaskCallback());
                     case 'reserved':
-                        return await client.userTasks.onUserTaskReserved(userTaskCallback(), {
-                            identity: currentIdentity,
-                        });
+                        return await client.userTasks.onUserTaskReserved(userTaskCallback());
                     case 'reservation-canceled':
-                        return await client.userTasks.onUserTaskReservationCanceled(userTaskCallback(), {
-                            identity: currentIdentity,
-                        });
+                        return await client.userTasks.onUserTaskReservationCanceled(userTaskCallback());
                     default:
                         console.error('no such event: ' + config.eventtype);
                 }
             }
 
-            if (node.engine.isIdentityReady()) {
-                subscription = subscribe();
-            }
-
-            node.engine.registerOnIdentityChanged(async (identity) => {
-                if (subscription) {
-                    client.userTasks.removeSubscription(subscription, currentIdentity);
-                }
-                currentIdentity = identity;
-
-                subscription = subscribe();
-            });
+            subscription = subscribe();
 
             node.on('close', async () => {
                 if (node.engine && node.engine.engineClient && client) {
-                    client.userTasks.removeSubscription(subscription, currentIdentity);
+                    client.userTasks.removeSubscription(subscription);
                 }
             });
         };