rclnodejs 0.21.3 → 0.22.0

package/lib/subscription.js

@@ -19,8 +19,13 @@ const Entity = require('./entity.js');
 const debug = require('debug')('rclnodejs:subscription');
 
 /**
- * @class - Class representing a Subscription in ROS
+ * @class - Class representing a ROS 2 Subscription
  * @hideconstructor
+ * Includes support for content-filtering topics beginning with the
+ * ROS Humble release. To learn more about content-filtering
+ * @see {@link Node#options}
+ * @see {@link Node#createSubscription}
+ * @see {@link https://www.omg.org/spec/DDS/1.4/PDF|DDS 1.4 specification, Annex B}
  */
 
 class Subscription extends Entity {
@@ -42,13 +47,21 @@ class Subscription extends Entity {
 
   static createSubscription(nodeHandle, typeClass, topic, options, callback) {
     let type = typeClass.type();
+
+    // convert contentFilter.parameters to a string[]
+    if (options.contentFilter && options.contentFilter.parameters) {
+      options.contentFilter.parameters = options.contentFilter.parameters.map(
+        (param) => param.toString()
+      );
+    }
+
     let handle = rclnodejs.createSubscription(
       nodeHandle,
       type.pkgName,
       type.subFolder,
       type.interfaceName,
       topic,
-      options.qos
+      options
     );
     return new Subscription(handle, typeClass, topic, options, callback);
   }
@@ -66,6 +79,43 @@ class Subscription extends Entity {
   get isRaw() {
     return this._isRaw;
   }
+
+  /**
+   * Test if the RMW supports content-filtered topics and that this subscription
+   * has an active wellformed content-filter.
+   * @returns {boolean} True if content-filtering will be applied; otherwise false.
+   */
+  hasContentFilter() {
+    return rclnodejs.hasContentFilter(this.handle);
+  }
+
+  /**
+   * If the RMW supports content-filtered topics set this subscription's content-filter.
+   * @param {object} contentFilter - The content-filter description.
+   * @param {string} contentFilter.expression - Specifies the criteria to select messages of interest.
+   *  It is similar to the WHERE part of an SQL clause. Clear the current contentFilter if
+   *  the expression is undefined or an empty string.
+   * @param {object[]}  [contentFilter.parameters=undefined] - Array of objects that give values to
+   *  the ‘parameters’ (i.e., "%n" tokens) in the filter_expression. The number of supplied parameters must
+   *  fit with the requested values in the filter_expression (i.e., the number of %n tokens). default: undefined.
+   * @returns {boolean} - True if successful; false otherwise
+   * @see {@link https://www.omg.org/spec/DDS/1.4/PDF|DDS 1.4 specification, Annex B}
+   */
+  setContentFilter(contentFilter) {
+    return contentFilter?.expression
+      ? rclnodejs.setContentFilter(this.handle, contentFilter)
+      : this.clearContentFilter();
+  }
+
+  /**
+   * Clear the current content-filter. No filtering is to be applied.
+   * @returns {boolean} - True if successful; false otherwise
+   */
+  clearContentFilter() {
+    return this.hasContentFilter()
+      ? rclnodejs.clearContentFilter(this.handle)
+      : true;
+  }
 }
 
 module.exports = Subscription;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rclnodejs",
-  "version": "0.21.3",
+  "version": "0.22.0",
   "description": "ROS2.0 JavaScript client with Node.js",
   "main": "index.js",
   "types": "types/index.d.ts",
@@ -13,21 +13,28 @@
     "typescript"
   ],
   "scripts": {
-    "install": "node-gyp rebuild",
+    "build": "node-gyp -j 16 build",
+    "build:dev": "node-gyp -j 16 build --debug",
+    "rebuild": "npm run clean && node-gyp -j 16 rebuild",
+    "rebuild:dev": "npm run clean && node-gyp -j 16 rebuild --debug",
+    "generate-messages": "node scripts/generate_messages.js",
+    "clean": "node-gyp clean && rimraf ./generated",
+    "install": "npm run rebuild",
+    "postinstall": "npm run generate-messages",
     "docs": "cd docs && make",
     "test": "node --expose-gc ./scripts/run_test.js && npm run dtslint",
     "dtslint": "node scripts/generate_tsd.js && dtslint test/types",
     "lint": "eslint --max-warnings=0 --ext js,ts index.js types scripts lib example rosidl_gen rosidl_parser test benchmark/rclnodejs && node ./scripts/cpplint.js",
-    "postinstall": "node scripts/generate_messages.js",
     "format": "clang-format -i -style=file ./src/*.cpp ./src/*.hpp && prettier --write \"{lib,rosidl_gen,rostsd_gen,rosidl_parser,types,example,test,scripts,benchmark}/**/*.{js,md,ts}\" ./*.{js,md,ts}"
   },
   "bin": {
     "generate-ros-messages": "./scripts/generate_messages.js"
   },
   "authors": [
-    "Minggang Wang <minggang.wang@intel.com>",
+    "Minggang Wang <minggangw@gmail.com>",
     "Kenny Yuan <kaining.yuan@intel.com>",
     "Wanming Lin <wanming.lin@intel.com>",
+    "Wayne Parrott",
     "Zhong Qiu <zhongx.qiu@intel.com>"
   ],
   "license": "Apache-2.0",
@@ -49,7 +56,7 @@
     "husky": "^4.2.5",
     "jsdoc": "^3.6.7",
     "lint-staged": "^10.2.11",
-    "mocha": "^8.0.1",
+    "mocha": "^10.2.0",
     "prettier": "^2.0.5",
     "rimraf": "^3.0.2",
     "sinon": "^9.0.2",
@@ -89,6 +96,6 @@
     ]
   },
   "engines": {
-    "node": ">= 10.23.1 <18.0.0"
+    "node": ">= 10.23.1 <20.0.0"
   }
 }

