lexxit-automation-framework 2.0.20 → 3.0.0

package/src/actions/browserManager.ts

@@ -0,0 +1,432 @@
+import { Browser, BrowserContext, Page, chromium, firefox } from 'playwright';
+import { StepResult } from '../types/types';
+import * as path from 'path';
+import * as fs from 'fs';
+
+const VIDEO_DIR = path.resolve(__dirname, '../../videos');
+
+export class BrowserManager {
+  private browser: Browser | null = null;
+  private context: BrowserContext | null = null;
+  private page: Page | null = null;
+  private videoEnabled: boolean = false;
+
+  // ─── Helpers ───────────────────────────────────────────────────────────────
+
+  private getStartTime(): string {
+    return new Date().toISOString();
+  }
+
+  private getDuration(startMs: number): number {
+    return Date.now() - startMs;
+  }
+
+  private buildResult(
+    status: 'PASS' | 'FAIL',
+    expected_result: string,
+    comments: string,
+    startMs: number,
+    startTime: string,
+    step_name: string = '',
+    step_script: string = '',
+    uid: string | null = null,
+    obj_uid: string | null = null,
+    page_uid: string | null = null
+  ): StepResult {
+    return {
+      uid,
+      obj_uid,
+      page_uid,
+      step_name,
+      step_script,
+      status,
+      expected_result,
+      comments,
+      duration:   this.getDuration(startMs),
+      start_time: startTime
+    };
+  }
+  async captureScreenshot(screenshotMode: 'on_failure' | 'always' | 'never', isFailure: boolean): Promise<string> {
+  if (screenshotMode === 'never') return '';
+  if (screenshotMode === 'on_failure' && !isFailure) return '';
+  try {
+    if (!this.page || this.page.isClosed()) return '';
+    const buf = await this.page.screenshot({ type: 'png', fullPage: false });
+    return buf.toString('base64');
+  } catch {
+    return '';
+  }
+}
+  private ensureVideoDir(): void {
+    if (!fs.existsSync(VIDEO_DIR)) {
+      fs.mkdirSync(VIDEO_DIR, { recursive: true });
+    }
+  }
+
+  private classifyError(error: any): string {
+    const msg: string = error?.message || String(error);
+
+    if (msg.includes('net::ERR_NAME_NOT_RESOLVED') || msg.includes('net::ERR_CONNECTION_REFUSED')) {
+      return `Network error - URL unreachable: ${msg}`;
+    }
+    if (msg.includes('net::ERR_INTERNET_DISCONNECTED')) {
+      return `No internet connection: ${msg}`;
+    }
+    if (msg.includes('Timeout') || msg.includes('timeout')) {
+      return `Timeout error - page took too long to respond: ${msg}`;
+    }
+    if (msg.includes('Target closed') || msg.includes('Target page, context or browser has been closed')) {
+      return `Browser or page was closed unexpectedly: ${msg}`;
+    }
+    if (msg.includes('net::ERR_CERT') || msg.includes('SSL')) {
+      return `SSL/Certificate error: ${msg}`;
+    }
+    if (msg.includes('executable doesn\'t exist') || msg.includes('Failed to launch')) {
+      return `Browser launch failed - browser executable not found: ${msg}`;
+    }
+    if (msg.includes('msedge') || msg.includes('edge')) {
+      return `Edge browser error - ensure Microsoft Edge is installed: ${msg}`;
+    }
+    if (msg.includes('Permission denied') || msg.includes('EACCES')) {
+      return `Permission denied - check folder/file permissions: ${msg}`;
+    }
+    if (msg.includes('ENOENT')) {
+      return `File or directory not found: ${msg}`;
+    }
+    if (msg.includes('Navigation failed')) {
+      return `Navigation failed - page may have crashed or redirected incorrectly: ${msg}`;
+    }
+    if (msg.includes('Page is not initialized') || msg.includes('Browser is not open')) {
+      return `Browser not initialized - call openBrowser first: ${msg}`;
+    }
+
+    return `Unexpected error: ${msg}`;
+  }
+
+  getPage(): Page {
+    if (!this.page) throw new Error('Page is not initialized. Call openBrowser first.');
+    return this.page;
+  }
+
+  // ─── openBrowser ───────────────────────────────────────────────────────────
+
+  // async openBrowser(
+  //   browserType: 'chromium' | 'firefox' | 'edge',
+  //   headless: boolean = false,
+  //   videoEnabled: boolean = false
+  // ): Promise<StepResult> {
+  //   const startMs = Date.now();
+  //   const startTime = this.getStartTime();
+  //   const expected = `${browserType} browser opened successfully`;
+  //   this.videoEnabled = videoEnabled;
+
+  //   try {
+  //     if (browserType === 'firefox') {
+  //       this.browser = await firefox.launch({ headless });
+  //     } else if (browserType === 'edge') {
+  //       this.browser = await chromium.launch({ channel: 'msedge', headless });
+  //     } else {
+  //       this.browser = await chromium.launch({ headless });
+  //     }
+
+  //     const contextOptions: any = {};
+
+  //     if (this.videoEnabled) {
+  //       this.ensureVideoDir();
+  //       contextOptions.recordVideo = {
+  //         dir: VIDEO_DIR,
+  //         size: { width: 1280, height: 720 }
+  //       };
+  //     }
+
+  //     this.context = await this.browser.newContext(contextOptions);
+  //     this.page = await this.context.newPage();
+
+  //     return this.buildResult('PASS', expected, expected, startMs, startTime, `Open ${browserType}`);
+  //   } catch (error: any) {
+  //     return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, `Open ${browserType}`);
+  //   }
+  // }
+async openBrowser(
+    browserType: 'chromium' | 'chrome' | 'firefox' | 'edge',
+    headless: boolean = false,
+    videoEnabled: boolean = false
+  ): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `${browserType} browser opened successfully`;
+    this.videoEnabled = videoEnabled;
+
+    try {
+      if (browserType === 'firefox') {
+        this.browser = await firefox.launch({ headless });
+      } else if (browserType === 'edge') {
+        this.browser = await chromium.launch({ channel: 'msedge', headless });
+      } else if (browserType === 'chrome') {
+        this.browser = await chromium.launch({ channel: 'chrome', headless });
+      } else {
+        this.browser = await chromium.launch({ headless });
+      }
+
+      const contextOptions: any = {};
+
+      if (this.videoEnabled) {
+        this.ensureVideoDir();
+        contextOptions.recordVideo = {
+          dir: VIDEO_DIR,
+          size: { width: 1280, height: 720 }
+        };
+      }
+
+      this.context = await this.browser.newContext(contextOptions);
+      this.page = await this.context.newPage();
+
+      return this.buildResult('PASS', expected, expected, startMs, startTime, `Open ${browserType}`);
+    } catch (error: any) {
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, `Open ${browserType}`);
+    }
+  }
+  // ─── closeBrowser ──────────────────────────────────────────────────────────
+
+  async closeBrowser(testScriptUid: string = ''): Promise<StepResult> {
+  const startMs = Date.now();
+  const startTime = this.getStartTime();
+  const expected = 'Browser closed successfully';
+
+  try {
+    if (this.videoEnabled && this.page) {
+      const video = this.page.video();
+
+      if (video) {
+        const destPath = path.join(VIDEO_DIR, `${testScriptUid || 'recording'}_${Date.now()}.webm`);
+  await this.context?.close();
+  await video.saveAs(destPath);
+  await video.delete();
+  this.savedVideoPath = destPath;
+      } else {
+        await this.context?.close();
+      }
+    } else {
+      await this.context?.close();
+    }
+
+    await this.browser?.close();
+    this.browser = null;
+    this.context = null;
+    this.page = null;
+
+    return this.buildResult('PASS', expected, expected, startMs, startTime, 'Close browser');
+  } catch (error: any) {
+    return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, 'Close browser');
+  }
+  
+}
+
+
+  // ─── navigateToURL ─────────────────────────────────────────────────────────
+
+  async navigateToURL(url: string): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `${url} opened successfully`;
+
+    try {
+      if (!this.page) throw new Error('Browser is not open');
+      await this.page.goto(url, { waitUntil: 'load', timeout: 30000 });
+
+      return this.buildResult('PASS', expected, expected, startMs, startTime, 'Navigate to URL');
+    } catch (error: any) {
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, 'Navigate to URL');
+    }
+  }
+
+  // ─── getTitle ──────────────────────────────────────────────────────────────
+
+  async getTitle(): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = 'Page title retrieved successfully';
+
+    try {
+      if (!this.page) throw new Error('Browser is not open');
+      const title = await this.page.title();
+
+      return this.buildResult('PASS', expected, `Page title is: ${title}`, startMs, startTime, 'Get title');
+    } catch (error: any) {
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, 'Get title');
+    }
+  }
+
+  // ─── waitUntilLoaded ───────────────────────────────────────────────────────
+
+  async waitUntilLoaded(): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = 'Page loaded successfully';
+
+    try {
+      if (!this.page) throw new Error('Browser is not open');
+      await this.page.waitForLoadState('load', { timeout: 30000 });
+
+      return this.buildResult('PASS', expected, expected, startMs, startTime, 'Wait until loaded');
+    } catch (error: any) {
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, 'Wait until loaded');
+    }
+  }
+
+  // ─── waitForNetworkIdle ────────────────────────────────────────────────────
+
+  async waitForNetworkIdle(): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = 'Network is idle';
+
+    try {
+      if (!this.page) throw new Error('Browser is not open');
+      await this.page.waitForLoadState('networkidle', { timeout: 30000 });
+
+      return this.buildResult('PASS', expected, expected, startMs, startTime, 'Wait for network idle');
+    } catch (error: any) {
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, 'Wait for network idle');
+    }
+  }
+
+  // ─── reloadPage ────────────────────────────────────────────────────────────
+
+  async reloadPage(): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = 'Page reloaded successfully';
+
+    try {
+      if (!this.page) throw new Error('Browser is not open');
+      await this.page.reload({ waitUntil: 'load', timeout: 30000 });
+
+      return this.buildResult('PASS', expected, expected, startMs, startTime, 'Reload page');
+    } catch (error: any) {
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, 'Reload page');
+    }
+  }
+
+  // ─── goBack ────────────────────────────────────────────────────────────────
+
+  async goBack(): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = 'Navigated back successfully';
+
+    try {
+      if (!this.page) throw new Error('Browser is not open');
+      await this.page.goBack({ waitUntil: 'load', timeout: 30000 });
+
+      return this.buildResult('PASS', expected, expected, startMs, startTime, 'Go back');
+    } catch (error: any) {
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, 'Go back');
+    }
+  }
+
+  // ─── goForward ─────────────────────────────────────────────────────────────
+
+  async goForward(): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = 'Navigated forward successfully';
+
+    try {
+      if (!this.page) throw new Error('Browser is not open');
+      await this.page.goForward({ waitUntil: 'load', timeout: 30000 });
+
+      return this.buildResult('PASS', expected, expected, startMs, startTime, 'Go forward');
+    } catch (error: any) {
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, 'Go forward');
+    }
+  }
+
+  // ─── getCurrentURL ─────────────────────────────────────────────────────────
+
+  async getCurrentURL(): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = 'Current URL retrieved successfully';
+
+    try {
+      if (!this.page) throw new Error('Browser is not open');
+      const url = this.page.url();
+
+      return this.buildResult('PASS', expected, `Current URL is: ${url}`, startMs, startTime, 'Get current URL');
+    } catch (error: any) {
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, 'Get current URL');
+    }
+  }
+
+  // ─── maximizeWindow ────────────────────────────────────────────────────────
+
+  async maximizeWindow(): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = 'Browser window maximized successfully';
+
+    try {
+      if (!this.page) throw new Error('Browser is not open');
+      await this.page.setViewportSize({ width: 1920, height: 1080 });
+
+      return this.buildResult('PASS', expected, expected, startMs, startTime, 'Maximize window');
+    } catch (error: any) {
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, 'Maximize window');
+    }
+  }
+
+  // ─── takeScreenshot ────────────────────────────────────────────────────────
+
+  async takeScreenshot(screenshotPath: string): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `Screenshot saved at ${screenshotPath}`;
+
+    try {
+      if (!this.page) throw new Error('Browser is not open');
+      const dir = path.dirname(screenshotPath);
+      if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
+      await this.page.screenshot({ path: screenshotPath, fullPage: true });
+
+      return this.buildResult('PASS', expected, expected, startMs, startTime, 'Take screenshot');
+    } catch (error: any) {
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, 'Take screenshot');
+    }
+  }
+
+  // ─── getPageSource ────────────────────────────────────────────────────────
+
+  /**
+   * Get the HTML page source (for auto-healing comparison)
+   */
+  async getPageSourceContent(): Promise<string | null> {
+    try {
+      if (!this.page) throw new Error('Browser is not open');
+      return await this.page.content();
+    } catch (error: any) {
+      console.error(`Failed to get page source: ${error.message}`);
+      return null;
+    }
+  }
+  private savedVideoPath: string | null = null;
+
+getSavedVideoPath(): string | null {
+  return this.savedVideoPath;
+}
+
+  // ─── getCurrentURLString ────────────────────────────────────────────────────
+
+  /**
+   * Get the current URL as a string (for auto-healing context)
+   */
+  async getCurrentURLString(): Promise<string> {
+    try {
+      if (!this.page) throw new Error('Browser is not open');
+      return this.page.url();
+    } catch (error: any) {
+      console.error(`Failed to get current URL: ${error.message}`);
+      return 'unknown';
+    }
+  }
+}