rename debug to statsSamples

Author: desher

src/NetworkScoresCalculator.ts

@@ -4,23 +4,23 @@ import {
   NetworkScores,
   INetworkScoresCalculator,
   WebRTCStatsParsed,
-  NetworkQualityStats,
+  NetworkQualityStatsSample,
 } from './types';
 import { scheduleTask } from './utils/tasks';
 import { CLEANUP_PREV_STATS_TTL_MS } from './utils/constants';
 
 type MosCalculatorResult = {
   mos: NetworkScore,
-  stats: NetworkQualityStats,
+  stats: NetworkQualityStatsSample,
 };
 
 class NetworkScoresCalculator implements INetworkScoresCalculator {
   #lastProcessedStats: { [connectionId: string]: WebRTCStatsParsed } = {};
 
   calculate(data: WebRTCStatsParsed): NetworkScores {
     const { connection: { id: connectionId } } = data;
-    const { mos: outbound, stats: outboundStats } = this.calculateOutboundScore(data) || {};
-    const { mos: inbound, stats: inboundStats } = this.calculateInboundScore(data) || {};
+    const { mos: outbound, stats: outboundStatsSample } = this.calculateOutboundScore(data) || {};
+    const { mos: inbound, stats: inboundStatsSample } = this.calculateInboundScore(data) || {};
     this.#lastProcessedStats[connectionId] = data;
 
     scheduleTask({
@@ -32,9 +32,9 @@ class NetworkScoresCalculator implements INetworkScoresCalculator {
     return {
       outbound,
       inbound,
-      debug: {
-        inboundStats,
-        outboundStats,
+      statsSamples: {
+        inboundStatsSample,
+        outboundStatsSample,
       },
     };
   }

src/types.ts

@@ -99,7 +99,7 @@ export type DetectIssuesPayload = {
 
 export type NetworkScore = number;
 
-export type NetworkQualityStats = {
+export type NetworkQualityStatsSample = {
   avgJitter: number;
   rtt: number;
   packetsLoss: number;
@@ -108,9 +108,9 @@ export type NetworkQualityStats = {
 export type NetworkScores = {
   outbound?: NetworkScore,
   inbound?: NetworkScore,
-  debug: {
-    outboundStats?: NetworkQualityStats,
-    inboundStats?: NetworkQualityStats,
+  statsSamples: {
+    outboundStatsSample?: NetworkQualityStatsSample,
+    inboundStatsSample?: NetworkQualityStatsSample,
   },
 };