node-web-audio-api 0.21.5 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v1.0.0 (11/01/2024)
+
+- Align version with upsteam crate
+- Refactor CI
+
 ## v0.21.5 (23/12/2024)
 
 - Fix: Use module import for `AudioWorklet#addModule`

package/js/AudioRenderCapacity.js

@@ -5,6 +5,7 @@ const {
   kOnUpdate,
 } = require('./lib/symbols.js');
 const {
+  isFunction,
   kEnumerableProperty,
 } = require('./lib/utils.js');
 const {
@@ -70,7 +71,7 @@ class AudioRenderCapacity extends EventTarget {
       }
 
       targetOptions.updateInterval = conversions['double'](options.updateInterval, {
-        context: `Failed to execute 'start' on 'AudioRenderCapacity': Failed to read the 'updateInterval' property on 'AudioRenderCapacityOptions': The provided value ()`
+        context: `Failed to execute 'start' on 'AudioRenderCapacity': Failed to read the 'updateInterval' property on 'AudioRenderCapacityOptions': The provided value ()`,
       });
     } else {
       targetOptions.updateInterval = 1;
@@ -108,7 +109,7 @@ Object.defineProperties(AudioRenderCapacity.prototype, {
   },
 
   onupdate: kEnumerableProperty,
-  stop: kEnumerableProperty,
+  start: kEnumerableProperty,
   stop: kEnumerableProperty,
 });
 

package/js/AudioWorklet.js

@@ -1,8 +1,9 @@
 const {
-  resolveObjectURL
+  resolveObjectURL,
 } = require('node:buffer');
