@vitormnm/node-red-simple-opcua 1.6.3 → 1.7.0

package/client/opcua-client-config.html

@@ -3,16 +3,28 @@
         function toggleCredentials() {
             var authType = $("#node-config-input-authType").val();
             $(".opcua-client-auth-row").toggle(authType === "username");
+            if (authType === "anonymous") {
+                $("#node-config-input-username").val("");
+                $("#node-config-input-password").val("");
+            }
         }
 
         RED.nodes.registerType("opcua-client-config", {
             category: "config",
             defaults: {
                 name: { value: "" },
+                sessionName: { value: "ClientSession1" },
                 endpoint: { value: "opc.tcp://localhost:4840", required: true },
                 securityPolicy: { value: "None", required: true },
                 securityMode: { value: "None", required: true },
-                authType: { value: "anonymous", required: true }
+                authType: { value: "anonymous", required: true },
+                initialDelay: { value: 1000, validate: RED.validators.number() },
+                maxDelay: { value: 10000, validate: RED.validators.number() },
+                maxRetry: { value: -1, validate: RED.validators.number() },
+                requestedSessionTimeout: { value: 300000, validate: RED.validators.number() },
+                keepSessionAlive: { value: true },
+                autoReconnect: { value: true },
+                endpointMustExist: { value: false }
             },
             credentials: {
                 username: { type: "text" },
@@ -22,22 +34,87 @@
                 return this.name || this.endpoint || "opcua-client-config";
             },
             oneditprepare: function () {
+                if (this.keepSessionAlive !== false) {
+                    $("#node-config-input-keepSessionAlive").prop("checked", true);
+                }
+                if (this.autoReconnect !== false) {
+                    $("#node-config-input-autoReconnect").prop("checked", true);
+                }
+                if (this.endpointMustExist === true) {
+                    $("#node-config-input-endpointMustExist").prop("checked", true);
+                }
+                if (this.maxRetry === undefined || Number(this.maxRetry) === 10) {
+                    $("#node-config-input-maxRetry").val(-1);
+                }
+
                 $("#node-config-input-authType").on("change", toggleCredentials);
                 toggleCredentials();
+
+                $("#node-config-input-securityPolicy").on("change", function () {
+                    var policy = $(this).val();
+                    var modeSelect = $("#node-config-input-securityMode");
+                    var mode = modeSelect.val();
+                    if (policy === "None") {
+                        if (mode !== "None") {
+                            modeSelect.val("None");
+                        }
+                    } else {
+                        if (mode === "None") {
+                            modeSelect.val("SignAndEncrypt");
+                        }
+                    }
+                });
+
+                $("#node-config-input-securityMode").on("change", function () {
+                    var mode = $(this).val();
+                    var policySelect = $("#node-config-input-securityPolicy");
+                    var policy = policySelect.val();
+                    if (mode === "None") {
+                        if (policy !== "None") {
+                            policySelect.val("None");
+                        }
+                    } else {
+                        if (policy === "None") {
+                            policySelect.val("Basic256Sha256");
+                        }
+                    }
+                });
+
+                function toggleReconnect() {
+                    var autoReconnect = $("#node-config-input-autoReconnect").prop("checked");
+                    $(".opcua-client-reconnect-row").toggle(autoReconnect);
+                }
+                $("#node-config-input-autoReconnect").on("change", toggleReconnect);
+                toggleReconnect();
             }
         });
     })();
 </script>
 
 <script type="text/html" data-template-name="opcua-client-config">
+    <!-- Connection Section -->
+    <div class="form-row" style="margin-top: 10px; margin-bottom: 10px;">
+        <span style="font-weight: bold;"><i class="fa fa-plug"></i> Connection Settings</span>
+        <hr style="margin-top: 5px; margin-bottom: 10px; border: 0; border-top: 1px solid #ccc;"/>
+    </div>
     <div class="form-row">
         <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
         <input type="text" id="node-config-input-name" placeholder="OPC UA Client">
     </div>
