@stream-io/video-client 1.57.0 → 1.59.0

package/src/gen/video/sfu/models/models.ts

@@ -40,6 +40,14 @@ export interface CallState {
    * @generated from protobuf field: repeated stream.video.sfu.models.Pin pins = 4;
    */
   pins: Pin[];
+  /**
+   * e2ee_enabled is true when the call uses end-to-end encryption. Clients
+   * must enable their frame encryptor; the SFU forwards encrypted frames
+   * opaquely and server-side recording/transcription/broadcasting are disabled.
+   *
+   * @generated from protobuf field: bool e2ee_enabled = 5 [json_name = "e2eeEnabled"];
+   */
+  e2EeEnabled: boolean;
 }
 /**
  * @generated from protobuf message stream.video.sfu.models.ParticipantCount
@@ -1401,6 +1409,13 @@ class CallState$Type extends MessageType<CallState> {
         repeat: 2 /*RepeatType.UNPACKED*/,
         T: () => Pin,
       },
+      {
+        no: 5,
+        name: 'e2ee_enabled',
+        kind: 'scalar',
+        jsonName: 'e2eeEnabled',
+        T: 8 /*ScalarType.BOOL*/,
+      },
     ]);
   }
 }

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/TypedEventEmitter.ts

@@ -0,0 +1,71 @@
+import { ScopedLogger, videoLoggerSystem } from '../logger';
+
+export type EventMap = Record<string, unknown>;
+
+export type Listener<P> = (payload: P) => void | Promise<void>;
+
+/**
+ * Tiny, type-safe event emitter.
+ *
+ * Usage styles:
+ * - compose: `private readonly events = new TypedEventEmitter<MyMap>()`
+ * - extend:  `class Foo extends TypedEventEmitter<MyMap> {}`
+ *
+ * Listener exceptions (sync throw or rejected promise) are caught and logged,
+ * so one bad listener cannot break dispatch for the rest.
+ */
+export class TypedEventEmitter<M extends EventMap> {
+  protected readonly logger: ScopedLogger;
+  private readonly byEvent = new Map<keyof M, Set<Listener<any>>>();
+
+  constructor(logger: ScopedLogger | string = 'TypedEventEmitter') {
+    this.logger =
+      typeof logger === 'string' ? videoLoggerSystem.getLogger(logger) : logger;
+  }
+
+  on = <E extends keyof M>(event: E, fn: Listener<M[E]>): (() => void) => {
+    let listeners = this.byEvent.get(event);
+    if (!listeners) {
+      listeners = new Set();
+      this.byEvent.set(event, listeners);
+    }
+    listeners.add(fn as Listener<any>);
+    return () => this.off(event, fn);
+  };
+
+  off = <E extends keyof M>(event: E, fn: Listener<M[E]>): void => {
+    const listeners = this.byEvent.get(event);
+    if (!listeners) return;
+    listeners.delete(fn as Listener<any>);
+    if (listeners.size === 0) this.byEvent.delete(event);
+  };
+
+  emit = <E extends keyof M>(event: E, payload: M[E]): void => {
+    const listeners = this.byEvent.get(event);
+    if (!listeners || listeners.size === 0) return;
+    for (const listener of [...listeners]) {
+      this.invoke(() => listener(payload), event);
+    }
+  };
+
+  removeAllListeners = (event?: keyof M): void => {
+    if (event === undefined) {
+      this.byEvent.clear();
+    } else {
+      this.byEvent.delete(event);
+    }
+  };
+
+  private invoke = (run: () => void | Promise<void>, event: keyof M): void => {
+    try {
+      const result = run();
+      if (result && typeof (result as Promise<void>).then === 'function') {
+        (result as Promise<void>).catch((err) => {
+          this.logger.warn(`Listener for '${String(event)}' rejected`, err);
+        });
+      }
+    } catch (err) {
+      this.logger.warn(`Listener for '${String(event)}' threw`, err);
+    }
+  };
+}

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__/TypedEventEmitter.test.ts

