@rtcstats/rtcstats-shared 2.6.1 → 2.6.3

package/compression.js

@@ -32,6 +32,11 @@ export function statsCompression(baseStatsInput, newStatsInput, statsIdMap) {
             return;
         }
         Object.keys(report).forEach((name) => {
+            if (name === 'timestamp') {
+                // Deleting it drops the whole report from the delta and the decoder
+                // restores it with the collapsed timestamp. Hits audio remote-*.
+                return;
+            }
             if (report[name] === baseStats[id][name]) {
                 delete delta[id][name];
             } else if (Array.isArray(report[name])) {
@@ -49,7 +54,6 @@ export function statsCompression(baseStatsInput, newStatsInput, statsIdMap) {
                     delete report[name];
                 }
             }
-            // TODO: does this ever happen since we have `timestamp`?
             if (Object.keys(report).length === 0) {
                 delete delta[id];
             }
@@ -145,6 +149,8 @@ export function statsCompression(baseStatsInput, newStatsInput, statsIdMap) {
  */
 export function statsDecompression(baseStatsInput, delta) {
     const baseStats = map2obj(baseStatsInput);
+    // TODO: replace the JSON round-trip and the rename loop below with a hand-rolled
+    // deep copy that decompresses property names while copying, roughly 2x faster.
     const newStats = JSON.parse(JSON.stringify(map2obj(delta)));
 
     // Decompress property names using a static table.
@@ -213,6 +219,13 @@ export function statsDecompression(baseStatsInput, delta) {
         });
     }
 
+    // The compression removes the id as it is the key.
+    Object.keys(newStats).forEach((id) => {
+        if (newStats[id] && typeof newStats[id] === 'object') {
+            newStats[id].id = id;
+        }
+    });
+
     return newStats;
 }
 
@@ -395,12 +408,17 @@ const methodTable = {
     'MediaStreamTrack.onunmute': 74,
     // HTMLMediaElement
     'HTMLMediaElement.resize': 80,
+    // Decompression-only until the next major version bump, see below.
+    // 'HTMLMediaElement.setSinkId': 81,
+    // 'HTMLMediaElement.setSinkIdOnFailure': 82,
 };
 // Properties that are decompressed but for release purpose not yet compressed.
 // These should be moved to the compression table at major version bumps.
 const methodTableDecompression = {
     1: 'getStats',
     68: 'navigator.mediaDevices.getDisplayMediaOnFailure',
+    81: 'HTMLMediaElement.setSinkId',
+    82: 'HTMLMediaElement.setSinkIdOnFailure',
 };
 const reverseMethodTable = Object.keys(methodTable).reduce((table, method) => {
     table[methodTable[method]] = method;

package/dump.js

@@ -110,6 +110,10 @@ export async function readRTCStatsDump(blob) {
 
         if (method === 'getStats') { // delta-compressed stats
             // statsDecompression does not modify its base stats argument.
+            if (!baseStats[connection_id]) {
+                console.error('stats without baseline');
+                return;
+            }
             value = statsDecompression(baseStats[connection_id], value);
             baseStats[connection_id] = value;
         } else if (method === 'setLocalDescription' && value &&

package/index.d.ts

@@ -1,11 +1,13 @@
 // Type definitions for @rtcstats/rtcstats-shared
 
-export async function maybeUncompressDump(blob: Blob): Promise<Blob>;
-export async function detectWebRTCInternalsDump(blob: Blob): Promise<boolean>;
-export async function readWebRTCInternalsDump(blob: Blob): Promise<object>;
-export async function detectRTCStatsDump(blob: Blob): Promise<boolean>;
-export async function readRTCStatsDump(blob: Blob): Promise<object>;
-export async function extractTracks(peerConnectionTrace: any[]): Promise<any[]>;
+export function maybeUncompressDump(blob: Blob): Promise<Blob>;
+export function detectWebRTCInternalsDump(blob: Blob): Promise<boolean>;
+export function readWebRTCInternalsDump(blob: Blob): Promise<object>;
+export function detectRTCStatsDump(blob: Blob): Promise<boolean>;
+export function readRTCStatsDump(blob: Blob): Promise<object>;
+export function internalsToRtcstats(data: object): object;
+export function readDump(blob: Blob): Promise<object>;
+export function extractTracks(peerConnectionTrace: any[]): Promise<any[]>;
 
 export function statsCompression(baseStatsInput: object | RTCStatsReport, newStatsInput: object | RTCStatsReport, statsIdMap: object): object;
 export function statsDecompression(baseStatsInput: object, delta: object): object;
@@ -17,6 +19,7 @@ export function compressStatsType(type: string): string | number;
 export function decompressStatsType(typeKey: string | number): string;
 export function compressStatsProperty(property: string): string | number;
 export function decompressStatsProperty(property: string | number): string;
+export const computePressureTable: {nominal: number, fair: number, serious: number, critical: number};
 
 export function createInternalsTimeSeries(connection: any): object;
 export function createRtcStatsTimeSeries(trace: any[]): object;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtcstats/rtcstats-shared",
-  "version": "2.6.1",
+  "version": "2.6.3",
   "main": "index.js",
   "description": "gather WebRTC API traces and statistics",
   "type": "module",
@@ -17,5 +17,8 @@
   "license": "MIT",
   "publishConfig": {
     "access": "public"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
   }
 }