test: add cpu & memory monitoring for e2e tests (#1862)

* test: add cpu & memory monitoring for e2e tests

* test: rework pidMonitor to singleton

* test: improve pid monitor start

* test: collect perf data only for chromium based browsers

Author: ljagiela

.github/actions/test/e2e/action.yml

@@ -92,4 +92,5 @@ runs:
           ./packages/e2e-tests/logs
           ./packages/e2e-tests/reports/allure/results
           ./packages/e2e-tests/dmesg.log
+          ./packages/e2e-tests/metrics
         retention-days: 5

.github/workflows/e2e-tests-linux-split.yml

@@ -254,3 +254,9 @@ jobs:
         with:
           name: allure-results
           path: ./artifacts/reports/allure/results
+
+      - name: Upload performance metrics
+        uses: actions/upload-artifact@v4
+        with:
+          name: performance-metrics
+          path: ./artifacts/metrics

packages/e2e-tests/.gitignore

@@ -3,3 +3,4 @@ reports/
 screenshots/
 wallet-extension-safari-build/
 src/support/walletConfiguration.ts
+metrics/

packages/e2e-tests/package.json

@@ -34,6 +34,7 @@
     "@rpii/wdio-report-events": "8.0.2",
     "@types/flat": "5.0.5",
     "@types/node": "20.14.2",
+    "@types/pidusage": "2.0.5",
     "@types/puppeteer": "7.0.4",
     "@typescript-eslint/eslint-plugin": "6.0.0",
     "@typescript-eslint/parser": "6.0.0",
@@ -53,6 +54,7 @@
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-wdio": "8.37.0",
     "flat": "6.0.1",
+    "pidusage": "4.0.1",
     "testcontainers": "10.24.2",
     "ts-node": "10.9.1",
     "typescript": "^4.9.5",

packages/e2e-tests/src/hooks/scenarioTagRunner.ts

@@ -5,15 +5,32 @@ import consoleManager from '../utils/consoleManager';
 
 import allure from '@wdio/allure-reporter';
 import testContext from '../utils/testContext';
+import PidMonitor from '../support/PidMonitor';
+import { Logger } from '../support/logger';
+
+const monitor = PidMonitor.getInstance();
 
 // eslint-disable-next-line no-unused-vars
 Before(async () => {
   if (String(process.env.SERVICE_WORKER_LOGS) === 'true') {
     await consoleManager.startLogsCollection();
   }
+  if (browser.isChromium) {
+    const pidMonitorInitialized = await monitor.init();
+    if (pidMonitorInitialized) {
+      monitor.start();
+    } else {
+      Logger.warn('PID monitor not initialized. Skipping start.');
+    }
+  }
 });
 
-After({ tags: 'not @Pending and not @pending' }, async () => {
+After({ tags: 'not @Pending and not @pending' }, async (scenario) => {
+  if (browser.isChromium) {
+    monitor.stop();
+    monitor.saveToFile(`./metrics/${scenario.testCaseStartedId}-chrome-usage.json`);
+    monitor.clear();
+  }
   testContext.clearContext();
   await browser.reloadSession();
 });

packages/e2e-tests/src/support/PidMonitor.ts

@@ -0,0 +1,109 @@
+import pidusage from 'pidusage';
+import fs from 'fs';
+import path from 'path';
+import { exec } from 'node:child_process';
+import { promisify } from 'util';
+import { clearInterval } from 'node:timers';
+import { Logger } from './logger';
+
+const execAsync = promisify(exec);
+
+interface UsageData {
+  timestamp: string;
+  cpu: number;
+  memory: number;
+}
+
+class PidMonitor {
+  private static _instance: PidMonitor;
+
+  private pid?: number;
+  private readonly intervalMs: number;
+  private _data: UsageData[] = [];
+  private timer?: ReturnType<typeof setInterval>;
+
+  private constructor(intervalMs = 1000) {
+    this.intervalMs = intervalMs;
+  }
+
+  public static getInstance(intervalMs = 1000): PidMonitor {
+    if (!PidMonitor._instance) {
+      PidMonitor._instance = new PidMonitor(intervalMs);
+    }
+    return PidMonitor._instance;
+  }
+
+  public get data(): UsageData[] {
+    return this._data;
+  }
+
+  public async init(): Promise<boolean> {
+    try {
+      const { stdout } = await execAsync(
+        "ps aux | grep '[c]hrome.*--extension-process.*--enable-automation.*--test-type=webdriver' | awk '{print $2}'"
+      );
+      const pid = Number(stdout.trim());
+
+      if (Number.isNaN(pid)) {
+        Logger.error(`Parsed PID is NaN from stdout: "${stdout}"`);
+        return false;
+      }
+
+      this.pid = pid;
+      return true;
+    } catch (error) {
+      Logger.error(`Error finding PID: ${error}`);
+      return false;
+    }
+  }
+
+  public start(): void {
+    if (this.pid === undefined) {
+      Logger.warn('PID is not set. Call init() first.');
+      return;
+    }
+
+    if (this.timer) return;
+
+    this.timer = setInterval(async () => {
+      if (this.pid === undefined) return;
+
+      try {
+        const stats = await pidusage(this.pid);
+        this._data.push({
+          timestamp: new Date().toISOString(),
+          cpu: stats.cpu,
+          memory: stats.memory
+        });
+      } catch (error) {
+        Logger.error(`pidusage failed: ${error}`);
+        this.stop();
+      }
+    }, this.intervalMs);
+  }
+
+  public stop(): void {
+    if (this.timer) {
+      clearInterval(this.timer);
+      this.timer = undefined;
+    }
+  }
+
+  public clear(): void {
+    this._data = [];
+  }
+
+  public saveToFile(filePath: string): void {
+    try {
+      const dir = path.dirname(filePath);
+      if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir, { recursive: true });
+      }
+      fs.writeFileSync(filePath, JSON.stringify(this._data, undefined, 2), 'utf-8');
+    } catch (error) {
+      Logger.error(`Failed to save data to file: ${error}`);
+    }
+  }
+}
+
+export default PidMonitor;

yarn.lock

@@ -12673,6 +12673,7 @@ __metadata:
     "@types/chai-string": 1.4.5
     "@types/flat": 5.0.5
     "@types/node": 20.14.2
+    "@types/pidusage": 2.0.5
     "@types/puppeteer": 7.0.4
     "@typescript-eslint/eslint-plugin": 6.0.0
     "@typescript-eslint/parser": 6.0.0
@@ -12695,6 +12696,7 @@ __metadata:
     eslint-plugin-import: 2.27.5
     eslint-plugin-wdio: 8.37.0
     flat: 6.0.1
+    pidusage: 4.0.1
     testcontainers: 10.24.2
     ts-node: 10.9.1
     typescript: ^4.9.5
@@ -23063,6 +23065,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/pidusage@npm:2.0.5":
+  version: 2.0.5
+  resolution: "@types/pidusage@npm:2.0.5"
+  checksum: 24188bf108b9b5a2ccb16155a492ff1cca7d7bf07aa4e2649cce421e0940dd5b0cd06baa48da9b8bde46343463fc500a7070c0788a0ed3f3f57d3e3bcf4ac64d
+  languageName: node
+  linkType: hard
+
 "@types/pify@npm:5.0.1":
   version: 5.0.1
   resolution: "@types/pify@npm:5.0.1"
@@ -47956,6 +47965,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"pidusage@npm:4.0.1":
+  version: 4.0.1
+  resolution: "pidusage@npm:4.0.1"
+  dependencies:
+    safe-buffer: ^5.2.1
+  checksum: 89ce11679b9871f8da6f21160c734f195fb6230e4a1017235133ac5294b9b0ec94d6c55a66fba43474bac524a7845ea309f43f37ce0e5c8f4e23512fa14ef2b6
+  languageName: node
+  linkType: hard
+
 "pify@npm:5.0.0, pify@npm:^5.0.0":
   version: 5.0.0
   resolution: "pify@npm:5.0.0"