package/rosidl_gen/blocklist.json

@@ -0,0 +1,5 @@
+[
+  {
+    "pkgName": "rosbag2_storage_mcap_testdata"
+  }
+]

package/rosidl_gen/filter.js

@@ -0,0 +1,104 @@
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+
+// blocklist.json format
+//  [
+//    {
+//      pkgName: RegExString,
+//      interfaceName: RegExString,
+//      os: RegExString
+//    },
+//    ...
+//  ]
+//
+// examples
+//  [
+//    {
+//      "pkgName": "action*"
+//    },
+//    {
+//      "pkgName": "std_msgs",
+//    },
+//    {
+//      "pkgName": "std_msgs",
+//      "interfaceName": "String"
+//    },
+//    {
+//      "os": "Linux"
+//    },
+//  ]
+
+const RosPackageFilters = {
+  filters: [],
+  _loaded: false,
+
+  addFilter: function (pkgName, interfaceName, os) {
+    this.filters.push({
+      pkgName: pkgName,
+      interfaceName: interfaceName,
+      os: os,
+    });
+  },
+
+  _matches: function (filter, pkgInfo) {
+    if (filter.os && filter.os.test(os.type())) {
+      return true;
+    }
+
+    if (filter.pkgName) {
+      if (filter.pkgName.test(pkgInfo.pkgName)) {
+        if (!filter.interfaceName) {
+          return true;
+        }
+      } else {
+        return false;
+      }
+    }
+
+    if (
+      filter.interfaceName &&
+      filter.interfaceName.test(pkgInfo.interfaceName)
+    ) {
+      return true;
+    }
+
+    return false;
+  },
+
+  load: function (
+    blocklistPath = path.join(__dirname, '../rosidl_gen/blocklist.json')
+  ) {
+    this._loaded = true;
+
+    if (!fs.existsSync(blocklistPath)) return;
+
+    // eslint-disable-next-line
+    let blocklistData = JSON.parse(fs.readFileSync(blocklistPath, 'utf8'));
+
+    let filters = blocklistData.map((pkgFilterData) => {
+      let filter = {};
+      if (pkgFilterData['pkgName']) {
+        filter.pkgName = new RegExp(pkgFilterData.pkgName);
+      }
+      if (pkgFilterData['interfaceName']) {
+        filter.interfaceName = new RegExp(pkgFilterData.interfaceName);
+      }
+      if (pkgFilterData['os']) {
+        filter.os = new RegExp(pkgFilterData.os);
+      }
+      return filter;
+    });
+
+    this.filters = filters.filter(
+      (filter) => !filter.os || filter.os.test(os.type())
+    );
+  },
+
+  matchesAny: function (pkgInfo) {
+    if (!this._loaded) this.load();
+    return this.filters.some((filter) => this._matches(filter, pkgInfo));
+  },
+};
+
+module.exports = RosPackageFilters;

package/rosidl_gen/idl_generator.js

@@ -30,6 +30,13 @@ function removeEmptyLines(str) {
   return str.replace(/^\s*\n/gm, '');
 }
 
