feat: Added debug stats to MOS output

Author: desher

README.md

@@ -28,11 +28,12 @@ const webRtcIssueDetector = new WebRTCIssueDetector({
     onIssues: (issues) => issues.map((issue) => {
         console.log('Issues type:', issue.type); // eg. "network"
         console.log('Issues reason:', issue.reason); // eg. "outbound-network-throughput"
-        console.log('Issues reason:', issue.statsSample); // eg. "packetLossPct: 12%, avgJitter: 230, rtt: 150"
+        console.log('Stats:', issue.statsSample); // eg. "packetLossPct: 12%, avgJitter: 230, rtt: 150"
     }),
     onNetworkScoresUpdated: (scores) => {
         console.log('Inbound network score', scores.inbound); // eg. 3.7
         console.log('Outbound network score', scores.outbound); // eg. 4.5
+        console.log('Network stats', scores.statsSamples); // eg. { inboundStatsSample: { avgJitter: 0.1, rtt: 30, packetsLoss: 8 }, ... }
     }
 });
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "webrtc-issue-detector",
-  "version": "1.6.0",
+  "version": "1.7.0-mos-additional-debug.2",
   "description": "WebRTC diagnostic tool that detects issues with network or user devices",
   "repository": "git@github.com:VLprojects/webrtc-issue-detector.git",
   "author": "Roman Kuzakov <roman.kuzakov@gmail.com>",

src/NetworkScoresCalculator.ts

@@ -4,17 +4,23 @@ import {
   NetworkScores,
   INetworkScoresCalculator,
   WebRTCStatsParsed,
+  NetworkQualityStatsSample,
 } from './types';
 import { scheduleTask } from './utils/tasks';
 import { CLEANUP_PREV_STATS_TTL_MS } from './utils/constants';
 
+type MosCalculatorResult = {
+  mos: NetworkScore,
+  stats: NetworkQualityStatsSample,
+};
+
 class NetworkScoresCalculator implements INetworkScoresCalculator {
   #lastProcessedStats: { [connectionId: string]: WebRTCStatsParsed } = {};
 
   calculate(data: WebRTCStatsParsed): NetworkScores {
     const { connection: { id: connectionId } } = data;
-    const outbound = this.calculateOutboundScore(data);
-    const inbound = this.calculateInboundScore(data);
+    const { mos: outbound, stats: outboundStatsSample } = this.calculateOutboundScore(data) || {};
+    const { mos: inbound, stats: inboundStatsSample } = this.calculateInboundScore(data) || {};
     this.#lastProcessedStats[connectionId] = data;
 
     scheduleTask({
@@ -23,10 +29,17 @@ class NetworkScoresCalculator implements INetworkScoresCalculator {
       callback: () => (delete this.#lastProcessedStats[connectionId]),
     });
 
-    return { outbound, inbound };
+    return {
+      outbound,
+      inbound,
+      statsSamples: {
+        inboundStatsSample,
+        outboundStatsSample,
+      },
+    };
   }
 
-  private calculateOutboundScore(data: WebRTCStatsParsed): NetworkScore | undefined {
+  private calculateOutboundScore(data: WebRTCStatsParsed): MosCalculatorResult | undefined {
     const remoteInboundRTPStreamsStats = [
       ...data.remote?.audio.inbound || [],
       ...data.remote?.video.inbound || [],
@@ -75,10 +88,14 @@ class NetworkScoresCalculator implements INetworkScoresCalculator {
       ? Math.round((deltaPacketLost * 100) / (deltaPacketSent + deltaPacketLost))
       : 0;
 
-    return this.calculateMOS({ avgJitter, rtt, packetsLoss });
+    const mos = this.calculateMOS({ avgJitter, rtt, packetsLoss });
+    return {
+      mos,
+      stats: { avgJitter, rtt, packetsLoss },
+    };
   }
 
-  private calculateInboundScore(data: WebRTCStatsParsed): NetworkScore | undefined {
+  private calculateInboundScore(data: WebRTCStatsParsed): MosCalculatorResult | undefined {
     const inboundRTPStreamsStats = [...data.audio?.inbound, ...data.video?.inbound];
     if (!inboundRTPStreamsStats.length) {
       return undefined;
@@ -117,7 +134,11 @@ class NetworkScoresCalculator implements INetworkScoresCalculator {
       ? Math.round((deltaPacketLost * 100) / (deltaPacketReceived + deltaPacketLost))
       : 0;
 
-    return this.calculateMOS({ avgJitter, rtt, packetsLoss });
+    const mos = this.calculateMOS({ avgJitter, rtt, packetsLoss });
+    return {
+      mos,
+      stats: { avgJitter, rtt, packetsLoss },
+    };
   }
 
   private calculateMOS(

src/types.ts

@@ -99,9 +99,19 @@ export type DetectIssuesPayload = {
 
 export type NetworkScore = number;
 
+export type NetworkQualityStatsSample = {
+  avgJitter: number;
+  rtt: number;
+  packetsLoss: number;
+};
+
 export type NetworkScores = {
   outbound?: NetworkScore,
   inbound?: NetworkScore,
+  statsSamples: {
+    outboundStatsSample?: NetworkQualityStatsSample,
+    inboundStatsSample?: NetworkQualityStatsSample,
+  },
 };
 
 export type StatsParsingFinishedPayload = {