-const fs = require('node:fs').promises;
-const { existsSync } = require('node:fs');
+const {
+  existsSync,
+} = require('node:fs');
 const path = require('node:path');
 const {
   Worker,
@@ -23,7 +24,7 @@ const {
 
 const caller = require('caller');
 // cf. https://www.npmjs.com/package/node-fetch#commonjs
-const fetch = (...args) => import('node-fetch').then(({default: fetch}) => fetch(...args));
+const fetch = (...args) => import('node-fetch').then(({ default: fetch }) => fetch(...args));
 
 /**
  * Retrieve code with different module resolution strategies
@@ -47,11 +48,11 @@ const resolveModule = async (moduleUrl) => {
     }
   } else if (moduleUrl.startsWith('http')) {
     try {
-        const res = await fetch(moduleUrl);
-        code = await res.text();
-      } catch (err) {
-        throw new DOMException(`Failed to execute 'addModule' on 'AudioWorklet': ${err.message}`, 'AbortError');
-      }
+      const res = await fetch(moduleUrl);
+      code = await res.text();
+    } catch (err) {
+      throw new DOMException(`Failed to execute 'addModule' on 'AudioWorklet': ${err.message}`, 'AbortError');
+    }
   } else if (moduleUrl.startsWith('blob:')) {
     try {
       const blob = resolveObjectURL(moduleUrl);
@@ -63,16 +64,8 @@ const resolveModule = async (moduleUrl) => {
     const callerSite = caller(2);
 
     if (callerSite.startsWith('http')) { // this branch exists for wpt where caller site is an url
-      let url;
-      // handle origin relative and caller path relative URLs
-      if (moduleUrl.startsWith('/')) {
-        const origin = new URL(baseUrl).origin;
-        url = origin + moduleUrl;
-      } else {
-        // we know separators are '/'
-        const baseUrl = callerSite.substr(0, callerSite.lastIndexOf('/'));
-        url = baseUrl + '/' + moduleUrl;
-      }
+      const baseUrl = callerSite.substring(0, callerSite.lastIndexOf('/'));
+      const url = baseUrl + '/' + moduleUrl;
 
       try {
         const res = await fetch(url);
@@ -92,7 +85,7 @@ const resolveModule = async (moduleUrl) => {
         try {
           // try resolve according to process.cwd()
           absPathname = require.resolve(moduleUrl, { paths: [process.cwd()] });
-        } catch (err) {
+        } catch {
           throw new DOMException(`Failed to execute 'addModule' on 'AudioWorklet': Cannot resolve module ${moduleUrl}`, 'AbortError');
         }
       }
@@ -100,7 +93,7 @@ const resolveModule = async (moduleUrl) => {
   }
 
   return { absPathname, code };
-}
+};
 
 class AudioWorklet {
   #workletId = null;
@@ -200,6 +193,7 @@ class AudioWorklet {
   // For OfflineAudioContext only, check that all processors have been properly
   // created before actual `startRendering`
   async [kCheckProcessorsCreated]() {
+    //  eslint-disable-next-line no-async-promise-executor
     return new Promise(async resolve => {
       while (this.#pendingCreateProcessors.size !== 0) {
         // we need a microtask to ensure message can be received

package/js/AudioWorkletGlobalScope.js

@@ -87,7 +87,7 @@ globalThis[kWorkletRecycleBuffer1] = buffer => pool1.recycle(buffer);
 globalThis[kWorkletMarkAsUntransferable] = obj => {
   markAsUntransferable(obj);
   return obj;
-}
+};
 
 function isIterable(obj) {
   // checks for null and undefined
@@ -101,7 +101,7 @@ function isIterable(obj) {
 function isConstructor(f) {
   try {
     Reflect.construct(String, [], f);
-  } catch (e) {
+  } catch {
     return false;
   }
   return true;
@@ -114,7 +114,7 @@ function runLoop() {
   runLoopImmediateId = setImmediate(runLoop);
 }
 
-globalThis.currentTime = 0
+globalThis.currentTime = 0;
 globalThis.currentFrame = 0;
 globalThis.sampleRate = sampleRate;
 // @todo - implement in upstream crate
@@ -153,7 +153,7 @@ globalThis.AudioWorkletProcessor = class AudioWorkletProcessor {
       this[kWorkletParamsCache][desc.name] = [
         pool128.get(), // should be globalThis.renderQuantumSize
         pool1.get(),
-      ]
+      ];
     });
 
     this.#port = port;
@@ -170,7 +170,7 @@ globalThis.AudioWorkletProcessor = class AudioWorkletProcessor {
   [kWorkletQueueTask](cmd, err) {
     this.#port.postMessage({ cmd, err });
   }
-}
+};
 
 // follow algorithm from:
 // https://webaudio.github.io/web-audio-api/#dom-audioworkletglobalscope-registerprocessor
@@ -300,10 +300,6 @@ globalThis.registerProcessor = function registerProcessor(name, processorCtor) {
 
 parentPort.on('message', async event => {
   switch (event.cmd) {
-    case 'node-web-audio-api:worklet:init': {
-      const { workletId, processors, promiseId } = event;
-      break;
-    }
     case 'node-web-audio-api:worklet:exit': {
       clearImmediate(runLoopImmediateId);
       // properly exit audio worklet on rust side

package/js/AudioWorkletNode.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-unused-vars */
 const conversions = require('webidl-conversions');
 const {
   toSanitizedSequence,
@@ -23,8 +22,6 @@ const {
   ErrorEvent,
 } = require('./Events.js');
 
-/* eslint-enable no-unused-vars */
-
 const AudioNode = require('./AudioNode.js');
 const AudioParamMap = require('./AudioParamMap.js');
 const IMPLEMENTATION_MAX_NUMBER_OF_CHANNELS = 32;
@@ -156,7 +153,7 @@ module.exports = (jsExport, nativeBinding) => {
         // if we delegate this check to Rust, this can poison a Mutex
         // (probably the `audio_param_descriptor_channel` one)
         if (parsedOptions.channelCount <= 0 || parsedOptions.channelCount > IMPLEMENTATION_MAX_NUMBER_OF_CHANNELS) {
-          throw new DOMException(`Failed to construct 'AudioWorkletNode': Invalid 'channelCount' property: Number of channels: ${parsedOptions.channelCount} is outside range [1, 32]`, 'NotSupportedError')
+          throw new DOMException(`Failed to construct 'AudioWorkletNode': Invalid 'channelCount' property: Number of channels: ${parsedOptions.channelCount} is outside range [1, 32]`, 'NotSupportedError');
         }
       }
 

package/js/OfflineAudioContext.js

@@ -138,10 +138,12 @@ module.exports = function patchOfflineAudioContext(jsExport, nativeBinding) {
       // ensure all AudioWorkletProcessor have finished their instanciation
       await this.audioWorklet[kCheckProcessorsCreated]();
 
-      let nativeAudioBuffer;
+      // keep this to highlight the workaround w/ the oncomplete event
+      let _nativeAudioBuffer;
 
       try {
-        nativeAudioBuffer = await this[kNapiObj].startRendering();
+        // eslint-disable-next-line no-unused-vars
+        _nativeAudioBuffer = await this[kNapiObj].startRendering();
       } catch (err) {
         throwSanitizedError(err);
       }

package/load-native.cjs

@@ -1,3 +1,4 @@
+const fs = require('node:fs');
 const { platform, arch } = process;
 
 let nativeBinding = null;
@@ -21,7 +22,7 @@ switch (platform) {
         }
         break;
       default:
-        throw new Error(`Unsupported architecture on Windows: ${arch}`);
+        loadError = new Error(`Unsupported architecture on Windows: ${arch}`);
     }
     break;
   case 'darwin':
@@ -41,11 +42,15 @@ switch (platform) {
         }
         break;
       default:
-        throw new Error(`Unsupported architecture on macOS: ${arch}`);
+        loadError = new Error(`Unsupported architecture on macOS: ${arch}`);
     }
     break;
+  //   case 'freebsd': x64 only
   case 'linux':
     switch (arch) {
+      // @todo
+      // - support riscv64 arch
+      // - support musl C lib
       case 'x64':
         try {
           nativeBinding = require('./node-web-audio-api.linux-x64-gnu.node');
@@ -68,11 +73,20 @@ switch (platform) {
         }
         break;
       default:
-        throw new Error(`Unsupported architecture on Linux: ${arch}`);
+        loadError = new Error(`Unsupported architecture on Linux: ${arch}`);
     }
     break;
   default:
-    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`);
+    loadError = new Error(`Unsupported OS: ${platform}, architecture: ${arch}`);
+}
+
+// use local build if exists
+if (fs.existsSync('node-web-audio-api.build-release.node')) {
+  nativeBinding = require('./node-web-audio-api.build-release.node');
+}
+
+if (fs.existsSync('node-web-audio-api.build-debug.node')) {
+  nativeBinding = require('./node-web-audio-api.build-debug.node');
 }
 
 if (!nativeBinding) {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "node-web-audio-api",
-  "version": "0.21.5",
+  "version": "1.0.0",
   "author": "Benjamin Matuszewski",
-  "description": "Node.js bindings for web-audio-api-rs using napi-rs",
+  "description": "Web Audio API implementation for Node.js",
   "exports": {
     "import": "./index.mjs",
     "require": "./index.cjs",
@@ -21,7 +21,7 @@
     "music",
     "dsp",
     "rust",
-    "n-api"
+    "node-api"
   ],
   "engines": {
     "node": ">= 14"
@@ -35,46 +35,41 @@
     "access": "public"
   },
   "scripts": {
-    "artifacts": "napi artifacts",
-    "build": "npm run generate && napi build --platform --release",
-    "build:jack": "npm run generate && napi build --platform --features jack --release",
-    "build:debug": "npm run generate && napi build --platform",
-    "build:only": "napi build --platform --release",
+    "build": "npm run generate && cargo build --release && node ./.scripts/move-artifact.mjs --release",
+    "build:jack": "npm run generate && cargo build --features jack --release && node ./.scripts/move-artifact.mjs --release",
+    "build:debug": "npm run generate && cargo build && node ./.scripts/move-artifact.mjs",
+    "build:only": "cargo build --release && node ./.scripts/move-artifact.mjs --release",
     "check": "cargo fmt && cargo clippy",
     "generate": "node generator/index.mjs && cargo fmt",
-    "lint": "npx eslint index.cjs index.mjs && npx eslint js/*.js && npx eslint examples/*.mjs",
-    "preversion": "yarn install && npm run generate",
+    "lint": "npx eslint index.cjs index.mjs && npx eslint js/*.js && npx eslint examples/*.js",
+    "preversion": "npm install && npm run generate",
     "postversion": "cargo bump $npm_package_version && git commit -am \"v$npm_package_version\" && node .scripts/check-changelog.mjs",
     "test": "mocha tests/*.spec.mjs",
+    "test:ci": "mocha tests/*.spec.mjs -- --ci",
     "test:only": "mocha",
     "wpt": "npm run build && node ./.scripts/wpt-harness.mjs",
     "wpt:only": "node ./.scripts/wpt-harness.mjs"
   },
   "devDependencies": {
-    "@ircam/eslint-config": "^1.3.0",
-    "@ircam/sc-gettime": "^1.0.0",
-    "@ircam/sc-scheduling": "^0.1.7",
-    "@ircam/sc-utils": "^1.3.3",
+    "@ircam/eslint-config": "^2.0.0",
+    "@ircam/sc-scheduling": "^1.0.0",
+    "@ircam/sc-utils": "^1.9.0",
     "@sindresorhus/slugify": "^2.1.1",
-    "camelcase": "^7.0.1",
-    "chai": "^4.3.7",
+    "camelcase": "^8.0.0",
+    "chai": "^5.1.2",
     "chalk": "^5.3.0",
     "cli-table": "^0.3.11",
-    "commander": "^11.1.0",
+    "commander": "^13.0.0",
     "dotenv": "^16.0.3",
-    "eslint": "^8.57.0",
+    "eslint": "^9.18.0",
     "js-beautify": "^1.15.1",
-    "mocha": "^10.2.0",
-    "node-ssh": "^13.0.0",
-    "octokit": "^2.0.11",
-    "ping": "^0.4.2",
+    "mocha": "^11.0.1",
+    "octokit": "^4.1.0",
     "template-literal": "^1.0.4",
     "webidl2": "^24.2.0",
     "wpt-runner": "^5.0.0"
   },
   "dependencies": {
-    "@napi-rs/cli": "^2.14.3",
-    "@node-rs/helper": "^1.3.3",
     "caller": "^1.1.0",
     "node-fetch": "^3.3.2",
     "webidl-conversions": "^7.0.0"

package/.eslintrc

@@ -1,3 +0,0 @@
-{
-  "extends": "@ircam"
-}

package/all-checks.sh

@@ -1,18 +0,0 @@
-#!/bin/bash
-
-
-echo "-----------------------------------------------"
-echo "> cargo fmt -- --check --color always"
-echo "-----------------------------------------------"
-cargo fmt -- --check --color always
-
-echo "-----------------------------------------------"
-echo "> cargo clippy --all-targets --features cpal -- -D warnings"
-echo "-----------------------------------------------"
-cargo clippy --all-targets --features cpal -- -D warnings
-
-echo "-----------------------------------------------"
-echo "> Run js tests"
-echo "-----------------------------------------------"
-npm run test
-

package/run-wpt.sh

@@ -1,5 +0,0 @@
-#!/bin/bash
-echo $1
-echo ~~~~~~~~~~~~~~~~~
-node ./.scripts/wpt-harness.mjs --filter "$1" 2>&1 | grep -A 3 RESULTS
-echo