+    <div class="form-row">
+        <label for="node-config-input-sessionName"><i class="fa fa-info-circle"></i> Session Name</label>
+        <input type="text" id="node-config-input-sessionName" placeholder="ClientSession1">
+    </div>
     <div class="form-row">
         <label for="node-config-input-endpoint"><i class="fa fa-plug"></i> Endpoint</label>
         <input type="text" id="node-config-input-endpoint" placeholder="opc.tcp://localhost:4840">
     </div>
+
+    <!-- Security Section -->
+    <div class="form-row" style="margin-top: 20px; margin-bottom: 10px;">
+        <span style="font-weight: bold;"><i class="fa fa-shield"></i> Security & Authentication</span>
+        <hr style="margin-top: 5px; margin-bottom: 10px; border: 0; border-top: 1px solid #ccc;"/>
+    </div>
     <div class="form-row">
         <label for="node-config-input-securityPolicy"><i class="fa fa-lock"></i> Security Policy</label>
         <select id="node-config-input-securityPolicy">
@@ -72,6 +149,46 @@
         <label for="node-config-input-password"><i class="fa fa-key"></i> Password</label>
         <input type="password" id="node-config-input-password">
     </div>
+
+    <!-- Client Settings Section -->
+    <div class="form-row" style="margin-top: 20px; margin-bottom: 10px;">
+        <span style="font-weight: bold;"><i class="fa fa-cog"></i> Client Settings</span>
+        <hr style="margin-top: 5px; margin-bottom: 10px; border: 0; border-top: 1px solid #ccc;"/>
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-requestedSessionTimeout"><i class="fa fa-clock-o"></i> Session Timeout (ms)</label>
+        <input type="number" id="node-config-input-requestedSessionTimeout" placeholder="300000">
+    </div>
+    <div class="form-row" style="display: flex; align-items: center;">
+        <label for="node-config-input-keepSessionAlive" style="width: auto; margin-right: 10px;"><i class="fa fa-heartbeat"></i> Keep Session Alive</label>
+        <input type="checkbox" id="node-config-input-keepSessionAlive" style="width: auto; margin: 0;">
+    </div>
+    <div class="form-row" style="display: flex; align-items: center; margin-bottom: 5px;">
+        <label for="node-config-input-endpointMustExist" style="width: auto; margin-right: 10px;"><i class="fa fa-exclamation-circle"></i> Endpoint Must Exist</label>
+        <input type="checkbox" id="node-config-input-endpointMustExist" style="width: auto; margin: 0;">
+    </div>
+    <div style="font-size: 0.85em; color: #666; margin-left: 20px; margin-top: -5px; margin-bottom: 10px;">
+        Verify that the server endpoint matches the requested security policy and mode before connecting.
+    </div>
+    <div class="form-row" style="display: flex; align-items: center;">
+        <label for="node-config-input-autoReconnect" style="width: auto; margin-right: 10px;"><i class="fa fa-refresh"></i> Automatic Reconnect</label>
+        <input type="checkbox" id="node-config-input-autoReconnect" style="width: auto; margin: 0;">
+    </div>
+    <div class="form-row opcua-client-reconnect-row">
+        <label for="node-config-input-initialDelay"><i class="fa fa-clock-o"></i> Initial Delay (ms)</label>
+        <input type="number" id="node-config-input-initialDelay" placeholder="1000">
+    </div>
+    <div class="form-row opcua-client-reconnect-row">
+        <label for="node-config-input-maxDelay"><i class="fa fa-clock-o"></i> Max Delay (ms)</label>
+        <input type="number" id="node-config-input-maxDelay" placeholder="10000">
+    </div>
+    <div class="form-row opcua-client-reconnect-row">
+        <label for="node-config-input-maxRetry"><i class="fa fa-repeat"></i> Max Retries</label>
+        <input type="number" id="node-config-input-maxRetry" placeholder="-1">
+        <div style="font-size: 0.85em; color: #666; margin-left: 110px; margin-top: 2px;">
+            -1: Retry indefinitely. 0: Do not attempt to reconnect.
+        </div>
+    </div>
 </script>
 
 <script type="text/html" data-help-name="opcua-client-config">

