@vpalmisano/webrtcperf 4.1.11 → 4.2.2

package/src/app.ts

@@ -2,9 +2,8 @@ import { getSessionThrottleIndex, startThrottle, stopThrottle } from '@vpalmisan
 import { paramCase } from 'change-case'
 import fs from 'fs'
 import json5 from 'json5'
-import wrap from 'word-wrap'
 
-import { Config, getConfigDocs, loadConfig } from './config'
+import { Config, getConfigDocs, loadConfig, loadConfigFromPrompt } from './config'
 import { MediaPath, prepareFakeMedia } from './media'
 import { Server } from './server'
 import { Session } from './session'
@@ -23,22 +22,34 @@ import {
 import { calculateVisqolScore } from './visqol'
 import { calculateVmafScore, convertToIvf, prepareVideo } from './vmaf'
 import path from 'path'
+import { markedTerminal } from 'marked-terminal'
+
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const { marked } = require('marked')
+marked.use(markedTerminal({ reflowText: true, tab: 2 }))
 
 const log = logger('webrtcperf')
 
 function showHelpOrVersion(): void {
-  if (process.argv.findIndex(a => a.localeCompare('--help') === 0) !== -1) {
+  if (process.argv.includes('--help') || process.argv.includes('-h')) {
     const docs = getConfigDocs()
-    let out = `Params:\n  --version\n        It shows the package version.\n`
+    let out = marked.parse(`**Webrtcperf parameters**
+
+\`--version\` It shows the package version.
+`)
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     Object.entries(docs).forEach(([name, value]: [string, any]) => {
-      out += `  --${paramCase(name)}
-${wrap(value.doc, { width: 72, indent: '        ' })}
-        Default: ${value.default}\n`
+      out += marked.parse(
+        `
+\`--${paramCase(name)}\`
+${value.doc}
+Default value: \`${value.default}\`
+`,
+      )
     })
     console.log(out)
     process.exit(0)
-  } else if (process.argv.findIndex(a => a.localeCompare('--version') === 0) !== -1) {
+  } else if (process.argv.includes('--version') || process.argv.includes('-v')) {
     const version = json5.parse(fs.readFileSync(resolvePackagePath('package.json')).toString()).version
     console.log(version)
     process.exit(0)
@@ -189,7 +200,23 @@ export async function setupApplication(config: Config): Promise<{ stats: Stats;
 async function main(): Promise<void> {
   showHelpOrVersion()
 
-  const config = await loadConfig(process.argv[2])
+  let config: Config
+
+  if (process.argv.slice(2).includes('--prompt')) {
+    const params = await loadConfigFromPrompt(
+      process.argv
+        .slice(2)
+        .filter(s => !['--prompt', '--dry-run'].includes(s))
+        .join(' '),
+    )
+    if (process.argv.slice(2).includes('--dry-run')) {
+      console.log(json5.stringify(params, null, 2))
+      process.exit(0)
+    }
+    config = await loadConfig(undefined, params)
+  } else {
+    config = await loadConfig(process.argv[2])
+  }
 
   if (config.vmafPrepareVideo) {
     await prepareVideo(config, true)

package/src/config.ts

@@ -1,8 +1,8 @@
-import convict, { addFormats } from 'convict'
+import convict, { addFormats, SchemaObj } from 'convict'
 import { ipaddress, url } from 'convict-format-with-validator'
 import { existsSync } from 'fs'
 import os from 'os'
-import { join } from 'path'
+import path, { join } from 'path'
 import json5 from 'json5'
 import yaml from 'yaml'
 import toml from 'toml'
@@ -110,7 +110,7 @@ The temporary files containing the raw video and audio will be stored at \
 \`\${VIDEO_CACHE_PATH}/video.\${VIDEO_FORMAT}\` and \
 \`\${VIDEO_CACHE_PATH}/audio.wav\`.`,
     format: String,
-    default: 'https://github.com/vpalmisano/webrtcperf/releases/download/v2.0.4/video.mp4',
+    default: 'https://github.com/vpalmisano/webrtcperf/releases/download/videos-1.0/kt.mp4',
     env: 'VIDEO_PATH',
     arg: 'video-path',
   },
@@ -190,7 +190,51 @@ seconds.`,
     arg: 'run-duration',
   },
   throttleConfig: {
-    doc: `A JSON5 string with a valid throtter configuration (https://github.com/vpalmisano/throttler).`,
+    doc: `A JSON5 string with a valid throttler configuration (https://github.com/vpalmisano/throttler). \
+Example: \
+
+  \`\`\`javascript
+  [{
+    sessions: '0-1',
+    device: 'eth0',
+    protocol: 'udp',
+    skipSourcePorts: "443",
+    skipDestinationPorts: "443",
+    filter: "--sports 443 --dports 443",
+    match: 'nbyte("ababa" at 12 layer 1)',
+    capture: 'capture.pcap',
+    up: {
+      rate: 1000,
+      delay: 50,
+      loss: 5,
+      queue: 10,
+    },
+    down: [
+      { rate: 2000, delay: 50, delayJitter: 10, delayJitterCorrelation: 25, loss: 2, lossBurst: 2, queue: 20 },
+      { rate: 1000, delay: 50, loss: 2, queue: 20, at: 60 },
+    ]
+  }]
+  \`\`\`
+- The sessions field represents the sessions IDs range that will be affected by the rule, e.g.: "0-10", "2,4" or simply "2".
+- The device, protocol, up, down fields are optional. When device is not set, the default route device will be used. If protocol is specified ('udp' or 'tcp'), \
+only the packets with the specified protocol will be affected by the shaping rules.
+- The capture field is optional and specifies the pcap file to save the captured packets.
+- With skipSourcePorts and skipDestinationPorts you can specify a comma-separated list of ports that will not be affected by the shaping rules.
+- The filter field is optional and specifies the additional IPTables filter to apply for filtering the packets.
+- The match field is optional and specifies the additional match rule to apply for filtering the packets (https://man7.org/linux/man-pages/man8/tc-ematch.8.html).
+- The up and down fields are optional and they specify the upstream and downstream shaping rules. The possible options for the up and down rules could be:
+  - rate: the shaping rate in Kbps;
+  - delay: the shaping delay in milliseconds;
+  - delayJitter: the shaping delay jitter in milliseconds;
+  - delayJitterCorrelation: the shaping delay jitter correlation in milliseconds;
+  - loss: the packet loss percentage;
+  - lossBurst: the packet loss burst percentage;
+  - queue: the shaping queue size in packets;
+  - at: the time in seconds when the shaping rule will be applied (default: 0).
+The up and down rules can be specified as a single object or an array of objects.
+When using an array of objects, specify a different "at" value for each of them, in order to apply a sequence of actions; please note that only the specified properties will override previous ones, so you can omit the values that you don't want to change. \
+  \
+    `,
     format: String,
     nullable: true,
     default: '',
@@ -367,9 +411,9 @@ calculated using \`Date.now()\``,
     arg: 'spawn-rate',
   },
   showPageLog: {
-    doc: `If \`true\`, the pages console logs will be shown on console.`,
+    doc: `If \`true\`, the pages console logs will be shown on console. Set to false to disable the page logs.`,
     format: 'Boolean',
-    default: true,
+    default: false,
     env: 'SHOW_PAGE_LOG',
     arg: 'show-page-log',
   },
@@ -401,7 +445,7 @@ on the console. Regexp string allowed.`,
   userAgent: {
     doc: `The user agent override.`,
     format: String,
-    default: 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36',
+    default: `Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/${puppeteer.PUPPETEER_REVISIONS.chrome} Safari/537.36`,
     nullable: true,
     env: 'USER_AGENT',
     arg: 'user-agent',
@@ -412,7 +456,9 @@ If set, the files contents will be executed inside each opened tab page; \
 the following global variables will be attached to the \`webrtcperf\` global object: \
 \`WEBRTC_PERF_SESSION\` the session number (0-indexed); \
 \`WEBRTC_PERF_TAB\` the tab number inside the same session (0-indexed); \
-\`WEBRTC_PERF_INDEX\` the page absolute index (0-indexed). \
+\`WEBRTC_PERF_INDEX\` the page absolute index (0-indexed).
+Suggested values:
+- With meet.google.com: https://raw.githubusercontent.com/vpalmisano/webrtcperf/refs/heads/devel/examples/google-meet.js
 `,
     format: String,
     default: '',
@@ -762,7 +808,7 @@ the reference and degraded versions.`,
   vmafCrop: {
     doc: `If set, the reference and degraded videos will be cropped using the specified configuration in JSON5 format. \
 Crop configuration should be expressed using the ffmpeg crop filter syntax (https://ffmpeg.org/ffmpeg-filters.html#crop). \
-E.g. \`{ "Participant-000001_recv-by_Participant-000000': { ref: { w: "iw-10", h: "ih-5" }, deg: { w: "200", h: "200" } } }\``,
+E.g. \`{ "Participant-000001_recv-by_Participant-000000": { ref: { w: "iw-10", h: "ih-5" }, deg: { w: "200", h: "200" } } }\``,
     format: String,
     nullable: true,
     default: '',
@@ -880,7 +926,12 @@ export async function loadConfig(filePath?: string, values?: any): Promise<Confi
       configSchema.load(values)
     } else if (existsSync(filePath)) {
       log.debug(`Loading config from local file: ${filePath}`)
-      configSchema.loadFile(filePath)
+      if (filePath.endsWith('.js') || filePath.endsWith('.mjs')) {
+        const module = await import(/* webpackIgnore: true */ path.resolve(filePath))
+        configSchema.load(await module.default())
+      } else {
+        configSchema.loadFile(filePath)
+      }
     }
   } else if (values) {
     log.debug('Loading config from values.')
@@ -896,3 +947,60 @@ export async function loadConfig(filePath?: string, values?: any): Promise<Confi
   log.debug('Using config:', config)
   return config
 }
+
+function getFunctionDeclaration() {
+  const properties: Record<string, { type: string; description: string; nullable?: boolean }> = {}
+  const required: string[] = []
+  const schema = configSchema.getSchema()
+
+  Object.entries(schema._cvtProperties).forEach(([name, value]) => {
+    const { format, doc, nullable } = value as SchemaObj
+    properties[name] = {
+      type: format as string,
+      description: doc as string,
+      nullable,
+    }
+  })
+
+  return {
+    name: 'webrtcperf',
+    description: 'Starts a webrtcperf test.',
+    parameters: {
+      type: 'object',
+      properties,
+      required,
+    },
+  }
+}
+
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const { GoogleGenAI } = require('@google/genai')
+
+export async function loadConfigFromPrompt(prompt: string) {
+  log.debug(`loadConfigFromPrompt: "${prompt}"`)
+  if (!process.env.GEMINI_API_KEY) {
+    throw new Error('GEMINI_API_KEY environment variable is not set. Please set it to use the Google GenAI API.')
+  }
+  const ai = new GoogleGenAI({ apiKey: process.env.GEMINI_API_KEY })
+  const response = await ai.models.generateContent({
+    model: 'gemini-2.5-flash',
+    contents: prompt,
+    config: {
+      tools: [
+        {
+          functionDeclarations: [getFunctionDeclaration()],
+        },
+      ],
+      thinkingConfig: {
+        thinkingBudget: 0,
+      },
+    },
+  })
+  if (response.functionCalls && response.functionCalls.length > 0) {
+    const functionCall = response.functionCalls[0]
+    log.debug('Using function call:', functionCall.name, functionCall.args)
+    return functionCall.args
+  } else {
+    throw new Error('No function call found in the response. Please check the prompt and try again.')
+  }
+}

package/src/session.ts

@@ -1,7 +1,6 @@
 import { getSessionThrottleValues, throttleLauncher } from '@vpalmisano/throttler'
 import assert from 'assert'
 import axios from 'axios'
-import chalk from 'chalk'
 import EventEmitter from 'events'
 import fs from 'fs'
 import JSON5 from 'json5'
@@ -50,6 +49,9 @@ import {
 } from './utils'
 import { MediaPath } from './media'
 
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const { default: chalk } = require('chalk-template')
+
 // eslint-disable-next-line @typescript-eslint/no-require-imports
 const NavigatorHardwareConcurrency = require('puppeteer-extra-plugin-stealth/evasions/navigator.hardwareConcurrency')
 

package/src/stats.ts

@@ -1,5 +1,4 @@
 import axios from 'axios'
-import chalk from 'chalk'
 import * as events from 'events'
 import { Stats as FastStats } from 'fast-stats'
 import * as fs from 'fs'
@@ -20,6 +19,9 @@ export { FastStats }
 
 const log = logger('webrtcperf:stats')
 
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const { default: chalk } = require('chalk-template')
+
 function calculateFailAmountPercentile(stat: FastStats, percentile = 95): number {
   return Math.round(stat.percentile(percentile))
 }
@@ -144,7 +146,7 @@ function formatStats(s: FastStats, forWriter = false): StatsData | string[] {
 function sprintfStatsTitle(name: string): string {
   return sprintf(chalk`-- {bold %(name)s} %(fill)s\n`, {
     name,
-    fill: '-'.repeat(100 - name.length - 4),
+    fill: '-'.repeat(110 - name.length - 4),
   })
 }