@@ -0,0 +1,133 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { TypedEventEmitter } from '../TypedEventEmitter';
+
+type TestEvents = {
+  hello: string;
+  ping: { n: number };
+  empty: undefined;
+};
+
+describe('TypedEventEmitter', () => {
+  let emitter: TypedEventEmitter<TestEvents>;
+
+  beforeEach(() => {
+    emitter = new TypedEventEmitter<TestEvents>();
+  });
+
+  it('invokes listeners registered with on()', () => {
+    const listener = vi.fn();
+    emitter.on('hello', listener);
+    emitter.emit('hello', 'world');
+    expect(listener).toHaveBeenCalledWith('world');
+  });
+
+  it('returns an unsubscribe function from on()', () => {
+    const listener = vi.fn();
+    const unsubscribe = emitter.on('hello', listener);
+    unsubscribe();
+    emitter.emit('hello', 'world');
+    expect(listener).not.toHaveBeenCalled();
+  });
+
+  it('removes listeners via off()', () => {
+    const listener = vi.fn();
+    emitter.on('hello', listener);
+    emitter.off('hello', listener);
+    emitter.emit('hello', 'world');
+    expect(listener).not.toHaveBeenCalled();
+  });
+
+  it('supports multiple listeners for the same event', () => {
+    const a = vi.fn();
+    const b = vi.fn();
+    emitter.on('ping', a);
+    emitter.on('ping', b);
+    emitter.emit('ping', { n: 1 });
+    expect(a).toHaveBeenCalledWith({ n: 1 });
+    expect(b).toHaveBeenCalledWith({ n: 1 });
+  });
+
+  it('deduplicates identical listener references', () => {
+    const listener = vi.fn();
+    emitter.on('hello', listener);
+    emitter.on('hello', listener);
+    emitter.emit('hello', 'once');
+    expect(listener).toHaveBeenCalledTimes(1);
+  });
+
+  it('isolates a throwing listener from subsequent listeners', () => {
+    const bad = vi.fn(() => {
+      throw new Error('boom');
+    });
+    const good = vi.fn();
+    emitter.on('hello', bad);
+    emitter.on('hello', good);
+    expect(() => emitter.emit('hello', 'world')).not.toThrow();
+    expect(bad).toHaveBeenCalled();
+    expect(good).toHaveBeenCalledWith('world');
+  });
+
+  it('isolates a rejecting async listener', async () => {
+    const rejected = vi.fn(async () => {
+      throw new Error('async boom');
+    });
+    const good = vi.fn();
+    emitter.on('hello', rejected);
+    emitter.on('hello', good);
+    expect(() => emitter.emit('hello', 'world')).not.toThrow();
+    expect(good).toHaveBeenCalled();
+    // allow microtask to settle; rejection should have been swallowed by the emitter
+    await Promise.resolve();
+  });
+
+  it('is safe to call off() from within a listener (current emit still fires siblings)', () => {
+    const sibling = vi.fn();
+    const self = vi.fn(() => {
+      emitter.off('hello', self);
+    });
+    emitter.on('hello', self);
+    emitter.on('hello', sibling);
+    emitter.emit('hello', 'world');
+    expect(self).toHaveBeenCalledTimes(1);
+    expect(sibling).toHaveBeenCalledTimes(1);
+    // second emit should not invoke self again
+    emitter.emit('hello', 'again');
+    expect(self).toHaveBeenCalledTimes(1);
+    expect(sibling).toHaveBeenCalledTimes(2);
+  });
+
+  it('is safe to add a listener from within a listener (added listener does not fire in current emit)', () => {
+    const later = vi.fn();
+    emitter.on('hello', () => {
+      emitter.on('hello', later);
+    });
+    emitter.emit('hello', 'first');
+    expect(later).not.toHaveBeenCalled();
+    emitter.emit('hello', 'second');
+    expect(later).toHaveBeenCalledWith('second');
+  });
+
+  it('removeAllListeners() clears every subscription when called without args', () => {
+    const a = vi.fn();
+    const b = vi.fn();
+    emitter.on('hello', a);
+    emitter.on('ping', b);
+    emitter.removeAllListeners();
+    emitter.emit('hello', 'world');
+    emitter.emit('ping', { n: 1 });
+    expect(a).not.toHaveBeenCalled();
+    expect(b).not.toHaveBeenCalled();
+  });
+
+  it('removeAllListeners(event) clears only that event', () => {
+    const a = vi.fn();
+    const b = vi.fn();
+    emitter.on('hello', a);
+    emitter.on('ping', b);
+    emitter.removeAllListeners('hello');
+    emitter.emit('hello', 'world');
+    emitter.emit('ping', { n: 1 });
+    expect(a).not.toHaveBeenCalled();
+    expect(b).toHaveBeenCalledWith({ n: 1 });
+  });
+});