package/client/opcua-client-config.js

@@ -1,5 +1,8 @@
 "use strict";
 
+const path = require("path");
+const { OPCUACertificateManager, UserTokenType } = require("node-opcua");
+
 const {
     OPCUAClient,
     getMethodArgumentDefinition,
@@ -23,10 +26,18 @@ module.exports = function (RED) {
         
 
         node.name = (config.name || "").trim();
+        node.sessionName = (config.sessionName || "ClientSession1").trim();
         node.endpoint = (config.endpoint || "").trim();
         node.securityPolicy = config.securityPolicy || "None";
         node.securityMode = config.securityMode || "None";
         node.authType = config.authType || "anonymous";
+        node.initialDelay = config.initialDelay !== undefined ? Number(config.initialDelay) : 1000;
+        node.maxDelay = config.maxDelay !== undefined ? Number(config.maxDelay) : 10000;
+        node.maxRetry = (config.maxRetry !== undefined && Number(config.maxRetry) !== 10) ? Number(config.maxRetry) : -1;
+        node.requestedSessionTimeout = config.requestedSessionTimeout !== undefined ? Number(config.requestedSessionTimeout) : 300000;
+        node.keepSessionAlive = config.keepSessionAlive !== false;
+        node.autoReconnect = config.autoReconnect !== false;
+        node.endpointMustExist = config.endpointMustExist === true;
         node.client = null;
         node.session = null;
         node.connectPromise = null;
@@ -52,23 +63,72 @@ module.exports = function (RED) {
         }
 
         this.connectPromise = (async () => {
+            const userDir = (RED.settings && RED.settings.userDir) || path.join(require('os').homedir(), ".node-red");
+            let flowFile = (RED.settings && RED.settings.flowFile) || "flows.json";
+            if (typeof flowFile !== "string") {
+                flowFile = "flows.json";
+            }
+            const flowFileFolder = path.isAbsolute(flowFile) ? path.dirname(flowFile) : path.join(userDir, path.dirname(flowFile));
+            const clientName = (this.name || "").trim() || this.sessionName || "default";
+            const safeClientName = clientName
+                .replace(/[\\/:\*\?"<>|]/g, "_")
+                .replace(/^\.+$/, "");
+            const clientCertificateFolder = path.join(flowFileFolder, "simple_opcua", "client", safeClientName);
+
+            // Ensure directories exist immediately
+            const fs = require("fs");
+            try {
+                const trustedDir = path.join(clientCertificateFolder, "trusted", "certs");
+                const rejectedDir = path.join(clientCertificateFolder, "rejected");
+                if (!fs.existsSync(trustedDir)) {
+                    fs.mkdirSync(trustedDir, { recursive: true });
+                }
+                if (!fs.existsSync(rejectedDir)) {
+                    fs.mkdirSync(rejectedDir, { recursive: true });
+                }
+            } catch (e) {
+                // Ignore directory creation errors
+            }
+
+            const clientCertificateManager = new OPCUACertificateManager({
+                rootFolder: clientCertificateFolder,
+                automaticallyAcceptUnknownCertificate: true
+            });
+            await clientCertificateManager.initialize();
+
             const client = OPCUAClient.create({
-                endpointMustExist: false,
-                keepSessionAlive: true,
+                endpointMustExist: this.endpointMustExist,
+                keepSessionAlive: this.keepSessionAlive,
                 securityMode: resolveSecurityMode(this.securityMode),
-                securityPolicy: resolveSecurityPolicy(this.securityPolicy)
+                securityPolicy: resolveSecurityPolicy(this.securityPolicy),
+                clientName: this.sessionName || "ClientSession",
+                clientCertificateManager: clientCertificateManager,
+                requestedSessionTimeout: this.requestedSessionTimeout,
+                connectionStrategy: {
+                    maxRetry: this.autoReconnect ? this.maxRetry : 0,
+                    initialDelay: this.initialDelay,
+                    maxDelay: this.maxDelay
+                }
             });
 
+            client._nextSessionName = () => {
+                return this.sessionName || "ClientSession1";
+            };
+
             try {
                 await client.connect(this.endpoint);
 
                 const credentials = this.credentials || {};
-                const session = this.authType === "username"
-                    ? await client.createSession({
+                let userIdentity = { type: UserTokenType.Anonymous };
+
+                if (this.authType === "username") {
+                    userIdentity = {
+                        type: UserTokenType.UserName,
                         userName: credentials.username || "",
                         password: credentials.password || ""
-                    })
-                    : await client.createSession();
+                    };
+                }
+                const session = await client.createSession(userIdentity);
 
                 session.on("session_closed", () => {
                     this.session = null;
@@ -158,7 +218,13 @@ module.exports = function (RED) {
 
 async function browseForEditor(configNode, nodeId) {
     const session = await configNode.getSession();
-    return browseNode(session, {
+    const result = await browseNode(session, {
         nodeID: nodeId || ROOT_NODE_ID
     });
+    if (result && result.children) {
+        result.browse = result.children;
+        delete result.children;
+    }
+    return result;
 }
+

package/client/opcua-client-help.html

@@ -5,6 +5,7 @@
     <p><b>Read</b>: reads one or more variable values.</p>
     <p><b>Write</b>: writes one or more variable values.</p>
     <p><b>Browse</b>: browses one or more OPC UA nodes and returns their children.</p>
+    <p><b>Browse Recursive</b>: perform a recursive search across all nodes starting from the specified node.</p>
     <p><b>Method</b>: calls one or more OPC UA methods.</p>
     <p><b>Subscription</b>: subscribes to one or more variable values and emits one message per change.</p>
 
@@ -33,6 +34,11 @@
     <p>If <code>msg.payload</code> is not an array and <code>NodeId</code> is configured, the node browses that configured node.</p>
     <p>If <code>msg.payload = []</code>, the node browses the OPC UA <code>RootFolder</code>.</p>
 
+    <h3>Browse Recursive</h3>
+    <p>Perform a recursive search across all nodes starting from the specified <code>nodeId</code>. It will return the value (if it is a variable), display name, description, and all other item information.</p>
+    <p>If <code>msg.payload</code> is not an array and <code>NodeId</code> is configured, the node browses recursively starting from that configured node.</p>
+    <p>If <code>msg.payload = []</code>, the node browses recursively starting from the OPC UA <code>RootFolder</code>.</p>
+
     <h3>Method</h3>
     <p><code>nodeID</code> and <code>objectId</code> are accepted explicitly. For backward compatibility, <code>nodeID</code> is also accepted as the method id.</p>
     <p><b>Input</b> <code>msg.payload</code>:</p>

package/client/opcua-client-utils.js

@@ -469,7 +469,15 @@ async function getMethodArgumentDefinition(session, methodNodeId, cache) {
 }
 
 async function enrichItemResultWithEnumeration(result, session, cache, nodeId) {
-    if (result.type !== "Int32" && result.type !== "Enumeration") {
+    const type = result.type || result.dataType;
+    if (!type) {
+        return result;
+    }
+
+    const isStandardEnum = type === "Int32" || type === "Enumeration";
+    const isCustomNodeId = typeof type === "string" && (type.includes("i=") || type.includes("ns="));
+
+    if (!isStandardEnum && !isCustomNodeId) {
         return result;
     }
     
@@ -481,15 +489,29 @@ async function enrichItemResultWithEnumeration(result, session, cache, nodeId) {
         const cacheKeyType = "dt:" + nodeId;
         let dtNodeId = cache ? cache.get(cacheKeyType) : undefined;
         if (dtNodeId === undefined) {
-            const dv = await session.read({
-                nodeId: nodeId,
-                attributeId: AttributeIds.DataType
-            });
-            if (dv.statusCode.isGood()) {
-                dtNodeId = dv.value.value;
-                if (cache) cache.set(cacheKeyType, dtNodeId);
-            } else {
-                if (cache) cache.set(cacheKeyType, null);
+            const isNodeIdLike = result.dataType && (
+                typeof result.dataType !== "string" || 
+                result.dataType.includes("i=") || 
+                result.dataType.includes("ns=")
+            );
+            if (isNodeIdLike) {
+                try {
+                    dtNodeId = coerceNodeId(result.dataType);
+                } catch (e) {
+                    dtNodeId = undefined;
+                }
+            }
+            if (dtNodeId === undefined) {
+                const dv = await session.read({
+                    nodeId: nodeId,
+                    attributeId: AttributeIds.DataType
+                });
+                if (dv.statusCode.isGood()) {
+                    dtNodeId = dv.value.value;
+                    if (cache) cache.set(cacheKeyType, dtNodeId);
+                } else {
+                    if (cache) cache.set(cacheKeyType, null);
+                }
             }
         }
         
@@ -549,6 +571,8 @@ async function enrichItemResultWithEnumeration(result, session, cache, nodeId) {
         
         if (enumStrings && enumStrings[result.value] !== undefined) {
             result.valueEnumeration = enumStrings[result.value];
+            if (result.type) result.type = "Enumeration";
+            if (result.dataType) result.dataType = "Enumeration";
         }
     } catch (e) {
         console.error("Error in enrichItemResultWithEnumeration:", e);

package/client/opcua-client.html

@@ -17,6 +17,7 @@
             <option value="read">Read</option>
             <option value="write">Write</option>
             <option value="browse">Browse</option>
+            <option value="browseRecursive">Browse Recursive</option>
             <option value="method">Method</option>
               <option value="getSubscriptionId">getSubscriptionId</option>
             <option value="subscription">Subscription</option>
@@ -85,6 +86,7 @@
     <p><b>Read</b>: reads one or more variable values.</p>
     <p><b>Write</b>: writes one or more variable values.</p>
     <p><b>Browse</b>: browses one or more OPC UA nodes and returns their children.</p>
+    <p><b>Browse Recursive</b>: perform a recursive search across all nodes starting from the specified node.</p>
     <p><b>Method</b>: calls one or more OPC UA methods.</p>
     <p><b>Subscription</b>: subscribes to one or more variable values and emits one message per change.</p>
 
@@ -113,6 +115,11 @@
     <p>If <code>msg.payload</code> is not an array and <code>NodeId</code> is configured, the node browses that configured node.</p>
     <p>If <code>msg.payload = []</code>, the node browses the OPC UA <code>RootFolder</code>.</p>
 
+    <h3>Browse Recursive</h3>
+    <p>Perform a recursive search across all nodes starting from the specified <code>nodeId</code>. It will return the value (if it is a variable), display name, description, and all other item information.</p>
+    <p>If <code>msg.payload</code> is not an array and <code>NodeId</code> is configured, the node browses recursively starting from that configured node.</p>
+    <p>If <code>msg.payload = []</code>, the node browses recursively starting from the OPC UA <code>RootFolder</code>.</p>
+
     <h3>Method</h3>
     <p><code>nodeID</code> and <code>objectId</code> are accepted explicitly. For backward compatibility, <code>nodeID</code> is also accepted as the method id.</p>
     <p><b>Input</b> <code>msg.payload</code>:</p>

package/client/opcua-client.js

@@ -15,6 +15,7 @@ const {
 
 const {
     browseNode: browseNodeWithSession,
+    browseRecursiveNode,
     ROOT_NODE_ID
 } = require("./lib/opcua-client-browser");
 
@@ -92,6 +93,9 @@ module.exports = function (RED) {
                 } else if (node.mode === "browse") {
                     payload = await executeBrowse(node, msg, session);
                     node.status({ fill: "green", shape: "dot", text: "browsed " + payload.length + " nodes" });
+                } else if (node.mode === "browseRecursive") {
+                    payload = await executeBrowseRecursive(node, msg, session);
+                    node.status({ fill: "green", shape: "dot", text: "browsed recursive " + payload.length + " nodes" });
                 } else if (node.mode === "method") {
                     //payload = await executeMethod(node, msg, session);
 
@@ -109,7 +113,88 @@ module.exports = function (RED) {
                 done();
             } catch (error) {
                 node.status({ fill: "red", shape: "ring", text: node.mode + " failed" });
-                done(error);
+                
+                let errorPayload;
+                try {
+                    if (node.mode === "read") {
+                        const items = itemsResolver.ensureClientItems(node, msg, "OPC UA read");
+                        errorPayload = items.map(item => ({
+                            name: resolveName(item, resolveNodeId(item)),
+                            nodeID: resolveNodeId(item),
+                            value: null,
+                            type: null,
+                            status: error.message || String(error),
+                            sourceTimestamp: null,
+                            serverTimestamp: null
+                        }));
+                    } else if (node.mode === "write") {
+                        const items = itemsResolver.ensureWriteItems(node, msg);
+                        errorPayload = items.map(item => ({
+                            name: item.name,
+                            nodeID: item.nodeID,
+                            value: item.value,
+                            type: item.type,
+                            status: error.message || String(error)
+                        }));
+                    } else if (node.mode === "browse" || node.mode === "browseRecursive") {
+                        const roots = normalizeBrowseRoots(node, msg ? msg.payload : undefined);
+                        errorPayload = roots.map(root => ({
+                            name: root.name,
+                            nodeID: root.nodeID,
+                            status: error.message || String(error),
+                            results: [],
+                            children: []
+                        }));
+                    } else if (node.mode === "method") {
+                        const items = itemsResolver.ensureMethodItems(node, msg);
+                        errorPayload = items.map(item => ({
+                            name: item.name,
+                            nodeID: item.nodeID,
+                            status: error.message || String(error),
+                            value: null
+                        }));
+                    } else if (node.mode === "subscription" || node.mode === "events") {
+                        const items = itemsResolver.ensureClientItems(node, msg, "OPC UA subscription");
+                        errorPayload = items.map(item => ({
+                            name: resolveName(item, resolveNodeId(item)),
+                            nodeID: resolveNodeId(item),
+                            value: null,
+                            type: null,
+                            status: error.message || String(error),
+                            sourceTimestamp: null,
+                            serverTimestamp: null
+                        }));
+                    } else {
+                        errorPayload = {
+                            status: "error",
+                            error: error.message || String(error)
+                        };
+                    }
+                } catch (payloadError) {
+                    errorPayload = {
+                        status: "error",
+                        error: error.message || String(error)
+                    };
+                }
+
+                const safeClone = {};
+                for (const key in msg) {
+                    if (msg.hasOwnProperty(key) && key !== "req" && key !== "res" && key !== "payload") {
+                        safeClone[key] = msg[key];
+                    }
+                }
+                safeClone.payload = msg.payload;
+
+                if (errorPayload && (Array.isArray(errorPayload) || typeof errorPayload === "object")) {
+                    errorPayload.msg = safeClone;
+                }
+
+                msg.payload = errorPayload;
+
+                node.error(error.message || String(error), msg);
+                if (done) {
+                    done();
+                }
             }
         });
 
@@ -134,6 +219,17 @@ module.exports = function (RED) {
         return payload;
     }
 
+    async function executeBrowseRecursive(node, msg, session) {
+        const roots = normalizeBrowseRoots(node, msg ? msg.payload : undefined);
+        const payload = [];
+
+        for (const root of roots) {
+            payload.push(await browseRecursiveNode(session, root));
+        }
+
+        return payload;
+    }
+