Merge branch '201-console-log-statements-vervangen-door-echo-in-de-codebase' into 'main'

Resolve "console.log statements vervangen door echo in de codebase"

See merge request elgentos/magento2-playwright!17

Author: Shay

tests/setup.spec.ts

@@ -5,10 +5,13 @@ import fs from 'fs';
 import path from 'path';
 import { inputValues } from '@config';
 import { requireEnv } from '@utils/env.utils';
+import { createLogger } from '@utils/logger';
 
 import MagentoAdminPage from '@poms/adminhtml/magentoAdmin.page';
 import RegisterPage from '@poms/frontend/register.page';
 
+const logger = createLogger('Setup');
+
 const magentoAdminUsername = requireEnv('MAGENTO_ADMIN_USERNAME');
 const magentoAdminPassword = requireEnv('MAGENTO_ADMIN_PASSWORD');
 
@@ -66,28 +69,27 @@ base.describe('Setting up the testing environment', () => {
       );
     });
 
-    await base.step(`Step 2: (optional) Update env file`, async () => {
-      console.log(process.env.CI);
-      if (process.env.CI === 'true') {
-        console.log("Running in CI environment. Skipping .env update.");
-        base.skip();
-      }
-
-      const envPath = path.resolve(__dirname, '../.env');
-      try {
-        if (fs.existsSync(envPath)) {
-          const envContent = fs.readFileSync(envPath, 'utf-8');
-          if (!envContent.includes(`SETUP_COMPLETE_${browserEngine}='DONE'`)) {
-            fs.appendFileSync(envPath, `\nSETUP_COMPLETE_${browserEngine}='DONE'`);
-            console.log(`Environment setup completed. Added SETUP_COMPLETE_${browserEngine}='DONE' to .env`);
+      await base.step(`Step 2: (optional) Update env file`, async () => {
+        if (process.env.CI === 'true') {
+          logger.info("Running in CI environment. Skipping .env update.");
+          base.skip();
+        }
+
+        const envPath = path.resolve(__dirname, '../.env');
+        try {
+          if (fs.existsSync(envPath)) {
+            const envContent = fs.readFileSync(envPath, 'utf-8');
+            if (!envContent.includes(`SETUP_COMPLETE_${browserEngine}='DONE'`)) {
+              fs.appendFileSync(envPath, `\nSETUP_COMPLETE_${browserEngine}='DONE'`);
+              logger.info(`Environment setup completed. Added SETUP_COMPLETE_${browserEngine}='DONE' to .env`);
+            }
+          } else {
+            throw new Error('.env file not found. Please ensure it exists in the root directory.');
           }
-        } else {
-          throw new Error('.env file not found. Please ensure it exists in the root directory.');
+        } catch (error) {
+          const err = error as Error;
+          throw new Error(`Failed to update .env file: ${err.message}`);
         }
-      } catch (error) {
-        const err = error as Error;
-        throw new Error(`Failed to update .env file: ${err.message}`);
-      }
     });
   });
 });

tests/utils/logger/Logger.ts

@@ -0,0 +1,67 @@
+// @ts-check
+
+export class Logger {
+    private readonly context: string;
+    private readonly isDebug: boolean;
+
+    constructor(context: string) {
+        this.context = context;
+        this.isDebug = process.env.DEBUG === 'true' || process.env.NODE_ENV === 'development';
+    }
+
+    private formatMessage(level: string, args: unknown[]): string {
+        const prefix = `[${this.context}] [${level.toUpperCase()}]`;
+        const message = args.map(arg => {
+            try {
+                return typeof arg === 'string' ? arg : JSON.stringify(arg);
+            } catch {
+                return '[Unserializable]';
+            }
+        }).join(' ');
+        return `${prefix} ${message}\n`;
+    }
+
+    private write(level: string, args: unknown[]): void {
+        if (!this.isDebug && level === 'log') {
+            return;
+        }
+        const msg = this.formatMessage(level, args);
+        if (typeof process !== 'undefined' && process.stdout?.write) {
+            if (level === 'error') {
+                process.stderr.write(msg);
+            } else {
+                process.stdout.write(msg);
+            }
+        } else {
+            // eslint-disable-next-line no-console
+            switch (level) {
+                case 'log':
+                case 'info':
+                    console.info(msg.trim());
+                    break;
+                case 'warn':
+                    console.warn(msg.trim());
+                    break;
+                case 'error':
+                    console.error(msg.trim());
+                    break;
+            }
+        }
+    }
+
+    public log(...args: unknown[]): void {
+        this.write('log', args);
+    }
+
+    public info(...args: unknown[]): void {
+        this.write('info', args);
+    }
+
+    public warn(...args: unknown[]): void {
+        this.write('warn', args);
+    }
+
+    public error(...args: unknown[]): void {
+        this.write('error', args);
+    }
+}

tests/utils/logger/factory.ts

@@ -0,0 +1,7 @@
+// @ts-check
+
+import { Logger } from './Logger';
+
+export function createLogger(context: string): Logger {
+    return new Logger(context);
+}

tests/utils/logger/index.ts

@@ -0,0 +1,4 @@
+// @ts-check
+
+export { Logger } from './Logger';
+export { createLogger } from './factory';