Open source Loom alternative. Beautiful, shareable screen recordings.
Rust appcapcossloommacnextjsnextjs15open-sourceossreactrecordrustscreen-capturescreen-recorderscreenshotsolidjstauritauri-apptypescriptvite
fix(sdk-recorder): isolate canceled recording stops
Akshar Pateld937565cf3bc
diff --git a/packages/sdk-recorder/__tests__/capture-release.test.ts b/packages/sdk-recorder/__tests__/capture-release.test.tsindex 1e2a58345..58486ac9a 100644--- a/packages/sdk-recorder/__tests__/capture-release.test.ts+++ b/packages/sdk-recorder/__tests__/capture-release.test.ts@@ -3,6 +3,7 @@ import { CapRecorder } from "../src/index";class Track {readyState: MediaStreamTrackState = "live";+ onended: (() => void) | null = null;constructor(readonly kind: "video" | "audio") {}stop() {this.readyState = "ended";@@ -23,9 +24,14 @@ class Stream {}class Encoder {+ static latest: Encoder;state: RecordingState = "inactive";+ stopGate: Promise<void> | null = null;ondataavailable: ((event: { data: Blob }) => void) | null = null;onstop: (() => void) | null = null;+ constructor() {+ Encoder.latest = this;+ }static isTypeSupported() {return true;}@@ -39,10 +45,12 @@ class Encoder {stop() {if (this.state === "inactive") return;this.state = "inactive";- queueMicrotask(() => {+ const finish = () => {this.ondataavailable?.({ data: new Blob(["final recording bytes"]) });this.onstop?.();- });+ };+ if (this.stopGate) this.stopGate.then(finish);+ else queueMicrotask(finish);}}@@ -141,3 +149,119 @@ test.each(["recording", "paused", "upload failure"] as const)(}},);++test.each(["explicit replacement", "source-ended replacement", "destroy only"])(+ "destroy cancels a pending encoder stop: %s",+ async (scenario) => {+ const oldDisplay = new Track("video");+ const oldMicrophone = new Track("audio");+ const display = new Track("video");+ const microphone = new Track("audio");+ const gate = Promise.withResolvers<void>();+ const requests: string[] = [];+ const uploaded: string[] = [];+ const phases: string[] = [];+ const errors: Error[] = [];+ const completed: string[] = [];+ let displayRequests = 0;+ let microphoneRequests = 0;+ for (const [name, value] of Object.entries({+ navigator: {+ mediaDevices: {+ getDisplayMedia: async () =>+ new Stream([displayRequests++ === 0 ? oldDisplay : display]),+ getUserMedia: async () =>+ new Stream([+ microphoneRequests++ === 0 ? oldMicrophone : microphone,+ ]),+ },+ },+ fetch: async (input: string, init?: RequestInit) => {+ requests.push(input);+ if (input.endsWith("/videos/create")) {+ return Response.json({+ videoId: "replacement",+ shareUrl: "https://fixture.invalid/s/replacement",+ embedUrl: "https://fixture.invalid/embed/replacement",+ });+ }+ if (input.endsWith("/initiate")) {+ return Response.json({ uploadId: "upload" });+ }+ if (input.endsWith("/presign-part")) {+ return Response.json({+ presignedUrl: "https://fixture.invalid/part",+ });+ }+ if (input === "https://fixture.invalid/part") {+ uploaded.push(await new Response(init?.body).text());+ return new Response(null, { headers: { ETag: "fixture-etag" } });+ }+ if (input.endsWith("/complete")) {+ return Response.json({ success: true });+ }+ throw new Error(`Unexpected request ${input}`);+ },+ })) {+ Object.defineProperty(globalThis, name, { configurable: true, value });+ }+ const recorder = new CapRecorder({+ publicKey: "fixture",+ camera: { enabled: false },+ });+ recorder.on("phasechange", ({ phase }) => phases.push(phase));+ recorder.on("error", ({ error }) => errors.push(error));+ recorder.on("complete", ({ videoId }) => completed.push(videoId));+ let stopping: Promise<unknown> | undefined;+ try {+ await recorder.start();+ Encoder.latest.stopGate = gate.promise;+ if (scenario === "source-ended replacement") oldDisplay.onended?.();+ else stopping = recorder.stop().catch((error: unknown) => error);+ expect(recorder.phase).toBe("stopping");+ expect(requests).toEqual([]);+ recorder.destroy();+ expect(oldDisplay.readyState).toBe("ended");+ expect(oldMicrophone.readyState).toBe("ended");+ if (scenario !== "destroy only") await recorder.start();+ const phasesBeforeFinalData = [...phases];+ gate.resolve();+ await new Promise<void>((resolve) => setImmediate(resolve));+ if (scenario !== "destroy only") {+ expect(display.readyState).toBe("live");+ expect(microphone.readyState).toBe("live");+ }+ expect(recorder.phase).toBe(+ scenario === "destroy only" ? "idle" : "recording",+ );+ expect(phases).toEqual(phasesBeforeFinalData);+ expect(requests).toEqual([]);+ expect(errors).toEqual([]);+ expect(completed).toEqual([]);+ if (stopping) {+ expect(await stopping).toMatchObject({+ name: "AbortError",+ message: "Recording was canceled",+ });+ }+ if (scenario === "destroy only") return;+ oldDisplay.onended?.();+ await new Promise<void>((resolve) => setImmediate(resolve));+ expect(recorder.phase).toBe("recording");+ expect(requests).toEqual([]);+ stopping = recorder.stop();+ await expect(stopping).resolves.toMatchObject({ videoId: "replacement" });+ expect(uploaded).toEqual(["recording bytesfinal recording bytes"]);+ expect(completed).toEqual(["replacement"]);+ expect(errors).toEqual([]);+ expect(display.readyState).toBe("ended");+ expect(microphone.readyState).toBe("ended");+ expect(recorder.phase).toBe("complete");+ } finally {+ gate.resolve();+ await stopping?.catch(() => {});+ recorder.destroy();+ await new Promise<void>((resolve) => setImmediate(resolve));+ }+ },+);diff --git a/packages/sdk-recorder/src/index.ts b/packages/sdk-recorder/src/index.tsindex a08ea9571..83f44f3c0 100644--- a/packages/sdk-recorder/src/index.ts+++ b/packages/sdk-recorder/src/index.ts@@ -155,17 +155,25 @@ export class CapRecorder {this.chunks = [];this.recorder.ondataavailable = (e) => {- if (e.data.size > 0) {+ if (this.recorder === recorder && e.data.size > 0) {this.chunks.push(e.data);}};+ const stop = () => {+ if (this.recorder !== recorder) return;+ this.stop().catch((error: unknown) => {+ if (error instanceof DOMException && error.name === "AbortError") {+ return;+ }+ console.error("CapRecorder: failed to stop recording:", error);+ });+ };+if (this.streams.display) {const videoTrack = this.streams.display.getVideoTracks()[0];if (videoTrack) {- videoTrack.onended = () => {- this.stop();- };+ videoTrack.onended = stop;}}@@ -173,9 +181,7 @@ export class CapRecorder {this.accumulatedMs = 0;this.lastResumeTime = Date.now();this.startDurationTimer();- this.maxDurationTimeout = setTimeout(() => {- this.stop();- }, maxDurationMs);+ this.maxDurationTimeout = setTimeout(stop, maxDurationMs);this.setPhase("recording");} catch (error) {if (startup.signal.aborted) return;@@ -212,18 +218,22 @@ export class CapRecorder {throw new Error(`Cannot stop from phase "${this._phase}"`);}+ const recorder = this.recorder;+ const streams = this.streams;+ const stopped = this.recordingStopped;this._durationMs =this.accumulatedMs +(this._phase === "recording" ? Date.now() - this.lastResumeTime : 0);this.setPhase("stopping");this.stopDurationTimer();- const recorder = this.recorder;- const stopped = this.recordingStopped;if (recorder.state !== "inactive") recorder.stop();await stopped;- if (this.streams) {- releaseStreams(this.streams);+ if (this.recorder !== recorder) {+ throw new DOMException("Recording was canceled", "AbortError");+ }+ if (streams) {+ releaseStreams(streams);this.streams = null;}return this.uploadRecording();