@rtcstats/rtcstats-js 2.2.4 → 2.4.0

package/README.md

@@ -9,6 +9,26 @@ an Experience Score, and a plain-English AI summary of what went wrong on the ca
 For a complete reference of every getStats() metric rtcstats collects and analyzes, see
 the [WebRTC Stats Reference](https://rtcstats.com/kb/webrtc-stats-reference-page).
 
+## Why rtcStats is built this way
+
+rtcStats keeps collecting session data, storing it, and analyzing it separate. The
+first two are open source and run in your stack. The third is optional and yours to
+trigger.
+
+- **Collection is a client SDK you control.** `rtcstats-js` runs in your client and
+  streams a dump of what WebRTC is doing to a server you run.
+- **Storage runs on your infrastructure.** `rtcstats-server` receives the stream and
+  writes each dump to your own storage. Session data lands and lives in your stack.
+- **Analysis is the layer you opt into.** You choose which stored dumps to send to
+  rtcstats.com: a random sample, per-user, per-region, a single dump when one call
+  goes bad, or none at all. rtcstats.com returns Observations, an Experience Score,
+  and a plain-English summary of what went wrong. It is the layer above
+  `webrtc-internals`, not a replacement for it.
+
+Send what you want, keep the rest.
+
+Start at https://rtcstats.com
+
 # rtcstats-js: A Javascript client SDK for monitoring WebRTC
 
 The Javascript SDK provides low-level logging on peerconnection API calls and periodic getStats calls for analytics/debugging purposes.

package/media.js

@@ -10,7 +10,7 @@ import {compressMethod, dumpTrackWithStreams} from '@rtcstats/rtcstats-shared';
  * @param {string} property - the track whose property (e.g. `enabled`) should be wrapped.
  * @param {function} trace - RTCStats trace callback.
  */
-function wrapTrackProperty(track, property, trace) {
+function wrapTrackProperty(track, property, trace, MediaStreamTrack) {
     const prop = Object.getOwnPropertyDescriptor(
         MediaStreamTrack.prototype, property);
     if (!prop || !prop.get || !prop.set) {
@@ -72,8 +72,8 @@ export function wrapGetUserMedia(trace, {navigator, MediaStreamTrack}) {
                         track.addEventListener('ended', () => {
                             trace('MediaStreamTrack.onended', null, track.id, track.__rtcStatsId);
                         });
-                        wrapTrackProperty(track, 'enabled', trace);
-                        wrapTrackProperty(track, 'contentHint', trace);
+                        wrapTrackProperty(track, 'enabled', trace, MediaStreamTrack);
+                        wrapTrackProperty(track, 'contentHint', trace, MediaStreamTrack);
                     });
                     return stream;
                 }, (err) => {

package/package.json

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

package/peerconnection.js

@@ -91,9 +91,8 @@ export function wrapRTCPeerConnection(trace, window, {getStatsInterval}) {
     }
     let lastComputePressureRecord;
     if (window.PressureObserver && getStatsInterval) {
-        const observer = new PressureObserver((records) => {
-            const lastRecord = records[records.length - 1]; // Usually only one record.
-            lastComputePressureRecord = [Date.now(), lastRecord];
+        const observer = new window.PressureObserver((records) => {
+            lastComputePressureRecord = records[records.length - 1]; // Usually only one record.
         });
         observer.observe('cpu', {sampleInterval: getStatsInterval});
     }
@@ -148,14 +147,9 @@ export function wrapRTCPeerConnection(trace, window, {getStatsInterval}) {
             e.track.addEventListener('mute', () => {
                 trace('MediaStreamTrack.onmute', pcId, e.track.id);
             });
-            if (e.transceiver) {
-                e.transceiver.__rtcStatsId = pcId;
-                e.transceiver.sender.__rtcStatsId = pcId;
-                e.transceiver.sender.__rtcStatsSenderId = e.track.id;
-            }
-            if (e.track.kind === 'video' && typeof document !== 'undefined' && document.querySelectorAll) {
+            if (e.track.kind === 'video' && window.document?.querySelectorAll) {
                 setTimeout(() => {
-                    document.querySelectorAll('video').forEach(el => {
+                    window.document.querySelectorAll('video').forEach(el => {
                         if (!el.srcObject) return;
                         if (el.srcObject.getTracks().indexOf(e.track) === -1) return;
                         el.addEventListener('resize', () => {
@@ -199,10 +193,10 @@ export function wrapRTCPeerConnection(trace, window, {getStatsInterval}) {
                 return;
             }
             if (lastComputePressureRecord) {
-                const [timestamp, record] = lastComputePressureRecord;
+                const record = lastComputePressureRecord;
                 stats['rtcStatsComputePressure'] = {
                     type: 'compute-pressure',
-                    timestamp,
+                    timestamp: window.performance.timeOrigin + record.time,
                     cpuState: computePressureTable[record.state] || record.state,
                 };
             }
@@ -376,6 +370,11 @@ export function wrapRTCPeerConnection(trace, window, {getStatsInterval}) {
 
             return nativeMethod.apply(this, [description, ...args])
                 .then(() => {
+                    this.getTransceivers().forEach((transceiver) => {
+                        transceiver.__rtcStatsId = this.__rtcStatsId;
+                        transceiver.sender.__rtcStatsId = this.__rtcStatsId;
+                        transceiver.sender.__rtcStatsSenderId = transceiver.receiver.track.id;
+                    });
                     trace(method + 'OnSuccess', this.__rtcStatsId, undefined,
                         trackingId);
                 }, (err) => {

package/rtcstats.js

@@ -7,15 +7,15 @@ import {WebSocketTrace} from './trace-websocket.js';
  *
  * @returns {function} RTCStats trace function.
  */
-export function wrapRTCStatsWithDefaultOptions(config = {getStatsInterval: 1000}) {
+export function wrapRTCStatsWithDefaultOptions(config = {getStatsInterval: 1000}, target = globalThis) {
     const trace = new WebSocketTrace(config);
 
     // Wrap RTCPeerConnection-related APIs and events
-    wrapRTCPeerConnection(trace, window, config);
+    wrapRTCPeerConnection(trace, target, config);
     // Wrap getUserMedia, getDisplayMedia and related events.
-    wrapGetUserMedia(trace, window);
+    wrapGetUserMedia(trace, target);
     // Wrap enumerateDevices.
-    wrapEnumerateDevices(trace, window);
+    wrapEnumerateDevices(trace, target);
 
     return trace;
 }

package/trace-websocket.js

@@ -44,7 +44,6 @@ export function WebSocketTrace(config = {}) {
             buffer.push(args);
         }
     };
-
     trace.close = () => {
         if (window.sessionStorage && config.countReloads) {
             // A clean disconnect clears the reload count.
@@ -67,9 +66,10 @@ export function WebSocketTrace(config = {}) {
             hardwareConcurrency: navigator.hardwareConcurrency,
             userAgentData: navigator.userAgentData,
             deviceMemory: navigator.deviceMemory,
+            cpuPerformance: navigator.cpuPerformance,
             screen: {
-                width: window.screen.availWidth,
-                height: window.screen.availHeight,
+                width: window.screen?.availWidth,
+                height: window.screen?.availHeight,
                 devicePixelRatio: window.devicePixelRatio,
             },
             window: {