@rtcstats/rtcstats-shared 2.3.0 → 2.5.0

package/anonymize.js

@@ -0,0 +1,39 @@
+import {decompressMethod} from './compression.js';
+import {obfuscateAddress, obfuscateIpOrAddress} from './address-obfuscator.js';
+
+// Anonymize addresses in either an rtcstats dump or a webrtc-internals JSON
+// dump (passed as text). Returns a Blob with the anonymized contents in the
+// same format, or undefined if the format is not recognized.
+export function anonymizeBlob(textBlob) {
+    if (textBlob.startsWith('RTCStatsDump\n')) {
+        const lines = textBlob.split('\n').map(line => {
+            if (line.startsWith('RTCStatsDump') || line === '') {
+                return line;
+            }
+            const data = JSON.parse(line);
+            obfuscateAddress(decompressMethod(data[0]), data);
+            return JSON.stringify(data);
+        });
+        return new Blob([lines.join('\n')]);
+    } else if (textBlob.startsWith('{')) {
+        const json = JSON.parse(textBlob);
+        Object.keys(json.PeerConnections).forEach(id => {
+            const pc = json.PeerConnections[id];
+            Object.keys(pc.stats).forEach(statsId => {
+                const stats = pc.stats[statsId];
+                const parts = statsId.split('-');
+                const type = parts[parts.length - 1];
+                if (!['address', 'ip', 'relatedAddress'].includes(type)) return;
+                const values = JSON.parse(stats.values);
+                stats.values = JSON.stringify(values.map(obfuscateIpOrAddress));
+            });
+            pc.updateLog.forEach(traceEvent => {
+                if (!traceEvent.value) return;
+                const value = JSON.parse(traceEvent.value);
+                obfuscateAddress(traceEvent.type, [,, value]);
+                traceEvent.value = JSON.stringify(value);
+            });
+        });
+        return new Blob([JSON.stringify(json, null, ' ')]);
+    }
+}

package/compression.js

@@ -175,23 +175,29 @@ export function statsDecompression(baseStatsInput, delta) {
             delete newStats[id];
             return;
         }
+        // A timestamp carried explicitly in the delta differs from the
+        // collapsed top-level one and must not be overwritten below.
+        const hasOwnTimestamp = newStats[id] !== undefined &&
+            newStats[id].timestamp !== undefined;
         if (!newStats[id]) {
-            newStats[id] = baseStats[id];
+            // Copy the report so the timestamp assignment below does not
+            // modify the base stats.
+            newStats[id] = Object.assign({}, baseStats[id]);
         } else {
             const report = baseStats[id];
             Object.keys(report).forEach(name => {
-                if (!newStats[id][name]) {
+                if (newStats[id][name] === undefined) {
                     newStats[id][name] = report[name];
-                } else if (typeof(report[name]) === 'object') {
-                    const newObject = newStats[id][name];
-                    newStats[id][name] = report[name];
-                    Object.keys(newObject).forEach(key => {
-                        newStats[id][name][key] = newObject[key];
-                    });
+                } else if (typeof(report[name]) === 'object' &&
+                        !Array.isArray(newStats[id][name])) {
+                    // Merge into a copy so the nested object of the
+                    // base stats is not modified. Arrays are serialized
+                    // wholesale on change and take the new value.
+                    newStats[id][name] = Object.assign({}, report[name], newStats[id][name]);
                 } // Else: take the new value.
             });
         }
-        if (timestamp !== undefined) {
+        if (timestamp !== undefined && !hasOwnTimestamp) {
             newStats[id].timestamp = timestamp;
         }
     });
@@ -367,12 +373,20 @@ const methodTable = {
     // getUserMedia and friends.
     'navigator.mediaDevices.getUserMedia': 60,
     'navigator.mediaDevices.getUserMediaOnSuccess': 61,
-    'navigator.mediaDevices.getUserMediaOnFailure': 62,
+    // 62 is not usable. It was originally assigned to
+    // getUserMediaOnFailure but a copy-paste bug duplicated the
+    // key onto 65, which was intended for getDisplayMediaOnFailure.
+    // The last duplicate key wins in an object literal, so released clients
+    // have always compressed getUserMediaOnFailure to 65.
+    'navigator.mediaDevices.getUserMediaOnFailure': 65,
     'navigator.mediaDevices.getDisplayMedia': 63,
     'navigator.mediaDevices.getDisplayMediaOnSuccess': 64,
-    'navigator.mediaDevices.getUserMediaOnFailure': 65,
     'navigator.mediaDevices.enumerateDevices': 66,
     'navigator.mediaDevices.ondevicechange': 67,
+    // Decompression-only until the next major version bump, see below.
+    // This method is therefore not compressed.
+    // 'navigator.mediaDevices.getDisplayMediaOnFailure': 68,
+    // Next free method id: 69.
     // MediaStreamTrack methods and events.
     'MediaStreamTrack.stop':  70,
     'MediaStreamTrack.applyConstraints':  71,
@@ -386,6 +400,7 @@ const methodTable = {
 // These should be moved to the compression table at major version bumps.
 const methodTableDecompression = {
     1: 'getStats',
+    68: 'navigator.mediaDevices.getDisplayMediaOnFailure',
 };
 const reverseMethodTable = Object.keys(methodTable).reduce((table, method) => {
     table[methodTable[method]] = method;

package/dump.js

@@ -62,8 +62,9 @@ export async function readRTCStatsDump(blob) {
         const time = new Date(lastTime);
 
         if (method === 'getStats') { // delta-compressed stats
+            // statsDecompression does not modify its base stats argument.
             value = statsDecompression(baseStats[connection_id], value);
-            baseStats[connection_id] = JSON.parse(JSON.stringify(value));
+            baseStats[connection_id] = value;
         } else if (method === 'setLocalDescription' && value &&
             // Workaround for Chrome <145 bug: https://source.chromium.org/chromium/chromium/src/+/4a2a384e43ea163127219548087e949fb00fa562
             connection_id !== 'undefined-undefined') {
@@ -312,3 +313,4 @@ export async function extractTracks(peerConnectionTrace) {
     }
     return tracks;
 }
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtcstats/rtcstats-shared",
-  "version": "2.3.0",
+  "version": "2.5.0",
   "main": "index.js",
   "description": "gather WebRTC API traces and statistics",
   "type": "module",