@livedigital/client 2.20.0 → 2.21.0-update-app-data.1

package/dist/types/common.d.ts

@@ -236,3 +236,7 @@ export declare enum DeviceErrors {
     DeviceIsBusy = "DeviceIsBusy",
     NotAllowedError = "NotAllowedError"
 }
+export declare type UpdatePeerAppDataPayload = {
+    peerId: string;
+    appData: Record<string, unknown>;
+};

package/package.json

@@ -2,7 +2,7 @@
   "name": "@livedigital/client",
   "author": "vlprojects",
   "license": "MIT",
-  "version": "2.20.0",
+  "version": "2.21.0-update-app-data.1",
   "private": false,
   "bugs": {
     "url": "https://github.com/vlprojects/livedigital-sdk/issues"

package/src/constants/common.ts

@@ -14,3 +14,5 @@ export const LogLevels = {
 
 export const CONSUMER_CHECK_STATE_TIMEOUT = 5000;
 export const PRODUCER_CHECK_STATE_TIMEOUT = 3000;
+
+export const PEER_APP_DATA_MAX_SIZE_BYTES = 1024;

package/src/constants/events.ts

@@ -3,6 +3,7 @@ export const CHANNEL_EVENTS = {
   channelJoin: 'channel.join',
   channelGetPeers: 'channel.getPeers',
   channelLeave: 'peer.disconnected',
+  updatePeerAppData: 'peer.updateAppData',
 };
 
 export const CLIENT_EVENTS = {
@@ -31,6 +32,7 @@ export const PEER_EVENTS = {
   trackPaused: 'track-paused',
   trackResumed: 'track-resumed',
   trackFailed: 'track-failed',
+  appDataUpdated: 'app-data-updated',
 };
 
 export enum SocketIOEvents {

package/src/engine/Peer.ts

@@ -11,11 +11,12 @@ import {
 } from '../types/common';
 import EnhancedEventEmitter from '../EnhancedEventEmitter';
 import Engine from './index';
-import { MEDIASOUP_EVENTS, PEER_EVENTS } from '../constants/events';
+import { CHANNEL_EVENTS, MEDIASOUP_EVENTS, PEER_EVENTS } from '../constants/events';
 import Logger from './Logger';
 import PeerProducer from './PeerProducer';
 import PeerConsumer from './PeerConsumer';
 import PeerTrack from './media/tracks/PeerTrack';
+import validateAppData from '../helpers/appDataValidator';
 
 interface PeerConstructor {
   id: string;
@@ -49,7 +50,7 @@ class Peer {
 
   public uid?: string;
 
-  public appData: Record<string, unknown>;
+  private applicationData: Record<string, unknown>;
 
   public role: Role;
 
@@ -84,7 +85,7 @@ class Peer {
     this.channelIds = channelIds;
     this.appId = appId;
     this.loginDate = loginDate;
-    this.appData = appData || {};
+    this.applicationData = appData || {};
     this.uid = uid;
     this.role = role;
     this.engine = engine;
@@ -96,6 +97,10 @@ class Peer {
     this.handlePeerEvents();
   }
 
+  get appData(): Record<string, unknown> {
+    return this.applicationData;
+  }
+
   get observer(): EnhancedEventEmitter {
     return this._observer;
   }
@@ -353,6 +358,17 @@ class Peer {
         spatialLayer,
       });
     });
+
+    this.observer.on(CHANNEL_EVENTS.updatePeerAppData, (appData: Record<string, unknown>) => {
+      try {
+        validateAppData(appData);
+        this.setAppData(appData);
+        this.observer.emit(PEER_EVENTS.appDataUpdated, appData);
+        this.logger.debug('updatePeerAppData', { peer: this, appData });
+      } catch (error) {
+        this.logger.error('updatePeerAppData', { peer: this, appData, error });
+      }
+    });
   }
 
   private emitConnectionQuality(): void {
@@ -402,6 +418,10 @@ class Peer {
   private getTrackByConsumerId(id: string): PeerTrack | undefined {
     return Array.from(this.tracks.values()).find((track) => track.consumerId === id);
   }
+
+  private setAppData(appData: Record<string, unknown>) {
+    this.applicationData = appData;
+  }
 }
 
 export default Peer;

package/src/engine/handlers/ChannelEventHandler.ts

@@ -1,4 +1,4 @@
-import { ChannelEvent, PeerResponse } from '../../types/common';
+import { ChannelEvent, PeerResponse, UpdatePeerAppDataPayload } from '../../types/common';
 import Engine from '../index';
 import { CHANNEL_EVENTS, CLIENT_EVENTS } from '../../constants/events';
 import Logger from '../Logger';
@@ -39,6 +39,15 @@ class ChannelEventHandler {
       this.engine.clientEventEmitter.safeEmit(CLIENT_EVENTS.peerLeft, peerId);
       this.logger.debug('Peer left the channel', { peerId });
     });
+
+    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);
+    });
   }
 }
 

package/src/engine/index.ts

@@ -31,6 +31,7 @@ import { retryAsync } from '../helpers/retry';
 import { EngineDependenciesFactory, IssuesHandler } from '../types/engine';
 import { LogLevels } from '../constants/common';
 import { LoadBalancerApiClientParams } from './network/LoadBalancerClient';
