Fix: EncryptionError Event Now Exposes Participant Identity (#1723)

Co-authored-by: lukasIO <mail@lukasseiler.de>

Author: CSantosM

.changeset/fast-rings-cover.md

@@ -0,0 +1,5 @@
+---
+"livekit-client": patch
+---
+
+Add participant as an optional parameter to EncryptionError events emitted on room level

src/e2ee/E2eeManager.ts

@@ -144,7 +144,7 @@ export class E2EEManager
     switch (kind) {
       case 'error':
         log.error(data.error.message);
-        this.emit(EncryptionEvent.EncryptionError, data.error);
+        this.emit(EncryptionEvent.EncryptionError, data.error, data.participantIdentity);
         break;
       case 'initAck':
         if (data.enabled) {
@@ -208,7 +208,7 @@ export class E2EEManager
 
   private onWorkerError = (ev: ErrorEvent) => {
     log.error('e2ee worker encountered an error:', { error: ev.error });
-    this.emit(EncryptionEvent.EncryptionError, ev.error);
+    this.emit(EncryptionEvent.EncryptionError, ev.error, undefined);
   };
 
   public setupEngine(engine: RTCEngine) {

src/e2ee/events.ts

@@ -45,7 +45,7 @@ export type E2EEManagerCallbacks = {
     enabled: boolean,
     participant: Participant,
   ) => void;
-  [EncryptionEvent.EncryptionError]: (error: Error) => void;
+  [EncryptionEvent.EncryptionError]: (error: Error, participantIdentity?: string) => void;
 };
 
 export type CryptorCallbacks = {

src/e2ee/types.ts

@@ -91,6 +91,7 @@ export interface ErrorMessage extends BaseMessage {
   kind: 'error';
   data: {
     error: Error;
+    participantIdentity?: string;
   };
 }
 

src/e2ee/worker/e2ee.worker.ts

@@ -279,7 +279,10 @@ function setupCryptorErrorEvents(cryptor: FrameCryptor) {
   cryptor.on(CryptorEvent.Error, (error) => {
     const msg: ErrorMessage = {
       kind: 'error',
-      data: { error: new Error(`${CryptorErrorReason[error.reason]}: ${error.message}`) },
+      data: {
+        error: new Error(`${CryptorErrorReason[error.reason]}: ${error.message}`),
+        participantIdentity: error.participantIdentity,
+      },
     };
     postMessage(msg);
   });

src/room/Room.ts

@@ -384,9 +384,12 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
           this.emit(RoomEvent.ParticipantEncryptionStatusChanged, enabled, participant);
         },
       );
-      this.e2eeManager.on(EncryptionEvent.EncryptionError, (error) =>
-        this.emit(RoomEvent.EncryptionError, error),
-      );
+      this.e2eeManager.on(EncryptionEvent.EncryptionError, (error, participantIdentity) => {
+        const participant = participantIdentity
+          ? this.getParticipantByIdentity(participantIdentity)
+          : undefined;
+        this.emit(RoomEvent.EncryptionError, error, participant);
+      });
       this.e2eeManager?.setup(this);
     }
   }
@@ -2698,7 +2701,7 @@ export type RoomEventCallbacks = {
   signalConnected: () => void;
   recordingStatusChanged: (recording: boolean) => void;
   participantEncryptionStatusChanged: (encrypted: boolean, participant?: Participant) => void;
-  encryptionError: (error: Error) => void;
+  encryptionError: (error: Error, participant?: Participant) => void;
   dcBufferStatusChanged: (isLow: boolean, kind: DataPacket_Kind) => void;
   activeDeviceChanged: (kind: MediaDeviceKind, deviceId: string) => void;
   chatMessage: (message: ChatMessage, participant?: RemoteParticipant | LocalParticipant) => void;