Add support for generic RequestResponse (#1221)

* Add support for generic RequestResponse

* Create rare-hairs-deny.md

* Bump protocol version

* update lockfile

.changeset/rare-hairs-deny.md

@@ -0,0 +1,5 @@
+---
+"livekit-client": patch
+---
+
+Add support for generic RequestResponse

package.json

@@ -53,7 +53,7 @@
     "size-limit": "size-limit"
   },
   "dependencies": {
-    "@livekit/protocol": "1.19.3",
+    "@livekit/protocol": "1.20.0",
     "events": "^3.3.0",
     "loglevel": "^1.8.0",
     "sdp-transform": "^2.14.1",

src/api/SignalClient.ts

@@ -4,7 +4,6 @@ import {
   ClientInfo,
   ConnectionQualityUpdate,
   DisconnectReason,
-  ErrorResponse,
   JoinResponse,
   LeaveRequest,
   LeaveRequest_Action,
@@ -13,6 +12,7 @@ import {
   Ping,
   ReconnectReason,
   ReconnectResponse,
+  RequestResponse,
   Room,
   SessionDescription,
   SignalRequest,
@@ -142,7 +142,7 @@ export class SignalClient {
 
   onLeave?: (leave: LeaveRequest) => void;
 
-  onErrorResponse?: (error: ErrorResponse) => void;
+  onRequestResponse?: (response: RequestResponse) => void;
 
   connectOptions?: ConnectOpts;
 
@@ -739,9 +739,9 @@ export class SignalClient {
       this.rtt = Date.now() - Number.parseInt(msg.value.lastPingTimestamp.toString());
       this.resetPingTimeout();
       pingHandled = true;
-    } else if (msg.case === 'errorResponse') {
-      if (this.onErrorResponse) {
-        this.onErrorResponse(msg.value);
+    } else if (msg.case === 'requestResponse') {
+      if (this.onRequestResponse) {
+        this.onRequestResponse(msg.value);
       }
     } else {
       this.log.debug('unsupported message', { ...this.logContext, msgCase: msg.case });

src/room/RTCEngine.ts

@@ -7,13 +7,13 @@ import {
   DataPacket,
   DataPacket_Kind,
   DisconnectReason,
-  ErrorResponse,
   type JoinResponse,
   type LeaveRequest,
   LeaveRequest_Action,
   ParticipantInfo,
   ReconnectReason,
   type ReconnectResponse,
+  RequestResponse,
   Room as RoomModel,
   SignalTarget,
   SpeakerInfo,
@@ -194,7 +194,8 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       this.emit(EngineEvent.SubscriptionPermissionUpdate, update);
     this.client.onSpeakersChanged = (update) => this.emit(EngineEvent.SpeakersChanged, update);
     this.client.onStreamStateUpdate = (update) => this.emit(EngineEvent.StreamStateChanged, update);
-    this.client.onErrorResponse = (error) => this.emit(EngineEvent.SignalRequestError, error);
+    this.client.onRequestResponse = (response) =>
+      this.emit(EngineEvent.SignalRequestResponse, response);
   }
 
   /** @internal */
@@ -1414,7 +1415,7 @@ export type EngineEventCallbacks = {
   localTrackUnpublished: (unpublishedResponse: TrackUnpublishedResponse) => void;
   remoteMute: (trackSid: string, muted: boolean) => void;
   offline: () => void;
-  signalRequestError: (error: ErrorResponse) => void;
+  signalRequestResponse: (response: RequestResponse) => void;
 };
 
 function supportOptionalDatachannel(protocol: number | undefined): boolean {

src/room/errors.ts

@@ -1,4 +1,4 @@
-import { ErrorResponse_Reason } from '@livekit/protocol';
+import { RequestResponse_Reason } from '@livekit/protocol';
 
 export class LivekitError extends Error {
   code: number;
@@ -65,10 +65,14 @@ export class PublishDataError extends LivekitError {
   }
 }
 
+export type RequestErrorReason =
+  | Exclude<RequestResponse_Reason, RequestResponse_Reason.OK>
+  | 'TimeoutError';
+
 export class SignalRequestError extends LivekitError {
-  reason: ErrorResponse_Reason;
+  reason: RequestErrorReason;
 
-  constructor(message: string, reason: ErrorResponse_Reason = ErrorResponse_Reason.UNKNOWN) {
+  constructor(message: string, reason: RequestErrorReason) {
     super(15, message);
     this.reason = reason;
   }

src/room/events.ts

@@ -539,7 +539,7 @@ export enum EngineEvent {
   SubscribedQualityUpdate = 'subscribedQualityUpdate',
   LocalTrackUnpublished = 'localTrackUnpublished',
   Offline = 'offline',
-  SignalRequestError = 'signalRequestError',
+  SignalRequestResponse = 'signalRequestResponse',
 }
 
 export enum TrackEvent {

src/room/participant/LocalParticipant.ts

@@ -3,9 +3,10 @@ import {
   DataPacket,
   DataPacket_Kind,
   Encryption_Type,
-  ErrorResponse,
   ParticipantInfo,
   ParticipantPermission,
+  RequestResponse,
+  RequestResponse_Reason,
   SimulcastCodec,
   SubscribedQualityUpdate,
   TrackUnpublishedResponse,
@@ -177,7 +178,7 @@ export default class LocalParticipant extends Participant {
       .on(EngineEvent.LocalTrackUnpublished, this.handleLocalTrackUnpublished)
       .on(EngineEvent.SubscribedQualityUpdate, this.handleSubscribedQualityUpdate)
       .on(EngineEvent.Disconnected, this.handleDisconnected)
-      .on(EngineEvent.SignalRequestError, this.handleSignalRequestError);
+      .on(EngineEvent.SignalRequestResponse, this.handleSignalRequestResponse);
   }
 
   private handleReconnecting = () => {
@@ -200,11 +201,13 @@ export default class LocalParticipant extends Participant {
     }
   };
 
-  private handleSignalRequestError = (error: ErrorResponse) => {
-    const { requestId, reason, message } = error;
-    const failedRequest = this.pendingSignalRequests.get(requestId);
-    if (failedRequest) {
-      failedRequest.reject(new SignalRequestError(message, reason));
+  private handleSignalRequestResponse = (response: RequestResponse) => {
+    const { requestId, reason, message } = response;
+    const targetRequest = this.pendingSignalRequests.get(requestId);
+    if (targetRequest) {
+      if (reason !== RequestResponse_Reason.OK) {
+        targetRequest.reject(new SignalRequestError(message, reason));
+      }
       this.pendingSignalRequests.delete(requestId);
     }
   };
@@ -278,7 +281,9 @@ export default class LocalParticipant extends Participant {
           }
           await sleep(50);
         }
-        reject(new SignalRequestError('Request to update local metadata timed out'));
+        reject(
+          new SignalRequestError('Request to update local metadata timed out', 'TimeoutError'),
+        );
       } catch (e: any) {
         if (e instanceof Error) reject(e);
       }

src/version.ts

@@ -1,4 +1,4 @@
 import { version as v } from '../package.json';
 
 export const version = v;
-export const protocolVersion = 13;
+export const protocolVersion = 15;