@dxos/plugin-thread 0.8.4-main.fd6878d → 0.9.0

package/src/calls/call-manager.ts

@@ -1,246 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { computed } from '@preact/signals-core';
-
-import { Event, synchronized } from '@dxos/async';
-import { type Client } from '@dxos/client';
-import { Resource } from '@dxos/context';
-import { invariant } from '@dxos/invariant';
-import { live } from '@dxos/live-object';
-import { type Tracks } from '@dxos/protocols/proto/dxos/edge/calls';
-import { isNonNullable } from '@dxos/util';
-
-import { type CallState, CallSwarmSynchronizer } from './call-swarm-synchronizer';
-import { MediaManager, type MediaState } from './media-manager';
-import { type ActivityState, CALLS_URL, type EncodedTrackName, TrackNameCodec, type UserState } from './types';
-
-export type GlobalState = {
-  call: CallState;
-  media: MediaState;
-};
-
-/**
- * Top level manager for call state.
- */
-export class CallManager extends Resource {
-  public readonly callStateUpdated = new Event<CallState>();
-  // TODO(wittjosiah): Consolidate isSpeaking into the MediaState type.
-  public readonly mediaStateUpdated = new Event<[MediaState, boolean]>();
-  public readonly left = new Event<string>();
-
-  /**
-   * Live object state. Is changed on internal events.
-   * CAUTION: Do not change directly.
-   */
-  private readonly _state = live<GlobalState>({
-    call: {},
-    media: { pulledAudioTracks: {}, pulledVideoStreams: {} },
-  });
-
-  // TODO(wittjosiah): This shouldn't be necessary, live-object's signals should be granular.
-  private readonly _raisedHandSignal = computed(() => this._state.call.raisedHand ?? false);
-  private readonly _speakingSignal = computed(() => this._state.call.speaking ?? false);
-  private readonly _joinedSignal = computed(() => this._state.call.joined ?? false);
-
-  private readonly _swarmSynchronizer: CallSwarmSynchronizer;
-  private readonly _mediaManager: MediaManager;
-
-  /** @reactive */
-  get roomId(): string | undefined {
-    return this._state.call.roomId;
-  }
-
-  /** @reactive */
-  get raisedHand(): boolean {
-    return this._raisedHandSignal.value;
-  }
-
-  /** @reactive */
-  get speaking(): boolean {
-    return this._speakingSignal.value;
-  }
-
-  /** @reactive */
-  get joined(): boolean {
-    return this._joinedSignal.value;
-  }
-
-  /** @reactive */
-  get self(): UserState {
-    return this._state.call.self ?? {};
-  }
-
-  /** @reactive */
-  get tracks(): Tracks {
-    return this._state.call.tracks ?? {};
-  }
-
-  /** @reactive */
-  get users(): UserState[] {
-    return this._state.call.users ?? [];
-  }
-
-  /** @reactive */
-  get media() {
-    return this._state.media;
-  }
-
-  /** @reactive */
-  get audioTracksToPlay(): MediaStreamTrack[] {
-    return (this._state.call.users ?? [])
-      .map((user) => (user.tracks?.audioEnabled ? user.tracks?.audio : undefined))
-      .filter(isNonNullable)
-      .map((track) => this._state.media.pulledAudioTracks[track as EncodedTrackName]?.track)
-      .filter(isNonNullable);
-  }
-
-  /** @reactive */
-  get state() {
-    return this._state;
-  }
-
-  /** @reactive */
-  getVideoStream(name?: EncodedTrackName): MediaStream | undefined {
-    return name ? this._state.media.pulledVideoStreams[name]?.stream : undefined;
-  }
-
-  /** @reactive */
-  getActivity(key: string): ActivityState | undefined {
-    return this._state.call.activities?.[key];
-  }
-
-  setRoomId(roomId: string): void {
-    this._swarmSynchronizer._setRoomId(roomId);
-  }
-
-  setSpeaking(speaking: boolean): void {
-    this._swarmSynchronizer.setSpeaking(speaking);
-  }
-
-  setRaisedHand(raisedHand: boolean): void {
-    this._swarmSynchronizer.setRaisedHand(raisedHand);
-  }
-
-  setActivity(key: string, payload: ActivityState['payload']): void {
-    this._swarmSynchronizer.setActivity(key, payload);
-  }
-
-  turnAudioOn(): Promise<void> {
-    return this._mediaManager.turnAudioOn();
-  }
-
-  turnAudioOff(): Promise<void> {
-    return this._mediaManager.turnAudioOff();
-  }
-
-  turnVideoOn(): Promise<void> {
-    return this._mediaManager.turnVideoOn();
-  }
-
-  turnVideoOff(): Promise<void> {
-    return this._mediaManager.turnVideoOff();
-  }
-
-  turnScreenshareOn(): Promise<void> {
-    return this._mediaManager.turnScreenshareOn();
-  }
-
-  turnScreenshareOff(): Promise<void> {
-    return this._mediaManager.turnScreenshareOff();
-  }
-
-  // TODO(burdon): Can this be mocked?
-  constructor(private readonly _client: Client) {
-    super();
-    this._client.config.getOrThrow('runtime.services.edge.url');
-    const networkService = this._client.services.services.NetworkService;
-    invariant(networkService, 'network service not found');
-    this._swarmSynchronizer = new CallSwarmSynchronizer({ networkService });
-    this._mediaManager = new MediaManager();
-  }
-
-  protected override async _open(): Promise<void> {
-    await this._mediaManager.open();
-    await this._swarmSynchronizer.open();
-    const subscription = this._client.halo.identity.subscribe((identity) => {
-      if (identity) {
-        this._swarmSynchronizer._setIdentity(identity);
-      }
-      if (this._client.halo.device) {
-        this._swarmSynchronizer._setDevice(this._client.halo.device);
-      }
-    });
-    this._ctx.onDispose(() => subscription.unsubscribe());
-
-    this._swarmSynchronizer.stateUpdated.on(this._ctx, (state) => this._onCallStateUpdated(state));
-    this._mediaManager.stateUpdated.on(this._ctx, (state) => this._onMediaStateUpdated(state));
-  }
-
-  protected override async _close(): Promise<void> {
-    await this._swarmSynchronizer.leave();
-    await this._swarmSynchronizer.close();
-    await this._mediaManager.close();
-  }
-
-  async peek(roomId: string): Promise<number> {
-    const peers = await this._swarmSynchronizer.querySwarm(roomId);
-    return peers.length;
-  }
-
-  // TODO(mykola): Reconcile with _swarmSynchronizer.state.joined.
-  @synchronized
-  async join(): Promise<void> {
-    this._swarmSynchronizer.setJoined(true);
-    await this._swarmSynchronizer.join();
-    await this._mediaManager.join({
-      iceServers: this._client.config.get('runtime.services.ice'),
-      apiBase: `${CALLS_URL}/api/calls`,
-    });
-  }
-
-  @synchronized
-  async leave(): Promise<void> {
-    this._swarmSynchronizer.setJoined(false);
-    await this._swarmSynchronizer.leave();
-    await this._mediaManager.leave();
-    this.roomId && this.left.emit(this.roomId);
-  }
-
-  private _onCallStateUpdated(state: CallState): void {
-    const tracksToPull = state.users
-      ?.filter((user) => user.joined && user.id !== state.self?.id)
-      ?.flatMap((user) => [user.tracks?.video, user.tracks?.audio, user.tracks?.screenshare])
-      .filter(isNonNullable);
-    this._mediaManager._schedulePullTracks(tracksToPull as EncodedTrackName[]);
-
-    this.callStateUpdated.emit(state);
-    this._updateState();
-  }
-
-  private _onMediaStateUpdated(state: MediaState): void {
-    this._swarmSynchronizer.setTracks({
-      video: state.pushedVideoTrack ? TrackNameCodec.encode(state.pushedVideoTrack) : undefined,
-      audio: state.pushedAudioTrack ? TrackNameCodec.encode(state.pushedAudioTrack) : undefined,
-      screenshare: state.pushedScreenshareTrack ? TrackNameCodec.encode(state.pushedScreenshareTrack) : undefined,
-      videoEnabled: state.videoEnabled,
-      audioEnabled: state.audioEnabled,
-      screenshareEnabled: state.screenshareEnabled,
-    });
-
-    const isSpeaking = this._mediaManager.isSpeaking ?? false;
-    this._swarmSynchronizer.setSpeaking(isSpeaking);
-
-    this.mediaStateUpdated.emit([state, isSpeaking]);
-    this._updateState();
-  }
-
-  /**
-   * Only this method is allowed to change state.
-   */
-  private _updateState(): void {
-    this._state.call = this._swarmSynchronizer._getState();
-    this._state.media = this._mediaManager._getState();
-  }
-}

