@stream-io/video-client 1.58.0 → 1.59.0

package/src/helpers/MediaStreamRecorder.ts

@@ -0,0 +1,104 @@
+import { videoLoggerSystem } from '../logger';
+import { promiseWithResolvers } from './promise';
+
+export type MediaStreamRecorderOptions = {
+  /** Auto-stop after this many milliseconds. */
+  maxDurationMs?: number;
+};
+
+export type MediaRecordingResult = {
+  blob: Blob;
+};
+
+/** Single-use `MediaRecorder` wrapper that returns an in-memory blob. */
+export class MediaStreamRecorder {
+  private recording = promiseWithResolvers<MediaRecordingResult | null>();
+  private logger = videoLoggerSystem.getLogger('MediaStreamRecorder');
+  private chunks: Blob[] = [];
+  private timeoutId: ReturnType<typeof setTimeout> | undefined;
+
+  private recorder: MediaRecorder;
+  private readonly tracks: MediaStreamTrack[];
+  private readonly maxDurationMs: number | undefined;
+
+  constructor(stream: MediaStream, options: MediaStreamRecorderOptions = {}) {
+    if (typeof MediaRecorder === 'undefined') {
+      throw new Error('MediaRecorder is not available in this environment');
+    }
+
+    this.tracks = stream.getTracks();
+    if (this.tracks.length === 0) {
+      throw new Error('cannot record a MediaStream that has no tracks');
+    }
+
+    this.maxDurationMs = options.maxDurationMs;
+    this.recorder = new MediaRecorder(new MediaStream(this.tracks));
+
+    this.recorder.ondataavailable = (event: BlobEvent) => {
+      if (event.data?.size) this.chunks.push(event.data);
+    };
+
+    this.recorder.onstop = this.handleStop;
+    this.recorder.onerror = this.handleError;
+  }
+
+  /** Starts recording and resolves when recording stops. */
+  start = (): Promise<MediaRecordingResult | null> => {
+    if (this.isSettled()) {
+      throw new Error(
+        'MediaStreamRecorder is single-use: this instance has already ' +
+          'recorded. Construct a new one.',
+      );
+    }
+
+    if (this.recorder.state === 'inactive') {
+      this.tracks.forEach((track) =>
+        track.addEventListener('ended', this.stop),
+      );
+      if (this.maxDurationMs !== undefined) {
+        this.timeoutId = setTimeout(this.stop, this.maxDurationMs);
+      }
+      this.recorder.start();
+    }
+
+    return this.recording.promise;
+  };
+
+  /** Stops recording early. */
+  stop = (): void => {
+    if (this.recorder.state !== 'inactive') this.recorder.stop();
+  };
+
+  private isSettled = () =>
+    this.recording.isResolved() || this.recording.isRejected();
+
+  private detach = () => {
+    clearTimeout(this.timeoutId);
+    this.tracks.forEach((track) =>
+      track.removeEventListener('ended', this.stop),
+    );
+  };
+
+  private handleStop = () => {
+    this.detach();
+
+    if (this.chunks.length === 0) {
+      this.logger.warn('MediaRecorder recording produced no data');
+      this.recording.resolve(null);
+      return;
+    }
+
+    const mimeType = this.chunks[0].type || this.recorder.mimeType;
+    this.recording.resolve({
+      blob: new Blob(this.chunks, { type: mimeType }),
+    });
+  };
+
+  private handleError = (event: Event) => {
+    if (this.isSettled()) return;
+    this.detach();
+    const error = (event as unknown as { error?: DOMException }).error;
+    this.logger.error('MediaRecorder error', error);
+    this.recording.reject(error ?? new Error('MediaRecorder failed'));
+  };
+}

package/src/helpers/__tests__/MediaStreamRecorder.test.ts

