@livedigital/client 3.3.0 → 3.4.0

package/dist/types/common.d.ts

@@ -231,6 +231,7 @@ export declare type CreateDataConsumerPayload = {
     producerId: string;
     appId?: string;
     channelId?: string;
+    ordered?: boolean;
 };
 export declare type CreateConsumerResponse = {
     consumer: Consumer;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@livedigital/client",
   "author": "vlprojects",
   "license": "MIT",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "private": false,
   "bugs": {
     "url": "https://github.com/vlprojects/livedigital-sdk/issues"

package/src/constants/common.ts

@@ -1,5 +1,7 @@
 import { LogLevel } from '../types/common';
 
+export const SIGNALING_API_VERSION = 2;
+
 export const LOG_LEVEL_ERROR: LogLevel = 3;
 export const LOG_LEVEL_WARN: LogLevel = 4;
 export const LOG_LEVEL_INFO: LogLevel = 6;

package/src/constants/events.ts

@@ -9,6 +9,7 @@ export const CHANNEL_EVENTS = {
   activityConfirmationRequired: 'channel.activityConfirmationRequired',
   activityConfirmationExpired: 'channel.activityConfirmationExpired',
   getAudioObserverProducer: 'channel.getAudioObserverProducer',
+  getGeneralDataProducer: 'channel.getGeneralDataProducer',
 };
 
 export const CLIENT_EVENTS = {

package/src/engine/handlers/ChannelEventHandler.ts

@@ -24,6 +24,24 @@ class ChannelEventHandler {
     });
   }
 
+  handleDataChannelEvent(payload: string): void {
+    try {
+      const { event, data } = JSON.parse(payload) as { event: string; data: Record<string, unknown> };
+      this.doHandleDataChannelEvent(event, data);
+    } catch (error: unknown) {
+      this.logger.error('Failed to handle data channel event', {
+        error,
+        payload,
+      });
+    }
+  }
+
+  private doHandleDataChannelEvent(event: string, payload: Record<string, unknown>) {
+    if (event === CHANNEL_EVENTS.updatePeerAppData) {
+      this.handlePeerAppDataUpdate(payload as UpdatePeerAppDataPayload);
+    }
+  }
+
   public subscribeToEvents(): void {
     const { connection } = this.engine.network.socket;
     if (!connection) {
@@ -62,15 +80,6 @@ class ChannelEventHandler {
       this.engine.clientEventEmitter.safeEmit(CLIENT_EVENTS.activityConfirmationAcquired, event);
       this.logger.info('Notify the channel that the activity has been acquired.', event);
     });
-
-    connection.on(CHANNEL_EVENTS.updatePeerAppData, ({ peerId, appData }: UpdatePeerAppDataPayload) => {
-      const peer = this.engine.peers.find((item) => item.id === peerId);
-      if (!peer) {
-        return;
-      }
-
-      peer.observer.emit(CHANNEL_EVENTS.updatePeerAppData, appData);
-    });
   }
 
   private removeEventListeners() {
@@ -93,6 +102,16 @@ class ChannelEventHandler {
     eventNames.forEach((x) => connection.removeAllListeners(x));
   }
 
+  private handlePeerAppDataUpdate({ peerId, appData }: UpdatePeerAppDataPayload) {
+    const peer = this.engine.peers.find(({ id }) => id === peerId);
+
+    if (!peer) {
+      return;
+    }
+
+    peer.observer.emit(CHANNEL_EVENTS.updatePeerAppData, appData);
+  }
+
   public reset() {
     this.removeEventListeners();
   }

package/src/engine/index.ts

@@ -100,11 +100,15 @@ class Engine {
 
   private audioObserver?: DataConsumer;
 
+  private generalDataConsumer?: DataConsumer;
+
   private activeSpeakerPeer?: Peer;
 
   private rejoinRequested = false;
 
-  private channelAudioObserverEventHandle: (data: string) => void;
+  private readonly handleChannelAudioObserverEvent: (data: string) => void;
+
+  private readonly handleDataChannelEvent: (data: string) => void;
 
   constructor(params: EngineParams) {
     const {
@@ -147,10 +151,14 @@ class Engine {
       onLogMessage: params.onLogMessage,
     });
 
-    this.channelAudioObserverEventHandle = (data) => {
+    this.handleChannelAudioObserverEvent = (data) => {
       this.channelAudioObserverEventHandler.handle(data);
     };
 
+    this.handleDataChannelEvent = (data) => {
+      this.channelEventsHandler.handleDataChannelEvent(data);
+    };
+
     this.logger = new Logger({
       logLevel: this.logLevel,
       namespace: 'Engine',
@@ -220,9 +228,12 @@ class Engine {
       await this.network.closeReceiveTransport();
       await this.media.clearTracks();
 
-      this.audioObserver?.removeListener('message', this.channelAudioObserverEventHandle);
+      this.audioObserver?.removeListener('message', this.handleChannelAudioObserverEvent);
       this.audioObserver?.close();
 
+      this.generalDataConsumer?.removeListener('message', this.handleDataChannelEvent);
+      this.generalDataConsumer?.close();
+
       this.channelEventsHandler.reset();
       this.mediaSoupEventsHandler.reset();
 
@@ -594,7 +605,10 @@ class Engine {
       this.mediaSoupEventsHandler.subscribeToEvents();
       this.isJoined = true;
       this.logger.debug('Successfully joined channel', { channelId });
-      await this.createAudioObserver();
+      await Promise.all([
+        this.createAudioObserver(),
+        this.createGeneralDataConsumer(),
+      ]);
     } catch (error) {
       this.logger.error('performJoin()', { error });
       throw error;
@@ -695,7 +709,7 @@ class Engine {
         channelId: this.channelId,
       });
 
-      audioObserver.on('message', this.channelAudioObserverEventHandle);
+      audioObserver.on('message', this.handleChannelAudioObserverEvent);
 
       this.audioObserver = audioObserver;
       this.logger.debug('Successfully create audio observer', logCtx);
@@ -704,6 +718,39 @@ class Engine {
     }
   }
 
+  private async createGeneralDataConsumer(): Promise<void> {
+    if (!this.isJoined) {
+      throw new NeedJoinFirstError('Need to join first');
+    }
+
+    const logCtx = {
+      channelId: this.channelId,
+      appId: this.appId,
+      peerId: this.myPeer?.id,
+    };
+
+    try {
+      const { producerId } = await this.network.getGeneralDataProducer() as { producerId: string };
+      this.generalDataConsumer = await this.network.createDataConsumer({
+        producerId,
+        appId: this.appId,
+        channelId: this.channelId,
+        ordered: true,
+      });
+
+      this.generalDataConsumer.on('message', this.handleDataChannelEvent);
+      this.logger.debug('Successfully created general data consumer', {
+        ...logCtx,
+        producerId,
+      });
+    } catch (error) {
+      this.logger.error('Failed to create general data consumer', {
+        ...logCtx,
+        error,
+      });
+    }
+  }
+
   private triggerRejoinEventIfAppropriate(reason?: string): void {
     if (this.rejoinRequested && !this.isChannelJoining) {
       return;

package/src/engine/network/Socket.ts

@@ -3,6 +3,7 @@ import EnhancedEventEmitter from '../../EnhancedEventEmitter';
 import { SocketIOEvents } from '../../types/socket';
 import { LogLevel, LogMessageHandler, SocketResponse } from '../../types/common';
 import Logger from '../Logger';
+import { SIGNALING_API_VERSION } from '../../constants/common';
 
 export type SocketIOConstructorParams = {
   logLevel: LogLevel,
@@ -57,6 +58,7 @@ class SocketIO {
       rememberUpgrade: false,
       auth: {
         token,
+        apiVersion: SIGNALING_API_VERSION,
       },
     });
 

package/src/engine/network/index.ts

@@ -392,6 +392,7 @@ class Network {
     producerId,
     appId,
     channelId,
+    ordered,
   }: CreateDataConsumerPayload): Promise<DataConsumer> {
     const transport = this.receiveTransport;
     if (!transport) {
@@ -401,6 +402,7 @@ class Network {
 
     this.logger.debug('createDataConsumer()', { producerId });
     const options = await this.socket.request(MEDIASOUP_EVENTS.createDataConsumer, {
+      ordered,
       dataProducerId: producerId,
       transportId: transport.id,
       appData: {
@@ -436,6 +438,10 @@ class Network {
     return this.socket.request(CHANNEL_EVENTS.getAudioObserverProducer);
   }
 
+  async getGeneralDataProducer(): Promise<SocketResponse> {
+    return this.socket.request(CHANNEL_EVENTS.getGeneralDataProducer);
+  }
+
   async getTransportsStateInfo(): Promise<TransportsStateInfo> {
     const [receive, send] = await Promise.all([
       this.getParsedTransportStats(this.receiveTransport),

package/src/types/common.ts

@@ -286,9 +286,10 @@ export type CreateConsumerPayload = {
 };
 
 export type CreateDataConsumerPayload = {
-  producerId: string,
-  appId?: string,
-  channelId?: string,
+  producerId: string;
+  appId?: string;
+  channelId?: string;
+  ordered?: boolean;
 };
 
 export type CreateConsumerResponse = {