feat: added ability to specify id for pc

Author: IlgamGabdullin

src/NetworkScoresCalculator.ts

@@ -5,6 +5,7 @@ import {
   INetworkScoresCalculator,
   WebRTCStatsParsed,
   NetworkQualityStatsSample,
+  NetworkScoresPayload,
 } from './types';
 import { scheduleTask } from './utils/tasks';
 import { CLEANUP_PREV_STATS_TTL_MS } from './utils/constants';
@@ -17,7 +18,7 @@ type MosCalculatorResult = {
 class NetworkScoresCalculator implements INetworkScoresCalculator {
   #lastProcessedStats: { [connectionId: string]: WebRTCStatsParsed } = {};
 
-  calculate(data: WebRTCStatsParsed): NetworkScores {
+  calculate({ data, id }: NetworkScoresPayload): NetworkScores {
     const { connection: { id: connectionId } } = data;
     const { mos: outbound, stats: outboundStatsSample } = this.calculateOutboundScore(data) || {};
     const { mos: inbound, stats: inboundStatsSample } = this.calculateInboundScore(data) || {};
@@ -32,6 +33,7 @@ class NetworkScoresCalculator implements INetworkScoresCalculator {
     return {
       outbound,
       inbound,
+      id,
       statsSamples: {
         inboundStatsSample,
         outboundStatsSample,

src/WebRTCIssueDetector.ts

@@ -9,7 +9,7 @@ import {
   Logger,
   StatsReportItem,
   WebRTCIssueDetectorConstructorParams,
-  WebRTCStatsParsed,
+  NetworkScoresPayload,
   WIDWindow,
 } from './types';
 import PeriodicWebRTCStatsReporter from './parser/PeriodicWebRTCStatsReporter';
@@ -85,12 +85,10 @@ class WebRTCIssueDetector {
       this.wrapRTCPeerConnection();
     }
 
-    this.statsReporter.on(PeriodicWebRTCStatsReporter.STATS_REPORT_READY_EVENT, (report: StatsReportItem) => {
-      this.detectIssues({
-        data: report.stats,
-      });
+    this.statsReporter.on(PeriodicWebRTCStatsReporter.STATS_REPORT_READY_EVENT, ({ stats, id }: StatsReportItem) => {
+      this.detectIssues({ data: stats });
 
-      this.calculateNetworkScores(report.stats);
+      this.calculateNetworkScores({ data: stats, id });
     });
 
     this.statsReporter.on(PeriodicWebRTCStatsReporter.STATS_REPORTS_PARSED, (data: { timeTaken: number }) => {
@@ -131,7 +129,7 @@ class WebRTCIssueDetector {
     this.statsReporter.stopReporting();
   }
 
-  public handleNewPeerConnection(pc: RTCPeerConnection): void {
+  public handleNewPeerConnection(pc: RTCPeerConnection, id?: string): void {
     if (!this.#running && this.autoAddPeerConnections) {
       this.logger.debug('Skip handling new peer connection. Detector is not running', pc);
       return;
@@ -143,9 +141,9 @@ class WebRTCIssueDetector {
       this.statsReporter.startReporting();
     }
 
-    this.logger.debug('Handling new peer connection', pc);
+    this.logger.debug(`Handling new peer connection with id ${id}`, pc);
 
-    this.compositeStatsParser.addPeerConnection({ pc });
+    this.compositeStatsParser.addPeerConnection({ pc, id });
   }
 
   private emitIssues(issues: IssuePayload[]): void {
@@ -159,8 +157,8 @@ class WebRTCIssueDetector {
     }
   }
 
-  private calculateNetworkScores(data: WebRTCStatsParsed): void {
-    const networkScores = this.networkScoresCalculator.calculate(data);
+  private calculateNetworkScores(payload: NetworkScoresPayload): void {
+    const networkScores = this.networkScoresCalculator.calculate(payload);
     this.eventEmitter.emit(EventType.NetworkScoresUpdated, networkScores);
   }
 

src/types.ts

@@ -15,7 +15,7 @@ export interface IssueDetector {
 }
 
 export interface INetworkScoresCalculator {
-  calculate(data: WebRTCStatsParsed): NetworkScores;
+  calculate(data: NetworkScoresPayload): NetworkScores;
 }
 
 export enum EventType {
@@ -105,9 +105,15 @@ export type NetworkQualityStatsSample = {
   packetsLoss: number;
 };
 
+export type NetworkScoresPayload = {
+  data: WebRTCStatsParsed,
+  id?: string;
+};
+
 export type NetworkScores = {
   outbound?: NetworkScore,
   inbound?: NetworkScore,
+  id?: string;
   statsSamples: {
     outboundStatsSample?: NetworkQualityStatsSample,
     inboundStatsSample?: NetworkQualityStatsSample,