package/src/calls/call-swarm-synchronizer.ts

@@ -1,350 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import md5Hex from 'md5-hex';
-
-import { DeferredTask, Event, scheduleTaskInterval, synchronized } from '@dxos/async';
-import { type Identity } from '@dxos/client/halo';
-import { Context, Resource } from '@dxos/context';
-import { generateName } from '@dxos/display-name';
-import { invariant } from '@dxos/invariant';
-import { PublicKey } from '@dxos/keys';
-import { log } from '@dxos/log';
-import { buf } from '@dxos/protocols/buf';
-import { ActivitySchema } from '@dxos/protocols/buf/dxos/edge/calls_pb';
-import { type Device, type NetworkService } from '@dxos/protocols/proto/dxos/client/services';
-import { ConnectionState, type SwarmResponse } from '@dxos/protocols/proto/dxos/edge/messenger';
-import { isNonNullable } from '@dxos/util';
-
-import { type ActivityState, type UserState, codec } from './types';
-
-export type CallState = {
-  /**
-   * Room id.
-   */
-  roomId?: string;
-
-  /**
-   * All users states in the swarm.
-   */
-  users?: UserState[];
-
-  /**
-   * Self state inside swarm.
-   */
-  self?: UserState;
-
-  /**
-   * Swarm synchronized CRDT transcription. Last write wins.
-   */
-  activities?: Record<string, ActivityState>;
-
-  raisedHand?: boolean;
-  speaking?: boolean;
-  joined?: boolean;
-
-  /**
-   * Tracks pushed by self to calls service.
-   */
-  tracks?: UserState['tracks'];
-};
-
-export type CallSwarmSynchronizerParams = { networkService: NetworkService };
-
-/**
- * Period for peer to reconnect to the call swarm gracefully if connection was lost abruptly.
- */
-const DISCONNECTED_ABRUPT_TIMEOUT = 10_000; // [ms]
-
-/**
- * Sends and receives state to/from Swarm network.
- */
-export class CallSwarmSynchronizer extends Resource {
-  public readonly stateUpdated = new Event<CallState>();
-
-  private readonly _state: CallState = { activities: {} };
-  private readonly _networkService: NetworkService;
-  private _lastSwarmEvent?: SwarmResponse = undefined;
-  private _reconcileSwarmStateTask?: DeferredTask = undefined;
-
-  private _identityKey?: string = undefined;
-  private _deviceKey?: string = undefined;
-  private _displayName?: string = undefined;
-
-  private _swarmCtx?: Context = undefined;
-
-  private _sendStateTask?: DeferredTask = undefined;
-
-  constructor({ networkService }: CallSwarmSynchronizerParams) {
-    super();
-    this._networkService = networkService;
-  }
-
-  /**
-   * @internal
-   */
-  _getState(): CallState {
-    return this._state;
-  }
-
-  setRaisedHand(raisedHand: boolean): void {
-    if (this._state.raisedHand === raisedHand) {
-      return;
-    }
-
-    this._state.raisedHand = raisedHand;
-    this._notifyAndSchedule();
-  }
-
-  setSpeaking(speaking: boolean): void {
-    if (this._state.speaking === speaking) {
-      return;
-    }
-
-    this._state.speaking = speaking;
-    this._notifyAndSchedule();
-  }
-
-  setJoined(joined: boolean): void {
-    if (this._state.joined === joined) {
-      return;
-    }
-
-    this._state.joined = joined;
-    this._notifyAndSchedule();
-  }
-
-  setTracks(tracks: UserState['tracks']): void {
-    this._state.tracks = { ...this._state.tracks, ...tracks };
-    this._notifyAndSchedule();
-  }
-
-  setActivity(key: string, payload: ActivityState['payload']): void {
-    const lamportTimestamp = LamportTimestampCrdt.increment(
-      this._state.activities?.[key]?.lamportTimestamp ?? { id: this._deviceKey },
-    );
-    this._state.activities![key] = { lamportTimestamp, payload };
-
-    this._notifyAndSchedule();
-  }
-
-  /**
-   * @internal
-   */
-  _setIdentity(identity: Identity): void {
-    this._identityKey = identity.identityKey.toHex();
-    this._displayName = identity.profile?.displayName ?? generateName(identity.identityKey.toHex());
-  }
-
-  /**
-   * @internal
-   */
-  _setDevice(device: Device): void {
-    this._deviceKey = device.deviceKey.toHex();
-  }
-
-  /**
-   * @internal
-   */
-  _setRoomId(roomId?: string): void {
-    if (this._swarmCtx) {
-      log.verbose('joined to a different room', { roomId });
-      return;
-    }
-
-    this._state.roomId = roomId;
-  }
-
-  protected override async _open(): Promise<void> {
-    this._sendStateTask = new DeferredTask(this._ctx, async () => {
-      await this._sendState();
-    });
-
-    this._reconcileSwarmStateTask = new DeferredTask(this._ctx, async () => {
-      await this._reconcileSwarmState();
-    });
-  }
-
-  protected override async _close(): Promise<void> {
-    this._sendStateTask = undefined;
-    this._reconcileSwarmStateTask = undefined;
-  }
-
-  @synchronized
-  async join(): Promise<void> {
-    invariant(this._state.roomId);
-    invariant(!this._swarmCtx, 'Already joined');
-
-    this._swarmCtx = new Context();
-    const topic = getTopic(this._state.roomId);
-    log('joining swarm', { topic, peer: { identityKey: this._identityKey, peerKey: this._deviceKey } });
-    const stream = this._networkService.subscribeSwarmState({ topic });
-    stream.subscribe((event) => this._processSwarmEvent(event));
-
-    const cleanup = () => {
-      void stream.close();
-      if (topic && this._identityKey && this._deviceKey) {
-        log('leaving swarm', { topic, peer: { identityKey: this._identityKey, peerKey: this._deviceKey } });
-        void this._networkService
-          .leaveSwarm({
-            topic,
-            peer: { identityKey: this._identityKey, peerKey: this._deviceKey },
-          })
-          .catch((err) => log.catch(err));
-      }
-      window.removeEventListener('beforeunload', cleanup);
-    };
-    window.addEventListener('beforeunload', cleanup);
-    this._swarmCtx.onDispose(cleanup);
-
-    this._notifyAndSchedule();
-  }
-
-  @synchronized
-  async leave(): Promise<void> {
-    if (!this._swarmCtx) {
-      return;
-    }
-
-    await this._swarmCtx.dispose();
-    this._swarmCtx = undefined;
-
-    this._state.users = undefined;
-    this._state.self = undefined;
-  }
-
-  async querySwarm(roomId: string) {
-    const topic = getTopic(roomId);
-    const swarm = await this._networkService.querySwarm({ topic });
-    return swarm.peers ?? [];
-  }
-
-  /**
-   * Notify and schedule send state task.
-   */
-  private _notifyAndSchedule(): void {
-    this.stateUpdated.emit(this._state);
-    if (this._state.joined) {
-      this._sendStateTask?.schedule();
-    }
-  }
-
-  private async _sendState(): Promise<void> {
-    if (!this._state.roomId || !this._identityKey || !this._deviceKey || !this._state.joined) {
-      return;
-    }
-
-    const state: UserState = {
-      ...this._state,
-      id: this._deviceKey,
-      name: this._displayName,
-      activities: this._state.activities
-        ? Object.fromEntries(
-            Object.entries(this._state.activities).map(([key, activity]) => [
-              key,
-              buf.create(ActivitySchema, activity),
-            ]),
-          )
-        : {},
-    };
-
-    await this._networkService.joinSwarm({
-      topic: getTopic(this._state.roomId),
-      peer: {
-        identityKey: this._identityKey,
-        peerKey: this._deviceKey,
-        state: codec.encode(state),
-      },
-    });
-  }
-
-  private _processSwarmEvent(swarmEvent: SwarmResponse): void {
-    if (!this._state.joined) {
-      return;
-    }
-
-    this._lastSwarmEvent = swarmEvent;
-    this._reconcileSwarmStateTask!.schedule();
-  }
-
-  private async _reconcileSwarmState(): Promise<void> {
-    const swarmEvent = this._lastSwarmEvent;
-    invariant(swarmEvent);
-    // We include inactive peers that were disconnected abruptly and have not yet reconnected to not drop them from call.
-    // Websocket connection could be unstable and we include graceful period for peers to reconnect.
-    const peers = [
-      ...(swarmEvent.peers ?? []),
-      ...(swarmEvent.inactivePeers ?? []).filter(
-        ({ disconnected, connectionState }) =>
-          connectionState === ConnectionState.DISCONNECTED_ABRUPT &&
-          disconnected &&
-          disconnected > Date.now() - DISCONNECTED_ABRUPT_TIMEOUT,
-      ),
-    ].sort((peer1, peer2) => peer1.peerKey.localeCompare(peer2.peerKey));
-    const users = peers
-      .map((peer) => {
-        try {
-          return codec.decode(peer.state!);
-        } catch (error) {
-          log.error('error decoding peer state', { error, peer });
-          return undefined;
-        }
-      })
-      .filter(isNonNullable);
-    this._state.users = users;
-    this._state.self = users.find((user) => user.id === this._deviceKey);
-    log('reconciling swarm state', { users });
-    if (users.length === 0) {
-      return;
-    }
-
-    const activityKeys = new Set<string>(users.flatMap((user) => Object.keys(user.activities)));
-    [...activityKeys].forEach((key) => {
-      const activities = users.map((user) => user.activities?.[key]).filter(isNonNullable);
-      const lastActivity = LamportTimestampCrdt.getLastState(activities);
-      if (
-        lastActivity &&
-        lastActivity.lamportTimestamp!.version! > (this._state.activities![key]?.lamportTimestamp?.version ?? 0)
-      ) {
-        this._state.activities![key] = lastActivity;
-      }
-    });
-    this.stateUpdated.emit(this._state);
-
-    // Schedule next reconcile if there are inactive peer to drop them after timeout.
-    if (peers.some((peer) => peer.connectionState !== ConnectionState.CONNECTED)) {
-      scheduleTaskInterval(
-        this._ctx,
-        async () => this._reconcileSwarmStateTask!.schedule(),
-        Math.min(DISCONNECTED_ABRUPT_TIMEOUT / 2, 1000),
-      );
-    }
-  }
-}
-
-type LamportTimestamp = ActivityState['lamportTimestamp'];
-
-// TODO(mykola): Factor out.
-class LamportTimestampCrdt {
-  static getLastState<T extends { lamportTimestamp?: LamportTimestamp }>(states: T[]): T | undefined {
-    const maxTimestamp = Math.max(...states.map((state) => state.lamportTimestamp?.version ?? 0));
-    const sortedStates = states
-      .filter(
-        (state) =>
-          state.lamportTimestamp && state.lamportTimestamp.version === maxTimestamp && state.lamportTimestamp.id,
-      )
-      .sort((a, b) => a.lamportTimestamp!.id!.localeCompare(b.lamportTimestamp!.id!));
-    return sortedStates[0];
-  }
-
-  static increment(timestamp: LamportTimestamp): LamportTimestamp {
-    return {
-      ...(timestamp ?? {}),
-      version: (timestamp?.version ?? 0) + 1,
-    };
-  }
-}
-
-// TODO(mykola): Delete once we refactor swarm to accept string as topic.
-const getTopic = (roomId: string): PublicKey => PublicKey.fromHex(md5Hex(roomId));

package/src/calls/index.ts

@@ -1,10 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export * from './call-manager';
-export * from './call-swarm-synchronizer';
-export * from './media-manager';
-export * from './speaking-monitor';
-export * from './types';
-export * from './util';