bluetooth-serial-port 3.0.2 → 3.0.4-beta.11

package/README.md

@@ -6,7 +6,7 @@ This piece of open source software is free (as in speech) to [use, modify and di
 
 > MacOS support has (temporarily) been dropped as of version v3.0.0 of the module. If you use the module on a Mac please stay on v2 of this module.
 
-> _DEPRECATED_ Currently I have no plans to add support for NodeJS version 1.13 and up. If you want to help out by adding support please contact me. It was a great experience maintaining this project for almost 8 years. It was great to see people step in to improve this project. Thank you all!
+> _DEPRECATED_ I am no longer actively maintaining this project. If you want to help out by adding support please contact me. It was a great experience maintaining this project for almost 8 years. It was great to see people step in to improve this project. Thank you all!
 
 [![Build status](https://dl.circleci.com/status-badge/img/gh/eelcocramer/node-bluetooth-serial-port/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/eelcocramer/node-bluetooth-serial-port/tree/master)
 [![Build status](https://ci.appveyor.com/api/projects/status/4p1r3ddoid98qc7k?svg=true)](https://ci.appveyor.com/project/eelcocramer/node-bluetooth-serial-port)
@@ -15,15 +15,19 @@ This node module lets you communicate over Bluetooth serial port with devices us
 
 If you have any problems make sure to [checkout the FAQ](https://github.com/eelcocramer/node-bluetooth-serial-port/issues?q=label%3AFAQ).
 
-## New in the last release
+## New in the last releases
 
--   Changes node version to `lts` in the Dockerfile
+* Downloads precompiled native assets from github
+* Bumps dependencies
+* Fixes memory leaks.
+* Adds support for node 20, 22 and 24
 
 Check the [release notes](RELEASE_NOTES.md) for an overview of the change history.
 
 ## Prerequisites on Linux
 
--   Needs Bluetooth development packages to build
+* Build prerequisites are only needed when no matching prebuilt binary is available.
+* Needs Bluetooth development packages for source builds.
 
 `apt-get install build-essential libbluetooth-dev`
 
@@ -52,13 +56,17 @@ sudo systemctl restart bluetooth
 
 ## Prerequisites on Windows
 
--   Needs Visual Studio (Visual C++) and its command line tools installed.
--   Needs Python 2.x installed and accessible from the command line path.
+-   Build prerequisites are only needed when no matching prebuilt binary is available.
+-   Needs Visual Studio (Visual C++) and its command line tools for source builds.
+-   Needs Python installed and accessible from the command line path.
 
 ## Install
 
 `npm install bluetooth-serial-port`
 
+For Linux x64 and Windows x64 on Node 18, 20, 22 and 24, installation first downloads a prebuilt native binary from GitHub Releases.
+If a matching prebuild is unavailable, install falls back to a local `node-gyp` build.
+
 ## Test build Linux using docker
 
 `docker build -t bluetooth-serial-port .`

package/lib/bluetooth-serial-port.js

@@ -15,9 +15,11 @@
 (function () {
     "use strict";
 
-    var util = require('util'),
+    var path = require('path'),
+        util = require('util'),
         EventEmitter = require('events').EventEmitter,
-        btSerial = require('bindings')('BluetoothSerialPort.node'),
+        loadNative = require('../scripts/load-native'),
+        btSerial = loadNative(path.join(__dirname, '..'), 'BluetoothSerialPort'),
         DeviceINQ = require("./device-inquiry.js").DeviceINQ;
 
     /**
@@ -143,9 +145,11 @@
         return;
     }
 
-    var util = require('util'),
+    var path = require('path'),
+        util = require('util'),
         EventEmitter = require('events').EventEmitter,
-        btSerial = require('bindings')('BluetoothSerialPortServer.node'),
+        loadNative = require('../scripts/load-native'),
+        btSerial = loadNative(path.join(__dirname, '..'), 'BluetoothSerialPortServer'),
         _SERIAL_PORT_PROFILE_UUID = '1101',
         _DEFAULT_SERVER_CHANNEL = 1,
         _ERROR_CLIENT_CLOSED_CONNECTION = 'Error: Connection closed by the client';

package/lib/device-inquiry.js

@@ -15,14 +15,13 @@
 (function () {
     "use strict";
 
-    // javascript shim that lets our object inherit from EventEmitter
-    var DeviceINQ = require('bindings')('BluetoothSerialPort.node').DeviceINQ,
+    var path = require('path'),
+        loadNative = require('../scripts/load-native'),
+        DeviceINQ = loadNative(path.join(__dirname, '..'), 'BluetoothSerialPort').DeviceINQ,
         events = require('events');
 
-    // extend prototype
     function inherits(target, source) {
         var k;
-
         for (k in source.prototype) {
             target.prototype[k] = source.prototype[k];
         }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bluetooth-serial-port",
-    "version": "3.0.2",
+    "version": "3.0.4-beta.11",
     "description": "Bluetooth serial port communication for Node.js",
     "author": "Eelco Cramer <eelco@hailendal.org>",
     "keywords": [
@@ -14,32 +14,44 @@
     "bugs": "https://github.com/eelcocramer/node-bluetooth-serial-port/issues",
     "repository": {
         "type": "git",
-        "url": "https://github.com/eelcocramer/node-bluetooth-serial-port"
+        "url": "git+https://github.com/eelcocramer/node-bluetooth-serial-port.git"
     },
     "directories": {
         "lib": "./lib"
     },
     "main": "./lib/bluetooth-serial-port.js",
     "types": "./lib/bluetooth-serial-port.d.ts",
+    "files": [
+        "lib/",
+        "src/",
+        "scripts/",
+        "binding.gyp",
+        "prebuilds/"
+    ],
     "os": [
         "linux",
         "win32"
     ],
     "dependencies": {
-        "bindings": "1.5.x",
-        "nan": "2.17.x",
+        "nan": "^2.28.0",
+        "node-gyp-build": "^4.8.4",
         "stable": "^0.1.8"
     },
+    "devDependencies": {},
     "optionalDependencies": {
-        "@types/node": "^18.0.0"
+        "@types/node": "^26.1.2"
     },
     "engines": {
-        "node": ">= 16.x",
+        "node": ">= 18.x",
         "npm": ">= 8.x"
     },
     "scripts": {
-        "install": "node-gyp configure build",
-        "install-debug": "node-gyp configure build --debug"
+        "install": "node-gyp-build",
+        "install-release": "node-gyp configure build",
+        "install-debug": "node-gyp configure build --debug",
+        "prebuild": "node scripts/create-prebuilds.js --strip",
+        "prepublishOnly": "node scripts/download-prebuilds.js",
+        "test": "node test/index.js"
     },
     "license": "MIT",
     "contributors": [

package/scripts/create-prebuilds.js

@@ -0,0 +1,42 @@
+// scripts/create-prebuilds.js
+'use strict';
+
+var cp = require('child_process');
+var fs = require('fs');
+var path = require('path');
+
+var strip = process.argv.includes('--strip');
+var abi = process.versions.modules;
+var platform = process.platform;
+var arch = process.arch;
+var rootDir = path.join(__dirname, '..');
+var releaseDir = path.join(rootDir, 'build', 'Release');
+var outDir = path.join(rootDir, 'prebuilds', platform + '-' + arch);
+var modules = ['BluetoothSerialPort'];
+if (platform === 'linux') {
+  modules.push('BluetoothSerialPortServer');
+}
+
+fs.mkdirSync(outDir, { recursive: true });
+
+modules.forEach(function(name) {
+  var src = path.join(releaseDir, name + '.node');
+
+  if (!fs.existsSync(src)) {
+    console.error('Error: ' + src + ' not found. Run "npm run install-release" first.');
+    process.exit(1);
+  }
+
+  var dest = path.join(outDir, name + '.abi' + abi + '.node');
+  fs.copyFileSync(src, dest);
+
+  if (strip && platform !== 'win32') {
+    try {
+      cp.execSync('strip "' + dest + '"', { stdio: 'inherit' });
+    } catch (e) {
+      console.warn('Warning: strip failed for ' + dest + ' (' + e.message + ')');
+    }
+  }
+
+  console.log('Created ' + path.relative(rootDir, dest));
+});

package/scripts/download-prebuilds.js

@@ -0,0 +1,98 @@
+// scripts/download-prebuilds.js
+'use strict';
+
+var fs = require('fs');
+var path = require('path');
+
+var pkg = require('../package.json');
+var token = process.env.GITHUB_TOKEN;
+
+// Parse owner/repo from repository.url
+// Handles: https://github.com/owner/repo or git+https://github.com/owner/repo
+var repoMatch = pkg.repository.url.match(/github\.com[/:]([^/]+)\/([^/.]+)/);
+if (!repoMatch) {
+  console.error('Error: Cannot parse GitHub owner/repo from: ' + pkg.repository.url);
+  process.exit(1);
+}
+var owner = repoMatch[1];
+var repo = repoMatch[2].replace(/\.git$/, '');
+var tag = 'v' + pkg.version;
+var rootDir = path.join(__dirname, '..');
+
+console.log('Downloading prebuilds for ' + owner + '/' + repo + '@' + tag + '...');
+
+async function main() {
+  var apiUrl = 'https://api.github.com/repos/' + owner + '/' + repo + '/releases/tags/' + tag;
+  var headers = {
+    'Accept': 'application/vnd.github.v3+json',
+    'User-Agent': repo + '-prebuild-downloader'
+  };
+
+  if (token) {
+    headers.Authorization = 'Bearer ' + token;
+  }
+
+  var apiRes = await fetch(apiUrl, {
+    headers: headers
+  });
+
+  if (!apiRes.ok) {
+    var body = await apiRes.text();
+    throw new Error('GitHub API ' + apiRes.status + ' for ' + apiUrl + ': ' + body);
+  }
+
+  var release = await apiRes.json();
+  var assets = release.assets.filter(function(a) { return /\.abi\d+\.node$/.test(a.name); });
+
+  if (assets.length === 0) {
+    console.error(
+      'Error: No prebuilt binaries found in GitHub Release ' + tag + '.\n' +
+      'Wait for CI to finish uploading prebuilts before running npm publish.'
+    );
+    process.exit(1);
+  }
+
+  console.log('Found ' + assets.length + ' prebuild asset(s).');
+
+  for (var asset of assets) {
+    // Asset name format: linux-x64--BluetoothSerialPort.abi108.node
+    var sep = asset.name.indexOf('--');
+    if (sep === -1) {
+      console.warn('Skipping unrecognised asset name: ' + asset.name);
+      continue;
+    }
+    var platformArch = asset.name.slice(0, sep);
+    var filename = asset.name.slice(sep + 2);
+    var destDir = path.join(rootDir, 'prebuilds', platformArch);
+    var destFile = path.join(destDir, filename);
+
+    fs.mkdirSync(destDir, { recursive: true });
+
+    var dlHeaders = {
+      'User-Agent': repo + '-prebuild-downloader'
+    };
+
+    if (token) {
+      dlHeaders.Authorization = 'Bearer ' + token;
+    }
+
+    var dlRes = await fetch(asset.browser_download_url, {
+      headers: dlHeaders
+    });
+
+    if (!dlRes.ok) {
+      throw new Error('Download failed for ' + asset.name + ': HTTP ' + dlRes.status);
+    }
+
+    var buf = await dlRes.arrayBuffer();
+    fs.writeFileSync(destFile, Buffer.from(buf));
+    console.log('  -> ' + path.relative(rootDir, destFile));
+  }
+
+  console.log('All prebuilds downloaded successfully.');
+}
+
+main().catch(function(err) {
+  console.error('Error:', err.message);
+  process.exit(1);
+});

package/scripts/load-native.js

@@ -0,0 +1,39 @@
+// scripts/load-native.js
+'use strict';
+
+var fs = require('fs');
+var path = require('path');
+
+/**
+ * Loads a named native module (.node file).
+ * Resolution order:
+ *   1. prebuilds/{platform}-{arch}/{name}.abi{abi}.node  (bundled prebuild)
+ *   2. build/Release/{name}.node                         (source-compiled release)
+ *   3. build/Debug/{name}.node                           (source-compiled debug)
+ *
+ * @param {string} packageRoot  Absolute path to the package root directory.
+ * @param {string} name         Module name without extension (e.g. 'BluetoothSerialPort').
+ * @returns {object} The native binding.
+ */
+module.exports = function loadNative(packageRoot, name) {
+  var abi = process.versions.modules;
+  var platform = process.platform;
+  var arch = process.arch;
+
+  var candidates = [
+    path.join(packageRoot, 'prebuilds', platform + '-' + arch, name + '.abi' + abi + '.node'),
+    path.join(packageRoot, 'build', 'Release', name + '.node'),
+    path.join(packageRoot, 'build', 'Debug', name + '.node')
+  ];
+
+  for (var i = 0; i < candidates.length; i++) {
+    if (fs.existsSync(candidates[i])) {
+      return require(candidates[i]);
+    }
+  }
+
+  throw new Error(
+    'Could not find native module "' + name + '". Searched:\n' +
+    candidates.map(function(p) { return '  ' + p; }).join('\n')
+  );
+};

package/src/linux/BTSerialPortBinding.cc

@@ -391,6 +391,7 @@ NAN_METHOD(BTSerialPortBinding::Read) {
         Nan::AsyncResource resource("bluetooth-serial-port:Read");
         Nan::Callback *nc = new Nan::Callback(cb);
         nc->Call(2, argv, &resource);
+        delete nc;
     } else {
         read_baton_t *baton = new read_baton_t();
         baton->rfcomm = rfcomm;

package/src/linux/DeviceINQ.cc

@@ -252,9 +252,12 @@ NAN_METHOD(DeviceINQ::InquireSync) {
       };
       found->Call(2, argv, &resource);
     }
+    free(inquiryResult.devices);
 
     Local<Value> argv[] = {};
     callback->Call(0, argv, &resource);
+    delete callback;
+    delete found;
     return;
 }
 
@@ -262,7 +265,9 @@ class InquireWorker : public Nan::AsyncWorker {
  public:
   InquireWorker(Nan::Callback* found, Nan::Callback *callback)
     : Nan::AsyncWorker(callback), found(found) {}
-  ~InquireWorker() {}
+  ~InquireWorker() {
+        delete found;
+    }
 
   // Executed inside the worker-thread.
   // It is not safe to access V8, or V8 data structures
@@ -289,6 +294,7 @@ class InquireWorker : public Nan::AsyncWorker {
 
     Local<Value> argv[] = {};
     callback->Call(0, argv, &resource);
+    free(inquiryResult.devices);
   }
 
   private:

package/src/windows/BTSerialPortBinding.cc

@@ -354,6 +354,7 @@ NAN_METHOD(BTSerialPortBinding::Read) {
         Nan::AsyncResource resource("bluetooth-serial-port:Read");
         Nan::Callback *nc = new Nan::Callback(cb);
         nc->Call(2, argv, &resource);
+        delete nc;
     } else {
         read_baton_t *baton = new read_baton_t();
         baton->rfcomm = rfcomm;