Use mutex helper package (#1289)

.changeset/warm-hornets-drive.md

@@ -0,0 +1,5 @@
+---
+"livekit-client": patch
+---
+
+Use shared mutex helper package

package.json

@@ -53,6 +53,7 @@
     "size-limit": "size-limit"
   },
   "dependencies": {
+    "@livekit/mutex": "1.0.0",
     "@livekit/protocol": "1.24.0",
     "events": "^3.3.0",
     "loglevel": "^1.8.0",

src/api/SignalClient.ts

@@ -1,3 +1,4 @@
+import { Mutex } from '@livekit/mutex';
 import {
   AddTrackRequest,
   AudioTrackFeature,
@@ -42,7 +43,7 @@ import log, { LoggerNames, getLogger } from '../logger';
 import { ConnectionError, ConnectionErrorReason } from '../room/errors';
 import CriticalTimers from '../room/timers';
 import type { LoggerOptions } from '../room/types';
-import { Mutex, getClientInfo, isReactNative, sleep, toWebsocketUrl } from '../room/utils';
+import { getClientInfo, isReactNative, sleep, toWebsocketUrl } from '../room/utils';
 import { AsyncQueue } from '../utils/AsyncQueue';
 
 // internal options

src/index.ts

@@ -1,3 +1,4 @@
+import { Mutex } from '@livekit/mutex';
 import { DataPacket_Kind, DisconnectReason, SubscriptionError } from '@livekit/protocol';
 import { LogLevel, LoggerNames, getLogger, setLogExtension, setLogLevel } from './logger';
 import DefaultReconnectPolicy from './room/DefaultReconnectPolicy';
@@ -26,7 +27,6 @@ import { TrackPublication } from './room/track/TrackPublication';
 import type { LiveKitReactNativeInfo } from './room/types';
 import type { AudioAnalyserOptions } from './room/utils';
 import {
-  Mutex,
   compareVersions,
   createAudioAnalyser,
   getEmptyAudioStreamTrack,

src/room/PCTransportManager.ts

@@ -1,11 +1,12 @@
+import { Mutex } from '@livekit/mutex';
 import { SignalTarget } from '@livekit/protocol';
 import log, { LoggerNames, getLogger } from '../logger';
 import PCTransport, { PCEvents } from './PCTransport';
 import { roomConnectOptionDefaults } from './defaults';
 import { ConnectionError, ConnectionErrorReason } from './errors';
 import CriticalTimers from './timers';
 import type { LoggerOptions } from './types';
-import { Mutex, sleep } from './utils';
+import { sleep } from './utils';
 
 export enum PCTransportState {
   NEW,

src/room/RTCEngine.ts

@@ -1,3 +1,4 @@
+import { Mutex } from '@livekit/mutex';
 import {
   type AddTrackRequest,
   ClientConfigSetting,
@@ -63,7 +64,7 @@ import type { Track } from './track/Track';
 import type { TrackPublishOptions, VideoCodec } from './track/options';
 import { getTrackPublicationInfo } from './track/utils';
 import type { LoggerOptions } from './types';
-import { Mutex, isVideoCodec, isWeb, sleep, supportsAddTrack, supportsTransceiver } from './utils';
+import { isVideoCodec, isWeb, sleep, supportsAddTrack, supportsTransceiver } from './utils';
 
 const lossyDataChannel = '_lossy';
 const reliableDataChannel = '_reliable';

src/room/Room.ts

@@ -1,3 +1,4 @@
+import { Mutex } from '@livekit/mutex';
 import {
   ChatMessage as ChatMessageModel,
   ConnectionQualityUpdate,
@@ -77,7 +78,6 @@ import type {
 } from './types';
 import {
   Future,
-  Mutex,
   createDummyVideoStreamTrack,
   extractChatMessage,
   extractTranscriptionSegments,

src/room/track/LocalTrack.ts

@@ -1,10 +1,11 @@
+import { Mutex } from '@livekit/mutex';
 import { debounce } from 'ts-debounce';
 import { getBrowser } from '../../utils/browserParser';
 import DeviceManager from '../DeviceManager';
 import { DeviceUnsupportedError, TrackInvalidError } from '../errors';
 import { TrackEvent } from '../events';
 import type { LoggerOptions } from '../types';
-import { Mutex, compareVersions, isMobile, sleep } from '../utils';
+import { compareVersions, isMobile, sleep } from '../utils';
 import { Track, attachToElement, detachTrack } from './Track';
 import type { VideoCodec } from './options';
 import type { TrackProcessor } from './processor/types';

src/room/track/LocalVideoTrack.ts

@@ -1,3 +1,4 @@
+import { Mutex } from '@livekit/mutex';
 import {
   VideoQuality as ProtoVideoQuality,
   SubscribedCodec,
@@ -10,7 +11,7 @@ import { ScalabilityMode } from '../participant/publishUtils';
 import type { VideoSenderStats } from '../stats';
 import { computeBitrate, monitorFrequency } from '../stats';
 import type { LoggerOptions } from '../types';
-import { Mutex, isFireFox, isMobile, isWeb, unwrapConstraint } from '../utils';
+import { isFireFox, isMobile, isWeb, unwrapConstraint } from '../utils';
 import LocalTrack from './LocalTrack';
 import { Track, VideoQuality } from './Track';
 import type { VideoCaptureOptions, VideoCodec } from './options';

src/room/utils.ts

@@ -454,44 +454,6 @@ export function createAudioAnalyser(
   return { calculateVolume, analyser, cleanup };
 }
 
-/**
- * @internal
- */
-export class Mutex {
-  private _locking: Promise<void>;
-
-  private _locks: number;
-
-  constructor() {
-    this._locking = Promise.resolve();
-    this._locks = 0;
-  }
-
-  isLocked() {
-    return this._locks > 0;
-  }
-
-  lock() {
-    this._locks += 1;
-
-    let unlockNext: () => void;
-
-    const willLock = new Promise<void>(
-      (resolve) =>
-        (unlockNext = () => {
-          this._locks -= 1;
-          resolve();
-        }),
-    );
-
-    const willUnlock = this._locking.then(() => unlockNext);
-
-    this._locking = this._locking.then(() => willLock);
-
-    return willUnlock;
-  }
-}
-
 export function isVideoCodec(maybeCodec: string): maybeCodec is VideoCodec {
   return videoCodecs.includes(maybeCodec as VideoCodec);
 }

src/utils/AsyncQueue.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, it } from 'vitest';
+import { assert, describe, expect, it } from 'vitest';
 import { sleep } from '../room/utils';
 import { AsyncQueue } from './AsyncQueue';
 
@@ -49,7 +49,7 @@ describe('asyncQueue', () => {
         task2Executed = true;
       })
       .catch(() => {
-        fail('task 2 should not have thrown');
+        assert.fail('task 2 should not have thrown');
       });
 
     expect(task1threw).toBeTruthy();

src/utils/AsyncQueue.ts

@@ -1,4 +1,4 @@
-import { Mutex } from '../room/utils';
+import { Mutex } from '@livekit/mutex';
 
 type QueueTask<T> = () => PromiseLike<T>;