@@ -0,0 +1,324 @@
+/**
+ * @vitest-environment happy-dom
+ */
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { fromPartial } from '@total-typescript/shoehorn';
+import { MediaStreamRecorder } from '../MediaStreamRecorder';
+import { videoLoggerSystem } from '../../logger';
+
+const createTrack = (kind: 'audio' | 'video' = 'video') => {
+  const events = new EventTarget();
+  return fromPartial<MediaStreamTrack>({
+    kind,
+    id: `${kind}-track`,
+    readyState: 'live',
+    stop: vi.fn(),
+    addEventListener: events.addEventListener.bind(events),
+    removeEventListener: events.removeEventListener.bind(events),
+    dispatchEvent: events.dispatchEvent.bind(events),
+  });
+};
+
+class FakeMediaStream {
+  private tracks: MediaStreamTrack[];
+
+  constructor(tracks: MediaStreamTrack[] = []) {
+    this.tracks = [...tracks];
+  }
+
+  getTracks = () => [...this.tracks];
+  addTrack = (track: MediaStreamTrack) => this.tracks.push(track);
+}
+
+const createStream = (...tracks: MediaStreamTrack[]) =>
+  new FakeMediaStream(tracks) as unknown as MediaStream;
+
+class FakeMediaRecorder {
+  static instances: FakeMediaRecorder[] = [];
+  static isTypeSupported = vi.fn(() => true);
+
+  stream: MediaStream;
+  options: MediaRecorderOptions | undefined;
+  state: 'inactive' | 'recording' | 'paused' = 'inactive';
+  mimeType: string;
+  ondataavailable: ((event: BlobEvent) => void) | null = null;
+  onstop: (() => void) | null = null;
+  onerror: ((event: Event) => void) | null = null;
+
+  finalChunks: Blob[] = [new Blob(['payload'], { type: 'video/webm' })];
+
+  constructor(stream: MediaStream, options?: MediaRecorderOptions) {
+    this.stream = stream;
+    this.options = options;
+    this.mimeType = options?.mimeType ?? 'video/webm;codecs=vp8,opus';
+    FakeMediaRecorder.instances.push(this);
+  }
+
+  start = vi.fn(() => {
+    this.state = 'recording';
+  });
+
+  stop = vi.fn(() => {
+    if (this.state === 'inactive') return;
+    this.state = 'inactive';
+    this.finalChunks.forEach((data) => this.emitData(data));
+    this.onstop?.();
+  });
+
+  emitData = (data: Blob) => {
+    this.ondataavailable?.(fromPartial<BlobEvent>({ data }));
+  };
+}
+
+const lastRecorder = () =>
+  FakeMediaRecorder.instances[FakeMediaRecorder.instances.length - 1];
+
+describe('MediaStreamRecorder', () => {
+  let logger: { debug: any; warn: any; error: any };
+
+  beforeEach(() => {
+    FakeMediaRecorder.instances = [];
+    vi.stubGlobal('MediaRecorder', FakeMediaRecorder);
+    vi.stubGlobal('MediaStream', FakeMediaStream);
+    logger = { debug: vi.fn(), warn: vi.fn(), error: vi.fn() };
+    vi.spyOn(videoLoggerSystem, 'getLogger').mockReturnValue(
+      fromPartial(logger),
+    );
+  });
+
+  afterEach(() => {
+    vi.unstubAllGlobals();
+    vi.restoreAllMocks();
+    vi.useRealTimers();
+  });
+
+  describe('construction', () => {
+    it('throws when MediaRecorder is unavailable', () => {
+      vi.stubGlobal('MediaRecorder', undefined);
+      expect(
+        () => new MediaStreamRecorder(createStream(createTrack())),
+      ).toThrow(/MediaRecorder is not available/);
+    });
+
+    it('throws when the stream has no tracks', () => {
+      expect(() => new MediaStreamRecorder(createStream())).toThrow(
+        /has no tracks/,
+      );
+    });
+
+    it('lets the browser choose the recording MIME type', () => {
+      new MediaStreamRecorder(createStream(createTrack()));
+
+      expect(lastRecorder().options).toBeUndefined();
+    });
+
+    it('does not start recording until `start` is called', () => {
+      new MediaStreamRecorder(createStream(createTrack()));
+
+      expect(lastRecorder().start).not.toHaveBeenCalled();
+    });
+
+    it('creates no DOM elements of its own', () => {
+      const recorder = new MediaStreamRecorder(createStream(createTrack()));
+      recorder.start();
+      expect(document.querySelectorAll('video, audio')).toHaveLength(0);
+    });
+
+    it('records a snapshot, so mutating the caller stream cannot disturb it', () => {
+      const track = createTrack();
+      const stream = createStream(track);
+      new MediaStreamRecorder(stream);
+
+      stream.addTrack(createTrack('audio'));
+
+      expect(lastRecorder().stream).not.toBe(stream);
+      expect(lastRecorder().stream.getTracks()).toEqual([track]);
+    });
+  });
+
+  describe('recording', () => {
+    it('resolves with the recorded blob', async () => {
+      vi.useFakeTimers();
+      const recorder = new MediaStreamRecorder(createStream(createTrack()));
+
+      const recording = recorder.start();
+      vi.advanceTimersByTime(2500);
+      recorder.stop();
+
+      const result = await recording;
+
+      expect(result?.blob.size).toBeGreaterThan(0);
+      expect(result?.blob.type).toBe('video/webm');
+    });
+
+    it('hands every awaiter of `start` the same result', async () => {
+      const recorder = new MediaStreamRecorder(createStream(createTrack()));
+
+      const first = recorder.start();
+      const second = recorder.start();
+      recorder.stop();
+
+      expect(await first).toBe(await second);
+      expect(lastRecorder().start).toHaveBeenCalledTimes(1);
+    });
+
+    it('sets the blob type from the recorder when the chunk carries none', async () => {
+      const recorder = new MediaStreamRecorder(createStream(createTrack()));
+      lastRecorder().finalChunks = [new Blob(['payload'])];
+
+      const recording = recorder.start();
+      recorder.stop();
+
+      expect((await recording)?.blob.type).toBe('video/webm;codecs=vp8,opus');
+    });
+
+    it('keeps chunks that arrive before stop', async () => {
+      const recorder = new MediaStreamRecorder(createStream(createTrack()));
+      const recording = recorder.start();
+      lastRecorder().emitData(new Blob(['early'], { type: 'video/webm' }));
+
+      recorder.stop();
+
+      expect((await recording)?.blob.size).toBe(12);
+    });
+
+    it('ignores empty chunks', async () => {
+      const recorder = new MediaStreamRecorder(createStream(createTrack()));
+      const recording = recorder.start();
+      lastRecorder().emitData(new Blob([]));
+      lastRecorder().finalChunks = [];
+
+      recorder.stop();
+
+      await expect(recording).resolves.toBeNull();
+    });
+
+    it('resolves null and warns when nothing was captured', async () => {
+      const recorder = new MediaStreamRecorder(createStream(createTrack()));
+      lastRecorder().finalChunks = [];
+
+      const recording = recorder.start();
+      recorder.stop();
+
+      await expect(recording).resolves.toBeNull();
+      expect(logger.warn).toHaveBeenCalledWith(
+        expect.stringContaining('recording produced no data'),
+      );
+    });
+
+    it('never stops the tracks it was handed', async () => {
+      const track = createTrack();
+      const recorder = new MediaStreamRecorder(createStream(track));
+
+      const recording = recorder.start();
+      recorder.stop();
+      await recording;
+
+      expect(track.stop).not.toHaveBeenCalled();
+    });
+  });
+
+  describe('auto-stop', () => {
+    it('stops once maxDurationMs elapses', async () => {
+      vi.useFakeTimers();
+      const recorder = new MediaStreamRecorder(createStream(createTrack()), {
+        maxDurationMs: 5000,
+      });
+
+      const recording = recorder.start();
+      vi.advanceTimersByTime(5000);
+
+      await expect(recording).resolves.toMatchObject({
+        blob: expect.any(Blob),
+      });
+    });
+
+    it('runs indefinitely when maxDurationMs is omitted', async () => {
+      vi.useFakeTimers();
+      const recorder = new MediaStreamRecorder(createStream(createTrack()));
+
+      const recording = recorder.start();
+      vi.advanceTimersByTime(10 * 60 * 1000);
+
+      expect(lastRecorder().stop).not.toHaveBeenCalled();
+      recorder.stop();
+      await recording;
+    });
+
+    it('stops when any source track ends, keeping what was captured', async () => {
+      const audioTrack = createTrack('audio');
+      const recorder = new MediaStreamRecorder(
+        createStream(createTrack(), audioTrack),
+      );
+
+      const recording = recorder.start();
+      audioTrack.dispatchEvent(new Event('ended'));
+
+      await expect(recording).resolves.toMatchObject({
+        blob: expect.any(Blob),
+      });
+    });
+
+    it('resolves when the user agent stops the recorder on its own', async () => {
+      const recorder = new MediaStreamRecorder(createStream(createTrack()));
+      const recording = recorder.start();
+
+      lastRecorder().stop();
+
+      await expect(recording).resolves.toMatchObject({
+        blob: expect.any(Blob),
+      });
+    });
+  });
+
+  describe('lifecycle guards', () => {
+    it('is a no-op when stopped before it was started', () => {
+      const recorder = new MediaStreamRecorder(createStream(createTrack()));
+
+      expect(() => recorder.stop()).not.toThrow();
+      expect(lastRecorder().stop).not.toHaveBeenCalled();
+      expect(lastRecorder().start).not.toHaveBeenCalled();
+    });
+
+    it('throws when restarted after finishing', async () => {
+      const recorder = new MediaStreamRecorder(createStream(createTrack()));
+      const recording = recorder.start();
+      recorder.stop();
+      await recording;
+
+      expect(() => recorder.start()).toThrow(/single-use/);
+    });
+
+    it('is idempotent across repeated stops', async () => {
+      const recorder = new MediaStreamRecorder(createStream(createTrack()));
+      const recording = recorder.start();
+
+      recorder.stop();
+      recorder.stop();
+
+      await expect(recording).resolves.toMatchObject({
+        blob: expect.any(Blob),
+      });
+      expect(lastRecorder().stop).toHaveBeenCalledTimes(1);
+    });
+  });
+
+  it('leaves no timer or listener behind after finishing', async () => {
+    vi.useFakeTimers();
+    const track = createTrack();
+    const recorder = new MediaStreamRecorder(createStream(track), {
+      maxDurationMs: 5000,
+    });
+
+    const recording = recorder.start();
+    recorder.stop();
+    const result = await recording;
+
+    expect(() => {
+      vi.advanceTimersByTime(10_000);
+      track.dispatchEvent(new Event('ended'));
+    }).not.toThrow();
+    expect(lastRecorder().stop).toHaveBeenCalledTimes(1);
+    expect(result?.blob).toBeInstanceOf(Blob);
+  });
+});

