feat: add stale connection stats auto removal (#4)

* feat: add stale connection stats auto removal

* feat: fix dependency vulnerability

* feat: add tests to check closed connection stats

* feat: cleanup unnecessary test files

* feat: add new tests

* feat: add maintainers and keywords to package json

Author: evgmel

.github/workflows/release.yml

@@ -27,6 +27,9 @@ jobs:
       - name: Lint
         run: yarn lint
 
+      - name: Lint
+        run: yarn lint:tests
+
       - name: Test
         run: yarn test
 

package.json

@@ -7,18 +7,36 @@
   "types": "dist/index.d.ts",
   "repository": "git@github.com:VLprojects/webrtc-issue-detector.git",
   "author": "Roman Kuzakov <roman.kuzakov@gmail.com>",
+  "maintainers": [
+    {
+      "name": "Vladimir Panov",
+      "email": "panov.va@mail.ru",
+      "url": "https://github.com/panov-va"
+    },
+    {
+      "name": "Evgeny Melnikov",
+      "email": "melnikov_evg@mail.ru",
+      "url": "https://github.com/evgmel"
+    }
+  ],
   "license": "MIT",
   "private": false,
   "homepage": "https://github.com/VLprojects/webrtc-issue-detector#readme",
   "keywords": [
-    "webrtc"
+    "webrtc",
+    "stats",
+    "rtcstatsreport",
+    "network",
+    "issues",
+    "mos calculator"
   ],
   "files": [
     "dist/"
   ],
   "scripts": {
     "build": "rm -rf dist && rollup -c",
     "lint": "eslint ./src",
+    "lint:tests": "cd test && eslint ./",
     "test": "NODE_ENV=test mocha --config test/utils/runners/mocha/.mocharc.js"
   },
   "devDependencies": {
@@ -30,7 +48,7 @@
     "@types/chai": "^4.3.3",
     "@types/chai-as-promised": "^7.1.5",
     "@types/chai-subset": "^1.3.3",
-    "@types/faker": "^6.6.9",
+    "@types/faker": "^5.5.9",
     "@types/mocha": "^9.1.1",
     "@types/node": "12",
     "@types/sinon": "^10.0.13",
@@ -46,7 +64,7 @@
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jsx-a11y": "^6.6.1",
     "faker": "^5.5.3",
-    "mocha": "^10.0.0",
+    "mocha": "^10.2.0",
     "rollup": "^2.78.0",
     "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-polyfill-node": "^0.10.2",

src/NetworkScoresCalculator.ts

@@ -10,13 +10,13 @@ class NetworkScoresCalculator implements INetworkScoresCalculator {
   #lastProcessedStats: { [connectionId: string]: WebRTCStatsParsed } = {};
 
   calculate(data: WebRTCStatsParsed): NetworkScores {
-    const outbound = this.calcucateOutboundScore(data);
+    const outbound = this.calculateOutboundScore(data);
     const inbound = this.calculateInboundScore(data);
     this.#lastProcessedStats[data.connection.id] = data;
     return { outbound, inbound };
   }
 
-  private calcucateOutboundScore(data: WebRTCStatsParsed): NetworkScore | undefined {
+  private calculateOutboundScore(data: WebRTCStatsParsed): NetworkScore | undefined {
     const remoteInboundRTPStreamsStats = [
       ...data.remote?.audio.inbound || [],
       ...data.remote?.video.inbound || [],

src/parser/RTCStatsParser.ts

@@ -16,27 +16,42 @@ import {
 } from '../types';
 import { checkIsConnectionClosed, calcBitrate } from './utils';
 
+interface PrevStatsItem {
+  stats: WebRTCStatsParsed;
+  ts: number;
+}
+
 interface WebRTCStatsParserParams {
   logger: Logger;
+  prevConnectionStatsTtlMs?: number;
 }
 
 class RTCStatsParser implements StatsParser {
-  private readonly prevStats = new Map<string, { stats: WebRTCStatsParsed, ts: number } | undefined>();
+  private readonly prevStats = new Map<string, PrevStatsItem | undefined>();
 
-  private readonly allowedReportTypes: RTCStatsType[] = [
+  private readonly prevStatsCleanupTimers = new Map<string, NodeJS.Timer>();
+
+  private readonly allowedReportTypes: Set<RTCStatsType> = new Set<RTCStatsType>([
     'candidate-pair',
     'inbound-rtp',
     'outbound-rtp',
     'remote-outbound-rtp',
     'remote-inbound-rtp',
     'track',
     'transport',
-  ];
+  ]);
 
   private readonly logger: Logger;
 
+  private readonly prevConnectionStatsTtlMs: number;
+
   constructor(params: WebRTCStatsParserParams) {
     this.logger = params.logger;
+    this.prevConnectionStatsTtlMs = params.prevConnectionStatsTtlMs ?? 55_000;
+  }
+
+  get previouslyParsedStatsConnectionsIds(): string[] {
+    return [...this.prevStats.keys()];
   }
 
   async parse(connection: ConnectionInfo): Promise<StatsReportItem | undefined> {
@@ -93,25 +108,28 @@ class RTCStatsParser implements StatsParser {
 
     reports.forEach((rtcStats: RTCStatsReport) => {
       rtcStats.forEach((reportItem: Record<string, unknown>) => {
-        if (!this.allowedReportTypes.includes(reportItem.type as RTCStatsType)) {
+        if (!this.allowedReportTypes.has(reportItem.type as RTCStatsType)) {
           return;
         }
 
         this.updateMappedStatsWithReportItemData(reportItem, mappedStats, rtcStats);
       });
     });
 
-    const prevStatsData = this.prevStats.get(connectionData.id);
+    const { id: connectionId } = connectionData;
+    const prevStatsData = this.prevStats.get(connectionId);
 
     if (prevStatsData) {
       this.propagateStatsWithRateValues(mappedStats, prevStatsData.stats);
     }
 
-    this.prevStats.set(connectionData.id, {
+    this.prevStats.set(connectionId, {
       stats: mappedStats,
       ts: Date.now(),
     });
 
+    this.resetStatsCleanupTimer(connectionId);
+
     return mappedStats;
   }
 
@@ -269,6 +287,21 @@ class RTCStatsParser implements StatsParser {
 
     return connectionStats as ParsedConnectionStats;
   }
+
+  private resetStatsCleanupTimer(connectionId: string): void {
+    const existingTimer = this.prevStatsCleanupTimers.get(connectionId);
+
+    if (existingTimer) {
+      clearTimeout(existingTimer);
+    }
+
+    const timer = setTimeout(() => {
+      this.prevStats.delete(connectionId);
+      this.prevStatsCleanupTimers.delete(connectionId);
+    }, this.prevConnectionStatsTtlMs);
+
+    this.prevStatsCleanupTimers.set(connectionId, timer);
+  }
 }
 
 export default RTCStatsParser;

test/.eslintrc

@@ -11,5 +11,8 @@
     "import/prefer-default-export": "off",
     "@typescript-eslint/no-unused-expressions": "off",
     "class-methods-use-this": "off"
-  }
+  },
+  "ignorePatterns": [
+    "**/*.js"
+  ]
 }

test/helpers/rtc.ts

@@ -1,7 +1,8 @@
+import { beforeEach } from 'mocha';
 import sinon from 'sinon';
 import { expect } from 'chai';
-import { createPeerConnectionFake, createStatsReportItem } from '../helpers/rtc';
-import { StatsParser, StatsReportItem } from '../../src/types';
+import { createPeerConnectionFake, createStatsReportItem } from '../utils/rtc';
+import { StatsParser, StatsReportItem } from '../../src';
 import CompositeRTCStatsParser from '../../src/parser/CompositeRTCStatsParser';
 
 const createStatsParserFake = (): StatsParser => ({
@@ -19,6 +20,10 @@ const createCompositeStatsParser = (
 describe('wid/lib/parser/CompositeRTCStatsParser', () => {
   const sandbox = sinon.createSandbox();
 
+  beforeEach(() => {
+    sandbox.restore();
+  });
+
   after(() => {
     sandbox.restore();
   });

test/parser/CompositeRTCStatsParser.spec.ts

@@ -1,8 +1,8 @@
 import faker from 'faker';
 import sinon, { SinonFakeTimers } from 'sinon';
 import { expect } from 'chai';
-import { StatsReportItem, CompositeStatsParser } from '../../src/types';
-import { createStatsReportItem } from '../helpers/rtc';
+import { StatsReportItem, CompositeStatsParser } from '../../src';
+import { createStatsReportItem } from '../utils/rtc';
 import PeriodicWebRTCStatsReporter from '../../src/parser/PeriodicWebRTCStatsReporter';
 
 const createCompositeStatsParserFake = (): CompositeStatsParser => ({