@vpalmisano/webrtcperf 4.4.1 → 4.4.3

package/build/src/session.js

@@ -99,6 +99,8 @@ class Session extends events_1.default {
     id;
     /** The throttle configuration index assigned to the session. */
     throttleIndex;
+    /** If true, the network will be throttled using the browser internal throttling mechanism. */
+    useBrowserThrottling;
     /** The test page url. */
     url;
     /** The url query. */
@@ -152,7 +154,7 @@ class Session extends events_1.default {
     });
     constructor({ chromiumUrl, chromiumPath, chromiumFieldTrials, windowWidth, windowHeight, deviceScaleFactor, display, 
     /* audioRedForOpus, */
-    url, urlQuery, customUrlHandler, customUrlHandlerFn, mediaPath, videoWidth, videoHeight, videoFramerate, useFakeMedia, enableGpu, enableBrowserLogging, startTimestamp, sessions, tabsPerSession, spawnPeriod, statsInterval, disabledVideoCodecs, localStorage, sessionStorage, clearCookies, scriptPath, showPageLog, pageLogFilter, pageLogPath, userAgent, id, throttleIndex, evaluateAfter, exposedFunctions, scriptParams, blockedUrls, extraHeaders, responseModifiers, downloadResponses, extraCSS, cookies, overridePermissions, hardwareConcurrency, debuggingPort, debuggingAddress, randomAudioPeriod, maxVideoDecoders, maxVideoDecodersRange, incognito, serverPort, serverSecret, serverUseHttps, emulateCpuThrottling, }) {
+    url, urlQuery, customUrlHandler, customUrlHandlerFn, mediaPath, videoWidth, videoHeight, videoFramerate, useFakeMedia, enableGpu, enableBrowserLogging, startTimestamp, sessions, tabsPerSession, spawnPeriod, statsInterval, disabledVideoCodecs, localStorage, sessionStorage, clearCookies, scriptPath, showPageLog, pageLogFilter, pageLogPath, userAgent, id, throttleIndex, useBrowserThrottling, evaluateAfter, exposedFunctions, scriptParams, blockedUrls, extraHeaders, responseModifiers, downloadResponses, extraCSS, cookies, overridePermissions, hardwareConcurrency, debuggingPort, debuggingAddress, randomAudioPeriod, maxVideoDecoders, maxVideoDecodersRange, incognito, serverPort, serverSecret, serverUseHttps, emulateCpuThrottling, }) {
         super();
         log.debug('constructor', { id });
         this.id = id;
@@ -230,6 +232,7 @@ class Session extends events_1.default {
         this.serverUseHttps = serverUseHttps;
         this.emulateCpuThrottling = emulateCpuThrottling;
         this.throttleIndex = throttleIndex;
+        this.useBrowserThrottling = useBrowserThrottling;
         this.evaluateAfter = evaluateAfter || [];
         this.exposedFunctions = exposedFunctions || {};
         if (scriptParams) {
@@ -601,6 +604,8 @@ webrtcperf.config.AUDIO_URL = "http${this.serverUseHttps ? 's' : ''}://localhost
             await this.context.overridePermissions(new URL(url).origin, this.overridePermissions);
         }
         const page = await this.getNewPage(tabIndex);
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const pageCDPSession = page._client();
         await page.setBypassCSP(true);
         if (this.userAgent) {
             await page.setUserAgent(this.userAgent);
@@ -632,8 +637,7 @@ Object.defineProperty(window.screen.orientation, 'type', { value: 'landscape-pri
         // Clear cookies.
         if (this.clearCookies) {
             try {
-                const client = await page.target().createCDPSession();
-                await client.send('Network.clearBrowserCookies');
+                await pageCDPSession.send('Network.clearBrowserCookies');
             }
             catch (err) {
                 log.error(`clearCookies error: ${err.stack}`);
@@ -671,8 +675,6 @@ Object.defineProperty(window.screen.orientation, 'type', { value: 'landscape-pri
         });
         // Enable request interception.
         let setRequestInterceptionState = true;
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const pageCDPSession = page._client();
         await pageCDPSession.send('Network.setBypassServiceWorker', {
             bypass: true,
         });
@@ -857,20 +859,25 @@ Object.defineProperty(window.screen.orientation, 'type', { value: 'landscape-pri
             await page.emulateCPUThrottling(this.emulateCpuThrottling);
         }
         // PeerConnectionExternal
-        await page.exposeFunction('createPeerConnectionExternal', 
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        async (options) => {
-            const pc = new utils_1.PeerConnectionExternal(options);
-            return { id: pc.id };
-        });
-        await page.exposeFunction('callPeerConnectionExternalMethod', 
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        async (id, name, arg) => {
-            const pc = utils_1.PeerConnectionExternal.get(id);
+        /* await page.exposeFunction(
+          'createPeerConnectionExternal',
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          async (options: any) => {
+            const pc = new PeerConnectionExternal(options)
+            return { id: pc.id }
+          },
+        )
+    
+        await page.exposeFunction(
+          'callPeerConnectionExternalMethod',
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          async (id: number, name: PeerConnectionExternalMethod, arg: any) => {
+            const pc = PeerConnectionExternal.get(id)
             if (pc) {
-                return pc[name](arg);
+              return pc[name](arg)
             }
-        });
+          },
+        )*/
         // Simulate keypress
         await page.exposeFunction('keypressText', async (selector, text, delay = 20) => {
             await page.type(selector, text, { delay });
@@ -1010,73 +1017,28 @@ Object.defineProperty(window.screen.orientation, 'type', { value: 'landscape-pri
                 await page.evaluate(() => webrtcperf.stopFakeScreenshare());
             }
         });
-        // HTTP stats.
-        const resourcesStats = {
-            sentBytes: 0,
-            recvBytes: 0,
-            recvLatency: new stats_1.FastStats({ store_data: false }),
-            wsSentBytes: 0,
-            wsRecvBytes: 0,
-            wsRecvLatency: new stats_1.FastStats({ store_data: false }),
-        };
-        this.httpResourcesStats.set(index, resourcesStats);
-        const pendingRequests = new Map();
-        pageCDPSession.on('Network.requestWillBeSent', event => {
-            if (event.request.url.startsWith('data:'))
-                return;
-            const { requestId, request, timestamp } = event;
-            const sentBytes = request.postDataEntries?.reduce((acc, entry) => acc + (entry.bytes?.length || 0), 0);
-            //log.log('Network.requestWillBeSent', event.type, request.url, sentBytes)
-            if (sentBytes)
-                resourcesStats.sentBytes += sentBytes;
-            pendingRequests.set(requestId, { url: request.url, timestamp });
-        });
-        pageCDPSession.on('Network.responseReceived', event => {
-            const request = pendingRequests.get(event.requestId);
-            if (!request)
-                return;
-            const { response } = event;
-            if (response.fromDiskCache) {
-                pendingRequests.delete(event.requestId);
-                return;
-            }
-            resourcesStats.recvBytes += response.encodedDataLength;
-        });
-        pageCDPSession.on('Network.dataReceived', event => {
-            const request = pendingRequests.get(event.requestId);
-            if (!request)
-                return;
-            resourcesStats.recvBytes += event.encodedDataLength;
-        });
-        pageCDPSession.on('Network.loadingFinished', event => {
-            const request = pendingRequests.get(event.requestId);
-            if (!request)
-                return;
-            pendingRequests.delete(event.requestId);
-            const { timestamp } = event;
-            resourcesStats.recvLatency.push(timestamp - request.timestamp);
+        await page.exposeFunction('webrtcperf_reload', () => {
+            return page.reload();
         });
-        pageCDPSession.on('Network.webSocketCreated', event => {
-            pendingRequests.set(event.requestId, { url: event.url, timestamp: Date.now() });
-        });
-        pageCDPSession.on('Network.webSocketHandshakeResponseReceived', event => {
-            const request = pendingRequests.get(event.requestId);
-            if (!request)
-                return;
-            pendingRequests.delete(event.requestId);
-            resourcesStats.wsRecvLatency.push((Date.now() - request.timestamp) / 1000);
-        });
-        pageCDPSession.on('Network.webSocketFrameSent', event => {
-            resourcesStats.wsSentBytes += event.response.payloadData.length;
-        });
-        pageCDPSession.on('Network.webSocketFrameReceived', event => {
-            resourcesStats.wsRecvBytes += event.response.payloadData.length;
-        });
-        // hardware concurrency
+        // HTTP stats.
+        this.setupPageNetworkStats(pageCDPSession, index);
+        // Hardware concurrency.
         if (this.hardwareConcurrency) {
             const plugin = NavigatorHardwareConcurrency({ hardwareConcurrency: this.hardwareConcurrency });
             await plugin.onPageCreated(page);
         }
+        // Network throttling.
+        if (this.throttleIndex > -1 && (process.platform !== 'linux' || this.useBrowserThrottling)) {
+            log.debug(`Using internal network throttling`);
+            await pageCDPSession.send('Network.emulateNetworkConditions', {
+                offline: false,
+                uploadThroughput: 100000000 / 8,
+                downloadThroughput: 100000000 / 8,
+                latency: 0,
+                packetLoss: 0,
+                packetQueueLength: 0,
+            });
+        }
         // Load page script.
         {
             const filePath = (0, utils_1.resolvePackagePath)('node_modules/@vpalmisano/webrtcperf-js/dist/webrtcperf.js');
@@ -1134,6 +1096,12 @@ Object.defineProperty(window.screen.orientation, 'type', { value: 'landscape-pri
         }
         // add to pages map
         this.pages.set(index, page);
+        if (this.throttleIndex > -1 && (process.platform !== 'linux' || this.useBrowserThrottling)) {
+            await this.applyNetworkThrottling(pageCDPSession);
+            throttler_1.throttleNotifier.on('change', async () => {
+                await this.applyNetworkThrottling(pageCDPSession);
+            });
+        }
         log.debug(`Page ${index + 1} "${url}" loaded in ${(Date.now() - pageLoadTime) / 1000}s`);
         for (let i = 0; i < this.evaluateAfter.length; i++) {
             await page.evaluate(
@@ -1141,6 +1109,87 @@ Object.defineProperty(window.screen.orientation, 'type', { value: 'landscape-pri
             this.evaluateAfter[i].pageFunction, ...this.evaluateAfter[i].args);
         }
     }
+    setupPageNetworkStats(pageCDPSession, index) {
+        const resourcesStats = {
+            sentBytes: 0,
+            recvBytes: 0,
+            recvLatency: new stats_1.FastStats({ store_data: false }),
+            wsSentBytes: 0,
+            wsRecvBytes: 0,
+            wsRecvLatency: new stats_1.FastStats({ store_data: false }),
+        };
+        this.httpResourcesStats.set(index, resourcesStats);
+        const pendingRequests = new Map();
+        pageCDPSession.on('Network.requestWillBeSent', event => {
+            if (event.request.url.startsWith('data:'))
+                return;
+            const { requestId, request, timestamp } = event;
+            const sentBytes = request.postDataEntries?.reduce((acc, entry) => acc + (entry.bytes?.length || 0), 0);
+            //log.log('Network.requestWillBeSent', event.type, request.url, sentBytes)
+            if (sentBytes)
+                resourcesStats.sentBytes += sentBytes;
+            pendingRequests.set(requestId, { url: request.url, timestamp });
+        });
+        pageCDPSession.on('Network.responseReceived', event => {
+            const request = pendingRequests.get(event.requestId);
+            if (!request)
+                return;
+            const { response } = event;
+            if (response.fromDiskCache) {
+                pendingRequests.delete(event.requestId);
+                return;
+            }
+            resourcesStats.recvBytes += response.encodedDataLength;
+        });
+        pageCDPSession.on('Network.dataReceived', event => {
+            const request = pendingRequests.get(event.requestId);
+            if (!request)
+                return;
+            resourcesStats.recvBytes += event.encodedDataLength;
+        });
+        pageCDPSession.on('Network.loadingFinished', event => {
+            const request = pendingRequests.get(event.requestId);
+            if (!request)
+                return;
+            pendingRequests.delete(event.requestId);
+            const { timestamp } = event;
+            resourcesStats.recvLatency.push(timestamp - request.timestamp);
+        });
+        pageCDPSession.on('Network.webSocketCreated', event => {
+            pendingRequests.set(event.requestId, { url: event.url, timestamp: Date.now() });
+        });
+        pageCDPSession.on('Network.webSocketHandshakeResponseReceived', event => {
+            const request = pendingRequests.get(event.requestId);
+            if (!request)
+                return;
+            pendingRequests.delete(event.requestId);
+            resourcesStats.wsRecvLatency.push((Date.now() - request.timestamp) / 1000);
+        });
+        pageCDPSession.on('Network.webSocketFrameSent', event => {
+            resourcesStats.wsSentBytes += event.response.payloadData.length;
+        });
+        pageCDPSession.on('Network.webSocketFrameReceived', event => {
+            resourcesStats.wsRecvBytes += event.response.payloadData.length;
+        });
+    }
+    async applyNetworkThrottling(pageCDPSession) {
+        const throttleUpValues = (0, throttler_1.getSessionThrottleValues)(this.throttleIndex, 'up');
+        const throttleDownValues = (0, throttler_1.getSessionThrottleValues)(this.throttleIndex, 'down');
+        const params = {
+            offline: false,
+            uploadThroughput: throttleUpValues.rate || -1,
+            downloadThroughput: throttleDownValues.rate || -1,
+            latency: Math.max(throttleUpValues.delay || 0, throttleDownValues.delay || 0),
+            packetLoss: Math.max(throttleUpValues.loss || 0, throttleDownValues.loss || 0),
+            packetQueueLength: Math.max(throttleUpValues.queue || 0, throttleDownValues.queue || 0),
+        };
+        log.debug(`Apply internal network throttling: ${JSON.stringify(params)}`);
+        await pageCDPSession.send('Network.emulateNetworkConditions', {
+            ...params,
+            uploadThroughput: params.uploadThroughput !== -1 ? params.uploadThroughput / 8 : -1,
+            downloadThroughput: params.downloadThroughput !== -1 ? params.downloadThroughput / 8 : -1,
+        });
+    }
     async getNewPage(tabIndex) {
         log.debug(`getNewPage ${tabIndex}`);
         (0, assert_1.default)(this.context, 'NoBrowserContextCreated');