@100mslive/hms-video-store/src/analytics/AnalyticsTransport.ts

@100mslive Core SDK which abstracts the complexities of webRTC while providing a reactive store for data management with a unidirectional data flow

import AnalyticsEvent from './AnalyticsEvent';
import { HTTPAnalyticsTransport } from './HTTPAnalyticsTransport';
import { IAnalyticsTransportProvider } from './IAnalyticsTransportProvider';
import HMSLogger from '../utils/logger';
import { Queue } from '../utils/queue';

export abstract class AnalyticsTransport {
  abstract transportProvider: IAnalyticsTransportProvider;
  abstract failedEvents: Queue<AnalyticsEvent>;
  private readonly TAG = '[AnalyticsTransport]';

  private eventCount = 0;
  private lastResetTime: number = Date.now();
  private readonly MAX_EVENTS_PER_MINUTE: number = 200;
  private readonly RESET_INTERVAL_MS: number = 60000;

  private checkRateLimit() {
    const now = Date.now();
    if (now - this.lastResetTime >= this.RESET_INTERVAL_MS) {
      this.eventCount = 0;
      this.lastResetTime = now;
    }
    if (this.eventCount >= this.MAX_EVENTS_PER_MINUTE) {
      throw new Error('Too many events being sent, please check the implementation.');
    }
    this.eventCount++;
  }

  sendEvent(event: AnalyticsEvent) {
    try {
      this.checkRateLimit();
    } catch (e) {
      HMSLogger.w(this.TAG, 'Rate limit exceeded', e);
      throw e;
    }
    try {
      this.sendSingleEvent(event);
      this.flushFailedEvents();
    } catch (error) {
      HMSLogger.w(this.TAG, 'sendEvent failed', error);
    }
  }

  flushFailedEvents(currentPeerId?: string) {
    try {
      HMSLogger.d(this.TAG, 'Flushing failed events', this.failedEvents);
      while (this.failedEvents.size() > 0) {
        const event = this.failedEvents.dequeue();
        if (event) {
          const isEventFromCurrentPeer = event.metadata?.peer.peer_id === currentPeerId;
          if (isEventFromCurrentPeer || !event.metadata.peer.peer_id) {
            this.sendSingleEvent(event);
          } else {
            HTTPAnalyticsTransport.sendEvent(event);
          }
        }
      }
    } catch (error) {
      HMSLogger.w(this.TAG, 'flushFailedEvents failed', error);
    }
  }

  private sendSingleEvent(event: AnalyticsEvent) {
    try {
      this.transportProvider.sendEvent(event);
      HMSLogger.d(this.TAG, 'Sent event', event.name, event);
    } catch (error) {
      HMSLogger.w(this.TAG, `${this.transportProvider.TAG}.sendEvent failed, adding to local storage events`, {
        event,
        error,
      });
      this.failedEvents.enqueue(event);
      throw error;
    }
  }
}