test: add scenario name to e2e performance metrics (#1872)

Author: ljagiela

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

@@ -11,13 +11,14 @@ import { Logger } from '../support/logger';
 const monitor = PidMonitor.getInstance();
 
 // eslint-disable-next-line no-unused-vars
-Before(async () => {
+Before(async (scenario) => {
   if (String(process.env.SERVICE_WORKER_LOGS) === 'true') {
     await consoleManager.startLogsCollection();
   }
   if (browser.isChromium) {
     const pidMonitorInitialized = await monitor.init();
     if (pidMonitorInitialized) {
+      monitor.setScenarioName(scenario.pickle.name);
       monitor.start();
     } else {
       Logger.warn('PID monitor not initialized. Skipping start.');

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

@@ -14,13 +14,19 @@ interface UsageData {
   memory: number;
 }
 
+interface OutputData {
+  scenarioName: string | undefined;
+  data: UsageData[];
+}
+
 class PidMonitor {
   private static _instance: PidMonitor;
 
   private pid?: number;
   private readonly intervalMs: number;
   private _data: UsageData[] = [];
   private timer?: ReturnType<typeof setInterval>;
+  private scenarioName: string | undefined = undefined;
 
   private constructor(intervalMs = 1000) {
     this.intervalMs = intervalMs;
@@ -33,6 +39,10 @@ class PidMonitor {
     return PidMonitor._instance;
   }
 
+  public setScenarioName(name: string): void {
+    this.scenarioName = name;
+  }
+
   public get data(): UsageData[] {
     return this._data;
   }
@@ -91,6 +101,7 @@ class PidMonitor {
 
   public clear(): void {
     this._data = [];
+    this.scenarioName = undefined;
   }
 
   public saveToFile(filePath: string): void {
@@ -99,7 +110,13 @@ class PidMonitor {
       if (!fs.existsSync(dir)) {
         fs.mkdirSync(dir, { recursive: true });
       }
-      fs.writeFileSync(filePath, JSON.stringify(this._data, undefined, 2), 'utf-8');
+
+      const output: OutputData = {
+        scenarioName: this.scenarioName,
+        data: this._data
+      };
+
+      fs.writeFileSync(filePath, JSON.stringify(output, undefined, 2), 'utf-8');
     } catch (error) {
       Logger.error(`Failed to save data to file: ${error}`);
     }