@vpalmisano/webrtcperf 4.4.1 → 4.4.3

package/src/session.ts

@@ -1,4 +1,4 @@
-import { getSessionThrottleValues, throttleLauncher } from '@vpalmisano/throttler'
+import { getSessionThrottleValues, throttleLauncher, throttleNotifier } from '@vpalmisano/throttler'
 import assert from 'assert'
 import axios from 'axios'
 import EventEmitter from 'events'
@@ -30,8 +30,8 @@ import { gunzipSync } from 'zlib'
 import { RtcStats, rtcStatKey, updateRtcStats } from './rtcstats'
 import { FastStats } from './stats'
 import {
-  PeerConnectionExternal,
-  PeerConnectionExternalMethod,
+  /* PeerConnectionExternal,
+  PeerConnectionExternalMethod, */
   checkChromeExecutable,
   downloadUrl,
   enabledForSession,
@@ -163,6 +163,7 @@ export interface SessionParams {
   userAgent: string
   id: number
   throttleIndex: number
+  useBrowserThrottling: boolean
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   evaluateAfter?: any[]
   exposedFunctions?: string
@@ -279,6 +280,8 @@ export class Session extends EventEmitter {
   readonly id: number
   /** The throttle configuration index assigned to the session. */
   readonly throttleIndex: number
+  /** If true, the network will be throttled using the browser internal throttling mechanism. */
+  readonly useBrowserThrottling: boolean
   /** The test page url. */
   readonly url: string
   /** The url query. */
@@ -378,6 +381,7 @@ export class Session extends EventEmitter {
     userAgent,
     id,
     throttleIndex,
+    useBrowserThrottling,
     evaluateAfter,
     exposedFunctions,
     scriptParams,
@@ -475,6 +479,7 @@ export class Session extends EventEmitter {
     this.emulateCpuThrottling = emulateCpuThrottling
 
     this.throttleIndex = throttleIndex
+    this.useBrowserThrottling = useBrowserThrottling
     this.evaluateAfter = evaluateAfter || []
     this.exposedFunctions = exposedFunctions || {}
     if (scriptParams) {
@@ -892,6 +897,9 @@ webrtcperf.config.AUDIO_URL = "http${this.serverUseHttps ? 's' : ''}://localhost
 
     const page = await this.getNewPage(tabIndex)
 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const pageCDPSession = (page as any)._client() as CDPSession
+
     await page.setBypassCSP(true)
 
     if (this.userAgent) {
@@ -932,8 +940,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 as Error).stack}`)
       }
@@ -977,8 +984,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 as any)._client() as CDPSession
     await pageCDPSession.send('Network.setBypassServiceWorker', {
       bypass: true,
     })
@@ -1181,7 +1186,7 @@ Object.defineProperty(window.screen.orientation, 'type', { value: 'landscape-pri
     }
 
     // PeerConnectionExternal
-    await page.exposeFunction(
+    /* await page.exposeFunction(
       'createPeerConnectionExternal',
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       async (options: any) => {
@@ -1199,7 +1204,7 @@ Object.defineProperty(window.screen.orientation, 'type', { value: 'landscape-pri
           return pc[name](arg)
         }
       },
-    )
+    )*/
 
     // Simulate keypress
     await page.exposeFunction('keypressText', async (selector: string, text: string, delay = 20) => {
@@ -1362,77 +1367,32 @@ Object.defineProperty(window.screen.orientation, 'type', { value: 'landscape-pri
       }
     })
 
-    // HTTP stats.
-    const resourcesStats = {
-      sentBytes: 0,
-      recvBytes: 0,
-      recvLatency: new FastStats({ store_data: false }),
-      wsSentBytes: 0,
-      wsRecvBytes: 0,
-      wsRecvLatency: new FastStats({ store_data: false }),
-    }
-    this.httpResourcesStats.set(index, resourcesStats)
-
-    const pendingRequests = new Map<string, { url: string; timestamp: number }>()
-    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
+    await page.exposeFunction('webrtcperf_reload', () => {
+      return page.reload()
     })
 
-    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
-    })
+    // HTTP stats.
+    this.setupPageNetworkStats(pageCDPSession, index)
 
-    // 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 = resolvePackagePath('node_modules/@vpalmisano/webrtcperf-js/dist/webrtcperf.js')
@@ -1492,6 +1452,13 @@ 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)
+      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++) {
@@ -1503,6 +1470,91 @@ Object.defineProperty(window.screen.orientation, 'type', { value: 'landscape-pri
     }
   }
 
+  private setupPageNetworkStats(pageCDPSession: CDPSession, index: number) {
+    const resourcesStats = {
+      sentBytes: 0,
+      recvBytes: 0,
+      recvLatency: new FastStats({ store_data: false }),
+      wsSentBytes: 0,
+      wsRecvBytes: 0,
+      wsRecvLatency: new FastStats({ store_data: false }),
+    }
+    this.httpResourcesStats.set(index, resourcesStats)
+
+    const pendingRequests = new Map<string, { url: string; timestamp: number }>()
+    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
+    })
+  }
+
+  private async applyNetworkThrottling(pageCDPSession: CDPSession) {
+    const throttleUpValues = getSessionThrottleValues(this.throttleIndex, 'up')
+    const throttleDownValues = 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,
+    })
+  }
+
   private async getNewPage(tabIndex: number): Promise<Page> {
     log.debug(`getNewPage ${tabIndex}`)
     assert(this.context, 'NoBrowserContextCreated')