@vpalmisano/webrtcperf 4.3.2 → 4.4.2

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) {
@@ -405,7 +408,7 @@ class Session extends events_1.default {
                         deviceScaleFactor: this.deviceScaleFactor,
                         isMobile: false,
                         hasTouch: false,
-                        isLandscape: false,
+                        isLandscape: true,
                     },
                 });
             }
@@ -525,7 +528,7 @@ try {
 } catch (err) {
   console.error('[webrtcperf] Error parsing scriptParams:', err);
   webrtcperf.params = {};
-}
+};
   `;
         if (this.serverPort) {
             cmd += `\
@@ -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);
@@ -611,22 +616,28 @@ webrtcperf.config.AUDIO_URL = "http${this.serverUseHttps ? 's' : ''}://localhost
         if (this.localStorage) {
             log.debug('Using localStorage:', this.localStorage);
             Object.entries(this.localStorage).map(([key, value]) => {
-                cmd += `localStorage.setItem('${key}', '${JSON.stringify(value)}');\n`;
+                cmd += `window.localStorage.setItem('${key}', ${JSON.stringify(value)});\n`;
             });
         }
         if (this.sessionStorage) {
             log.debug('Using sessionStorage:', this.sessionStorage);
             Object.entries(this.sessionStorage).map(([key, value]) => {
-                cmd += `sessionStorage.setItem('${key}', '${JSON.stringify(value)}');\n`;
+                cmd += `window.sessionStorage.setItem('${key}', ${JSON.stringify(value)});\n`;
             });
         }
+        cmd += `
+Object.defineProperty(window.screen, 'width', { value: ${this.windowWidth}, writable: false });
+Object.defineProperty(window.screen, 'height', { value: ${this.windowHeight}, writable: false });
+Object.defineProperty(window.screen, 'availWidth', { value: ${this.windowWidth}, writable: false });
+Object.defineProperty(window.screen, 'availHeight', { value: ${this.windowHeight}, writable: false });
+Object.defineProperty(window.screen.orientation, 'type', { value: 'landscape-primary', writable: false });
+    `;
         log.debug('init command:', cmd);
         await page.evaluateOnNewDocument(cmd);
         // 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}`);
@@ -664,8 +675,6 @@ webrtcperf.config.AUDIO_URL = "http${this.serverUseHttps ? 's' : ''}://localhost
         });
         // 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,
         });
@@ -850,20 +859,25 @@ webrtcperf.config.AUDIO_URL = "http${this.serverUseHttps ? 's' : ''}://localhost
             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 });
@@ -962,7 +976,7 @@ webrtcperf.config.AUDIO_URL = "http${this.serverUseHttps ? 's' : ''}://localhost
         if (this.showPageLog || saveFile) {
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             page.on('pageerror', async (error) => {
-                const text = `pageerror: ${error.message?.message || error.message} - ${error.message?.stack || error.stack}`;
+                const text = `pageerror: ${error?.message?.message || error?.message || error} - ${error?.message?.stack || error?.stack}`;
                 await this.onPageMessage(index, 'error', text, saveFile);
             });
             page.on('requestfailed', async (request) => {
@@ -1065,11 +1079,23 @@ webrtcperf.config.AUDIO_URL = "http${this.serverUseHttps ? 's' : ''}://localhost
         pageCDPSession.on('Network.webSocketFrameReceived', event => {
             resourcesStats.wsRecvBytes += event.response.payloadData.length;
         });
-        // hardware concurrency
+        // 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');
@@ -1127,6 +1153,12 @@ webrtcperf.config.AUDIO_URL = "http${this.serverUseHttps ? 's' : ''}://localhost
         }
         // 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(
@@ -1134,6 +1166,24 @@ webrtcperf.config.AUDIO_URL = "http${this.serverUseHttps ? 's' : ''}://localhost
             this.evaluateAfter[i].pageFunction, ...this.evaluateAfter[i].args);
         }
     }
+    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');