@vpalmisano/webrtcperf 4.1.10 → 4.2.0

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,7 +411,7 @@ 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,
     env: 'SHOW_PAGE_LOG',
@@ -657,13 +701,13 @@ service (example: "http://127.0.0.1:9091").`,
     env: 'ALERT_RULES',
     arg: 'alert-rules',
   },
-  alertRulesFilename: {
-    doc: `The alert rules report output filename.`,
+  alertRulesOutput: {
+    doc: `The alert rules report output filename. If the file ends with .log extension, a detailed log will be generated, otherwise a JSON report will be generated.`,
     format: String,
     nullable: true,
     default: '',
-    env: 'ALERT_RULES_FILENAME',
-    arg: 'alert-rules-filename',
+    env: 'ALERT_RULES_OUTPUT',
+    arg: 'alert-rules-output',
   },
   alertRulesFailPercentile: {
     doc: `The alert rules report fails percentile (0-100). With the default value the \
@@ -762,7 +806,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 +924,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 +945,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.info('Using function call:', functionCall.name, functionCall.args)
+    return loadConfig(undefined, functionCall.args)
+  } else {
+    throw new Error('No function call found in the response. Please check the prompt and try again.')
+  }
+}

package/src/server.ts

@@ -392,14 +392,14 @@ export class Server {
   /**
    * GET /download/alert-rules endpoint.
    *
-   * Downloads the alert rules report stored into the {@link Stats.alertRulesFilename}.
+   * Downloads the alert rules report stored into the {@link Stats.alertRulesOutput}.
    */
   private getAlertRules(req: express.Request, res: express.Response, next: express.NextFunction): void {
     log.debug(`GET /download/alert-rules`, req.query)
-    if (!this.stats.alertRulesFilename) {
-      return next(new Error('Stats alertRulesFilename not set'))
+    if (!this.stats.alertRulesOutput) {
+      return next(new Error('Stats alertRulesOutput not set'))
     }
-    res.download(this.stats.alertRulesFilename)
+    res.download(this.stats.alertRulesOutput)
   }
 
   /**

package/src/stats.ts

@@ -331,7 +331,7 @@ export class Stats extends events.EventEmitter {
   private scheduler?: Scheduler
 
   private alertRules: Record<string, AlertRule> | null = null
-  readonly alertRulesFilename: string
+  readonly alertRulesOutput: string
   private readonly alertRulesFailPercentile: number
   private readonly pushStatsUrl: string
   private readonly pushStatsId: string
@@ -414,7 +414,7 @@ export class Stats extends events.EventEmitter {
     rtcStatsTimeout,
     customMetrics,
     alertRules,
-    alertRulesFilename,
+    alertRulesOutput,
     alertRulesFailPercentile,
     pushStatsUrl,
     pushStatsId,
@@ -436,7 +436,7 @@ export class Stats extends events.EventEmitter {
     rtcStatsTimeout: number
     customMetrics: string
     alertRules: string
-    alertRulesFilename: string
+    alertRulesOutput: string
     alertRulesFailPercentile: number
     pushStatsUrl: string
     pushStatsId: string
@@ -487,7 +487,7 @@ export class Stats extends events.EventEmitter {
       this.alertRules = json5.parse(alertRules)
       log.debug(`using alertRules: ${JSON.stringify(this.alertRules, undefined, 2)}`)
     }
-    this.alertRulesFilename = alertRulesFilename
+    this.alertRulesOutput = alertRulesOutput
     this.alertRulesFailPercentile = alertRulesFailPercentile
     this.pushStatsUrl = pushStatsUrl
     this.pushStatsId = pushStatsId
@@ -1616,12 +1616,12 @@ export class Stats extends events.EventEmitter {
    * writeAlertRulesReport
    */
   async writeAlertRulesReport(): Promise<void> {
-    if (!this.alertRules || !this.alertRulesFilename || !this.running) {
+    if (!this.alertRules || !this.alertRulesOutput || !this.running) {
       return
     }
-    log.debug(`writeAlertRulesReport writing in ${this.alertRulesFilename}`)
+    log.debug(`writeAlertRulesReport writing in ${this.alertRulesOutput}`)
     try {
-      const ext = this.alertRulesFilename.split('.').slice(-1)[0]
+      const ext = this.alertRulesOutput.split('.').slice(-1)[0]
       const report = this.formatAlertRulesReport(ext)
       if (!report.length) {
         return
@@ -1641,10 +1641,10 @@ export class Stats extends events.EventEmitter {
       } else {
         out = report
       }
-      await fs.promises.mkdir(path.dirname(this.alertRulesFilename), {
+      await fs.promises.mkdir(path.dirname(this.alertRulesOutput), {
         recursive: true,
       })
-      await fs.promises.writeFile(this.alertRulesFilename, out)
+      await fs.promises.writeFile(this.alertRulesOutput, out)
     } catch (err) {
       log.error(`writeAlertRulesReport error: ${(err as Error).stack}`)
     }