pw-automation-framework 2.0.1

package/src/core/BrowserManager.ts

@@ -0,0 +1,398 @@
+import { chromium, firefox, webkit, Browser, BrowserContext, Page } from "playwright";
+import { ActionResponse, TestCaseConfig } from "../types/types";
+import { pass, fail } from "../utils/response";
+import { ScreenshotManager } from "./ScreenshotManager";
+import { Logger } from "../utils/logger";
+
+export class BrowserManager {
+  private browser?:  Browser;
+  private context?:  BrowserContext;
+  private page?:     Page;
+  private shots:     ScreenshotManager;
+  private log:       Logger;
+  private headless:  boolean;
+  private timeout:   number;
+  private slowMo:    number;
+  private recordVideo: boolean;
+  private videoDir:  string;
+
+  constructor(tConfig: TestCaseConfig) {
+    this.headless    = tConfig.headless     ?? false;
+    this.timeout     = tConfig.timeout      ?? 30000;
+    this.slowMo      = tConfig.slowMo       ?? 0;
+    this.recordVideo = tConfig.record_video ?? false;
+    this.videoDir    = `videos/${tConfig.executionId}`;
+    // this.videoDir = require("path").join(process.cwd(), "videos", tConfig.executionId);
+    this.shots       = new ScreenshotManager(tConfig.screenshot_mode);
+    this.log         = Logger.create("BrowserManager", tConfig.executionId);
+  }
+
+  // ─── Open ──────────────────────────────────────────────────────────────────
+
+  async openBrowser(type: string = "chromium"): Promise<ActionResponse> {
+    try {
+      const launcher = this.getLauncher(type);
+      this.browser   = await launcher.launch({
+        headless: this.headless,
+        slowMo:   this.slowMo,
+        args: ["--no-sandbox", 
+          "--disable-dev-shm-usage", 
+          "--disable-blink-features=AutomationControlled",
+          "--start-maximized"
+        ],
+      });
+
+      const ctxOpts: Parameters<Browser["newContext"]>[0] = {
+        viewport:            { width: 1280, height: 720 },
+        // Avoid waiting for networkidle by default — use domcontentloaded instead
+        // Individual nav calls can override this
+      };
+
+      if (this.recordVideo) {
+        ctxOpts.recordVideo = { dir: this.videoDir, size: { width: 1280, height: 720 } };
+      }
+
+      this.context = await this.browser!.newContext(ctxOpts);
+      // ✅ FIX: Use domcontentloaded globally — networkidle was the dropdown delay root cause
+      // Each navigation still passes waitUntil but falls back faster
+      this.context.setDefaultTimeout(this.timeout);
+      this.context.setDefaultNavigationTimeout(this.timeout);
+      this.page    = await this.context.newPage();
+
+      this.log.info(`${type} browser launched successfully`);
+      const sc = await this.shots.onPass(this.page);
+      return pass(`Browser opened: ${type}`, sc);
+    } catch (error: any) {
+      this.log.error(`openBrowser failed`, { error: error.message });
+      return fail("Failed to open browser", error.message);
+    }
+  }
+
+  private getLauncher(type: string) {
+    const map: Record<string, any> = {
+      chromium, chrome: chromium, edge: chromium,
+      firefox,
+      webkit, safari: webkit,
+    };
+    const l = map[type.toLowerCase()];
+    if (!l) throw new Error(`Unsupported browser: "${type}". Use: chromium|chrome|firefox|webkit|safari|edge`);
+    return l;
+  }
+
+  // ─── Close ─────────────────────────────────────────────────────────────────
+
+  async closeBrowser(): Promise<ActionResponse> {
+    try {
+      if (this.page    && !this.page.isClosed()) await this.page.close().catch(() => {});
+      if (this.context) await this.context.close().catch(() => {});
+      if (this.browser) await this.browser.close().catch(() => {});
+      if (this.recordVideo) this.log.info(`Video saved to: ${this.videoDir}`);
+      return pass("Browser closed successfully");
+    } catch (error: any) {
+      return fail("Failed to close browser", error.message);
+    }
+  }
+
+  // ─── Navigation ────────────────────────────────────────────────────────────
+  // ✅ ROOT CAUSE FIX: switched from "networkidle" to "domcontentloaded"
+  // networkidle waits for ALL network requests to stop (can be 5-30s on SPAs)
+  // domcontentloaded fires as soon as HTML is parsed — much faster
+
+  async navigateToURL(url: string): Promise<ActionResponse> {
+    try {
+      await this.getPage().goto(url, {
+        waitUntil: "domcontentloaded",  // ✅ was networkidle — that caused dropdown delay
+        timeout:   this.timeout,
+      });
+      const sc = await this.shots.onPass(this.page);
+      return pass(`Navigated to ${url}`, sc);
+    } catch (error: any) {
+      const sc = await this.shots.onFail(this.page);
+      return fail(`Failed to navigate to: ${url}`, error.message, sc);
+    }
+  }
+
+  async navigateBack(): Promise<ActionResponse> {
+    try {
+      await this.getPage().goBack({ waitUntil: "domcontentloaded" });
+      const sc = await this.shots.onPass(this.page);
+      return pass("Navigated back", sc);
+    } catch (error: any) {
+      const sc = await this.shots.onFail(this.page);
+      return fail("Failed to navigate back", error.message, sc);
+    }
+  }
+
+  async navigateForward(): Promise<ActionResponse> {
+    try {
+      await this.getPage().goForward({ waitUntil: "domcontentloaded" });
+      const sc = await this.shots.onPass(this.page);
+      return pass("Navigated forward", sc);
+    } catch (error: any) {
+      const sc = await this.shots.onFail(this.page);
+      return fail("Failed to navigate forward", error.message, sc);
+    }
+  }
+
+  async refreshPage(): Promise<ActionResponse> {
+    try {
+      await this.getPage().reload({ waitUntil: "domcontentloaded" });
+      const sc = await this.shots.onPass(this.page);
+      return pass("Page refreshed", sc);
+    } catch (error: any) {
+      const sc = await this.shots.onFail(this.page);
+      return fail("Failed to refresh page", error.message, sc);
+    }
+  }
+
+  // ─── Window / Viewport ─────────────────────────────────────────────────────
+
+  async maximizeWindow(): Promise<ActionResponse> {
+    try {
+      await this.getPage().setViewportSize({ width: 1920, height: 1080 });
+      return pass("Window maximized to 1920×1080");
+    } catch (error: any) {
+      return fail("Failed to maximize window", error.message);
+    }
+  }
+
+  async setWindowSize(width: string, height: string): Promise<ActionResponse> {
+    try {
+      await this.getPage().setViewportSize({ width: parseInt(width, 10), height: parseInt(height, 10) });
+      return pass(`Window set to ${width}×${height}`);
+    } catch (error: any) {
+      return fail("Failed to set window size", error.message);
+    }
+  }
+
+  // ─── Tabs ──────────────────────────────────────────────────────────────────
+
+  async switchToTab(indexStr: string): Promise<ActionResponse> {
+    try {
+      const pages = this.context!.pages();
+      const index = parseInt(indexStr, 10);
+      if (index >= pages.length) return fail(`Tab index ${index} out of range (${pages.length} tabs)`);
+      this.page = pages[index];
+      await this.page.bringToFront();
+      const sc = await this.shots.onPass(this.page);
+      return pass(`Switched to tab ${index}`, sc);
+    } catch (error: any) {
+      return fail("Failed to switch tab", error.message);
+    }
+  }
+
+  async openNewTab(url?: string): Promise<ActionResponse> {
+    try {
+      this.page = await this.context!.newPage();
+      if (url) await this.page.goto(url, { waitUntil: "domcontentloaded" });
+      const sc = await this.shots.onPass(this.page);
+      return pass(`Opened new tab${url ? ": " + url : ""}`, sc);
+    } catch (error: any) {
+      return fail("Failed to open new tab", error.message);
+    }
+  }
+
+  async closeCurrentTab(): Promise<ActionResponse> {
+    try {
+      await this.getPage().close();
+      const pages = this.context!.pages();
+      if (pages.length > 0) this.page = pages[pages.length - 1];
+      return pass("Current tab closed");
+    } catch (error: any) {
+      return fail("Failed to close tab", error.message);
+    }
+  }
+
+  async waitForNewTab(triggerAction: () => Promise<void>): Promise<ActionResponse> {
+    try {
+      const [newPage] = await Promise.all([
+        this.context!.waitForEvent("page"),
+        triggerAction(),
+      ]);
+      await newPage.waitForLoadState("domcontentloaded");
+      this.page = newPage;
+      const sc = await this.shots.onPass(this.page);
+      return pass("New tab opened and switched to", sc);
+    } catch (error: any) {
+      return fail("Failed waiting for new tab", error.message);
+    }
+  }
+
+  // ─── Title / URL ───────────────────────────────────────────────────────────
+
+  async getTitle(storeKey?: string): Promise<ActionResponse> {
+    try {
+      const title = await this.getPage().title();
+      const sc    = await this.shots.onPass(this.page);
+      return pass(`Page title: "${title}"`, sc, { title });
+    } catch (error: any) {
+      const sc = await this.shots.onFail(this.page);
+      return fail("Failed to get title", error.message, sc);
+    }
+  }
+
+  async verifyTitle(expected: string): Promise<ActionResponse> {
+    try {
+      const title = await this.getPage().title();
+      const ok    = title === expected;
+      const msg   = ok ? `Title matches: "${expected}"` : `Title mismatch. Expected: "${expected}", Actual: "${title}"`;
+      const sc    = ok ? await this.shots.onPass(this.page) : await this.shots.onFail(this.page);
+      return ok ? pass(msg, sc) : fail(msg, undefined, sc);
+    } catch (error: any) {
+      const sc = await this.shots.onFail(this.page);
+      return fail("Failed to verify title", error.message, sc);
+    }
+  }
+
+  async verifyPartialTitle(partial: string): Promise<ActionResponse> {
+    try {
+      const title = await this.getPage().title();
+      const ok    = title.includes(partial);
+      const msg   = ok ? `Title contains: "${partial}"` : `Title does not contain "${partial}". Actual: "${title}"`;
+      const sc    = ok ? await this.shots.onPass(this.page) : await this.shots.onFail(this.page);
+      return ok ? pass(msg, sc) : fail(msg, undefined, sc);
+    } catch (error: any) {
+      const sc = await this.shots.onFail(this.page);
+      return fail("Failed to verify partial title", error.message, sc);
+    }
+  }
+
+  async getCurrentURL(): Promise<ActionResponse> {
+    const url = this.getPage().url();
+    return pass(`Current URL: "${url}"`, undefined, { url });
+  }
+  async getPageSource(): Promise<ActionResponse> {
+  try {
+    const pageSource = this.getPage().content();
+    return pass("Page source captured", undefined, { pagesource: pageSource });
+  } catch (error: any) {
+    return fail(`Failed to get page source — ${error.message}`);
+  }
+}
+
+  // ─── Dialogs ───────────────────────────────────────────────────────────────
+
+  async acceptAlert(promptText?: string): Promise<ActionResponse> {
+    try {
+      this.getPage().once("dialog", (d) => d.accept(promptText));
+      return pass("Dialog handler set: will accept next dialog");
+    } catch (error: any) {
+      return fail("Failed to set accept handler", error.message);
+    }
+  }
+
+  async dismissAlert(): Promise<ActionResponse> {
+    try {
+      this.getPage().once("dialog", (d) => d.dismiss());
+      return pass("Dialog handler set: will dismiss next dialog");
+    } catch (error: any) {
+      return fail("Failed to set dismiss handler", error.message);
+    }
+  }
+
+  async getAlertText(storeKey?: string): Promise<ActionResponse> {
+    return new Promise((resolve) => {
+      const timer = setTimeout(() => resolve(fail("No dialog appeared within timeout")), this.timeout);
+      this.getPage().once("dialog", async (d) => {
+        clearTimeout(timer);
+        const text = d.message();
+        await d.dismiss();
+        if (storeKey) {/* testData would need to be injected here if needed */}
+        resolve(pass(`Alert text: "${text}"`, undefined, { text }));
+      });
+    });
+  }
+
+  // ─── Frames ────────────────────────────────────────────────────────────────
+
+  async switchToFrame(nameOrSelector: string): Promise<ActionResponse> {
+    try {
+      const frame = this.getPage().frame({ name: nameOrSelector });
+      if (!frame) {
+        // try as locator-based frame
+        this.getPage().frameLocator(nameOrSelector);
+        return pass(`FrameLocator set for: "${nameOrSelector}"`);
+      }
+      return pass(`Switched to frame: "${nameOrSelector}"`);
+    } catch (error: any) {
+      return fail("Failed to switch to frame", error.message);
+    }
+  }
+
+  // ─── JavaScript ────────────────────────────────────────────────────────────
+
+  async executeScript(script: string): Promise<ActionResponse> {
+    try {
+      const result = await this.getPage().evaluate(script);
+      const sc     = await this.shots.onPass(this.page);
+      return pass("Script executed", sc, { result });
+    } catch (error: any) {
+      const sc = await this.shots.onFail(this.page);
+      return fail("Failed to execute script", error.message, sc);
+    }
+  }
+
+  async scrollToBottom(): Promise<ActionResponse> {
+    try {
+      await this.getPage().evaluate("window.scrollTo(0, document.body.scrollHeight)");
+      return pass("Scrolled to bottom");
+    } catch (error: any) {
+      return fail("Failed to scroll to bottom", error.message);
+    }
+  }
+
+  async scrollToTop(): Promise<ActionResponse> {
+    try {
+      await this.getPage().evaluate("window.scrollTo(0, 0)");
+      return pass("Scrolled to top");
+    } catch (error: any) {
+      return fail("Failed to scroll to top", error.message);
+    }
+  }
+
+  // ─── Cookies / Storage ─────────────────────────────────────────────────────
+
+  async deleteAllCookies(): Promise<ActionResponse> {
+    try {
+      await this.context!.clearCookies();
+      return pass("All cookies deleted");
+    } catch (error: any) {
+      return fail("Failed to delete cookies", error.message);
+    }
+  }
+
+  async clearLocalStorage(): Promise<ActionResponse> {
+    try {
+      await this.getPage().evaluate("localStorage.clear()");
+      return pass("LocalStorage cleared");
+    } catch (error: any) {
+      return fail("Failed to clear localStorage", error.message);
+    }
+  }
+
+  async clearSessionStorage(): Promise<ActionResponse> {
+    try {
+      await this.getPage().evaluate("sessionStorage.clear()");
+      return pass("SessionStorage cleared");
+    } catch (error: any) {
+      return fail("Failed to clear sessionStorage", error.message);
+    }
+  }
+
+  // ─── Screenshot ────────────────────────────────────────────────────────────
+
+  async takeScreenshot(): Promise<ActionResponse> {
+    const sc = await this.shots.force(this.page);
+    return pass("Screenshot captured", sc);
+  }
+
+  // ─── Getters ───────────────────────────────────────────────────────────────
+
+  getPage(): Page {
+    if (!this.page || this.page.isClosed())
+      throw new Error("Browser not initialized. Call openBrowser() first.");
+    return this.page;
+  }
+
+  hasPage(): boolean { return !!this.page && !this.page.isClosed(); }
+}