+/**
+ * Output generated code to disk. Do not overwrite
+ * an existing file. If file already exists do nothing.
+ * @param {string} dir
+ * @param {string} fileName
+ * @param {string} code
+ */
 async function writeGeneratedCode(dir, fileName, code) {
   await fse.mkdirs(dir);
   await fse.writeFile(path.join(dir, fileName), code);

package/rosidl_gen/index.js

@@ -20,13 +20,16 @@ const packages = require('./packages.js');
 const path = require('path');
 
 const generatedRoot = path.join(__dirname, '../generated/');
-const installedPackagePaths = process.env.AMENT_PREFIX_PATH.split(
-  path.delimiter
-);
+
+function getInstalledPackagePaths() {
+  return process.env.AMENT_PREFIX_PATH.split(path.delimiter);
+}
 
 async function generateInPath(path) {
   const pkgs = await packages.findPackagesInDirectory(path);
+
   const pkgsInfo = Array.from(pkgs.values());
+
   await Promise.all(
     pkgsInfo.map((pkgInfo) => generateJSStructFromIDL(pkgInfo, generatedRoot))
   );
@@ -38,13 +41,23 @@ async function generateAll(forcedGenerating) {
   // all the JavaScript files will be created.
   const exist = await fse.exists(generatedRoot);
   if (forcedGenerating || !exist) {
+    if (exist) {
+      // recursively clear all previously generated struct files
+      await fse.emptyDir(generatedRoot);
+    }
+
     await fse.copy(
       path.join(__dirname, 'generator.json'),
       path.join(generatedRoot, 'generator.json')
     );
-    await Promise.all(
-      installedPackagePaths.map((path) => generateInPath(path))
-    );
+
+    // Process in AMENT_PREFIX_PATH in reverse order to
+    // such that interfaces defined earlier on the AMENX_PREFIX_PATH
+    // have higher priority over earlier versions and will override
+    // them - occurences of this are expected to be rare.
+    for (let path of getInstalledPackagePaths().reverse()) {
+      await generateInPath(path);
+    }
   }
 }
 

package/rosidl_gen/packages.js

@@ -21,6 +21,7 @@ const path = require('path');
 const walk = require('walk');
 const os = require('os');
 const flat = require('array.prototype.flat');
+const pkgFilters = require('../rosidl_gen/filter.js');
 
 const fsp = fs.promises;
 
@@ -140,28 +141,30 @@ async function findAmentPackagesInDirectory(dir) {
     pkgs.map((pkg) => getPackageDefinitionsFiles(pkg, dir))
   );
 
-  // Support flat() methond for nodejs < 11.
+  // Support flat() method for nodejs < 11.
   const rosFiles = Array.prototype.flat ? files.flat() : flat(files);
 
   const pkgMap = new Map();
   return new Promise((resolve, reject) => {
     rosFiles.forEach((filePath) => {
-      if (path.extname(filePath) === '.msg') {
-        // Some .msg files were generated prior to 0.3.2 for .action files,
-        // which has been disabled. So these files should be ignored here.
-        if (path.dirname(dir).split(path.sep).pop() !== 'action') {
-          addInterfaceInfo(
-            grabInterfaceInfo(filePath, true),
-            'messages',
-            pkgMap
-          );
-        }
-      } else if (path.extname(filePath) === '.srv') {
-        addInterfaceInfo(grabInterfaceInfo(filePath, true), 'services', pkgMap);
-      } else if (path.extname(filePath) === '.action') {
-        addInterfaceInfo(grabInterfaceInfo(filePath, true), 'actions', pkgMap);
+      const interfaceInfo = grabInterfaceInfo(filePath, true);
+      const ignore = pkgFilters.matchesAny(interfaceInfo);
+      if (ignore) {
+        console.log('Omitting filtered interface: ', interfaceInfo);
       } else {
-        // we ignore all other files
+        if (path.extname(filePath) === '.msg') {
+          // Some .msg files were generated prior to 0.3.2 for .action files,
+          // which has been disabled. So these files should be ignored here.
+          if (path.dirname(dir).split(path.sep).pop() !== 'action') {
+            addInterfaceInfo(interfaceInfo, 'messages', pkgMap);
+          }
+        } else if (path.extname(filePath) === '.srv') {
+          addInterfaceInfo(interfaceInfo, 'services', pkgMap);
+        } else if (path.extname(filePath) === '.action') {
+          addInterfaceInfo(interfaceInfo, 'actions', pkgMap);
+        } else {
+          // we ignore all other files
+        }
       }
     });
     resolve(pkgMap);
@@ -191,30 +194,27 @@ async function findPackagesInDirectory(dir) {
       let walker = walk.walk(dir, { followLinks: true });
       let pkgMap = new Map();
       walker.on('file', (root, file, next) => {
-        if (path.extname(file.name) === '.msg') {
-          // Some .msg files were generated prior to 0.3.2 for .action files,
-          // which has been disabled. So these files should be ignored here.
-          if (path.dirname(root).split(path.sep).pop() !== 'action') {
-            addInterfaceInfo(
-              grabInterfaceInfo(path.join(root, file.name), amentExecuted),
-              'messages',
-              pkgMap
-            );
-          }
-        } else if (path.extname(file.name) === '.srv') {
-          addInterfaceInfo(
-            grabInterfaceInfo(path.join(root, file.name), amentExecuted),
-            'services',
-            pkgMap
-          );
-        } else if (path.extname(file.name) === '.action') {
-          addInterfaceInfo(
-            grabInterfaceInfo(path.join(root, file.name), amentExecuted),
-            'actions',
-            pkgMap
-          );
+        const interfaceInfo = grabInterfaceInfo(
+          path.join(root, file.name),
+          amentExecuted
+        );
+        const ignore = pkgFilters.matchesAny(interfaceInfo);
+        if (ignore) {
+          console.log('Omitting filtered interface: ', interfaceInfo);
         } else {
-          // we ignore all other files
+          if (path.extname(file.name) === '.msg') {
+            // Some .msg files were generated prior to 0.3.2 for .action files,
+            // which has been disabled. So these files should be ignored here.
+            if (path.dirname(root).split(path.sep).pop() !== 'action') {
+              addInterfaceInfo(interfaceInfo, 'messages', pkgMap);
+            }
+          } else if (path.extname(file.name) === '.srv') {
+            addInterfaceInfo(interfaceInfo, 'services', pkgMap);
+          } else if (path.extname(file.name) === '.action') {
+            addInterfaceInfo(interfaceInfo, 'actions', pkgMap);
+          } else {
+            // we ignore all other files
+          }
         }
         next();
       });

package/rostsd_gen/index.js

@@ -31,6 +31,7 @@ declare module "rclnodejs" {
 const path = require('path');
 const fs = require('fs');
 const loader = require('../lib/interface_loader.js');
+const pkgFilters = require('../rosidl_gen/filter.js');
 
 async function generateAll() {
   // load pkg and interface info (msgs and srvs)
@@ -63,7 +64,14 @@ function getPkgInfos(rootDir) {
 
     for (let filename of files) {
       const typeClass = fileName2Typeclass(filename);
-      if (!typeClass.type) continue;
+      if (
+        !typeClass.type ||
+        pkgFilters.matchesAny({
+          pkgName: typeClass.package,
+          interfaceName: typeClass.name,
+        })
+      )
+        continue;
 
       const rosInterface = loader.loadInterface(typeClass);
 

package/scripts/npmjs-readme.md

@@ -45,7 +45,7 @@ npm i rclnodejs@x.y.z
 
 |                                                            RCLNODEJS Version                                                            |                                                                                                                                                                     Compatible ROS 2 Release                                                                                                                                                                     |
 | :-------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
-| [0.21.3 (current)](https://www.npmjs.com/package/rclnodejs/v/0.21.3) ([API](http://robotwebtools.org/rclnodejs/docs/0.21.3/index.html)) | [Humble Hawksbill](https://github.com/ros2/ros2/releases/tag/release-humble-20220523)<br>[Galactic Geochelone](https://github.com/ros2/ros2/releases/tag/release-galactic-20210716)<br>[Foxy Fitzroy](https://github.com/ros2/ros2/releases/tag/release-foxy-20201211)<br>[Eloquent Elusor](https://github.com/ros2/ros2/releases/tag/release-eloquent-20200124) |
+| [0.21.4 (current)](https://www.npmjs.com/package/rclnodejs/v/0.21.4) ([API](http://robotwebtools.org/rclnodejs/docs/0.21.3/index.html)) | [Humble Hawksbill](https://github.com/ros2/ros2/releases/tag/release-humble-20220523)<br>[Galactic Geochelone](https://github.com/ros2/ros2/releases/tag/release-galactic-20210716)<br>[Foxy Fitzroy](https://github.com/ros2/ros2/releases/tag/release-foxy-20201211)<br>[Eloquent Elusor](https://github.com/ros2/ros2/releases/tag/release-eloquent-20200124) |
 |                                [0.10.3](https://github.com/RobotWebTools/rclnodejs/releases/tag/0.10.3)                                 |                                                                                                                                [Dashing Diademata - Patch 4](https://github.com/ros2/ros2/releases/tag/release-dashing-20191018)                                                                                                                                 |
 
 ## Documentation

package/scripts/run_test.js

@@ -20,12 +20,6 @@ const os = require('os');
 const path = require('path');
 
 let rootDir = path.dirname(__dirname);
-let actionPath = path.join(rootDir, 'test', 'ros1_actions');
-process.env.AMENT_PREFIX_PATH =
-  process.env.AMENT_PREFIX_PATH + path.delimiter + actionPath;
-let msgPath = path.join(rootDir, 'test', 'rclnodejs_test_msgs');
-process.env.AMENT_PREFIX_PATH =
-  process.env.AMENT_PREFIX_PATH + path.delimiter + msgPath;
 
 fs.remove(path.join(path.dirname(__dirname), 'generated'), (err) => {
   if (!err) {