feat: add cleanup of prev stats

evgmel · evgmel · commit 3fecb18bbdbf · 2022-12-22T18:11:07.000+07:00
diff --git a/src/detectors/FramesDroppedIssueDetector.ts b/src/detectors/FramesDroppedIssueDetector.ts
@@ -5,15 +5,25 @@ import {
   IssueType,
   WebRTCStatsParsed,
 } from '../types';
+import { scheduleTask } from '../utils/tasks';
+import { CLEANUP_PREV_STATS_TTL_MS } from '../utils/constants';
 
 class FramesDroppedIssueDetector implements IssueDetector {
   #lastProcessedStats: { [connectionId: string]: WebRTCStatsParsed | undefined } = {};
 
   #framesDroppedThreshold = 0.5;
 
   detect(data: WebRTCStatsParsed): IssueDetectorResult {
+    const { connection: { id: connectionId } } = data;
     const issues = this.processData(data);
-    this.#lastProcessedStats[data.connection.id] = data;
+    this.#lastProcessedStats[connectionId] = data;
+
+    scheduleTask({
+      taskId: connectionId,
+      delayMs: CLEANUP_PREV_STATS_TTL_MS,
+      callback: () => (delete this.#lastProcessedStats[connectionId]),
+    });
+
     return issues;
   }
 
diff --git a/src/detectors/FramesEncodedSentIssueDetector.ts b/src/detectors/FramesEncodedSentIssueDetector.ts
@@ -5,15 +5,25 @@ import {
   IssueType,
   WebRTCStatsParsed,
 } from '../types';
+import { scheduleTask } from '../utils/tasks';
+import { CLEANUP_PREV_STATS_TTL_MS } from '../utils/constants';
 
 class FramesEncodedSentIssueDetector implements IssueDetector {
   #lastProcessedStats: { [connectionId: string]: WebRTCStatsParsed | undefined } = {};
 
   #missedFramesThreshold = 0.15;
 
   detect(data: WebRTCStatsParsed): IssueDetectorResult {
+    const { connection: { id: connectionId } } = data;
     const issues = this.processData(data);
-    this.#lastProcessedStats[data.connection.id] = data;
+    this.#lastProcessedStats[connectionId] = data;
+
+    scheduleTask({
+      taskId: connectionId,
+      delayMs: CLEANUP_PREV_STATS_TTL_MS,
+      callback: () => (delete this.#lastProcessedStats[connectionId]),
+    });
+
     return issues;
   }
 
diff --git a/src/detectors/InboundNetworkIssueDetector.ts b/src/detectors/InboundNetworkIssueDetector.ts
@@ -5,13 +5,23 @@ import {
   IssueType,
   WebRTCStatsParsed,
 } from '../types';
+import { scheduleTask } from '../utils/tasks';
+import { CLEANUP_PREV_STATS_TTL_MS } from '../utils/constants';
 
 class InboundNetworkIssueDetector implements IssueDetector {
   #lastProcessedStats: { [connectionId: string]: WebRTCStatsParsed | undefined } = {};
 
   detect(data: WebRTCStatsParsed): IssueDetectorResult {
+    const { connection: { id: connectionId } } = data;
     const issues = this.processData(data);
-    this.#lastProcessedStats[data.connection.id] = data;
+    this.#lastProcessedStats[connectionId] = data;
+
+    scheduleTask({
+      taskId: connectionId,
+      delayMs: CLEANUP_PREV_STATS_TTL_MS,
+      callback: () => (delete this.#lastProcessedStats[connectionId]),
+    });
+
     return issues;
   }
 
diff --git a/src/detectors/NetworkMediaSyncIssueDetector.ts b/src/detectors/NetworkMediaSyncIssueDetector.ts
@@ -5,13 +5,23 @@ import {
   IssueType,
   WebRTCStatsParsed,
 } from '../types';
+import { scheduleTask } from '../utils/tasks';
+import { CLEANUP_PREV_STATS_TTL_MS } from '../utils/constants';
 
 class NetworkMediaSyncIssueDetector implements IssueDetector {
   #lastProcessedStats: { [connectionId: string]: WebRTCStatsParsed | undefined } = {};
 
   detect(data: WebRTCStatsParsed): IssueDetectorResult {
+    const { connection: { id: connectionId } } = data;
     const issues = this.processData(data);
-    this.#lastProcessedStats[data.connection.id] = data;
+    this.#lastProcessedStats[connectionId] = data;
+
+    scheduleTask({
+      taskId: connectionId,
+      delayMs: CLEANUP_PREV_STATS_TTL_MS,
+      callback: () => (delete this.#lastProcessedStats[connectionId]),
+    });
+
     return issues;
   }
 
diff --git a/src/detectors/OutboundNetworkIssueDetector.ts b/src/detectors/OutboundNetworkIssueDetector.ts
@@ -5,13 +5,23 @@ import {
   IssueType,
   WebRTCStatsParsed,
 } from '../types';
+import { scheduleTask } from '../utils/tasks';
+import { CLEANUP_PREV_STATS_TTL_MS } from '../utils/constants';
 
 class OutboundNetworkIssueDetector implements IssueDetector {
   #lastProcessedStats: { [connectionId: string]: WebRTCStatsParsed | undefined } = {};
 
   detect(data: WebRTCStatsParsed): IssueDetectorResult {
+    const { connection: { id: connectionId } } = data;
     const issues = this.processData(data);
-    this.#lastProcessedStats[data.connection.id] = data;
+    this.#lastProcessedStats[connectionId] = data;
+
+    scheduleTask({
+      taskId: connectionId,
+      delayMs: CLEANUP_PREV_STATS_TTL_MS,
+      callback: () => (delete this.#lastProcessedStats[connectionId]),
+    });
+
     return issues;
   }
 
diff --git a/src/detectors/QualityLimitationsIssueDetector.ts b/src/detectors/QualityLimitationsIssueDetector.ts
@@ -5,13 +5,23 @@ import {
   IssueType,
   WebRTCStatsParsed,
 } from '../types';
+import { scheduleTask } from '../utils/tasks';
+import { CLEANUP_PREV_STATS_TTL_MS } from '../utils/constants';
 
 class QualityLimitationsIssueDetector implements IssueDetector {
   #lastProcessedStats: { [connectionId: string]: WebRTCStatsParsed | undefined } = {};
 
   detect(data: WebRTCStatsParsed): IssueDetectorResult {
+    const { connection: { id: connectionId } } = data;
     const issues = this.processData(data);
-    this.#lastProcessedStats[data.connection.id] = data;
+    this.#lastProcessedStats[connectionId] = data;
+
+    scheduleTask({
+      taskId: connectionId,
+      delayMs: CLEANUP_PREV_STATS_TTL_MS,
+      callback: () => (delete this.#lastProcessedStats[connectionId]),
+    });
+
     return issues;
   }
 
diff --git a/src/detectors/VideoCodecMismatchDetector.ts b/src/detectors/VideoCodecMismatchDetector.ts
@@ -5,6 +5,8 @@ import {
   IssueType,
   WebRTCStatsParsed,
 } from '../types';
+import { scheduleTask } from '../utils/tasks';
+import { CLEANUP_PREV_STATS_TTL_MS } from '../utils/constants';
 
 class VideoCodecMismatchDetector implements IssueDetector {
   readonly UNKNOWN_DECODER = 'unknown';
@@ -16,8 +18,19 @@ class VideoCodecMismatchDetector implements IssueDetector {
   } = {};
 
   detect(data: WebRTCStatsParsed): IssueDetectorResult {
+    const { connection: { id: connectionId } } = data;
     const issues = this.processData(data);
-    this.#lastProcessedStats[data.connection.id] = data;
+    this.#lastProcessedStats[connectionId] = data;
+
+    scheduleTask({
+      taskId: connectionId,
+      delayMs: CLEANUP_PREV_STATS_TTL_MS,
+      callback: () => {
+        delete this.#lastProcessedStats[connectionId];
+        delete this.#lastDecoderWithIssue[connectionId];
+      },
+    });
+
     return issues;
   }
 
diff --git a/src/utils/constants.ts b/src/utils/constants.ts
@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/prefer-default-export
+export const CLEANUP_PREV_STATS_TTL_MS = 35_000;
diff --git a/src/utils/tasks.ts b/src/utils/tasks.ts
@@ -0,0 +1,30 @@
+export const createTaskScheduler = () => {
+  const scheduledTasks = new Map<string, NodeJS.Timer>();
+
+  return (payload: {
+    taskId: string;
+    callback: () => void;
+    delayMs: number;
+    maxJitterMs?: number;
+  }) => {
+    const {
+      taskId, delayMs, maxJitterMs, callback,
+    } = payload;
+    const jitter = Math.ceil(Math.random() * (maxJitterMs || 0));
+
+    const timer = scheduledTasks.get(taskId);
+
+    if (timer) {
+      clearTimeout(timer);
+    }
+
+    const newTimer = setTimeout(() => {
+      callback();
+      scheduledTasks.delete(taskId);
+    }, delayMs + jitter);
+
+    scheduledTasks.set(taskId, newTimer);
+  };
+};
+
+export const scheduleTask = createTaskScheduler();
diff --git a/test/parser/PeriodicWebRTCStatsReporter.spec.ts b/test/parser/PeriodicWebRTCStatsReporter.spec.ts
@@ -92,6 +92,19 @@ describe('wid/lib/PeriodicWebRTCStatsReporter', () => {
     expect(parseMethodDouble.getCalls()).to.have.length(numberOfIntervals);
   });
 
+  it('should emit stats parsed event', async () => {
+    const getStatsInterval = faker.datatype.number({ min: 1, max: 9999 });
+    const compositeStatsParser = createCompositeStatsParserFake();
+    const reporter = createPeriodicStatsReporter({ compositeStatsParser, getStatsInterval });
+    sandbox.stub(compositeStatsParser, 'parse');
+    const emitSpy = sandbox.spy(reporter, 'emit');
+
+    reporter.startReporting();
+    await clock.tickAsync(getStatsInterval);
+
+    expect(emitSpy).to.be.calledWith(PeriodicWebRTCStatsReporter.STATS_REPORTS_PARSED, { timeTaken: 0 });
+  });
+
   it('should emit stats report ready event for each stats report item', async () => {
     const getStatsInterval = faker.datatype.number({ min: 1, max: 9999 });
     const compositeStatsParser = createCompositeStatsParserFake();
@@ -105,9 +118,8 @@ describe('wid/lib/PeriodicWebRTCStatsReporter', () => {
     reporter.startReporting();
     await clock.tickAsync(getStatsInterval);
 
-    expect(emitSpy).to.be.calledTwice;
-    expect(emitSpy.getCall(0)).to.be.calledWithExactly(PeriodicWebRTCStatsReporter.STATS_REPORT_READY_EVENT, firstReportItem);
-    expect(emitSpy.getCall(1)).to.be.calledWithExactly(PeriodicWebRTCStatsReporter.STATS_REPORT_READY_EVENT, secondReportItem);
+    expect(emitSpy).to.be.calledWith(PeriodicWebRTCStatsReporter.STATS_REPORT_READY_EVENT, firstReportItem);
+    expect(emitSpy).to.be.calledWith(PeriodicWebRTCStatsReporter.STATS_REPORT_READY_EVENT, secondReportItem);
   });
 
   it('should be be in stopped state', async () => {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// eslint-disable-next-line import/prefer-default-export`
	`2`	`+export const CLEANUP_PREV_STATS_TTL_MS = 35_000;`