Merge branch 'separateLog'

Author: bznein

.github/workflows/playwright.yml

@@ -94,9 +94,9 @@ jobs:
           SIMULATOR_PATH: ${{ github.workspace }}/simulator-bin/simulator
         run: make webe2etest
 
-      - name: Upload Playwright artifacts
-        if: failure()
+      - name: Upload Playwright artifacts and logs.
+        if: always()
         uses: actions/upload-artifact@v4
         with:
-          name: playwright-artifacts
+          name: playwright-artifacts-and-logs
           path: frontends/web/test-results/*

frontends/web/tests/base.test.ts

@@ -20,10 +20,10 @@ import { expect } from '@playwright/test';
 
 let servewallet: ServeWallet;
 
-test('App main page loads', async ({ page, host, frontendPort, servewalletPort }) => {
+test('App main page loads', async ({ page, host, frontendPort, servewalletPort }, testInfo) => {
 
   await test.step('Start servewallet', async () => {
-    servewallet = new ServeWallet(page, servewalletPort, frontendPort, host);
+    servewallet = new ServeWallet(page, servewalletPort, frontendPort, host, testInfo.title, testInfo.project.name);
     await servewallet.start();
   });
 

frontends/web/tests/gapSettings.test.ts

@@ -24,10 +24,10 @@ import { deleteAccountsFile } from './helpers/fs';
 
 let servewallet: ServeWallet;
 
-test('Gap limits are correctly saved', async ({ page, host, frontendPort, servewalletPort }) => {
+test('Gap limits are correctly saved', async ({ page, host, frontendPort, servewalletPort }, testInfo) => {
 
   await test.step('Start servewallet', async () => {
-    servewallet = new ServeWallet(page, servewalletPort, frontendPort, host);
+    servewallet = new ServeWallet(page, servewalletPort, frontendPort, host, testInfo.title, testInfo.project.name);
     await servewallet.start();
   });
 

frontends/web/tests/helpers/fs.ts

@@ -34,4 +34,28 @@ function deleteFile(filePath: string) {
   } else {
     console.warn(`File ${filePath} does not exist, skipping removal.`);
   }
+
+}
+
+function sanitizeFileName(name: string): string {
+  return name.replace(/\s+/g, '_').replace(/[^a-zA-Z0-9_-]/g, '');
+}
+
+
+/**
+ * Returns a full path for a log file in test-results/<test>-<project>/
+ * Automatically creates the folder if it doesn't exist.
+ *
+ * @param testName - Current test name
+ * @param projectName - Playwright project name
+ * @param logFileName - The log filename (e.g., 'backend.log' or 'simulator.log')
+ */
+export function getLogFilePath(testName: string, projectName: string, logFileName: string): string {
+  const safeTest = sanitizeFileName(testName);
+  const safeProject = sanitizeFileName(projectName);
+
+  const folderPath = path.resolve(process.cwd(), 'test-results', `${safeTest}-${safeProject}`);
+  fs.mkdirSync(folderPath, { recursive: true });
+
+  return path.join(folderPath, logFileName);
 }

frontends/web/tests/helpers/servewallet.ts

@@ -16,7 +16,9 @@
 
 import { spawn, ChildProcess } from 'child_process';
 import * as net from 'net';
+import * as fs from 'fs';
 import type { Page } from '@playwright/test';
