node-opcua-transport 2.55.0 → 2.59.0

package/source/client_tcp_transport.ts

@@ -1,366 +1,366 @@
-/**
- * @module node-opcua-transport
- */
-// tslint:disable:class-name
-// system
-import * as os from "os";
-import * as chalk from "chalk";
-
-import { createConnection, Socket } from "net";
-import { assert } from "node-opcua-assert";
-import { BinaryStream } from "node-opcua-binary-stream";
-import { readMessageHeader } from "node-opcua-chunkmanager";
-import { ErrorCallback } from "node-opcua-status-code";
-
-import { getFakeTransport, TCP_transport } from "./tcp_transport";
-import { decodeMessage, packTcpMessage, parseEndpointUrl } from "./tools";
-
-import * as debug from "node-opcua-debug";
-import { AcknowledgeMessage } from "./AcknowledgeMessage";
-import { HelloMessage } from "./HelloMessage";
-import { TCPErrorMessage } from "./TCPErrorMessage";
-import { doTraceHelloAck } from "./utils";
-
-const doDebug = debug.checkDebugFlag(__filename);
-const debugLog = debug.make_debugLog(__filename);
-const errorLog = debug.make_errorLog(__filename);
-const gHostname = os.hostname();
-
-function createClientSocket(endpointUrl: string): Socket {
-    // create a socket based on Url
-    const ep = parseEndpointUrl(endpointUrl);
-    const port = parseInt(ep.port!, 10);
-    const hostname = ep.hostname!;
-    let socket: Socket;
-    switch (ep.protocol) {
-        case "opc.tcp:":
-            socket = createConnection({ host: hostname, port });
-
-            //        // Setting true for noDelay will immediately fire off data each time socket.write() is called.
-            socket.setNoDelay(true);
-
-            return socket;
-        case "fake:":
-            socket = getFakeTransport();
-            assert(ep.protocol === "fake:", " Unsupported transport protocol");
-            process.nextTick(() => socket.emit("connect"));
-            return socket;
-
-        case "websocket:":
-        case "http:":
-        case "https:FF":
-        default: {
-            const msg = "[NODE-OPCUA-E05] this transport protocol is not supported :" + ep.protocol;
-            errorLog(msg);
-            throw new Error(msg);
-        }
-    }
-}
-export interface ClientTCP_transport {
-    on(eventName: "message", eventHandler: (message: Buffer) => void): this;
-    once(eventName: "message", eventHandler: (message: Buffer) => void): this;
-    on(eventName: "socket_closed", eventHandler: (err: Error | null) => void): this;
-    once(eventName: "socket_closed", eventHandler: (err: Error | null) => void): this;
-    on(eventName: "close", eventHandler: (err: Error | null) => void): this;
-    once(eventName: "close", eventHandler: (err: Error | null) => void): this;
-//
-    on(eventName: "connection_break", eventHandler: () => void): this;
-    once(eventName: "connection_break", eventHandler: () => void): this;
-}
-
-/**
- * a ClientTCP_transport connects to a remote server socket and
- * initiates a communication with a HEL/ACK transaction.
- * It negotiates the communication parameters with the other end.
- *
- * @class ClientTCP_transport
- * @extends TCP_transport
- * @constructor
- * @example
- *
- *    ```javascript
- *    const transport = ClientTCP_transport(url);
- *
- *    transport.timeout = 10000;
- *
- *    transport.connect(function(err)) {
- *         if (err) {
- *            // cannot connect
- *         } else {
- *            // connected
- *
- *         }
- *    });
- *    ....
- *
- *    transport.write(message_chunk,'F');
- *
- *    ....
- *
- *    transport.on("message",function(message_chunk) {
- *        // do something with message from server...
- *    });
- *
- *
- *    ```
- *
- *
- */
-export class ClientTCP_transport extends TCP_transport {
-    public endpointUrl: string;
-    public serverUri: string;
-    public numberOfRetry: number;
-    public parameters?: AcknowledgeMessage;
-
-    private connected: boolean;
-    private _counter: number;
-
-    constructor() {
-        super();
-        this.connected = false;
-        this.endpointUrl = "";
-        this.serverUri = "";
-        this._counter = 0;
-        this.numberOfRetry = 0;
-    }
-
-    public dispose() {
-        /* istanbul ignore next */
-        if (doDebug) {
-            debugLog(" ClientTCP_transport disposed");
-        }
-        super.dispose();
-    }
-
-    public connect(endpointUrl: string, callback: ErrorCallback) {
-        assert(arguments.length === 2);
-        assert(typeof callback === "function");
-
-        const ep = parseEndpointUrl(endpointUrl);
-
-        this.endpointUrl = endpointUrl;
-
-        this.serverUri = "urn:" + gHostname + ":Sample";
-        /* istanbul ignore next */
-        if (doDebug) {
-            debugLog(chalk.cyan("ClientTCP_transport#connect(endpointUrl = " + endpointUrl + ")"));
-        }
-        try {
-            this._socket = createClientSocket(endpointUrl);
-        } catch (err) {
-            /* istanbul ignore next */
-            if (doDebug) {
-                debugLog("CreateClientSocket has failed");
-            }
-            return callback(err as Error);
-        }
-
-        const _on_socket_error_after_connection = (err: Error) => {
-            /* istanbul ignore next */
-            if (doDebug) {
-                debugLog(" _on_socket_error_after_connection ClientTCP_transport Socket Error", err.message);
-            }
-            // EPIPE : EPIPE (Broken pipe): A write on a pipe, socket, or FIFO for which there is no process to read the
-            // data. Commonly encountered at the net and http layers, indicative that the remote side of the stream
-            // being written to has been closed.
-
-            // ECONNRESET (Connection reset by peer): A connection was forcibly closed by a peer. This normally results
-            // from a loss of the connection on the remote socket due to a timeout or reboot. Commonly encountered
-            // via the http and net module
-            if (err.message.match(/ECONNRESET|EPIPE/)) {
-                /**
-                 * @event connection_break
-                 *
-                 */
-                this.emit("connection_break");
-            }
-        };
-
-        const _on_socket_connect = () => {
-            /* istanbul ignore next */
-            if (doDebug) {
-                debugLog("entering _on_socket_connect");
-            }
-            _remove_connect_listeners();
-            this._perform_HEL_ACK_transaction((err?: Error) => {
-                if (!err) {
-                    /* istanbul ignore next */
-                    if (!this._socket) {
-                        throw new Error("internal error");
-                    }
-                    // install error handler to detect connection break
-                    this._socket.on("error", _on_socket_error_after_connection);
-
-                    this.connected = true;
-                    /**
-                     * notify the observers that the transport is connected (the socket is connected and the the HEL/ACK
-                     * transaction has been done)
-                     * @event connect
-                     *
-                     */
-                    this.emit("connect");
-                } else {
-                    debugLog("_perform_HEL_ACK_transaction has failed with err=", err.message);
-                }
-                callback(err);
-            });
-        };
-
-        const _on_socket_error_for_connect = (err: Error) => {
-            // this handler will catch attempt to connect to an inaccessible address.
-            /* istanbul ignore next */
-            if (doDebug) {
-                debugLog(chalk.cyan("ClientTCP_transport#connect - _on_socket_error_for_connect"), err.message);
-            }
-            assert(err instanceof Error);
-            _remove_connect_listeners();
-            callback(err);
-        };
-
-        const _on_socket_end_for_connect = (err: Error | null) => {
-            /* istanbul ignore next */
-            if (doDebug) {
-                debugLog(
-                    chalk.cyan("ClientTCP_transport#connect -> _on_socket_end_for_connect Socket has been closed by server"),
-                    err
-                );
-            }
-        };
-
-        const _remove_connect_listeners = () => {
-            /* istanbul ignore next */
-            if (!this._socket) {
-                return;
-            }
-            this._socket.removeListener("error", _on_socket_error_for_connect);
-            this._socket.removeListener("end", _on_socket_end_for_connect);
-        };
-
-        this._socket.once("error", _on_socket_error_for_connect);
-        this._socket.once("end", _on_socket_end_for_connect);
-        this._socket.once("connect", _on_socket_connect);
-        this._install_socket(this._socket);
-    }
-
-    protected on_socket_ended(err: Error | null) {
-        debugLog("on_socket_ended", this.name, err ? err.message : "");
-        if (this.connected) {
-            super.on_socket_ended(err);
-        }
-        //  if (this._socket) {
-        //      this._socket.removeAllListeners();
-        // }
-    }
-
-    private _handle_ACK_response(messageChunk: Buffer, callback: ErrorCallback) {
-        const _stream = new BinaryStream(messageChunk);
-        const messageHeader = readMessageHeader(_stream);
-        let err;
-        /* istanbul ignore next */
-        if (messageHeader.isFinal !== "F") {
-            err = new Error(" invalid ACK message");
-            return callback(err);
-        }
-
-        let responseClass;
-        let response;
-
-        if (messageHeader.msgType === "ERR") {
-            responseClass = TCPErrorMessage;
-            _stream.rewind();
-            response = decodeMessage(_stream, responseClass) as TCPErrorMessage;
-
-            err = new Error("ACK: ERR received " + response.statusCode.toString() + " : " + response.reason);
-            (err as any).statusCode = response.statusCode;
-            // istanbul ignore next
-            if (doTraceHelloAck) {
-                console.log("receiving ERR instead of Ack", response.toString());
-            }
-            callback(err);
-        } else {
-            responseClass = AcknowledgeMessage;
-            _stream.rewind();
-            response = decodeMessage(_stream, responseClass);
-            this.parameters = response as AcknowledgeMessage;
-
-            // istanbul ignore next
-            if (doTraceHelloAck) {
-                console.log("receiving Ack\n", response.toString());
-            }
-    
-            callback();
-        }
-    }
-
-    private _send_HELLO_request() {
-        /* istanbul ignore next */
-        if (doDebug) {
-            debugLog("entering _send_HELLO_request");
-        }
-        assert(this._socket);
-        assert(isFinite(this.protocolVersion));
-        assert(this.endpointUrl.length > 0, " expecting a valid endpoint url");
-
-        // Write a message to the socket as soon as the client is connected,
-        // the server will receive it as message from the client
-        const helloMessage = new HelloMessage({
-            endpointUrl: this.endpointUrl,
-            maxChunkCount: 0, // 0 - no limits
-            maxMessageSize: 0, // 0 - no limits
-
-            protocolVersion: this.protocolVersion,
-            receiveBufferSize: 1024 * 64 * 10,
-            sendBufferSize: 1024 * 64 * 10 // 8192 min,
-        });
-        // istanbul ignore next
-        if (doTraceHelloAck) {
-            console.log(`sending Hello\n ${helloMessage.toString()}`);
-        }
-
-        const messageChunk = packTcpMessage("HEL", helloMessage);
-        this._write_chunk(messageChunk);
-    }
-
-    private _on_ACK_response(externalCallback: ErrorCallback, err: Error | null, data?: Buffer) {
-        /* istanbul ignore next */
-        if (doDebug) {
-            debugLog("entering _on_ACK_response");
-        }
-
-        assert(typeof externalCallback === "function");
-        assert(this._counter === 0, "Ack response should only be received once !");
-        this._counter += 1;
-
-        if (err || !data) {
-            externalCallback(err || new Error("no data"));
-            if (this._socket) {
-                this._socket.end();
-                // Xx this._socket.removeAllListeners();
-            }
-        } else {
-            this._handle_ACK_response(data, externalCallback);
-        }
-    }
-
-    private _perform_HEL_ACK_transaction(callback: ErrorCallback) {
-        /* istanbul ignore next */
-        if (!this._socket) {
-            return callback(new Error("No socket available to perform HEL/ACK transaction"));
-        }
-        assert(this._socket, "expecting a valid socket to send a message");
-        assert(typeof callback === "function");
-        this._counter = 0;
-        /* istanbul ignore next */
-        if (doDebug) {
-            debugLog("entering _perform_HEL_ACK_transaction");
-        }
-        this._install_one_time_message_receiver((err: Error | null, data?: Buffer) => {
-            /* istanbul ignore next */
-            if (doDebug) {
-                debugLog("before  _on_ACK_response ", err ? err.message : "");
-            }
-            this._on_ACK_response(callback, err, data);
-        });
-        this._send_HELLO_request();
-    }
-}
+/**
+ * @module node-opcua-transport
+ */
+// tslint:disable:class-name
+// system
+import * as os from "os";
+import { createConnection, Socket } from "net";
+import * as chalk from "chalk";
+
+import { assert } from "node-opcua-assert";
+import { BinaryStream } from "node-opcua-binary-stream";
+import { readMessageHeader } from "node-opcua-chunkmanager";
+import { ErrorCallback } from "node-opcua-status-code";
+
+import * as debug from "node-opcua-debug";
+import { getFakeTransport, TCP_transport } from "./tcp_transport";
+import { decodeMessage, packTcpMessage, parseEndpointUrl } from "./tools";
+
+import { AcknowledgeMessage } from "./AcknowledgeMessage";
+import { HelloMessage } from "./HelloMessage";
+import { TCPErrorMessage } from "./TCPErrorMessage";
+import { doTraceHelloAck } from "./utils";
+
+const doDebug = debug.checkDebugFlag(__filename);
+const debugLog = debug.make_debugLog(__filename);
+const errorLog = debug.make_errorLog(__filename);
+const gHostname = os.hostname();
+
+function createClientSocket(endpointUrl: string): Socket {
+    // create a socket based on Url
+    const ep = parseEndpointUrl(endpointUrl);
+    const port = parseInt(ep.port!, 10);
+    const hostname = ep.hostname!;
+    let socket: Socket;
+    switch (ep.protocol) {
+        case "opc.tcp:":
+            socket = createConnection({ host: hostname, port });
+
+            //        // Setting true for noDelay will immediately fire off data each time socket.write() is called.
+            socket.setNoDelay(true);
+
+            return socket;
+        case "fake:":
+            socket = getFakeTransport();
+            assert(ep.protocol === "fake:", " Unsupported transport protocol");
+            process.nextTick(() => socket.emit("connect"));
+            return socket;
+
+        case "websocket:":
+        case "http:":
+        case "https:FF":
+        default: {
+            const msg = "[NODE-OPCUA-E05] this transport protocol is not supported :" + ep.protocol;
+            errorLog(msg);
+            throw new Error(msg);
+        }
+    }
+}
+export interface ClientTCP_transport {
+    on(eventName: "message", eventHandler: (message: Buffer) => void): this;
+    on(eventName: "socket_closed", eventHandler: (err: Error | null) => void): this;
+    on(eventName: "close", eventHandler: (err: Error | null) => void): this;
+    on(eventName: "connection_break", eventHandler: () => void): this;
+
+    once(eventName: "message", eventHandler: (message: Buffer) => void): this;
+    once(eventName: "socket_closed", eventHandler: (err: Error | null) => void): this;
+    once(eventName: "close", eventHandler: (err: Error | null) => void): this;
+    once(eventName: "connection_break", eventHandler: () => void): this;
+}
+
+/**
+ * a ClientTCP_transport connects to a remote server socket and
+ * initiates a communication with a HEL/ACK transaction.
+ * It negotiates the communication parameters with the other end.
+ *
+ * @class ClientTCP_transport
+ * @extends TCP_transport
+ * @constructor
+ * @example
+ *
+ *    ```javascript
+ *    const transport = ClientTCP_transport(url);
+ *
+ *    transport.timeout = 10000;
+ *
+ *    transport.connect(function(err)) {
+ *         if (err) {
+ *            // cannot connect
+ *         } else {
+ *            // connected
+ *
+ *         }
+ *    });
+ *    ....
+ *
+ *    transport.write(message_chunk,'F');
+ *
+ *    ....
+ *
+ *    transport.on("message",function(message_chunk) {
+ *        // do something with message from server...
+ *    });
+ *
+ *
+ *    ```
+ *
+ *
+ */
+export class ClientTCP_transport extends TCP_transport {
+    public endpointUrl: string;
+    public serverUri: string;
+    public numberOfRetry: number;
+    public parameters?: AcknowledgeMessage;
+
+    private connected: boolean;
+    private _counter: number;
+
+    constructor() {
+        super();
+        this.connected = false;
+        this.endpointUrl = "";
+        this.serverUri = "";
+        this._counter = 0;
+        this.numberOfRetry = 0;
+    }
+
+    public dispose(): void {
+        /* istanbul ignore next */
+        if (doDebug) {
+            debugLog(" ClientTCP_transport disposed");
+        }
+        super.dispose();
+    }
+
+    public connect(endpointUrl: string, callback: ErrorCallback): void {
+        assert(arguments.length === 2);
+        assert(typeof callback === "function");
+
+        const ep = parseEndpointUrl(endpointUrl);
+
+        this.endpointUrl = endpointUrl;
+
+        this.serverUri = "urn:" + gHostname + ":Sample";
+        /* istanbul ignore next */
+        if (doDebug) {
+            debugLog(chalk.cyan("ClientTCP_transport#connect(endpointUrl = " + endpointUrl + ")"));
+        }
+        try {
+            this._socket = createClientSocket(endpointUrl);
+        } catch (err) {
+            /* istanbul ignore next */
+            if (doDebug) {
+                debugLog("CreateClientSocket has failed");
+            }
+            return callback(err as Error);
+        }
+
+        const _on_socket_error_after_connection = (err: Error) => {
+            /* istanbul ignore next */
+            if (doDebug) {
+                debugLog(" _on_socket_error_after_connection ClientTCP_transport Socket Error", err.message);
+            }
+            // EPIPE : EPIPE (Broken pipe): A write on a pipe, socket, or FIFO for which there is no process to read the
+            // data. Commonly encountered at the net and http layers, indicative that the remote side of the stream
+            // being written to has been closed.
+
+            // ECONNRESET (Connection reset by peer): A connection was forcibly closed by a peer. This normally results
+            // from a loss of the connection on the remote socket due to a timeout or reboot. Commonly encountered
+            // via the http and net module
+            if (err.message.match(/ECONNRESET|EPIPE/)) {
+                /**
+                 * @event connection_break
+                 *
+                 */
+                this.emit("connection_break");
+            }
+        };
+
+        const _on_socket_connect = () => {
+            /* istanbul ignore next */
+            if (doDebug) {
+                debugLog("entering _on_socket_connect");
+            }
+            _remove_connect_listeners();
+            this._perform_HEL_ACK_transaction((err?: Error) => {
+                if (!err) {
+                    /* istanbul ignore next */
+                    if (!this._socket) {
+                        throw new Error("internal error");
+                    }
+                    // install error handler to detect connection break
+                    this._socket.on("error", _on_socket_error_after_connection);
+
+                    this.connected = true;
+                    /**
+                     * notify the observers that the transport is connected (the socket is connected and the the HEL/ACK
+                     * transaction has been done)
+                     * @event connect
+                     *
+                     */
+                    this.emit("connect");
+                } else {
+                    debugLog("_perform_HEL_ACK_transaction has failed with err=", err.message);
+                }
+                callback(err);
+            });
+        };
+
+        const _on_socket_error_for_connect = (err: Error) => {
+            // this handler will catch attempt to connect to an inaccessible address.
+            /* istanbul ignore next */
+            if (doDebug) {
+                debugLog(chalk.cyan("ClientTCP_transport#connect - _on_socket_error_for_connect"), err.message);
+            }
+            assert(err instanceof Error);
+            _remove_connect_listeners();
+            callback(err);
+        };
+
+        const _on_socket_end_for_connect = (err: Error | null) => {
+            /* istanbul ignore next */
+            if (doDebug) {
+                debugLog(
+                    chalk.cyan("ClientTCP_transport#connect -> _on_socket_end_for_connect Socket has been closed by server"),
+                    err
+                );
+            }
+        };
+
+        const _remove_connect_listeners = () => {
+            /* istanbul ignore next */
+            if (!this._socket) {
+                return;
+            }
+            this._socket.removeListener("error", _on_socket_error_for_connect);
+            this._socket.removeListener("end", _on_socket_end_for_connect);
+        };
+
+        this._socket.once("error", _on_socket_error_for_connect);
+        this._socket.once("end", _on_socket_end_for_connect);
+        this._socket.once("connect", _on_socket_connect);
+        this._install_socket(this._socket);
+    }
+
+    protected on_socket_ended(err: Error | null): void {
+        debugLog("on_socket_ended", this.name, err ? err.message : "");
+        if (this.connected) {
+            super.on_socket_ended(err);
+        }
+        //  if (this._socket) {
+        //      this._socket.removeAllListeners();
+        // }
+    }
+
+    private _handle_ACK_response(messageChunk: Buffer, callback: ErrorCallback) {
+        const _stream = new BinaryStream(messageChunk);
+        const messageHeader = readMessageHeader(_stream);
+        let err;
+        /* istanbul ignore next */
+        if (messageHeader.isFinal !== "F") {
+            err = new Error(" invalid ACK message");
+            return callback(err);
+        }
+
+        let responseClass;
+        let response;
+
+        if (messageHeader.msgType === "ERR") {
+            responseClass = TCPErrorMessage;
+            _stream.rewind();
+            response = decodeMessage(_stream, responseClass) as TCPErrorMessage;
+
+            err = new Error("ACK: ERR received " + response.statusCode.toString() + " : " + response.reason);
+            (err as any).statusCode = response.statusCode;
+            // istanbul ignore next
+            if (doTraceHelloAck) {
+                console.log("receiving ERR instead of Ack", response.toString());
+            }
+            callback(err);
+        } else {
+            responseClass = AcknowledgeMessage;
+            _stream.rewind();
+            response = decodeMessage(_stream, responseClass);
+            this.parameters = response as AcknowledgeMessage;
+
+            // istanbul ignore next
+            if (doTraceHelloAck) {
+                console.log("receiving Ack\n", response.toString());
+            }
+
+            callback();
+        }
+    }
+
+    private _send_HELLO_request() {
+        /* istanbul ignore next */
+        if (doDebug) {
+            debugLog("entering _send_HELLO_request");
+        }
+        assert(this._socket);
+        assert(isFinite(this.protocolVersion));
+        assert(this.endpointUrl.length > 0, " expecting a valid endpoint url");
+
+        // Write a message to the socket as soon as the client is connected,
+        // the server will receive it as message from the client
+        const helloMessage = new HelloMessage({
+            endpointUrl: this.endpointUrl,
+            maxChunkCount: 0, // 0 - no limits
+            maxMessageSize: 0, // 0 - no limits
+
+            protocolVersion: this.protocolVersion,
+            receiveBufferSize: 1024 * 64 * 10,
+            sendBufferSize: 1024 * 64 * 10 // 8192 min,
+        });
+        // istanbul ignore next
+        if (doTraceHelloAck) {
+            console.log(`sending Hello\n ${helloMessage.toString()}`);
+        }
+
+        const messageChunk = packTcpMessage("HEL", helloMessage);
+        this._write_chunk(messageChunk);
+    }
+
+    private _on_ACK_response(externalCallback: ErrorCallback, err: Error | null, data?: Buffer) {
+        /* istanbul ignore next */
+        if (doDebug) {
+            debugLog("entering _on_ACK_response");
+        }
+
+        assert(typeof externalCallback === "function");
+        assert(this._counter === 0, "Ack response should only be received once !");
+        this._counter += 1;
+
+        if (err || !data) {
+            externalCallback(err || new Error("no data"));
+            if (this._socket) {
+                this._socket.end();
+                // Xx this._socket.removeAllListeners();
+            }
+        } else {
+            this._handle_ACK_response(data, externalCallback);
+        }
+    }
+
+    private _perform_HEL_ACK_transaction(callback: ErrorCallback) {
+        /* istanbul ignore next */
+        if (!this._socket) {
+            return callback(new Error("No socket available to perform HEL/ACK transaction"));
+        }
+        assert(this._socket, "expecting a valid socket to send a message");
+        assert(typeof callback === "function");
+        this._counter = 0;
+        /* istanbul ignore next */
+        if (doDebug) {
+            debugLog("entering _perform_HEL_ACK_transaction");
+        }
+        this._install_one_time_message_receiver((err: Error | null, data?: Buffer) => {
+            /* istanbul ignore next */
+            if (doDebug) {
+                debugLog("before  _on_ACK_response ", err ? err.message : "");
+            }
+            this._on_ACK_response(callback, err, data);
+        });
+        this._send_HELLO_request();
+    }
+}