package/src/helpers/__tests__/concurrency.test.ts

@@ -1,6 +1,7 @@
 import { beforeEach, describe, expect, it } from 'vitest';
 import {
   hasPending,
+  singleFlight,
   withCancellation,
   withoutConcurrency,
 } from '../concurrency';
@@ -168,6 +169,79 @@ it('keeps track of pending promises', async () => {
   expect(hasPending(tag)).toBeFalsy();
 });
 
+describe('single flight', () => {
+  it('shares an in-flight promise for the wrapped function', async () => {
+    const [run1, resolve1] = mockAsyncFn('promise1');
+    const run = singleFlight(run1);
+
+    const ready1 = run();
+    const ready2 = run();
+
+    expect(ready2).toBe(ready1);
+    expect(log).toMatchObject(['promise1 start']);
+
+    resolve1();
+    await expect(Promise.all([ready1, ready2])).resolves.toEqual([
+      undefined,
+      undefined,
+    ]);
+    expect(log).toMatchObject(['promise1 start', 'promise1 end']);
+  });
+
+  it('allows a new execution after the in-flight promise settles', async () => {
+    const [run1, resolve1] = mockAsyncFn('promise1');
+    const run = singleFlight(run1);
+
+    const ready1 = run();
+    resolve1();
+    await ready1;
+
+    const ready2 = run();
+    expect(ready2).not.toBe(ready1);
+
+    resolve1();
+    await ready2;
+    expect(log).toMatchObject([
+      'promise1 start',
+      'promise1 end',
+      'promise1 start',
+      'promise1 end',
+    ]);
+  });
+
+  it('does not share promises across different wrapped functions', async () => {
+    const [runTom, resolveTom] = mockAsyncFn('tom');
+    const [runJerry, resolveJerry] = mockAsyncFn('jerry');
+    const tom = singleFlight(runTom);
+    const jerry = singleFlight(runJerry);
+
+    const readyTom = tom();
+    const readyJerry = jerry();
+
+    expect(readyJerry).not.toBe(readyTom);
+    expect(log).toMatchObject(['tom start', 'jerry start']);
+
+    resolveTom();
+    resolveJerry();
+    await Promise.all([readyTom, readyJerry]);
+  });
+
+  it('shares the first call arguments while a call is in flight', async () => {
+    const run = singleFlight(async (value: string) => {
+      log.push(`${value} start`);
+      await new Promise<void>((resolve) => setTimeout(resolve, 0));
+      log.push(`${value} end`);
+      return value;
+    });
+
+    await expect(Promise.all([run('first'), run('second')])).resolves.toEqual([
+      'first',
+      'first',
+    ]);
+    expect(log).toMatchObject(['first start', 'first end']);
+  });
+});
+
 describe('cancelation', () => {
   it('cancels promises mid-action', async () => {
     const tag = Symbol();