@encharm/cws 4.8.3 → 4.8.4

package/CHANGELOG.md

@@ -1,3 +1,6 @@
+## Released 4.8.4
+* `npm install` no longer rebuilds the binding from source when a prebuilt one matches the platform and Node ABI. Since the node-gyp fallback was repaired in 4.8.0, every install on a machine with a compiler was silently replacing the shipped zlib-ng binding with a Node-zlib build. `CWS_FORCE_BUILD=1` forces the source build.
+
 ## Released 4.8.3
 * Corked sends up to 1 KB use the per-loop block pool instead of malloc/free per message; queued messages remember their pool block. Also initialise the `reserved` callback argument, which was passed uninitialised for messages that hit the write queue.
 * JS: resolve the native namespace once per socket instead of on every `send`/`close`/`ping`.

package/CLAUDE.md

@@ -21,7 +21,7 @@ Tests bind ports 3000 (ws) and 3001 (wss, certs in `tests/certs/`). The test fil
 
 ### Building the release binaries (multi-ABI)
 
-`binding.gyp` is only used by `npm install` for a local build against the running Node (Node's zlib, no zlib-ng); it must carry the same include path and defines as the Makefile or it fails silently (the install script discards the exit code). Release binaries are built by the `Makefile` (macOS/Linux) and `make.bat` (Windows), which:
+`binding.gyp` is only used by `npm install` for a local build against the running Node (Node's zlib, no zlib-ng), and only when `scripts/install.js` finds no prebuilt binding for the platform/ABI (`CWS_FORCE_BUILD=1` overrides); it must carry the same include path and defines as the Makefile or it fails silently (the install script discards the exit code). Release binaries are built by the `Makefile` (macOS/Linux) and `make.bat` (Windows), which:
 
 1. Download official Node header tarballs for one pinned version per supported major into `targets/` (`VER_115`=Node 20, `VER_127`=Node 22, `VER_137`=Node 24, `VER_147`=Node 26; the number is the Node ABI / `process.versions.modules`).
 2. Compile `src/*.cpp` once per ABI with `g++`/`cl` directly, with `-I src/headers/$V` for the matching Node major.

package/README.md

@@ -14,6 +14,7 @@ This table is true if you run ssl directly with `cws` (`Node.js`). In case if yo
 
 | cWS Version | Node 26 | Node 24  | Node 22 | Node 20 |
 |-------------|---------|----------|---------|----------
+| 4.8.4       |    X    |    X     |    X    |   X     |
 | 4.8.3       |    X    |    X     |    X    |   X     |
 | 4.8.2       |    X    |    X     |    X    |   X     |
 | 4.8.1       |    X    |    X     |    X    |   X     |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@encharm/cws",
-  "version": "4.8.3",
+  "version": "4.8.4",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "description": "cWS - fast C++ WebSocket implementation for Node.js",
@@ -8,7 +8,7 @@
     "lint": "tslint -c tslint.json 'lib/**/*.ts'",
     "test": "nyc mocha './tests/**/*.test.ts' --exit",
     "clean": "rimraf dist/bindings/*",
-    "install": "node-gyp rebuild > build_log.txt 2>&1 || exit 0",
+    "install": "node scripts/install.js",
     "build-ts": "rimraf dist/*.js && rimraf dist/*.ts && npm run lint && tsc",
     "build-cpp": "node-gyp rebuild > build_log.txt 2>&1 || exit 0"
   },

package/scripts/install.js

@@ -0,0 +1,21 @@
+// npm/yarn `install` hook. The package ships prebuilt bindings under dist/bindings; only
+// fall back to a node-gyp source build (against Node's own zlib, no zlib-ng) when none
+// matches this platform and Node ABI. Set CWS_FORCE_BUILD=1 to build regardless.
+// The build is best effort: failures are logged to build_log.txt and never fail the install.
+'use strict';
+const fs = require('fs');
+const path = require('path');
+const { spawnSync } = require('child_process');
+
+const root = path.join(__dirname, '..');
+const binding = path.join(root, 'dist', 'bindings', `cws_${process.platform}_${process.arch}_node${process.versions.modules}.node`);
+
+if (fs.existsSync(binding) && !process.env.CWS_FORCE_BUILD) {
+  process.exit(0);
+}
+
+const log = fs.openSync(path.join(root, 'build_log.txt'), 'w');
+fs.writeSync(log, process.env.CWS_FORCE_BUILD ? `CWS_FORCE_BUILD set, building from source (prebuilt: ${binding})\n` : `no prebuilt binding at ${binding}, building from source\n`);
+spawnSync('node-gyp', ['rebuild'], { cwd: root, stdio: ['ignore', log, log], shell: true });
+fs.closeSync(log);
+process.exit(0);