Forward disconnect reason on leave requests and ConnectionErrors (#1323)

* Forward disconnect reason on leave requests

* util

* revert pending publish await change

* Create wicked-frogs-beg.md

* Update wicked-frogs-beg.md

.changeset/wicked-frogs-beg.md

@@ -0,0 +1,5 @@
+---
+"livekit-client": patch
+---
+
+Forward disconnect reason on leave requests and ConnectionErrors

src/api/SignalClient.ts

@@ -394,6 +394,8 @@ export class SignalClient {
                 new ConnectionError(
                   'Received leave request while trying to (re)connect',
                   ConnectionErrorReason.LeaveRequest,
+                  undefined,
+                  resp.message.value.reason,
                 ),
               );
             } else if (!opts.reconnect) {

src/room/Room.ts

@@ -81,6 +81,7 @@ import {
   createDummyVideoStreamTrack,
   extractChatMessage,
   extractTranscriptionSegments,
+  getDisconnectReasonFromConnectionError,
   getEmptyAudioStreamTrack,
   isBrowserSupported,
   isCloud,
@@ -562,11 +563,18 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
             this.recreateEngine();
             await connectFn(resolve, reject, nextUrl);
           } else {
-            this.handleDisconnect(this.options.stopLocalTrackOnUnpublish);
+            this.handleDisconnect(
+              this.options.stopLocalTrackOnUnpublish,
+              getDisconnectReasonFromConnectionError(e),
+            );
             reject(e);
           }
         } else {
-          this.handleDisconnect(this.options.stopLocalTrackOnUnpublish);
+          let disconnectReason = DisconnectReason.UNKNOWN_REASON;
+          if (e instanceof ConnectionError) {
+            disconnectReason = getDisconnectReasonFromConnectionError(e);
+          }
+          this.handleDisconnect(this.options.stopLocalTrackOnUnpublish, disconnectReason);
           reject(e);
         }
       }

src/room/errors.ts

@@ -1,4 +1,4 @@
-import { RequestResponse_Reason } from '@livekit/protocol';
+import { DisconnectReason, RequestResponse_Reason } from '@livekit/protocol';
 
 export class LivekitError extends Error {
   code: number;
@@ -20,12 +20,20 @@ export const enum ConnectionErrorReason {
 export class ConnectionError extends LivekitError {
   status?: number;
 
+  context?: unknown | DisconnectReason;
+
   reason: ConnectionErrorReason;
 
-  constructor(message: string, reason: ConnectionErrorReason, status?: number) {
+  constructor(
+    message: string,
+    reason: ConnectionErrorReason,
+    status?: number,
+    context?: unknown | DisconnectReason,
+  ) {
     super(1, message);
     this.status = status;
     this.reason = reason;
+    this.context = context;
   }
 }
 

src/room/utils.ts

@@ -2,10 +2,12 @@ import {
   ChatMessage as ChatMessageModel,
   ClientInfo,
   ClientInfo_SDK,
+  DisconnectReason,
   Transcription as TranscriptionModel,
 } from '@livekit/protocol';
 import { getBrowser } from '../utils/browserParser';
 import { protocolVersion, version } from '../version';
+import { type ConnectionError, ConnectionErrorReason } from './errors';
 import CriticalTimers from './timers';
 import type LocalAudioTrack from './track/LocalAudioTrack';
 import type RemoteAudioTrack from './track/RemoteAudioTrack';
@@ -531,3 +533,18 @@ export function extractChatMessage(msg: ChatMessageModel): ChatMessage {
     message,
   };
 }
+
+export function getDisconnectReasonFromConnectionError(e: ConnectionError) {
+  switch (e.reason) {
+    case ConnectionErrorReason.LeaveRequest:
+      return e.context as DisconnectReason;
+    case ConnectionErrorReason.Cancelled:
+      return DisconnectReason.CLIENT_INITIATED;
+    case ConnectionErrorReason.NotAllowed:
+      return DisconnectReason.USER_REJECTED;
+    case ConnectionErrorReason.ServerUnreachable:
+      return DisconnectReason.JOIN_FAILURE;
+    default:
+      return DisconnectReason.UNKNOWN_REASON;
+  }
+}