feat: Add UI optional UI locking when microphone is hot (#2484)

2026-06-30 17:45:12 -07:00
parent 9a763db1f3
commit be7e7d79dc
45 changed files with 922 additions and 53 deletions
@@ -0,0 +1,142 @@
+import { describe, expect, it, vi } from 'vitest';
+import { LockManager } from '../../../src/card-controller/lock/manager';
+import {
+  createCameraAction,
+  createDisplayModeAction,
+  createGeneralAction,
+  createLogAction,
+  createMediaPlayerAction,
+  createViewAction,
+} from '../../../src/utils/action';
+import { createCardAPI } from '../../test-utils';
+
+describe('LockManager', () => {
+  it('should report unlocked when no lock source is active', () => {
+    const api = createCardAPI();
+    vi.mocked(api.getMicrophoneManager().isLocking).mockReturnValue(false);
+
+    expect(new LockManager(api).isLocked()).toBeFalsy();
+  });
+
+  it('should report locked when the microphone is locking', () => {
+    const api = createCardAPI();
+    vi.mocked(api.getMicrophoneManager().isLocking).mockReturnValue(true);
+
+    expect(new LockManager(api).isLocked()).toBeTruthy();
+  });
+
+  it('should reuse lock manager epoch until the lock state changes', () => {
+    const api = createCardAPI();
+    vi.mocked(api.getMicrophoneManager().isLocking).mockReturnValue(false);
+    const manager = new LockManager(api);
+
+    const unlockedEpoch = manager.getEpoch();
+    expect(manager.getEpoch()).toBe(unlockedEpoch);
+    expect(unlockedEpoch.locked).toBeFalsy();
+
+    vi.mocked(api.getMicrophoneManager().isLocking).mockReturnValue(true);
+    const lockedEpoch = manager.getEpoch();
+    expect(lockedEpoch).not.toBe(unlockedEpoch);
+    expect(lockedEpoch.locked).toBeTruthy();
+    expect(manager.getEpoch()).toBe(lockedEpoch);
+  });
+
+  it('should not filter actions when unlocked', () => {
+    const api = createCardAPI();
+    vi.mocked(api.getMicrophoneManager().isLocking).mockReturnValue(false);
+
+    const actions = [createGeneralAction('reload'), createLogAction('Allowed')];
+
+    expect(new LockManager(api).getAllowedActions(actions)).toBe(actions);
+  });
+
+  it('should reject microphone-session-disruptive actions when locked', () => {
+    const api = createCardAPI();
+    vi.mocked(api.getMicrophoneManager().isLocking).mockReturnValue(true);
+    const manager = new LockManager(api);
+
+    for (const action of [
+      createViewAction('clips'),
+      createCameraAction('camera_select', 'cam-1'),
+      createCameraAction('live_substream_select', 'cam-1'),
+      createGeneralAction('live_substream_on'),
+      createGeneralAction('live_substream_off'),
+      createGeneralAction('default'),
+      createGeneralAction('pause'),
+      createGeneralAction('reload'),
+      createMediaPlayerAction('media_player.living_room', 'play'),
+    ]) {
+      expect(manager.getAllowedActions(action)).toEqual([]);
+    }
+  });
+
+  it('should preserve non-disruptive actions when locked', () => {
+    const api = createCardAPI();
+    vi.mocked(api.getMicrophoneManager().isLocking).mockReturnValue(true);
+    const manager = new LockManager(api);
+
+    for (const action of [
+      createGeneralAction('play'),
+      createGeneralAction('fullscreen'),
+      createGeneralAction('expand'),
+      createGeneralAction('pip'),
+      createGeneralAction('screenshot'),
+      createGeneralAction('mute'),
+      createGeneralAction('unmute'),
+      createGeneralAction('microphone_unmute'),
+      createDisplayModeAction('grid'),
+      { action: 'none' as const },
+    ]) {
+      expect(manager.getAllowedActions(action)).toEqual([action]);
+    }
+  });
+
+  it('should preserve non-disruptive actions from a mixed action list when locked', () => {
+    const api = createCardAPI();
+    vi.mocked(api.getMicrophoneManager().isLocking).mockReturnValue(true);
+
+    const manager = new LockManager(api);
+    const allowedAction = createLogAction('Allowed');
+
+    expect(
+      manager.getAllowedActions([createGeneralAction('reload'), allowedAction]),
+    ).toEqual([allowedAction]);
+  });
+
+  it('should report whether all configured actions are blocked', () => {
+    const api = createCardAPI();
+    vi.mocked(api.getMicrophoneManager().isLocking).mockReturnValue(true);
+
+    const manager = new LockManager(api);
+
+    expect(
+      manager.areAllActionsBlocked({
+        tap_action: createGeneralAction('reload'),
+        hold_action: createGeneralAction('pause'),
+      }),
+    ).toBeTruthy();
+    expect(
+      manager.areAllActionsBlocked({
+        tap_action: createGeneralAction('reload'),
+        hold_action: createLogAction('Allowed'),
+      }),
+    ).toBeFalsy();
+    expect(manager.areAllActionsBlocked({})).toBeFalsy();
+  });
+
+  it('should never report all-actions-blocked when unlocked', () => {
+    const api = createCardAPI();
+    vi.mocked(api.getMicrophoneManager().isLocking).mockReturnValue(false);
+
+    const manager = new LockManager(api);
+
+    // Even when every action would be blocked under an active policy, an
+    // inactive lock short-circuits to false.
+    expect(
+      manager.areAllActionsBlocked({
+        tap_action: createGeneralAction('reload'),
+        hold_action: createGeneralAction('pause'),
+      }),
+    ).toBeFalsy();
+  });
+});