@livedigital/client 2.7.0 → 2.7.2-improve-network-issue-detector.1

package/package.json

@@ -2,7 +2,7 @@
   "name": "@livedigital/client",
   "author": "vlprojects",
   "license": "MIT",
-  "version": "2.7.0",
+  "version": "2.7.2-improve-network-issue-detector.1",
   "private": false,
   "bugs": {
     "url": "https://github.com/vlprojects/livedigital-sdk/issues"

package/src/engine/wid/WebRTCIssueDetector.ts

@@ -81,6 +81,10 @@ class WebRTCIssueDetector {
       return;
     }
 
+    if (!(pc instanceof RTCPeerConnection)) {
+      return;
+    }
+
     this.webrtcStats.addConnection({
       pc,
       peerId: this.webrtcStatsPeerId,

package/src/engine/wid/detectors/FramesDroppedIssueDetector.ts

@@ -18,6 +18,10 @@ class FramesDroppedIssueDetector implements IssueDetector {
   }
 
   private processData(data: WebRTCStatsEventData): IssueDetectorResult {
+    if (!data.video?.inbound) {
+      return [];
+    }
+
     const streamsWithDroppedFrames = data.video.inbound.filter((stats) => stats.framesDropped > 0);
     const issues: IssueDetectorResult = [];
     const previousInboundRTPVideoStreamsStats = this.#lastProcessedStats[data.connection.id]?.video.inbound;

package/src/engine/wid/detectors/FramesEncodedSentIssueDetector.ts

@@ -18,6 +18,10 @@ class FramesEncodedSentIssueDetector implements IssueDetector {
   }
 
   private processData(data: WebRTCStatsEventData): IssueDetectorResult {
+    if (!data.video?.outbound) {
+      return [];
+    }
+
     const streamsWithEncodedFrames = data.video.outbound.filter((stats) => stats.framesEncoded > 0);
     const issues: IssueDetectorResult = [];
     const previousOutboundRTPVideoStreamsStats = this.#lastProcessedStats[data.connection.id]?.video.outbound;

package/src/engine/wid/detectors/NetworkIssueDetector.ts

@@ -17,9 +17,9 @@ class NetworkIssueDetector implements IssueDetector {
 
   private processData(data: WebRTCStatsEventData): IssueDetectorResult {
     const issues: IssueDetectorResult = [];
-    const inboundRTPStreamsStats = [...data.audio.inbound, ...data.video.inbound];
+    const inboundRTPStreamsStats = [...data.audio?.inbound, ...data.video?.inbound];
     const previousStats = this.#lastProcessedStats[data.connection.id];
-    const previousInboundStreamStats = [...previousStats.video.inbound, ...previousStats.audio.inbound];
+    const previousInboundStreamStats = [...previousStats.video?.inbound, ...previousStats.audio?.inbound];
 
     if (!inboundRTPStreamsStats.length || !previousStats) {
       return issues;
@@ -30,21 +30,30 @@ class NetworkIssueDetector implements IssueDetector {
 
     const rtpNetworkStats = inboundRTPStreamsStats.reduce((stats, currentStreamStats) => {
       const previousStreamStats = previousInboundStreamStats.find((stream) => stream.ssrc === currentStreamStats.ssrc);
+
       const lastJitterBufferDelay = previousStreamStats?.jitterBufferDelay || 0;
       const lastJitterBufferEmittedCount = previousStreamStats?.jitterBufferEmittedCount || 0;
       const delay = currentStreamStats.jitterBufferDelay - lastJitterBufferDelay;
       const emitted = currentStreamStats.jitterBufferEmittedCount - lastJitterBufferEmittedCount;
-      const latency = delay && emitted ? (1e3 * delay) / emitted : 0;
+      const jitterBufferDelayMs = delay && emitted ? (1e3 * delay) / emitted : 0;
 
       return {
-        maxLatency: latency > stats.maxLatency ? latency : stats.maxLatency,
+        sumJitter: stats.sumJitter + currentStreamStats.jitter,
+        sumJitterBufferDelayMs: stats.sumJitterBufferDelayMs + jitterBufferDelayMs,
         packetsLost: stats.packetsLost + currentStreamStats.packetsLost,
         lastPacketsLost: stats.lastPacketsLost + (previousStreamStats?.packetsLost || 0),
       };
-    }, { maxLatency: 0, packetsLost: 0, lastPacketsLost: 0 });
+    }, {
+      sumJitter: 0,
+      sumJitterBufferDelayMs: 0,
+      packetsLost: 0,
+      lastPacketsLost: 0,
+    });
 
     const rtt = (1e3 * data.connection.currentRoundTripTime) || 0;
-    const jitter = Math.round(rtt / 2 + rtpNetworkStats.maxLatency);
+    const { sumJitter, sumJitterBufferDelayMs } = rtpNetworkStats;
+    const avgJitter = sumJitter / inboundRTPStreamsStats.length;
+    const avgJitterBufferDelay = sumJitterBufferDelayMs / inboundRTPStreamsStats.length;
 
     const deltaPacketReceived = packetsReceived - lastPacketsReceived;
     const deltaPacketLost = rtpNetworkStats.packetsLost - rtpNetworkStats.lastPacketsLost;
@@ -54,19 +63,24 @@ class NetworkIssueDetector implements IssueDetector {
       : 0;
 
     const isHighPacketsLoss = packetsLoss > 5;
-    const isHighJitter = jitter >= 200;
-    const isHighRTT = rtt >= 200;
+    const isHighJitter = avgJitter >= 200;
+    const isHighRTT = rtt >= 250;
+    const isHighJitterBufferDelay = avgJitterBufferDelay > 500;
 
     const isNetworkIssue = (!isHighPacketsLoss && isHighJitter) || isHighJitter || isHighPacketsLoss;
     const isServerIssue = isHighRTT && !isHighJitter && !isHighPacketsLoss;
     const isNetworkMediaLatencyIssue = isHighPacketsLoss && isHighJitter;
+    const isNetworkMediaSyncIssue = isHighJitter && isHighJitterBufferDelay;
+
+    const debug = `packetLoss: ${packetsLoss}%, jitter: ${avgJitter}, rtt: ${rtt},`
+      + ` jitterBuffer: ${avgJitterBufferDelay}ms`;
 
     if (isNetworkIssue) {
       issues.push({
         type: IssueType.Network,
         reason: IssueReason.NetworkQuality,
         iceCandidate: data.connection.local.id,
-        debug: `packetLoss: ${packetsLoss}%, jitter: ${jitter}`,
+        debug,
       });
     }
 
@@ -75,7 +89,7 @@ class NetworkIssueDetector implements IssueDetector {
         type: IssueType.Server,
         reason: IssueReason.ServerIssue,
         iceCandidate: data.connection.remote.id,
-        debug: `packetLoss: ${packetsLoss}%,jitter: ${jitter}, rtt: ${rtt},`,
+        debug,
       });
     }
 
@@ -84,7 +98,16 @@ class NetworkIssueDetector implements IssueDetector {
         type: IssueType.Network,
         reason: IssueReason.NetworkMediaLatency,
         iceCandidate: data.connection.local.id,
-        debug: `packetLoss: ${packetsLoss}%, jitter: ${jitter}`,
+        debug,
+      });
+    }
+
+    if (isNetworkMediaSyncIssue) {
+      issues.push({
+        type: IssueType.Network,
+        reason: IssueReason.NetworkMediaSyncFailure,
+        iceCandidate: data.connection.local.id,
+        debug,
       });
     }
 

package/src/engine/wid/detectors/QualityLimitationsIssueDetector.ts

@@ -16,6 +16,10 @@ class QualityLimitationsIssueDetector implements IssueDetector {
   }
 
   private processData(data: WebRTCStatsEventData): IssueDetectorResult {
+    if (!data.video?.outbound) {
+      return [];
+    }
+
     const streamsWithLimitation = data.video.outbound.filter((stats) => stats.qualityLimitationReason !== 'none');
     const issues: IssueDetectorResult = [];
     const previousOutboundRTPVideoStreamsStats = this.#lastProcessedStats[data.connection.id]?.video.outbound;