@livedigital/client 2.11.1 → 2.12.0-add-onissue-callback.3

package/src/engine/wid/types.ts

@@ -19,7 +19,7 @@ export enum EventType {
 export type EventPayload = IssueDetectorResult;
 
 export type WebRTCIssueDetectorConstructorParams = {
-  onIssue?: (payload: IssueDetectorResult) => void,
+  onIssues?: (payload: IssueDetectorResult) => void,
 };
 
 export enum IssueType {
@@ -37,7 +37,7 @@ export enum IssueReason {
   EncoderCPUThrottling = 'encoder-cpu-throttling',
   DecoderCPUThrottling = 'decoder-cpu-throttling',
   ServerIssue = 'server-issue',
-  LowMOS = 'low-mean-opinion-score',
+  MOS = 'mean-opinion-score',
 }
 
 export type IssuePayload = {

package/src/helpers/retry.ts

@@ -6,9 +6,9 @@ export type RetryOpts = {
   minBackoffDelayMs?: number;
   maxBackoffDelayMs?: number;
   actionName?: string; // human-readable action name for debug purposes
+  logger?: Logger;
 };
 
-const logger = new Logger('Retry');
 const timeProvider = new DefaultTimeProvider();
 
 const retryAsync = async <ReturnType>(
@@ -28,7 +28,9 @@ const retryAsync = async <ReturnType>(
       return await action();
     } catch (err: unknown) {
       lastError = err;
-      logger.warn('Action retry failed', currentAttempt, opts.actionName, err);
+      if (opts.logger) {
+        opts.logger.info('Action retry failed', currentAttempt, opts.actionName, err);
+      }
 
       if (currentAttempt < maxRetries) {
         const delay = 2 ** (currentAttempt - 1) * minBackoffDelayMs;

package/src/index.ts

@@ -4,6 +4,7 @@ import {
   CreateMicrophoneAudioTrackOptions,
   CreateScreenMediaOptions,
   JoinChannelParams,
+  LogLevel,
   LogMessageHandler,
   Role,
   Track,
@@ -13,13 +14,16 @@ import Engine from './engine';
 import Peer from './engine/Peer';
 import { LoadBalancerApiClientParams } from './engine/network/LoadBalancerClient';
 import DefaultEngineDependenciesFactory from './engine/DefaultEngineDependenciesFactory';
+import { IssuesHandler } from './types/engine';
 
 type ClientParams = {
   observer?: EnhancedEventEmitter;
   network?: {
     loadbalancer?: LoadBalancerApiClientParams;
   },
+  logLevel: LogLevel,
   onLogMessage?: LogMessageHandler;
+  onIssues?: IssuesHandler,
 };
 
 class Client {
@@ -28,7 +32,14 @@ class Client {
   private readonly _observer: EnhancedEventEmitter;
 
   constructor(params: ClientParams) {
-    const { observer, network, onLogMessage } = params;
+    const {
+      observer,
+      network,
+      onLogMessage,
+      onIssues,
+      logLevel,
+    } = params;
+
     this._observer = observer ?? new EnhancedEventEmitter();
     const dependenciesFactory = new DefaultEngineDependenciesFactory();
     this.engine = new Engine({
@@ -40,7 +51,9 @@ class Client {
           customNode: network?.loadbalancer?.customNode,
         },
       },
+      logLevel,
       onLogMessage,
+      onIssues,
     });
   }
 

package/src/types/common.ts

@@ -241,3 +241,5 @@ export type TransformParams = {
 };
 
 export type LogMessageHandler = (msg: any, ...meta: any) => void;
+
+export type LogLevel = 3 | 4 | 6 | 7;

package/src/types/engine.ts

@@ -7,20 +7,33 @@ import ChannelEventHandler from '../engine/handlers/ChannelEventHandler';
 import MediaSoupEventHandler from '../engine/handlers/MediaSoupEventHandler';
 import WebRTCIssueDetector from '../engine/wid/WebRTCIssueDetector';
 import { LoadBalancerApiClientParams } from '../engine/network/LoadBalancerClient';
-import Logger from '../engine/Logger';
+import { IssueDetectorResult } from '../engine/wid/types';
+import { LogLevel } from './common';
+
+export type IssuesHandler = (issues: IssueDetectorResult) => void;
 
 export interface CreateIssueDetectorParams {
-  logger: Logger;
+  onIssues?: IssuesHandler;
+}
+
+export interface CreateMediaParams {
+  logLevel: LogLevel;
 }
 
 export interface CreateNetworkParams {
+  logLevel: LogLevel;
   loadbalancer: LoadBalancerApiClientParams;
 }
 
+export interface CreateSystemParams {
+  logLevel: LogLevel;
+  clientEventEmitter: EnhancedEventEmitter
+}
+
 export interface EngineDependenciesFactory {
-  createSystem: (clientEventEmitter: EnhancedEventEmitter) => System;
-  createMedia: () => Media;
-  createNetwork: (networkParams: CreateNetworkParams) => Network;
+  createSystem: (params: CreateSystemParams) => System;
+  createMedia: (params: CreateMediaParams) => Media;
+  createNetwork: (params: CreateNetworkParams) => Network;
   createChannelEventHandler: (engine: Engine) => ChannelEventHandler;
   createMediaSoupEventHandler: (engine: Engine) => MediaSoupEventHandler;
   createIssueDetector: (params: CreateIssueDetectorParams) => WebRTCIssueDetector;