+import validateAppData from '../helpers/appDataValidator';
 
 type EngineParams = {
   clientEventEmitter: EnhancedEventEmitter,
@@ -220,6 +221,21 @@ class Engine {
     this.peersRepository.delete(peerId);
   }
 
+  public async updateAppData(appData: Record<string, unknown>): Promise<void> {
+    const { myPeer } = this;
+    if (!myPeer) {
+      throw new Error('Need join to channel first');
+    }
+
+    try {
+      validateAppData(appData);
+      await this.network.updatePeerAppData({ peerId: myPeer.id, appData });
+    } catch (error) {
+      this.logger.error('updateAppData()', { error });
+      throw new Error('Can not update peer appData');
+    }
+  }
+
   async createCameraVideoTrack(options?: CreateCameraVideoTrackOptions): Promise<Track> {
     const trackParams = Media.getCameraVideoTrackParams(options);
     try {

package/src/engine/media/tracks/BaseTrack.ts

@@ -140,7 +140,7 @@ class BaseTrack {
 
   private async checkProducerState(): Promise<void> {
     try {
-      if (this.#closed) {
+      if (this.#closed || this.kind === 'audio') {
         return;
       }
 
@@ -149,6 +149,7 @@ class BaseTrack {
 
       const isCodecsMatched = await this.isCodecsMatched();
       if (this.#producerRestarted && !isCodecsMatched) {
+        await this.closeSelfConsumer();
         this.clientEventEmitter.emit(CLIENT_EVENTS.trackPublishingFailed, this);
         this.logger.debug('trackPublishingFail()', { track: this });
         return;

package/src/engine/media/tracks/PeerTrack.ts

@@ -1,3 +1,4 @@
+import { MediaKind } from 'mediasoup-client/lib/types';
 import {
   PreferredLayersParams, SetConsumerPriorityParams,
   SpatialLayerParams,
@@ -59,6 +60,10 @@ class PeerTrack {
     return this.#mediaStreamTrack;
   }
 
+  get kind(): MediaKind {
+    return this.mediaStreamTrack.kind as MediaKind;
+  }
+
   get isPaused(): boolean {
     return this.#paused;
   }
@@ -252,7 +257,7 @@ class PeerTrack {
 
   private async checkConsumerState(): Promise<void> {
     try {
-      if (this.#closed) {
+      if (this.#closed || this.kind === 'audio') {
         return;
       }
 

package/src/engine/network/index.ts

@@ -8,10 +8,10 @@ import { Device } from 'mediasoup-client';
 import { Consumer } from 'mediasoup-client/lib/Consumer';
 import SocketIO from './Socket';
 import {
-  CreateConsumerPayload, LogLevel, ProduceParams, RemoteConsumerOptions, SocketResponse,
+  CreateConsumerPayload, LogLevel, ProduceParams, RemoteConsumerOptions, SocketResponse, UpdatePeerAppDataPayload,
 } from '../../types/common';
 import LoadBalancerApiClient from './LoadBalancerClient';
-import { MEDIASOUP_EVENTS, MEDIASOUP_TRANSPORT_EVENTS } from '../../constants/events';
+import { CHANNEL_EVENTS, MEDIASOUP_EVENTS, MEDIASOUP_TRANSPORT_EVENTS } from '../../constants/events';
 import Logger from '../Logger';
 
 export type NetworkParams = {
@@ -264,6 +264,10 @@ class Network {
   async pauseRemoteConsumer(consumerId: string): Promise<SocketResponse> {
     return this.socket.request(MEDIASOUP_EVENTS.pauseConsumer, { consumerId });
   }
+
+  async updatePeerAppData({ peerId, appData }: UpdatePeerAppDataPayload): Promise<SocketResponse> {
+    return this.socket.request(CHANNEL_EVENTS.updatePeerAppData, { peerId, appData });
+  }
 }
 
 export default Network;

package/src/helpers/appDataValidator.ts

@@ -0,0 +1,19 @@
+import { PEER_APP_DATA_MAX_SIZE_BYTES } from '../constants/common';
+
+const validateAppData = (appData: Record<string, unknown>): void => {
+  let validStringifiesJsonAppData;
+  try {
+    validStringifiesJsonAppData = JSON.stringify(appData);
+  } catch (err) {
+    throw new Error('Invalid appData');
+  }
+
+  const size = new TextEncoder().encode(validStringifiesJsonAppData).length;
+  if (size <= PEER_APP_DATA_MAX_SIZE_BYTES) {
+    return;
+  }
+
+  throw new Error('Maximum size appData reached');
+};
+
+export default validateAppData;

package/src/index.ts

@@ -112,6 +112,10 @@ class Client {
   loadPeers(role?: Role): Promise<void> {
     return this.engine.loadPeers(role);
   }
+
+  updateAppData(appData: Record<string, unknown>): Promise<void> {
+    return this.engine.updateAppData(appData);
+  }
 }
 
 export default Client;

package/src/types/common.ts

@@ -273,3 +273,8 @@ export enum DeviceErrors {
   DeviceIsBusy = 'DeviceIsBusy',
   NotAllowedError = 'NotAllowedError',
 }
+
+export type UpdatePeerAppDataPayload = {
+  peerId: string,
+  appData: Record<string, unknown>,
+};