ads-client 1.13.2 → 1.14.1

package/CHANGELOG.md

@@ -4,6 +4,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.14.1] - 13.09.2022
+### Changed
+- Bug fix: Connecting to local router failed with ECONNREFUSED error on Node.js version 17 and newer
+  - See [https://github.com/nodejs/node/issues/40702](https://github.com/nodejs/node/issues/40702)
+  - Fixed by using `127.0.0.1` instead of `localhost`
+
+
+## [1.14.0] - 23.07.2022
+### Added
+- Created end-to-end testing for the library using Jest
+  - Separate PLC project required for testing: https://github.com/jisotalo/ads-client-test-plc-project
+  - Test is started using command `npm test`
+  - First version tests
+    - Connecting
+    - Reading
+    - Writing
+    - RPC methods
+
+### Changed
+- Bug fix: Value converted to Javascript variable incorrectly in some edge cases [See issue #94](https://github.com/jisotalo/ads-client/issues/94)
+
 ## [1.13.2] - 17.05.2022
 ### Changed
 - Bug fix: Incorrect parsing of ARRAY OF ARRAY, now works as should [See issue #91](https://github.com/jisotalo/ads-client/issues/91)

package/README.md

@@ -89,6 +89,7 @@ Check out the [node-red-contrib-ads-client](https://www.npmjs.com/package/node-r
   * [Enabling debug from code](#enabling-debug-from-code)
   * [Enabling debugging from terminal](#enabling-debugging-from-terminal)
 - [FAQ](#faq)
+- [Automatic testing](#automatic-testing)
 - [Documentation](#documentation)
 - [License](#license)
 
@@ -1712,8 +1713,6 @@ Solution:
 Solution:
 - See [this issue comment](https://github.com/jisotalo/ads-client/issues/51#issuecomment-758016428) by hansipete how to do it.
 
-
-
 ### A data type is not found even when it should be
 
 If you use methods like `convertFromRaw()` and `getDataType()` but receive an error similar to `ClientException: Finding data type *data type* failed`, make sure you have really written the data type correctly.
@@ -1755,7 +1754,22 @@ Another option is to use setting `bareClient: true` (since v.1.13.0). However, w
 
 I would suggest to use ads-client normally without any special settings. If the target is at config mode, use separate client instance to start it, and the again the normal instance to connect to a running system. This way the client works the best.
 
+### Getting a message `Ads notification received but it has unknown notificationHandle (**). Use unsubscribe() to save resources.`
+
+Possible reasons:
+* You have created notifications (subscriptions) using `subscribe()` and then closed the Node.js application without unsubscribing them first (TwinCAT still sends the data)
+* You are connecting without router (providing directly the target IP as router address) and you have other connections too like TwinCAT XAE running. See issue: https://github.com/jisotalo/ads-client/issues/85
+
+Solution:
+* When closing application, first unsubscribe from all notifications using `unsubscribeAll()`
+* Use router instead of direct connection, see https://github.com/jisotalo/ads-client/issues/85#issuecomment-1193098519
+
+# Automatic testing
+Since version 1.14.0 the library has automatic testing using Jest. Idea is to run the tests before updates to make sure everything works OK (this should have been done much earlier...)
+
+Separate PLC project is required for testing, see https://github.com/jisotalo/ads-client-test-plc-project for more project and more info.
 
+Tests are run with command `npm test` (not in npm version, please clone this repository).
 
 # Documentation
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "ads-client",
-  "version": "1.13.2",
+  "version": "1.14.1",
   "description": "Beckhoff TwinCAT ADS client library for Node.js (unofficial). Connects to Beckhoff TwinCAT automation systems using ADS protocol.",
   "main": "./src/ads-client.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "jest --runInBand",
     "generate-docs": "jsdoc ./src/ads-client.js ./README.md -c ./jsdoc-conf.json -d ./docs/ -t ./node_modules/docdash/"
   },
   "keywords": [
@@ -39,6 +39,7 @@
   },
   "devDependencies": {
     "docdash": "^1.2.0",
+    "jest": "^28.1.3",
     "jsdoc": "^3.6.7"
   },
   "files": [

package/src/ads-client.js

@@ -61,7 +61,7 @@ class Client extends EventEmitter {
    * @property {boolean} [readAndCacheDataTypes=false] - If true, all PLC data types are cached during connecting. Otherwise they are read and cached only when needed - Optional (**default**: false)
    * @property {boolean} [disableSymbolVersionMonitoring=false] - If true, PLC symbol version changes aren't monitored and cached symbols and datatypes won't be updated after PLC program download - Optional - Optional (**default**: false)
    * @property {number} [routerTcpPort=48898] - Target ADS router TCP port - Optional (**default**: 48898)
-   * @property {string} [routerAddress=localhost] - Target ADS router IP address/hostname - Optional (**default**: localhost)
+   * @property {string} [routerAddress=127.0.0.1] - Target ADS router IP address/hostname - Optional (**default**: 127.0.0.1)
    * @property {string} [localAddress='(system default)'] - Local IP address to use, use this to change used network interface if required - Optional (**default**: System default)
    * @property {number} [localTcpPort='(system default)'] - Local TCP port to use for outgoing connections - Optional (**default**: System default)
    * @property {string} [localAmsNetId='(from AMS router)'] - Local AmsNetId to use - Optional (**default**: From AMS router)
@@ -91,7 +91,7 @@ class Client extends EventEmitter {
       readAndCacheDataTypes: false,
       disableSymbolVersionMonitoring: false,
       routerTcpPort: 48898,
-      routerAddress: 'localhost',
+      routerAddress: '127.0.0.1',
       localAddress: null,
       localTcpPort: null,
       localAmsNetId: null,
@@ -145,6 +145,12 @@ class Client extends EventEmitter {
       this.settings.targetAmsNetId = '127.0.0.1.1.1'
     }
 
+    //Checking that router address is 127.0.0.1 instead of localhost
+    //to prevent problem like https://github.com/nodejs/node/issues/40702
+    if (this.settings.routerAddress.toLowerCase() === 'localhost') {
+      this.settings.routerAddress = '127.0.0.1'
+    }
+
     /**
      * Internal variables - Not intended for external use
      * 
@@ -5230,8 +5236,8 @@ function _parseJsObjectToBuffer(value, dataType, objectPathStr = '', isArraySubI
 
   //Struct or array subitem - Go through each subitem 
   if ((dataType.arrayData.length === 0 || isArraySubItem) && dataType.subItems.length > 0) {
-    buffer = Buffer.alloc(dataType.offset + dataType.size)
-
+    buffer = Buffer.alloc(dataType.size)
+    
     for (const subItem of dataType.subItems) {
       //Try the find the subitem from javascript object
       let key = null