@vpalmisano/webrtcperf 4.2.2 → 4.4.1

package/src/server.ts

@@ -11,10 +11,12 @@ import { WebSocketServer } from 'ws'
 import zlib from 'zlib'
 import auth from 'basic-auth'
 
-import { loadConfig } from './config'
+import { Config, loadConfig } from './config'
 import { Session, SessionParams } from './session'
 import { Stats } from './stats'
 import { logger, runShellCommand, getDockerLogsPath } from './utils'
+import { getSessionThrottleIndex } from '@vpalmisano/throttler'
+import { MediaPath, prepareFakeMedia } from './media'
 
 const log = logger('webrtcperf:server')
 
@@ -272,7 +274,8 @@ export class Server {
   private async putSession(req: express.Request, res: express.Response, next: express.NextFunction): Promise<void> {
     log.debug(`PUT /session`, req.body)
     try {
-      const id = this.stats.consumeSessionId()
+      const config = req.body as Config
+      const id = this.stats.consumeSessionId(config.tabsPerSession)
       await this.startLocalSession(id, req.body)
       res.json({
         message: `Session created`,
@@ -293,10 +296,10 @@ export class Server {
   private async putSessions(req: express.Request, res: express.Response, next: express.NextFunction): Promise<void> {
     log.debug(`PUT /sessions`, req.body)
     try {
-      const { sessions } = req.body
+      const { sessions, tabsPerSession } = req.body as Config
       const sessionsIds = []
       for (let i = 0; i < sessions; i++) {
-        const id = this.stats.sessions.size
+        const id = this.stats.consumeSessionId(tabsPerSession)
         await this.startLocalSession(id, req.body)
         sessionsIds.push(id)
       }
@@ -471,12 +474,25 @@ export class Server {
    * @param config The session configuration.
    */
   private async startLocalSession(id: number, config: SessionParams): Promise<Session> {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const sessionConfig = loadConfig(undefined, config) as any
-    const session = new Session({ ...sessionConfig, id })
+    const configs = await loadConfig(undefined, config)
+    const sessionConfig = configs[0]
+    const throttleIndex = getSessionThrottleIndex(id)
+    const spawnPeriod = 1000 / sessionConfig.spawnRate
+
+    // Prepare fake video and audio.
+    const mediaPaths: MediaPath[] = []
+    if (sessionConfig.videoPath) {
+      for (const videoPath of sessionConfig.videoPath.split(',')) {
+        const ret = await prepareFakeMedia({ ...sessionConfig, videoPath })
+        mediaPaths.push(ret)
+      }
+    }
+    const mediaPath = mediaPaths.length ? mediaPaths[id % mediaPaths.length] : undefined
+
+    const session = new Session({ ...sessionConfig, throttleIndex, spawnPeriod, mediaPath, id })
     session.once('stop', () => {
       console.warn(`Session ${id} stopped, reloading...`)
-      setTimeout(this.startLocalSession.bind(this), sessionConfig.spawnPeriod, id, config)
+      setTimeout(this.startLocalSession.bind(this), spawnPeriod, id, config)
     })
     this.stats.addSession(session)
     try {
@@ -510,13 +526,17 @@ export class Server {
     log.debug('start')
     if (this.serverUseHttps) {
       const destDir = path.join(os.homedir(), '.webrtcperf/ssl')
-      await runShellCommand(
-        `mkdir -p ${destDir} && openssl req -newkey rsa:2048 -nodes -keyout ${destDir}/domain.key -x509 -days 365 -out ${destDir}/domain.crt -subj "/C=EU/ST=London/L=London/O=Global Security/OU=IT Department/CN=example.com"`,
-      )
+      const keyPath = path.join(destDir, 'domain.key')
+      const crtPath = path.join(destDir, 'domain.crt')
+      if (!fs.existsSync(keyPath) || !fs.existsSync(crtPath)) {
+        await runShellCommand(
+          `mkdir -p ${destDir} && openssl req -newkey rsa:2048 -nodes -keyout ${keyPath} -x509 -days 365 -out ${crtPath} -subj "/C=EU/ST=London/L=London/O=Global Security/OU=IT Department/CN=example.com"`,
+        )
+      }
       this.server = _createServer(
         {
-          key: fs.readFileSync(`${destDir}/domain.key`),
-          cert: fs.readFileSync(`${destDir}/domain.crt`),
+          key: fs.readFileSync(keyPath),
+          cert: fs.readFileSync(crtPath),
         },
         this.app,
       )

package/src/session.ts

@@ -676,7 +676,7 @@ export class Session extends EventEmitter {
             deviceScaleFactor: this.deviceScaleFactor,
             isMobile: false,
             hasTouch: false,
-            isLandscape: false,
+            isLandscape: true,
           },
         })
       } catch (err) {
@@ -803,7 +803,7 @@ try {
 } catch (err) {
   console.error('[webrtcperf] Error parsing scriptParams:', err);
   webrtcperf.params = {};
-}
+};
   `
 
     if (this.serverPort) {
@@ -910,15 +910,22 @@ 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)
 
@@ -1305,7 +1312,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: any) => {
-        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)
       })
 

package/src/stats.ts

@@ -32,23 +32,19 @@ function calculateFailAmountPercentile(stat: FastStats, percentile = 95): number
 class StatsWriter {
   fname: string
   columns: string[]
-  private _header_written = false
+  private headerWritten = false
 
   constructor(fname = 'stats.log', columns: string[]) {
     this.fname = fname
     this.columns = columns
   }
 
-  /**
-   * push
-   * @param dataColumns
-   */
-  async push(dataColumns: string[]): Promise<void> {
-    if (!this._header_written) {
+  async push(dataColumns: string[], append = true): Promise<void> {
+    if (!this.headerWritten || !append) {
       const data = ['datetime', ...this.columns].join(',') + '\n'
       await fs.promises.mkdir(path.dirname(this.fname), { recursive: true })
       await fs.promises.writeFile(this.fname, data)
-      this._header_written = true
+      this.headerWritten = true
     }
     //
     const data = [Date.now(), ...dataColumns].join(',') + '\n'
@@ -330,6 +326,7 @@ export class Stats extends events.EventEmitter {
   nextSessionId: number
   statsWriter: StatsWriter | null
   detailedStatsWriter: StatsWriter | null
+  detailedStatsSummaryWriter: StatsWriter | null
   private scheduler?: Scheduler
 
   private alertRules: Record<string, AlertRule> | null = null
@@ -386,18 +383,18 @@ export class Stats extends events.EventEmitter {
 
   collectedStats: Record<string, CollectedStats>
 
-  collectedStatsConfig = {
+  private collectedStatsConfig = {
     url: '',
     pages: 0,
     startTime: 0,
   }
-  externalCollectedStats = new Map<
+  private externalCollectedStats = new Map<
     string,
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     { addedTime: number; externalStats: any; config: any }
   >()
-  pushStatsInstance: axios.AxiosInstance | null = null
-
+  private pushStatsInstance: axios.AxiosInstance | null = null
+  private detailedStatsSummary: Record<string, Record<string, FastStats>> = {}
   private running = false
 
   /**
@@ -485,6 +482,7 @@ export class Stats extends events.EventEmitter {
 
     this.statsWriter = null
     this.detailedStatsWriter = null
+    this.detailedStatsSummaryWriter = null
     if (alertRules.trim()) {
       this.alertRules = json5.parse(alertRules)
       log.debug(`using alertRules: ${JSON.stringify(this.alertRules, undefined, 2)}`)
@@ -615,6 +613,11 @@ export class Stats extends events.EventEmitter {
         'trackId',
         ...this.statsNames,
       ])
+      this.detailedStatsSummaryWriter = new StatsWriter(this.detailedStatsPath.replace(/\.(.+)$/, '-summary.$1'), [
+        'participantName',
+        'trackId',
+        ...this.statsNames,
+      ])
     }
 
     if (this.prometheusPushgateway) {
@@ -821,8 +824,7 @@ export class Stats extends events.EventEmitter {
             collectedStats.all.push(obj)
           } else {
             for (const [key, value] of Object.entries(obj)) {
-              // eslint-disable-next-line @typescript-eslint/no-explicit-any
-              if (typeof value === 'number' && isFinite(value as any)) {
+              if (typeof value === 'number' && isFinite(value)) {
                 collectedStats.all.push(value)
                 // Push host label.
                 const { trackId, hostName, participantName } = parseRtStatKey(key)
@@ -955,7 +957,7 @@ export class Stats extends events.EventEmitter {
 
   async writeDetailedStats() {
     if (!this.detailedStatsWriter) return
-    const participantTrackStats = new Map<string, Record<string, string>>()
+    const participantTrackStats = new Map<string, Record<string, number>>()
     Object.entries(this.collectedStats).forEach(([name, stats]) => {
       Object.entries(stats.byParticipantAndTrack).forEach(([label, value]) => {
         let stats = participantTrackStats.get(label)
@@ -963,19 +965,47 @@ export class Stats extends events.EventEmitter {
           stats = {}
           participantTrackStats.set(label, stats)
         }
-        stats[name] = toPrecision(value, 6)
+        stats[name] = value
       })
     })
     for (const [label, trackStats] of participantTrackStats.entries()) {
       const [participantName, trackId] = label.split(':', 2)
+      if (!this.detailedStatsSummary[label]) {
+        this.detailedStatsSummary[label] = {}
+      }
+      const summary = this.detailedStatsSummary[label]
       const values = [participantName, trackId]
       for (const name of this.statsNames) {
-        values.push(trackStats[name] ?? '')
+        values.push(trackStats[name] !== undefined ? toPrecision(trackStats[name], 6) : '')
+        // Update the summary stats.
+        if (!summary[name]) {
+          summary[name] = new FastStats({ store_data: false })
+        }
+        const stat = summary[name]
+        if (trackStats[name] !== undefined) {
+          stat.push(trackStats[name])
+        }
       }
       await this.detailedStatsWriter.push(values)
     }
   }
 
+  async writeDetailedStatsSummary() {
+    if (!this.detailedStatsSummaryWriter) return
+    let append = false
+    for (const label of Object.keys(this.detailedStatsSummary)) {
+      const summary = this.detailedStatsSummary[label]
+      const [participantName, trackId] = label.split(':', 2)
+      const values = [participantName, trackId]
+      for (const name of this.statsNames) {
+        const stat = summary[name]
+        values.push(stat?.length > 0 ? toPrecision(stat.amean(), 6) : '')
+      }
+      await this.detailedStatsSummaryWriter.push(values, append)
+      append = true
+    }
+  }
+
   /**
    * addCollectedStats
    * @param id
@@ -1652,17 +1682,13 @@ export class Stats extends events.EventEmitter {
     }
   }
 
-  /**
-   * Stop the stats collector and the added Sessions.
-   */
-  async stop(): Promise<void> {
-    if (!this.running) {
-      return
-    }
+  async stop() {
+    if (!this.running) return
     this.running = false
     log.debug('stop')
+
     if (this.scheduler) {
-      this.scheduler.stop()
+      await this.scheduler.stop()
       this.scheduler = undefined
     }
 
@@ -1676,7 +1702,12 @@ export class Stats extends events.EventEmitter {
     }
     this.sessions.clear()
 
+    await this.writeDetailedStatsSummary()
+
     this.statsWriter = null
+    this.detailedStatsWriter = null
+    this.detailedStatsSummaryWriter = null
+    this.detailedStatsSummary = {}
 
     // delete metrics
     if (this.gateway) {

package/src/utils.ts

@@ -291,7 +291,6 @@ export async function randomActivateAudio(
         pages = pages.concat(sessionPages)
       }
     }
-    // Remove pages with no audio tracks.
     for (const [i, page] of pages.entries()) {
       if (!page) {
         continue
@@ -307,15 +306,8 @@ export async function randomActivateAudio(
       }
     }
     const pagesWithAudio: Page[] = pages.filter(p => !!p)
-    //
     const index = Math.floor(Math.random() * pagesWithAudio.length)
     const enable = Math.round(100 * Math.random()) <= randomAudioProbability
-    log.debug('randomActivateAudio %j', {
-      pages: pagesWithAudio.length,
-      randomAudioProbability,
-      index,
-      enable,
-    })
     for (const [i, page] of pagesWithAudio.entries()) {
       try {
         if (i === index) {
@@ -613,7 +605,8 @@ SIGNALS.forEach(event =>
 export async function checkChromeExecutable(): Promise<string> {
   // eslint-disable-next-line @typescript-eslint/no-require-imports
   const { loadConfig } = require('./config')
-  const config = await loadConfig()
+  const configs = await loadConfig()
+  const config = configs[0]
   const cacheDir = path.join(os.homedir(), '.webrtcperf/chrome')
 
   const fixSemVer = (v: string) => v.split('.').slice(0, 3).join('.')
@@ -658,28 +651,37 @@ export async function runShellCommand(
   cmd: string,
   verbose = false,
   maxBuffer = 1024 * 1024,
+  { provideStdin = false, returnStdout = true, returnStderr = true } = {},
 ): Promise<{ stdout: string; stderr: string }> {
   if (verbose) log.debug(`runShellCommand cmd: ${cmd}`)
   return new Promise((resolve, reject) => {
     const p = spawn(cmd, {
       shell: true,
-      stdio: ['ignore', 'pipe', 'pipe'],
+      stdio: [
+        provideStdin ? 'inherit' : 'ignore',
+        returnStdout ? 'pipe' : 'inherit',
+        returnStderr ? 'pipe' : 'inherit',
+      ],
       detached: true,
     })
     let stdout = ''
     let stderr = ''
-    p.stdout.on('data', data => {
-      if (maxBuffer && stdout.length > maxBuffer) {
-        stdout = stdout.slice(data.length)
-      }
-      stdout += data
-    })
-    p.stderr.on('data', data => {
-      if (maxBuffer && stderr.length > maxBuffer) {
-        stderr = stderr.slice(data.length)
-      }
-      stderr += data
-    })
+    if (returnStdout) {
+      p.stdout?.on('data', data => {
+        if (maxBuffer && stdout.length > maxBuffer) {
+          stdout = stdout.slice(data.length)
+        }
+        stdout += data
+      })
+    }
+    if (returnStderr) {
+      p.stderr?.on('data', data => {
+        if (maxBuffer && stderr.length > maxBuffer) {
+          stderr = stderr.slice(data.length)
+        }
+        stderr += data
+      })
+    }
     p.once('error', err => reject(err))
     p.once('close', code => {
       if (code !== 0) {
@@ -806,21 +808,26 @@ export class Scheduler {
     log.debug(`[${this.name}-scheduler] constructor interval=${this.interval}ms`)
   }
 
-  start(): void {
+  start() {
     log.debug(`[${this.name}-scheduler] start`)
     this.running = true
     this.scheduleNext()
   }
 
-  stop(): void {
+  async stop() {
     log.debug(`[${this.name}-scheduler] stop`)
     this.running = false
     if (this.statsTimeoutId) {
       clearTimeout(this.statsTimeoutId)
     }
+    try {
+      await this.callback(Date.now())
+    } catch (err) {
+      log.error(`[${this.name}-scheduler] stop callback error: ${(err as Error).stack}`, err)
+    }
   }
 
-  private scheduleNext(): void {
+  private scheduleNext() {
     if (!this.running) {
       return
     }