@100mslive/hms-video-store 0.12.3-alpha.2 → 0.12.3-alpha.4

package/dist/plugins/audio/HMSAudioPlugin.d.ts

@@ -25,7 +25,7 @@ export interface HMSAudioPlugin {
      * variables, loading ML models etc. This can be used by a plugin to ensure it's prepared at the time
      * processAudio is called.
      */
-    init(): Promise<void> | void;
+    init(sessionID?: string): Promise<void> | void;
     /**
      * The name is meant to uniquely specify a plugin instance. This will be used to track number of plugins
      * added to the track, and same name won't be allowed twice.

package/dist/plugins/video/HMSMediaStreamPlugin.d.ts

@@ -4,6 +4,6 @@ export interface HMSMediaStreamPlugin {
      * added to the track, and same name won't be allowed twice.
      */
     getName(): string;
-    apply(stream: MediaStream): MediaStream;
+    apply(stream: MediaStream, sessionID?: string): MediaStream;
     stop(): void;
 }

package/dist/plugins/video/HMSVideoPlugin.d.ts

@@ -25,7 +25,7 @@ export interface HMSVideoPlugin {
      * variables, loading ML models etc. This can be used by a plugin to ensure it's prepared at the time
      * processVideoFrame is called.
      */
-    init(): Promise<void>;
+    init(sessionID?: string): Promise<void>;
     /**
      * @see HMSVideoPluginType
      */

package/dist/sdk/index.d.ts

@@ -38,6 +38,7 @@ export declare class HMSSdk implements HMSInterface {
     private wakeLockManager;
     private sessionStore;
     private interactivityCenter;
+    private pluginUsageTracker;
     private sdkState;
     private frameworkInfo?;
     private playlistSettings;

package/dist/transport/index.d.ts

@@ -2,6 +2,7 @@ import ITransportObserver from './ITransportObserver';
 import { AdditionalAnalyticsProperties } from '../analytics/AdditionalAnalyticsProperties';
 import { AnalyticsEventsService } from '../analytics/AnalyticsEventsService';
 import { AnalyticsTimer } from '../analytics/AnalyticsTimer';
+import { PluginUsageTracker } from '../common/PluginUsageTracker';
 import HMSSubscribeConnection from '../connection/subscribe/subscribeConnection';
 import { DeviceManager } from '../device-manager';
 import { EventBus } from '../events/EventBus';
@@ -18,6 +19,7 @@ export default class HMSTransport {
     private eventBus;
     private analyticsEventsService;
     private analyticsTimer;
+    private pluginUsageTracker;
     private state;
     private trackStates;
     private publishConnection;
@@ -31,7 +33,7 @@ export default class HMSTransport {
     private subscribeStatsAnalytics?;
     private maxSubscribeBitrate;
     joinRetryCount: number;
-    constructor(observer: ITransportObserver, deviceManager: DeviceManager, store: Store, eventBus: EventBus, analyticsEventsService: AnalyticsEventsService, analyticsTimer: AnalyticsTimer);
+    constructor(observer: ITransportObserver, deviceManager: DeviceManager, store: Store, eventBus: EventBus, analyticsEventsService: AnalyticsEventsService, analyticsTimer: AnalyticsTimer, pluginUsageTracker: PluginUsageTracker);
     /**
      * Map of callbacks used to wait for an event to fire.
      * Used here for:

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.12.3-alpha.2",
+  "version": "0.12.3-alpha.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -73,5 +73,5 @@
     "conferencing",
     "100ms"
   ],
-  "gitHead": "ada10fb3dc34984fd59f37f08629e8bd2a0f6c4c"
+  "gitHead": "f402d418c294acc6ce73bc81ab286d26431a6f53"
 }

package/src/analytics/AnalyticsEventFactory.ts

@@ -3,7 +3,6 @@ import { AdditionalAnalyticsProperties } from './AdditionalAnalyticsProperties';
 import AnalyticsEvent from './AnalyticsEvent';
 import { AnalyticsEventLevel } from './AnalyticsEventLevel';
 import { IAnalyticsPropertiesProvider } from './IAnalyticsPropertiesProvider';
-import { pluginUsageTracker } from '../common';
 import { HMSException } from '../error/HMSException';
 import { DeviceMap, SelectedDevices } from '../interfaces';
 import { HMSTrackSettings } from '../media/settings/HMSTrackSettings';
@@ -236,8 +235,7 @@ export default class AnalyticsEventFactory {
     });
   }
 
-  static getKrispUsage(sessionID: string) {
-    const duration = pluginUsageTracker.getPluginUsage('HMSKrispPlugin', sessionID);
+  static getKrispUsage(duration: number) {
     return new AnalyticsEvent({
       name: 'krisp.usage',
       level: AnalyticsEventLevel.INFO,

package/src/common/PluginUsageTracker.ts

@@ -1,53 +1,57 @@
 import AnalyticsEvent from '../analytics/AnalyticsEvent';
+import { EventBus } from '../events/EventBus';
 
-class PluginUsageTracker {
+export class PluginUsageTracker {
   private pluginUsage: Map<string, number> = new Map<string, number>();
   private pluginLastAddedAt: Map<string, number> = new Map<string, number>();
 
-  getPluginUsage = (name: string, sessionID: string) => {
-    const pluginKey = `${sessionID}-${name}`;
+  constructor(private eventBus: EventBus) {
+    this.eventBus.analytics.subscribe(e => this.updatePluginUsageData(e));
+  }
 
-    if (!this.pluginUsage.has(pluginKey)) {
-      this.pluginUsage.set(pluginKey, 0);
+  getPluginUsage = (name: string) => {
+    if (!this.pluginUsage.has(name)) {
+      this.pluginUsage.set(name, 0);
     }
-    if (this.pluginLastAddedAt.has(pluginKey)) {
-      const lastAddedAt = this.pluginLastAddedAt.get(pluginKey) || 0;
+    if (this.pluginLastAddedAt.has(name)) {
+      const lastAddedAt = this.pluginLastAddedAt.get(name) || 0;
       const extraDuration = lastAddedAt ? Date.now() - lastAddedAt : 0;
-      this.pluginUsage.set(pluginKey, (this.pluginUsage.get(pluginKey) || 0) + extraDuration);
-      this.pluginLastAddedAt.delete(pluginKey);
+      this.pluginUsage.set(name, (this.pluginUsage.get(name) || 0) + extraDuration);
+      this.pluginLastAddedAt.delete(name);
     }
-    return this.pluginUsage.get(pluginKey);
+    return this.pluginUsage.get(name);
   };
 
-  updatePluginUsageData = (event: AnalyticsEvent, sessionID: string) => {
-    // Sent on leave, after krisp usage is sent
-    if (event.name === 'transport.leave') {
-      this.cleanup(sessionID);
-      return;
-    }
-
-    const name = event.properties.plugin_name;
-    const pluginKey = `${sessionID}-${name}`;
-    if (event.name === 'mediaPlugin.added') {
-      const addedAt = event.properties.added_at;
-      this.pluginLastAddedAt.set(pluginKey, addedAt);
-    } else if (event.name === 'mediaPlugin.stats') {
-      const duration = event.properties.duration;
-      if (duration > 0) {
-        this.pluginUsage.set(pluginKey, (this.pluginUsage.get(pluginKey) || 0) + duration * 1000);
-        this.pluginLastAddedAt.delete(pluginKey);
+  // eslint-disable-next-line complexity
+  updatePluginUsageData = (event: AnalyticsEvent) => {
+    const name = event.properties?.plugin_name || '';
+    switch (event.name) {
+      // Sent on leave, after krisp usage is sent
+      case 'transport.leave': {
+        this.cleanup();
+        return;
+      }
+      case 'mediaPlugin.toggled.on':
+      case 'mediaPlugin.added': {
+        const addedAt = event.properties.added_at || Date.now();
+        this.pluginLastAddedAt.set(name, addedAt);
+        break;
+      }
+      case 'mediaPlugin.toggled.off':
+      case 'mediaPlugin.stats': {
+        if (this.pluginLastAddedAt.has(name)) {
+          const duration = event.properties.duration || (Date.now() - (this.pluginLastAddedAt.get(name) || 0)) / 1000;
+          this.pluginUsage.set(name, (this.pluginUsage.get(name) || 0) + Math.max(duration, 0) * 1000);
+          this.pluginLastAddedAt.delete(name);
+        }
+        break;
       }
+      default:
     }
   };
 
-  private cleanup = (sessionID: string) => {
-    for (const key of this.pluginUsage.keys()) {
-      if (sessionID.length && key.includes(sessionID)) {
-        this.pluginUsage.delete(key);
-        this.pluginLastAddedAt.delete(key);
-      }
-    }
+  cleanup = () => {
+    this.pluginLastAddedAt.clear();
+    this.pluginUsage.clear();
   };
 }
-
-export const pluginUsageTracker = new PluginUsageTracker();

package/src/index.ts

@@ -53,7 +53,7 @@ export type {
   HMSQuizLeaderboardSummary,
 } from './internal';
 
-export { pluginUsageTracker } from './common';
+export { EventBus } from './events/EventBus';
 export { HMSReactiveStore } from './reactive-store/HMSReactiveStore';
 export { HMSPluginUnsupportedTypes, HMSRecordingState, HLSPlaylistType } from './internal';
 export type {

package/src/plugins/audio/HMSAudioPlugin.ts

@@ -29,7 +29,7 @@ export interface HMSAudioPlugin {
    * variables, loading ML models etc. This can be used by a plugin to ensure it's prepared at the time
    * processAudio is called.
    */
-  init(): Promise<void> | void;
+  init(sessionID?: string): Promise<void> | void;
 
   /**
    * The name is meant to uniquely specify a plugin instance. This will be used to track number of plugins

package/src/plugins/audio/HMSAudioPluginsManager.ts

@@ -87,6 +87,8 @@ export class HMSAudioPluginsManager {
     }
 
     await this.validateAndThrow(name, plugin);
+    // @ts-ignore
+    plugin.setEventBus?.(this.eventBus);
 
     try {
       if (this.pluginsMap.size === 0) {

package/src/plugins/video/HMSMediaStreamPlugin.ts

@@ -5,7 +5,7 @@ export interface HMSMediaStreamPlugin {
    */
   getName(): string;
 
-  apply(stream: MediaStream): MediaStream;
+  apply(stream: MediaStream, sessionID?: string): MediaStream;
 
   stop(): void;
 }

package/src/plugins/video/HMSVideoPlugin.ts

@@ -29,7 +29,7 @@ export interface HMSVideoPlugin {
    * variables, loading ML models etc. This can be used by a plugin to ensure it's prepared at the time
    * processVideoFrame is called.
    */
-  init(): Promise<void>;
+  init(sessionID?: string): Promise<void>;
 
   /**
    * @see HMSVideoPluginType

package/src/sdk/index.ts

@@ -12,7 +12,7 @@ import { HMSAnalyticsLevel } from '../analytics/AnalyticsEventLevel';
 import { AnalyticsEventsService } from '../analytics/AnalyticsEventsService';
 import { AnalyticsTimer, TimedEvent } from '../analytics/AnalyticsTimer';
 import { AudioSinkManager } from '../audio-sink-manager';
-import { pluginUsageTracker } from '../common/PluginUsageTracker';
+import { PluginUsageTracker } from '../common/PluginUsageTracker';
 import { DeviceManager } from '../device-manager';
 import { AudioOutputManager } from '../device-manager/AudioOutputManager';
 import { DeviceStorageManager } from '../device-manager/DeviceStorage';
@@ -119,6 +119,7 @@ export class HMSSdk implements HMSInterface {
   private wakeLockManager!: WakeLockManager;
   private sessionStore!: SessionStore;
   private interactivityCenter!: InteractivityCenter;
+  private pluginUsageTracker!: PluginUsageTracker;
   private sdkState = { ...INITIAL_STATE };
   private frameworkInfo?: HMSFrameworkInfo;
   private playlistSettings: HMSPlaylistSettings = {
@@ -156,6 +157,7 @@ export class HMSSdk implements HMSInterface {
     this.sdkState.isInitialised = true;
     this.store = new Store();
     this.eventBus = new EventBus();
+    this.pluginUsageTracker = new PluginUsageTracker(this.eventBus);
     this.wakeLockManager = new WakeLockManager();
     this.networkTestManager = new NetworkTestManager(this.eventBus, this.listener);
     this.playlistManager = new PlaylistManager(this, this.eventBus);
@@ -179,6 +181,7 @@ export class HMSSdk implements HMSInterface {
       this.eventBus,
       this.analyticsEventsService,
       this.analyticsTimer,
+      this.pluginUsageTracker,
     );
     this.sessionStore = new SessionStore(this.transport);
     this.interactivityCenter = new InteractivityCenter(this.transport, this.store, this.listener);
@@ -572,8 +575,6 @@ export class HMSSdk implements HMSInterface {
       throw error;
     }
     HMSLogger.timeEnd(`join-room-${roomId}`);
-    const sessionID = this.store.getRoom()?.sessionId || '';
-    this.eventBus.analytics.subscribe(e => pluginUsageTracker.updatePluginUsageData(e, sessionID));
   }
 
   private stringifyMetadata(config: HMSConfig) {
@@ -587,6 +588,7 @@ export class HMSSdk implements HMSInterface {
   private cleanup() {
     this.cleanDeviceManagers();
     this.eventBus.analytics.unsubscribe(this.sendAnalyticsEvent);
+    this.pluginUsageTracker?.cleanup();
     this.analyticsTimer.cleanup();
     DeviceStorageManager.cleanup();
     this.playlistManager.cleanup();

package/src/transport/index.ts

@@ -11,6 +11,7 @@ import { AnalyticsTimer, TimedEvent } from '../analytics/AnalyticsTimer';
 import { HTTPAnalyticsTransport } from '../analytics/HTTPAnalyticsTransport';
 import { SignalAnalyticsTransport } from '../analytics/signal-transport/SignalAnalyticsTransport';
 import { PublishStatsAnalytics, SubscribeStatsAnalytics } from '../analytics/stats';
+import { PluginUsageTracker } from '../common/PluginUsageTracker';
 import { HMSConnectionRole, HMSTrickle } from '../connection/model';
 import { IPublishConnectionObserver } from '../connection/publish/IPublishConnectionObserver';
 import HMSPublishConnection from '../connection/publish/publishConnection';
@@ -86,6 +87,7 @@ export default class HMSTransport {
     private eventBus: EventBus,
     private analyticsEventsService: AnalyticsEventsService,
     private analyticsTimer: AnalyticsTimer,
+    private pluginUsageTracker: PluginUsageTracker,
   ) {
     this.webrtcInternals = new HMSWebrtcInternals(
       this.store,
@@ -495,8 +497,9 @@ export default class HMSTransport {
     this.joinParameters = undefined;
     HMSLogger.d(TAG, 'leaving in transport');
     try {
-      const sessionID = this.store.getRoom()?.sessionId || '';
-      this.eventBus.analytics.publish(AnalyticsEventFactory.getKrispUsage(sessionID));
+      this.eventBus.analytics.publish(
+        AnalyticsEventFactory.getKrispUsage(this.pluginUsageTracker.getPluginUsage('HMSKrispPlugin')!),
+      );
       this.eventBus.analytics.publish(AnalyticsEventFactory.transportLeave());
       this.state = TransportState.Leaving;
       this.publishStatsAnalytics?.stop();

package/dist/common/index.d.ts

@@ -1 +0,0 @@
-export { pluginUsageTracker } from './PluginUsageTracker';

package/src/common/index.ts

@@ -1 +0,0 @@
-export { pluginUsageTracker } from './PluginUsageTracker';