node-web-audio-api 0.21.1 → 0.21.3

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# CHANGELOG
+
+## v0.21.3 (06/10/2024)
+
+- Fix typescript export
+
+## v0.21.2 (20/09/2024)
+
+- Update upstream crate to [v1.0.1](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-101-2024-09-18)
+- Fix: Make sure `AudioBuffer` returned by `OfflineContext` is valid
+- Fix: Allow contexts to be properly garbage collected
+
 ## v0.21.1 (10/06/2024)
 
 - Feat: Buffer pool for AudioWorketProcessor
@@ -92,7 +104,7 @@
 ## v0.5.0 (19/12/2022)
 
 - Implement AudioParam#setValueCurveAtTime
-- Offline context constructor 
+- Offline context constructor
 
 ## v0.4.0 (07/11/2022)
 

package/all-checks.sh

@@ -0,0 +1,18 @@
+#!/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/js/AudioContext.js

@@ -104,7 +104,7 @@ module.exports = function(jsExport, nativeBinding) {
       // object after its instantiation, and that we don't have any initial `resume` call.
       this[kNapiObj].listen_to_events();
 
-      // @todo - check if this is still required
+      // @todo - This is probably not requested anymore as the event listeners
       // prevent garbage collection and process exit
       const id = contextId++;
       // store in process to prevent garbage collection

package/js/AudioWorklet.js

@@ -64,7 +64,7 @@ const resolveModule = async (moduleUrl) => {
     // get caller site from error stack trace
     const callerSite = caller(2);
 
-    if (callerSite.startsWith('http')) {
+    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('/')) {

package/js/OfflineAudioContext.js

@@ -82,24 +82,25 @@ module.exports = function patchOfflineAudioContext(jsExport, nativeBinding) {
 
       // Add function to Napi object to bridge from Rust events to JS EventTarget
       // They will be effectively registered on rust side when `startRendering` is called
-      this[kNapiObj][kOnStateChange] = (function(err, rawEvent) {
+      this[kNapiObj][kOnStateChange] = (function(_err, rawEvent) {
         const event = new Event(rawEvent.type);
         propagateEvent(this, event);
       }).bind(this);
 
       // This event is, per spec, the last trigerred one
       this[kNapiObj][kOnComplete] = (function(err, rawEvent) {
-        // workaround the fact that this event seems to be triggered before
+        // workaround the fact that the oncomplete event is triggered before
         // startRendering fulfills and that we want to return the exact same instance
-        if (this.#renderedBuffer === null) {
-          this.#renderedBuffer = new jsExport.AudioBuffer({ [kNapiObj]: rawEvent.renderedBuffer });
-        }
+        this.#renderedBuffer = new jsExport.AudioBuffer({ [kNapiObj]: rawEvent.renderedBuffer });
 
         const event = new jsExport.OfflineAudioCompletionEvent(rawEvent.type, {
           renderedBuffer: this.#renderedBuffer,
         });
 
-        propagateEvent(this, event);
+        // delay event propagation to next tick that it is executed after startRendering fulfills
+        setImmediate(() => {
+          propagateEvent(this, event);
+        }, 0);
       }).bind(this);
     }
 
@@ -145,15 +146,9 @@ module.exports = function patchOfflineAudioContext(jsExport, nativeBinding) {
         throwSanitizedError(err);
       }
 
-      // release audio worklet, if any
+      // release audio worklets
       await this.audioWorklet[kWorkletRelease]();
 
-      // workaround the fact that this event seems to be triggered before
-      // startRendering fulfills and that we want to return the exact same instance
-      if (this.#renderedBuffer === null) {
-        this.#renderedBuffer = new jsExport.AudioBuffer({ [kNapiObj]: nativeAudioBuffer });
-      }
-
       return this.#renderedBuffer;
     }
 

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "node-web-audio-api",
-  "version": "0.21.1",
+  "version": "0.21.3",
   "author": "Benjamin Matuszewski",
   "description": "Node.js bindings for web-audio-api-rs using napi-rs",
   "exports": {
     "import": "./index.mjs",
-    "require": "./index.cjs"
+    "require": "./index.cjs",
+    "types": "./index.d.ts"
   },
   "repository": {
     "type": "git",
@@ -44,7 +45,8 @@
     "lint": "npx eslint index.cjs index.mjs && npx eslint js/*.js && npx eslint examples/*.mjs",
     "preversion": "yarn 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",
+    "test": "mocha tests/*.spec.mjs",
+    "test:only": "mocha",
     "wpt": "npm run build && node ./.scripts/wpt-harness.mjs",
     "wpt:only": "node ./.scripts/wpt-harness.mjs"
   },