tone 15.3.10 → 15.3.11

package/Tone/source/oscillator/Oscillator.test.ts

@@ -1,4 +1,7 @@
-import { expect } from "chai";
+import { expect, use } from "chai";
+import sinon from "sinon";
+import sinonChai from "sinon-chai";
+use(sinonChai);
 
 import { BasicTests } from "../../../test/helper/Basic.js";
 import { CompareToFile } from "../../../test/helper/CompareToFile.js";
@@ -6,6 +9,7 @@ import { Offline } from "../../../test/helper/Offline.js";
 import { OscillatorTests } from "../../../test/helper/OscillatorTests.js";
 import { OutputAudio } from "../../../test/helper/OutputAudio.js";
 import { SourceTests } from "../../../test/helper/SourceTests.js";
+import { Signal } from "../../signal/Signal.js";
 import { Oscillator } from "./Oscillator.js";
 import { ToneOscillatorType } from "./OscillatorInterface.js";
 
@@ -15,6 +19,11 @@ describe("Oscillator", () => {
 	SourceTests(Oscillator);
 	OscillatorTests(Oscillator);
 
+	const sandbox = sinon.createSandbox();
+	afterEach(() => {
+		sandbox.restore();
+	});
+
 	it("matches a file", () => {
 		return CompareToFile(
 			() => {
@@ -27,6 +36,24 @@ describe("Oscillator", () => {
 		);
 	});
 
+	it("cleans up connections after stopping", async () => {
+		const SignalPrototype = Signal.prototype;
+		const connectSpy = sandbox.spy(SignalPrototype, "connect");
+		const disconnectSpy = sandbox.spy(SignalPrototype, "disconnect");
+		await new Promise<void>((done) => {
+			const osc = new Oscillator({
+				onstop: () => done(),
+			}).toDestination();
+			osc.start().stop("+0.05");
+
+			// called with two connections: frequency and detune
+			expect(connectSpy).to.have.been.callCount(2);
+		});
+
+		// called with two disconnections: frequency and detune
+		expect(disconnectSpy).to.have.been.callCount(2);
+	});
+
 	context("Get/Set", () => {
 		it("can be set with an options object", () => {
 			const osc = new Oscillator();

package/Tone/source/oscillator/Oscillator.ts

@@ -138,7 +138,10 @@ export class Oscillator
 		// new oscillator with previous values
 		const oscillator = new ToneOscillatorNode({
 			context: this.context,
-			onended: () => this.onstop(this),
+			onended: () => {
+				this._cleanUpConnections(oscillator);
+				this.onstop(this);
+			},
 		});
 		this._oscillator = oscillator;
 		if (this._wave) {
@@ -155,6 +158,20 @@ export class Oscillator
 		this._oscillator.start(computedTime);
 	}
 
+	/**
+	 * Cleans up the connections to the oscillator for online contexts once it
+	 * has stopped.
+	 */
+	private _cleanUpConnections(oscillator: ToneOscillatorNode): void {
+		if (this.context.isOffline) {
+			return;
+		}
+		// Clean up connections fixes #1379
+		this.frequency.disconnect(oscillator.frequency);
+		this.detune.disconnect(oscillator.detune);
+		oscillator.disconnect();
+	}
+
 	/**
 	 * stop the oscillator
 	 */

package/Tone/version.ts

@@ -1 +1 @@
-export const version: string = "15.3.10";
+export const version: string = "15.3.11";