@100mslive/hms-video-store 0.12.20-alpha.3 → 0.12.20

package/dist/interfaces/room.d.ts

@@ -31,7 +31,6 @@ export interface HMSRoom {
     max_size?: number;
     large_room_optimization?: boolean;
     isEffectsEnabled?: boolean;
-    disableNoneLayerRequest?: boolean;
     isVBEnabled?: boolean;
     effectsKey?: string;
     isHipaaEnabled?: boolean;

package/dist/media/tracks/HMSRemoteVideoTrack.d.ts

@@ -9,8 +9,7 @@ export declare class HMSRemoteVideoTrack extends HMSVideoTrack {
     private history;
     private preferredLayer;
     private bizTrackId;
-    private disableNoneLayerRequest;
-    constructor(stream: HMSRemoteStream, track: MediaStreamTrack, source?: string, disableNoneLayerRequest?: boolean);
+    constructor(stream: HMSRemoteStream, track: MediaStreamTrack, source?: string);
     setTrackId(trackId: string): void;
     get trackId(): string;
     get degraded(): boolean;

package/dist/schema/room.d.ts

@@ -37,7 +37,6 @@ export interface HMSRoom {
     peerCount?: number;
     isLargeRoom?: boolean;
     isEffectsEnabled?: boolean;
-    disableNoneLayerRequest?: boolean;
     isVBEnabled?: boolean;
     effectsKey?: string;
     isHipaaEnabled?: boolean;

package/dist/sdk/models/HMSRoom.d.ts

@@ -15,7 +15,6 @@ export default class Room implements HMSRoom {
     large_room_optimization?: boolean;
     transcriptions?: HMSTranscriptionInfo[];
     isEffectsEnabled?: boolean;
-    disableNoneLayerRequest?: boolean;
     isVBEnabled?: boolean;
     effectsKey?: string;
     isHipaaEnabled?: boolean;

package/dist/signal/init/models.d.ts

@@ -55,6 +55,5 @@ export declare enum InitFlags {
     FLAG_VB_ENABLED = "vb",
     FLAG_HIPAA_ENABLED = "hipaa",
     FLAG_NOISE_CANCELLATION = "noiseCancellation",
-    FLAG_SCALE_SCREENSHARE_BASED_ON_PIXELS = "scaleScreenshareBasedOnPixels",
-    FLAG_DISABLE_NONE_LAYER_REQUEST = "disableNoneLayerRequest"
+    FLAG_SCALE_SCREENSHARE_BASED_ON_PIXELS = "scaleScreenshareBasedOnPixels"
 }

package/dist/transport/RetryScheduler.d.ts

@@ -18,7 +18,7 @@ interface ScheduleTaskParams {
     error: HMSException;
     task: RetryTask;
     originalState: TransportState;
-    maxRetryTime?: number;
+    maxFailedRetries?: number;
     changeState?: boolean;
 }
 export declare class RetryScheduler {
@@ -28,10 +28,11 @@ export declare class RetryScheduler {
     private inProgress;
     private retryTaskIds;
     constructor(onStateChange: (state: TransportState, error?: HMSException) => Promise<void>, sendEvent: (error: HMSException, category: TFC) => void);
-    schedule({ category, error, task, originalState, maxRetryTime, changeState, }: ScheduleTaskParams): Promise<void>;
+    schedule({ category, error, task, originalState, maxFailedRetries, changeState, }: ScheduleTaskParams): Promise<void>;
     reset(): void;
     isTaskInProgress(category: TFC): boolean;
     private scheduleTask;
+    private getBaseDelayForTask;
     private getDelayForRetryCount;
     private setTimeoutPromise;
 }

package/dist/utils/constants.d.ts

@@ -2,12 +2,13 @@ export declare const RENEGOTIATION_CALLBACK_ID = "renegotiation-callback-id";
 export declare const API_DATA_CHANNEL = "ion-sfu";
 export declare const ANALYTICS_BUFFER_SIZE = 100;
 /**
- * Maximum time that transport-layer will try
+ * Maximum number of retries that transport-layer will try
  * before giving up on the connection and returning a failure
  *
  * Refer https://100ms.atlassian.net/browse/HMS-2369
  */
-export declare const MAX_TRANSPORT_RETRY_TIME = 60000;
+export declare const MAX_TRANSPORT_RETRIES = 5;
+export declare const MAX_TRANSPORT_RETRY_DELAY = 60;
 export declare const DEFAULT_SIGNAL_PING_TIMEOUT = 12000;
 export declare const DEFAULT_SIGNAL_PING_INTERVAL = 3000;
 export declare const PONG_RESPONSE_TIMES_SIZE = 5;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.12.20-alpha.3",
+  "version": "0.12.20",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -73,5 +73,5 @@
     "conferencing",
     "100ms"
   ],
-  "gitHead": "7432edcc726ca36bf1ffeab7e0ab8ab16f461ac3"
+  "gitHead": "da50781c2357d6201da1c94dcfef574a0081e2dc"
 }

package/src/connection/subscribe/subscribeConnection.ts

@@ -98,11 +98,8 @@ export default class HMSSubscribeConnection extends HMSConnection {
       });
 
       const remote = this.remoteStreams.get(streamId)!;
-      const isAudioTrack = e.track.kind === 'audio';
-      const TrackCls = isAudioTrack ? HMSRemoteAudioTrack : HMSRemoteVideoTrack;
-      const track = isAudioTrack
-        ? new TrackCls(remote, e.track)
-        : new TrackCls(remote, e.track, undefined, this.isFlagEnabled(InitFlags.FLAG_DISABLE_NONE_LAYER_REQUEST));
+      const TrackCls = e.track.kind === 'audio' ? HMSRemoteAudioTrack : HMSRemoteVideoTrack;
+      const track = new TrackCls(remote, e.track);
       // reset the simulcast layer to none when new video tracks are added, UI will subscribe when required
       if (e.track.kind === 'video') {
         remote.setVideoLayerLocally(HMSSimulcastLayer.NONE, 'addTrack', 'subscribeConnection');

package/src/device-manager/DeviceManager.ts

@@ -259,7 +259,7 @@ export class DeviceManager implements HMSDeviceManager {
     if (defaultDevice) {
       // Selecting a non-default device so that the deviceId comparision does not give
       // false positives when device is removed, because the other available device
-      // gets the deviceId as default once this device is removed
+      // get's the deviceId as default once this device is removed
       const nextDevice = this.audioInput.find(device => {
         return device.deviceId !== 'default' && defaultDevice.label.includes(device.label);
       });

package/src/interfaces/room.ts

@@ -34,7 +34,6 @@ export interface HMSRoom {
   max_size?: number;
   large_room_optimization?: boolean;
   isEffectsEnabled?: boolean;
-  disableNoneLayerRequest?: boolean;
   isVBEnabled?: boolean;
   effectsKey?: string;
   isHipaaEnabled?: boolean;

package/src/media/tracks/HMSLocalAudioTrack.ts

@@ -184,8 +184,8 @@ export class HMSLocalAudioTrack extends HMSAudioTrack {
       return;
     }
 
-    // Replace silent empty track or muted track(happens when microphone is disabled from address bar in iOS) with an actual audio track, if enabled.
-    if (value && (isEmptyTrack(this.nativeTrack) || this.nativeTrack.muted)) {
+    // Replace silent empty track with an actual audio track, if enabled.
+    if (value && isEmptyTrack(this.nativeTrack)) {
       await this.replaceTrackWith(this.settings);
     }
     await super.setEnabled(value);

package/src/media/tracks/HMSLocalVideoTrack.ts

@@ -566,7 +566,12 @@ export class HMSLocalVideoTrack extends HMSVideoTrack {
     if (document.visibilityState === 'hidden') {
       this.enabledStateBeforeBackground = this.enabled;
       if (this.enabled) {
-        await this.setEnabled(false);
+        const track = await this.replaceTrackWithBlank();
+        await this.replaceSender(track, this.enabled);
+        this.nativeTrack?.stop();
+        this.nativeTrack = track;
+      } else {
+        await this.replaceSender(this.nativeTrack, false);
       }
       // started interruption event
       this.eventBus.analytics.publish(
@@ -576,9 +581,12 @@ export class HMSLocalVideoTrack extends HMSVideoTrack {
         }),
       );
     } else {
-      HMSLogger.d(this.TAG, 'visibility visible, restoring track state', this.enabledStateBeforeBackground);
+      HMSLogger.d(this.TAG, 'visibility visibile, restoring track state', this.enabledStateBeforeBackground);
       if (this.enabledStateBeforeBackground) {
         await this.setEnabled(true);
+      } else {
+        this.nativeTrack.enabled = this.enabledStateBeforeBackground;
+        await this.replaceSender(this.nativeTrack, this.enabledStateBeforeBackground);
       }
       // ended interruption event
       this.eventBus.analytics.publish(
@@ -588,5 +596,6 @@ export class HMSLocalVideoTrack extends HMSVideoTrack {
         }),
       );
     }
+    this.eventBus.localVideoEnabled.publish({ enabled: this.nativeTrack.enabled, track: this });
   };
 }

package/src/media/tracks/HMSRemoteVideoTrack.ts

@@ -18,11 +18,9 @@ export class HMSRemoteVideoTrack extends HMSVideoTrack {
   private history = new TrackHistory();
   private preferredLayer: HMSPreferredSimulcastLayer = HMSSimulcastLayer.HIGH;
   private bizTrackId!: string;
-  private disableNoneLayerRequest = false;
 
-  constructor(stream: HMSRemoteStream, track: MediaStreamTrack, source?: string, disableNoneLayerRequest?: boolean) {
+  constructor(stream: HMSRemoteStream, track: MediaStreamTrack, source?: string) {
     super(stream, track, source);
-    this.disableNoneLayerRequest = !!disableNoneLayerRequest;
     this.setVideoHandler(new VideoElementManager(this));
   }
 
@@ -172,10 +170,7 @@ export class HMSRemoteVideoTrack extends HMSVideoTrack {
   }
 
   private async updateLayer(source: string) {
-    const newLayer =
-      (this.degraded || !this.enabled || !this.hasSinks()) && !this.disableNoneLayerRequest
-        ? HMSSimulcastLayer.NONE
-        : this.preferredLayer;
+    const newLayer = this.degraded || !this.enabled || !this.hasSinks() ? HMSSimulcastLayer.NONE : this.preferredLayer;
     if (!this.shouldSendVideoLayer(newLayer, source)) {
       return;
     }

package/src/media/tracks/RemoteVideoTrack.test.ts

@@ -19,7 +19,7 @@ describe('remoteVideoTrack', () => {
     const connection = { sendOverApiDataChannelWithResponse } as unknown as HMSSubscribeConnection;
     stream = new HMSRemoteStream(nativeStream, connection);
     nativeTrack = { id: trackId, kind: 'video', enabled: true } as MediaStreamTrack;
-    track = new HMSRemoteVideoTrack(stream, nativeTrack, 'regular', false);
+    track = new HMSRemoteVideoTrack(stream, nativeTrack, 'regular');
     window.MediaStream = jest.fn().mockImplementation(() => ({
       addTrack: jest.fn(),
       // Add any method you want to mock
@@ -156,63 +156,3 @@ describe('remoteVideoTrack', () => {
     expectLayersSent([HMSSimulcastLayer.HIGH, HMSSimulcastLayer.NONE]);
   });
 });
-
-describe('HMSRemoteVideoTrack with disableNoneLayerRequest', () => {
-  let stream: HMSRemoteStream;
-  let sendOverApiDataChannelWithResponse: jest.Mock;
-  let track: HMSRemoteVideoTrack;
-  let nativeTrack: MediaStreamTrack;
-  let videoElement: HTMLVideoElement;
-  const trackId = 'test-track-id';
-
-  beforeEach(() => {
-    videoElement = document.createElement('video');
-    sendOverApiDataChannelWithResponse = jest.fn();
-    const connection = { sendOverApiDataChannelWithResponse } as unknown as HMSSubscribeConnection;
-    const nativeStream = new MediaStream();
-    stream = new HMSRemoteStream(nativeStream, connection);
-    nativeTrack = { id: trackId, kind: 'video', enabled: true } as MediaStreamTrack;
-    track = new HMSRemoteVideoTrack(stream, nativeTrack, 'regular', true); // disableNoneLayerRequest flag is set
-    track.setTrackId(trackId);
-
-    window.MediaStream = jest.fn().mockImplementation(() => ({
-      addTrack: jest.fn(),
-    }));
-  });
-
-  const expectLayersSent = (layers: HMSSimulcastLayer[]) => {
-    const allCalls = sendOverApiDataChannelWithResponse.mock.calls;
-    expect(allCalls.length).toBe(layers.length);
-    for (let i = 0; i < allCalls.length; i++) {
-      const data = allCalls[i][0];
-      expect(data.params.max_spatial_layer).toBe(layers[i]);
-    }
-  };
-
-  const sfuDegrades = () => {
-    track.setLayerFromServer({
-      subscriber_degraded: true,
-      expected_layer: HMSSimulcastLayer.HIGH,
-      current_layer: HMSSimulcastLayer.NONE,
-      publisher_degraded: false,
-      track_id: trackId,
-    });
-  };
-
-  test('disableNoneLayerRequest - degradation', async () => {
-    await track.addSink(videoElement);
-    expectLayersSent([HMSSimulcastLayer.HIGH]);
-
-    sfuDegrades();
-    expectLayersSent([HMSSimulcastLayer.HIGH]);
-  });
-
-  test('disableNoneLayerRequest - mute and removeSink', async () => {
-    await track.addSink(videoElement);
-    track.setEnabled(false);
-    expectLayersSent([HMSSimulcastLayer.HIGH]);
-
-    await track.removeSink(videoElement);
-    expectLayersSent([HMSSimulcastLayer.HIGH]);
-  });
-});

package/src/notification-manager/managers/onDemandTrackManager.ts

@@ -67,12 +67,7 @@ export class OnDemandTrackManager extends TrackManager {
     const remoteStream = new HMSRemoteStream(new MediaStream(), this.transport.getSubscribeConnection()!);
     const emptyTrack = LocalTrackManager.getEmptyVideoTrack();
     emptyTrack.enabled = !trackInfo.mute;
-    const track = new HMSRemoteVideoTrack(
-      remoteStream,
-      emptyTrack,
-      trackInfo.source,
-      this.store.getRoom()?.disableNoneLayerRequest,
-    );
+    const track = new HMSRemoteVideoTrack(remoteStream, emptyTrack, trackInfo.source);
     track.setTrackId(trackInfo.track_id);
     track.peerId = hmsPeer.peerId;
     track.logIdentifier = hmsPeer.name;

package/src/reactive-store/adapter.ts

@@ -159,7 +159,6 @@ export class SDKToHMS {
       peerCount: sdkRoom.peerCount,
       isLargeRoom: sdkRoom.large_room_optimization,
       isEffectsEnabled: sdkRoom.isEffectsEnabled,
-      disableNoneLayerRequest: sdkRoom.disableNoneLayerRequest,
       isVBEnabled: sdkRoom.isVBEnabled,
       effectsKey: sdkRoom.effectsKey,
       isHipaaEnabled: sdkRoom.isHipaaEnabled,

package/src/schema/room.ts

@@ -40,7 +40,6 @@ export interface HMSRoom {
   peerCount?: number;
   isLargeRoom?: boolean;
   isEffectsEnabled?: boolean;
-  disableNoneLayerRequest?: boolean;
   isVBEnabled?: boolean;
   effectsKey?: string;
   isHipaaEnabled?: boolean;

package/src/sdk/models/HMSRoom.ts

@@ -16,7 +16,6 @@ export default class Room implements HMSRoom {
   large_room_optimization?: boolean;
   transcriptions?: HMSTranscriptionInfo[] = [];
   isEffectsEnabled?: boolean;
-  disableNoneLayerRequest?: boolean;
   isVBEnabled?: boolean;
   effectsKey?: string;
   isHipaaEnabled?: boolean;

package/src/signal/init/models.ts

@@ -62,5 +62,4 @@ export enum InitFlags {
   FLAG_HIPAA_ENABLED = 'hipaa',
   FLAG_NOISE_CANCELLATION = 'noiseCancellation',
   FLAG_SCALE_SCREENSHARE_BASED_ON_PIXELS = 'scaleScreenshareBasedOnPixels',
-  FLAG_DISABLE_NONE_LAYER_REQUEST = 'disableNoneLayerRequest',
 }

package/src/transport/RetryScheduler.ts

@@ -1,7 +1,7 @@
 import { Dependencies as TFCDependencies, TransportFailureCategory as TFC } from './models/TransportFailureCategory';
 import { TransportState } from './models/TransportState';
 import { HMSException } from '../error/HMSException';
-import { MAX_TRANSPORT_RETRY_TIME } from '../utils/constants';
+import { MAX_TRANSPORT_RETRIES, MAX_TRANSPORT_RETRY_DELAY } from '../utils/constants';
 import HMSLogger from '../utils/logger';
 import { PromiseWithCallbacks } from '../utils/promise';
 
@@ -23,7 +23,7 @@ interface ScheduleTaskParams {
   error: HMSException;
   task: RetryTask;
   originalState: TransportState;
-  maxRetryTime?: number;
+  maxFailedRetries?: number;
   changeState?: boolean;
 }
 
@@ -42,10 +42,10 @@ export class RetryScheduler {
     error,
     task,
     originalState,
-    maxRetryTime = MAX_TRANSPORT_RETRY_TIME,
+    maxFailedRetries = MAX_TRANSPORT_RETRIES,
     changeState = true,
   }: ScheduleTaskParams) {
-    await this.scheduleTask({ category, error, changeState, task, originalState, maxRetryTime, failedAt: Date.now() });
+    await this.scheduleTask({ category, error, changeState, task, originalState, maxFailedRetries });
   }
 
   reset() {
@@ -65,10 +65,9 @@ export class RetryScheduler {
     changeState,
     task,
     originalState,
-    failedAt,
-    maxRetryTime = MAX_TRANSPORT_RETRY_TIME,
+    maxFailedRetries = MAX_TRANSPORT_RETRIES,
     failedRetryCount = 0,
-  }: ScheduleTaskParams & { failedAt: number; failedRetryCount?: number }): Promise<void> {
+  }: ScheduleTaskParams & { failedRetryCount?: number }): Promise<void> {
     HMSLogger.d(this.TAG, 'schedule: ', { category: TFC[category], error });
 
     // First schedule call
@@ -114,9 +113,8 @@ export class RetryScheduler {
       }
     }
 
-    const timeElapsedSinceError = Date.now() - failedAt;
-    if (timeElapsedSinceError >= maxRetryTime || hasFailedDependency) {
-      error.description += `. [${TFC[category]}] Could not recover after ${timeElapsedSinceError} milliseconds`;
+    if (failedRetryCount >= maxFailedRetries || hasFailedDependency) {
+      error.description += `. [${TFC[category]}] Could not recover after ${failedRetryCount} tries`;
 
       if (hasFailedDependency) {
         error.description += ` Could not recover all of it's required dependencies - [${(dependencies as Array<TFC>)
@@ -146,7 +144,7 @@ export class RetryScheduler {
       this.onStateChange(TransportState.Reconnecting, error);
     }
 
-    const delay = this.getDelayForRetryCount(category);
+    const delay = this.getDelayForRetryCount(category, failedRetryCount);
 
     HMSLogger.d(
       this.TAG,
@@ -173,10 +171,7 @@ export class RetryScheduler {
       if (changeState && this.inProgress.size === 0) {
         this.onStateChange(originalState);
       }
-      HMSLogger.d(
-        this.TAG,
-        `schedule: [${TFC[category]}] [failedRetryCount=${failedRetryCount}] Recovered ♻️ after ${timeElapsedSinceError}ms`,
-      );
+      HMSLogger.d(this.TAG, `schedule: [${TFC[category]}] [failedRetryCount=${failedRetryCount}] Recovered ♻️`);
     } else {
       await this.scheduleTask({
         category,
@@ -184,23 +179,25 @@ export class RetryScheduler {
         changeState,
         task,
         originalState,
-        maxRetryTime,
-        failedAt,
+        maxFailedRetries,
         failedRetryCount: failedRetryCount + 1,
       });
     }
   }
 
-  private getDelayForRetryCount(category: TFC) {
-    const jitter = category === TFC.JoinWSMessageFailed ? Math.random() * 2 : Math.random();
-    let delaySeconds = 0;
+  private getBaseDelayForTask(category: TFC, n: number) {
     if (category === TFC.JoinWSMessageFailed) {
       // linear backoff(2 + jitter for every retry)
-      delaySeconds = 2 + jitter;
-    } else if (category === TFC.SignalDisconnect) {
-      delaySeconds = 1;
+      return 2;
     }
-    return delaySeconds * 1000;
+    // exponential backoff
+    return Math.pow(2, n);
+  }
+
+  private getDelayForRetryCount(category: TFC, n: number) {
+    const delay = this.getBaseDelayForTask(category, n);
+    const jitter = category === TFC.JoinWSMessageFailed ? Math.random() * 2 : Math.random();
+    return Math.round(Math.min(delay + jitter, MAX_TRANSPORT_RETRY_DELAY) * 1000);
   }
 
   private async setTimeoutPromise<T>(task: () => Promise<T>, delay: number): Promise<T> {

package/src/transport/index.ts

@@ -36,6 +36,7 @@ import { ISignalEventsObserver } from '../signal/ISignalEventsObserver';
 import JsonRpcSignal from '../signal/jsonrpc';
 import {
   ICE_DISCONNECTION_TIMEOUT,
+  MAX_TRANSPORT_RETRIES,
   PROTOCOL_SPEC,
   PROTOCOL_VERSION,
   PUBLISH_STATS_PUSH_INTERVAL,
@@ -351,6 +352,7 @@ export default class HMSTransport {
           error,
           task,
           originalState: this.state,
+          maxFailedRetries: MAX_TRANSPORT_RETRIES,
           changeState: false,
         });
       } else {
@@ -921,6 +923,7 @@ export default class HMSTransport {
           error: hmsError,
           task,
           originalState: TransportState.Joined,
+          maxFailedRetries: 3,
           changeState: false,
         });
       } else {
@@ -1084,6 +1087,7 @@ export default class HMSTransport {
         error,
         task: this.retrySubscribeIceFailedTask,
         originalState: TransportState.Joined,
+        maxFailedRetries: 1,
       });
     }
   }
@@ -1105,7 +1109,6 @@ export default class HMSTransport {
       if (room) {
         room.effectsKey = this.initConfig.config.vb?.effectsKey;
         room.isEffectsEnabled = this.isFlagEnabled(InitFlags.FLAG_EFFECTS_SDK_ENABLED);
-        room.disableNoneLayerRequest = this.isFlagEnabled(InitFlags.FLAG_DISABLE_NONE_LAYER_REQUEST);
         room.isVBEnabled = this.isFlagEnabled(InitFlags.FLAG_VB_ENABLED);
         room.isHipaaEnabled = this.isFlagEnabled(InitFlags.FLAG_HIPAA_ENABLED);
         room.isNoiseCancellationEnabled = this.isFlagEnabled(InitFlags.FLAG_NOISE_CANCELLATION);

package/src/utils/constants.ts

@@ -3,12 +3,13 @@ export const API_DATA_CHANNEL = 'ion-sfu';
 export const ANALYTICS_BUFFER_SIZE = 100;
 
 /**
- * Maximum time that transport-layer will try
+ * Maximum number of retries that transport-layer will try
  * before giving up on the connection and returning a failure
  *
  * Refer https://100ms.atlassian.net/browse/HMS-2369
  */
-export const MAX_TRANSPORT_RETRY_TIME = 60_000;
+export const MAX_TRANSPORT_RETRIES = 5;
+export const MAX_TRANSPORT_RETRY_DELAY = 60;
 
 export const DEFAULT_SIGNAL_PING_TIMEOUT = 12_000;
 export const DEFAULT_SIGNAL_PING_INTERVAL = 3_000;