+import { getLogFilePath } from './fs';
 
 async function connectOnce(host: string, port: number): Promise<void> {
   return new Promise((resolve, reject) => {
@@ -36,19 +38,25 @@ export interface ServeWalletOptions {
 
 export class ServeWallet {
   private proc?: ChildProcess;
+  private outStream?: number;
   private readonly simulator: boolean;
   private readonly page: Page;
   private readonly servewalletPort: number;
   private readonly frontendPort: number;
   private readonly host: string;
   private readonly timeout: number;
   private readonly testnet: boolean;
+  private readonly testName: string;
+  private readonly projectName: string;
+  private readonly logPath: string;
 
   constructor(
     page: Page,
     servewalletPort: number,
     frontendPort: number,
     host: string,
+    testName: string,
+    projectName: string,
     options: ServeWalletOptions = {}
   ) {
     const { simulator = false, timeout = 90000, testnet = true } = options;
@@ -64,11 +72,24 @@ export class ServeWallet {
     this.simulator = simulator;
     this.timeout = timeout;
     this.testnet = testnet;
+    this.testName = testName;
+    this.projectName = projectName;
+
+    this.logPath = getLogFilePath(this.testName, this.projectName, 'servewallet.log');
+    this.openOutStream(false); // On the first time, open the file in "w" mode.
+  }
+
+  private openOutStream(append: boolean): void {
+    if (this.outStream) {
+      fs.closeSync(this.outStream);
+    }
+    this.outStream = fs.openSync(this.logPath, append ? 'a' : 'w');
   }
 
   async start(): Promise<void> {
-    let target: string;
+    this.openOutStream(true); // On starts/restarts, open the file in "a" mode.
 
+    let target: string;
     if (this.testnet && !this.simulator) {
       target = 'servewallet';
     } else if (this.testnet && this.simulator) {
@@ -81,7 +102,7 @@ export class ServeWallet {
     }
 
     this.proc = spawn('make', ['-C', '../../', target], {
-      stdio: 'inherit',
+      stdio: ['ignore', this.outStream, this.outStream],
       detached: true,
     });
 
@@ -100,7 +121,7 @@ export class ServeWallet {
           );
           return;
         } catch {
-          // page.goto failed, likely connection refused; retry
+          // page.goto failed; likely connection refused; retry
         }
       } catch {
         // port not ready yet
@@ -124,6 +145,19 @@ export class ServeWallet {
       // Listen for exit event
       this.proc.once('exit', () => {
         console.log('Servewallet stopped');
+        this.proc = undefined;
+
+        if (this.outStream) {
+          try {
+            fs.closeSync(this.outStream);
+            console.log('Servewallet log file closed');
+          } catch (err) {
+            console.warn('Failed to close servewallet log file:', err);
+          } finally {
+            this.outStream = undefined;
+          }
+        }
+
         resolve();
       });
 

frontends/web/tests/helpers/simulator.ts

@@ -15,9 +15,10 @@
 */
 
 
-import { spawn, ChildProcessWithoutNullStreams } from 'child_process';
+import { spawn, ChildProcess } from 'child_process';
 import type { Page } from '@playwright/test';
 import { clickButtonWithText, typeIntoFocusedInput, clickAllAgreements } from './dom';
+import { getLogFilePath } from './fs';
 import * as fs from 'fs';
 import * as path from 'path';
 
@@ -55,30 +56,34 @@ export function cleanFakeMemoryFiles() {
  */
 export function startSimulator(
   simulatorPath: string,
+  testName: string,
+  projectName: string,
   useFakeMemory = false
-): ChildProcessWithoutNullStreams {
+): ChildProcess {
   const env = { ...process.env };
   if (useFakeMemory) {
     env.FAKE_MEMORY_FILEPATH = '/tmp/fake_memory';
   }
 
-  const proc = spawn(simulatorPath, { stdio: 'pipe', env });
 
-  // Pipe output to logs (needed in CI)
-  proc.stdout?.on('data', (chunk) => process.stdout.write(chunk));
-  proc.stderr?.on('data', (chunk) => process.stderr.write(chunk));
+  const logPath = getLogFilePath(testName, projectName, 'simulator.log');
+  const outStream = fs.openSync(logPath, 'w');
+
+  const proc = spawn(simulatorPath, { stdio: ['ignore', outStream, outStream], env });
 
   proc.on('error', (err) => {
     console.error('Simulator process error:', String(err));
   });
 
   proc.on('exit', (code, signal) => {
     console.log(`Simulator exited: code=${String(code)}, signal=${String(signal)}`);
+    fs.closeSync(outStream); // close log file when simulator exits
   });
 
   return proc;
 }
 
+
 /**
  * Performs the wallet setup flow in order:
  * 1. Click "Continue"

frontends/web/tests/testnetRestart.test.ts

@@ -35,10 +35,10 @@ let servewallet: ServeWallet;
  * - Kill servewallet
  * - Restart servewallet in mainnet mode - testnet mode should be disabled now.
  */
-test('Testnet mode', async ({ page, host, frontendPort, servewalletPort }) => {
+test('Testnet mode', async ({ page, host, frontendPort, servewalletPort }, testInfo) => {
 
   await test.step('Start servewallet', async () => {
-    servewallet = new ServeWallet(page, servewalletPort, frontendPort, host, { testnet: false });
+    servewallet = new ServeWallet(page, servewalletPort, frontendPort, host, testInfo.title, testInfo.project.name, { testnet: false });
     await servewallet.start();
   });
 

frontends/web/tests/watch-only.test.ts

@@ -20,10 +20,10 @@ import { test } from './helpers/fixtures';
 import { ServeWallet } from './helpers/servewallet';
 import { startSimulator, completeWalletSetupFlow, cleanFakeMemoryFiles } from './helpers/simulator';
 import { assertFieldsCount, clickButtonWithText } from './helpers/dom';
-import { ChildProcessWithoutNullStreams } from 'child_process';
+import { ChildProcess } from 'child_process';
 
 let servewallet: ServeWallet;
-let simulatorProc : ChildProcessWithoutNullStreams | undefined;
+let simulatorProc : ChildProcess | undefined;
 
 /**
  * Test scenario 1:
@@ -34,9 +34,9 @@ let simulatorProc : ChildProcessWithoutNullStreams | undefined;
  * - Restart app (kill and restart servewallet)
  * - Check that accounts do not show up without simulator running.
  */
-test('Test #1 - No passphrase and no watch-only', async ({ page, host, frontendPort, servewalletPort }) => {
+test('Test #1 - No passphrase and no watch-only', async ({ page, host, frontendPort, servewalletPort }, testInfo) => {
   await test.step('Start servewallet', async () => {
-    servewallet = new ServeWallet(page, servewalletPort, frontendPort, host, { simulator: true });
+    servewallet = new ServeWallet(page, servewalletPort, frontendPort, host, testInfo.title, testInfo.project.name, { simulator: true });
     await servewallet.start();
   });
 
@@ -46,7 +46,7 @@ test('Test #1 - No passphrase and no watch-only', async ({ page, host, frontendP
       throw new Error('SIMULATOR_PATH environment variable not set');
     }
 
-    simulatorProc = startSimulator(simulatorPath, true);
+    simulatorProc = startSimulator(simulatorPath, testInfo.title, testInfo.project.name, true);
     console.log('Simulator started');
   });
 
@@ -88,9 +88,9 @@ test('Test #1 - No passphrase and no watch-only', async ({ page, host, frontendP
  * - Restart app (kill and restart servewallet)
  * - Check that watch-only accounts still show up (with no simulator running)
  */
-test('Test #2 - No passphrase - Watch-only account', async ({ page, host, frontendPort, servewalletPort }) => {
+test('Test #2 - No passphrase - Watch-only account', async ({ page, host, frontendPort, servewalletPort }, testInfo) => {
   await test.step('Start servewallet', async () => {
-    servewallet = new ServeWallet(page, servewalletPort, frontendPort, host, { simulator: true });
+    servewallet = new ServeWallet(page, servewalletPort, frontendPort, host, testInfo.title, testInfo.project.name, { simulator: true });
     await servewallet.start();
   });
 
@@ -101,7 +101,7 @@ test('Test #2 - No passphrase - Watch-only account', async ({ page, host, fronte
       throw new Error('SIMULATOR_PATH environment variable not set');
     }
 
-    simulatorProc = startSimulator(simulatorPath, true);
+    simulatorProc = startSimulator(simulatorPath, testInfo.title, testInfo.project.name, true);
 
     console.log('Simulator started');
   });