lexxit-automation-framework 2.0.19 → 3.0.0

package/src/actions/textHandler.ts

@@ -0,0 +1,498 @@
+import { Page } from 'playwright';
+import { ScreenshotMode, StepResult } from '../types/types';
+import { LocatorService } from '../utils/locatorService';
+import { BaseHandler } from './baseHandler';
+import * as fs from 'fs';
+import { DEFAULT_SCREENSHOT_MODE } from '../config';
+
+export class TextHandler extends BaseHandler {
+  protected page: Page;
+  // private lastApiResponse: { status: number; url: string; body: any } | null = null;
+
+ constructor(page: Page, screenshotMode: ScreenshotMode = DEFAULT_SCREENSHOT_MODE) {
+  super();
+  this.page = page;
+  this.screenshotMode = screenshotMode;
+  this.setupNetworkCapture(page);
+}
+
+  // // private getLastApiResponse() {
+  //   return this.lastApiResponse;
+  // }
+
+  // // ─── 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 = '',
+  //   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
+  //   };
+  // }
+
+  // private async captureScreenshot(isFailure: boolean): Promise<string | undefined> {
+  //   if (this.screenshotMode === 'never') return undefined;
+  //   if (this.screenshotMode === 'on_failure' && !isFailure) return undefined;
+  //   try {
+  //     if (!this.page || this.page.isClosed()) return undefined;
+  //     const buf = await this.page.screenshot({ type: 'png', fullPage: false });
+  //     return buf.toString('base64');
+  //   } catch {
+  //     return undefined;
+  //   }
+  // }
+
+  // private classifyError(error: any): string {
+  //   const msg: string = error?.message || String(error);
+
+  //   if (msg.includes('Element not found') || msg.includes('not visible')) {
+  //     return `Element not found or not visible: ${msg}`;
+  //   }
+  //   if (msg.includes('Timeout') || msg.includes('timeout')) {
+  //     return `Timeout error - element took too long to respond: ${msg}`;
+  //   }
+  //   if (msg.includes('not editable') || msg.includes('not enabled')) {
+  //     return `Element is not editable or disabled: ${msg}`;
+  //   }
+  //   if (msg.includes('detached')) {
+  //     return `Element got detached from DOM: ${msg}`;
+  //   }
+  //   if (msg.includes('Target closed') || msg.includes('has been closed')) {
+  //     return `Browser or page closed unexpectedly: ${msg}`;
+  //   }
+  //   if (msg.includes('intercepts pointer events') || msg.includes('not visible within')) {
+  //     return `Element is covered by another element: ${msg}`;
+  //   }
+
+  //   return `Unexpected error: ${msg}`;
+  // }
+
+  // private appendMatchedLocatorInfo(comments: string, matchedIndex: number, matchedXPath: string): string {
+  //   if (matchedIndex > 0) {
+  //     return `${comments} (Matched locator at position ${matchedIndex}: ${matchedXPath})`;
+  //   }
+  //   return comments;
+  // }
+
+  // ─── enterText ─────────────────────────────────────────────────────────────
+
+  async enterText(label: string, locators: string[], value: string, step_name: string = 'Enter text'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `'${value}' entered into '${label}' successfully`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      await resolved.element.fill(value);
+
+      const comments = this.appendMatchedLocatorInfo(expected, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      const msg = (error?.message || String(error)).toLowerCase();
+      if (
+        msg.includes('waiting for locator') ||
+        msg.includes('timeout') ||
+        msg.includes('no element') ||
+        msg.includes('not found') ||
+        msg.includes('not visible') ||
+        msg.includes('not attached')
+      ) {
+        const captured = this.getLastApiResponse();
+        if (captured) {
+          const bodyText = typeof captured.body === 'object' ? JSON.stringify(captured.body, null, 2) : String(captured.body);
+          const comments = `Element "${label}" not found on page.\nNetwork response [HTTP ${captured.status}] from ${captured.url}:\n${bodyText}`;
+          return this.buildResult('FAIL', expected, comments, startMs, startTime, step_name);
+        }
+
+        return this.buildResult('FAIL', expected, `"${label}" not found`, startMs, startTime, step_name);
+      }
+
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── clearText ─────────────────────────────────────────────────────────────
+
+  async clearText(label: string, locators: string[], step_name: string = 'Clear text'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `'${label}' cleared successfully`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      await resolved.element.fill('');
+
+      const comments = this.appendMatchedLocatorInfo(expected, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      const msg = (error?.message || String(error)).toLowerCase();
+      if (
+        msg.includes('waiting for locator') ||
+        msg.includes('timeout') ||
+        msg.includes('no element') ||
+        msg.includes('not found') ||
+        msg.includes('not visible') ||
+        msg.includes('not attached')
+      ) {
+        const captured = this.getLastApiResponse();
+        if (captured) {
+          const bodyText = typeof captured.body === 'object' ? JSON.stringify(captured.body, null, 2) : String(captured.body);
+          const comments = `Element "${label}" not found on page.\nNetwork response [HTTP ${captured.status}] from ${captured.url}:\n${bodyText}`;
+          return this.buildResult('FAIL', expected, comments, startMs, startTime, step_name);
+        }
+
+        return this.buildResult('FAIL', expected, `"${label}" not found`, startMs, startTime, step_name);
+      }
+
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── getText ───────────────────────────────────────────────────────────────
+
+  async getText(label: string, locators: string[], step_name: string = 'Get text'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `Text retrieved from '${label}' successfully`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      const text = await resolved.element.innerText();
+
+      const comments = this.appendMatchedLocatorInfo(`Text is: ${text}`, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      const msg = (error?.message || String(error)).toLowerCase();
+      if (
+        msg.includes('waiting for locator') ||
+        msg.includes('timeout') ||
+        msg.includes('no element') ||
+        msg.includes('not found') ||
+        msg.includes('not visible') ||
+        msg.includes('not attached')
+      ) {
+        const captured = this.getLastApiResponse();
+        if (captured) {
+          const bodyText = typeof captured.body === 'object' ? JSON.stringify(captured.body, null, 2) : String(captured.body);
+          const comments = `Element "${label}" not found on page.\nNetwork response [HTTP ${captured.status}] from ${captured.url}:\n${bodyText}`;
+          return this.buildResult('FAIL', expected, comments, startMs, startTime, step_name);
+        }
+
+        return this.buildResult('FAIL', expected, `"${label}" not found`, startMs, startTime, step_name);
+      }
+
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── appendText ────────────────────────────────────────────────────────────
+
+  async appendText(label: string, locators: string[], value: string, step_name: string = 'Append text'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `'${value}' appended to '${label}' successfully`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      const existing = await resolved.element.inputValue();
+      await resolved.element.fill(existing + value);
+
+      const comments = this.appendMatchedLocatorInfo(expected, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      const msg = (error?.message || String(error)).toLowerCase();
+      if (
+        msg.includes('waiting for locator') ||
+        msg.includes('timeout') ||
+        msg.includes('no element') ||
+        msg.includes('not found') ||
+        msg.includes('not visible') ||
+        msg.includes('not attached')
+      ) {
+        const captured = this.getLastApiResponse();
+        if (captured) {
+          const bodyText = typeof captured.body === 'object' ? JSON.stringify(captured.body, null, 2) : String(captured.body);
+          const comments = `Element "${label}" not found on page.\nNetwork response [HTTP ${captured.status}] from ${captured.url}:\n${bodyText}`;
+          return this.buildResult('FAIL', expected, comments, startMs, startTime, step_name);
+        }
+
+        return this.buildResult('FAIL', expected, `"${label}" not found`, startMs, startTime, step_name);
+      }
+
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── getValue ──────────────────────────────────────────────────────────────
+
+  async getValue(label: string, locators: string[], step_name: string = 'Get value'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `Value retrieved from '${label}' successfully`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      const value = await resolved.element.inputValue();
+
+      const comments = this.appendMatchedLocatorInfo(`Value is: ${value}`, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      const msg = (error?.message || String(error)).toLowerCase();
+      if (
+        msg.includes('waiting for locator') ||
+        msg.includes('timeout') ||
+        msg.includes('no element') ||
+        msg.includes('not found') ||
+        msg.includes('not visible') ||
+        msg.includes('not attached')
+      ) {
+        const captured = this.getLastApiResponse();
+        if (captured) {
+          const bodyText = typeof captured.body === 'object' ? JSON.stringify(captured.body, null, 2) : String(captured.body);
+          const comments = `Element "${label}" not found on page.\nNetwork response [HTTP ${captured.status}] from ${captured.url}:\n${bodyText}`;
+          return this.buildResult('FAIL', expected, comments, startMs, startTime, step_name);
+        }
+
+        return this.buildResult('FAIL', expected, `"${label}" not found`, startMs, startTime, step_name);
+      }
+
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── getPlaceholder ────────────────────────────────────────────────────────
+
+  async getPlaceholder(label: string, locators: string[], step_name: string = 'Get placeholder'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `Placeholder retrieved from '${label}' successfully`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      const placeholder = await resolved.element.getAttribute('placeholder');
+
+      const comments = this.appendMatchedLocatorInfo(`Placeholder is: ${placeholder}`, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── isTextPresent ─────────────────────────────────────────────────────────
+
+  async isTextPresent(label: string, locators: string[], expectedText: string, step_name: string = 'Check text presence'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `Text '${expectedText}' is present in '${label}'`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      const text = await resolved.element.innerText();
+      const isPresent = text.includes(expectedText);
+
+      if (!isPresent) {
+        const failComments = this.appendMatchedLocatorInfo(
+          `Expected text '${expectedText}' not found. Actual text: '${text}'`,
+          resolved.matchedIndex,
+          resolved.matchedXPath
+        );
+        // const sc = await this.captureScreenshot(true);
+        return this.buildResult('FAIL', expected, failComments, startMs, startTime, step_name);
+      }
+
+      const comments = this.appendMatchedLocatorInfo(expected, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      const msg = (error?.message || String(error)).toLowerCase();
+      if (
+        msg.includes('waiting for locator') ||
+        msg.includes('timeout') ||
+        msg.includes('no element') ||
+        msg.includes('not found') ||
+        msg.includes('not visible') ||
+        msg.includes('not attached')
+      ) {
+        const captured = this.getLastApiResponse();
+        if (captured) {
+          const bodyText = typeof captured.body === 'object' ? JSON.stringify(captured.body, null, 2) : String(captured.body);
+          const comments = `Element "${label}" not found on page.\nNetwork response [HTTP ${captured.status}] from ${captured.url}:\n${bodyText}`;
+          return this.buildResult('FAIL', expected, comments, startMs, startTime, step_name);
+        }
+
+        return this.buildResult('FAIL', expected, `"${label}" not found`, startMs, startTime, step_name);
+      }
+
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+
+  // ─── verifyText ────────────────────────────────────────────────────────────
+
+  async verifyText(label: string, locators: string[], expectedText: string, step_name: string = 'Verify text'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `Text in '${label}' matches '${expectedText}'`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      const actualText = await resolved.element.innerText();
+
+      if (actualText.trim() !== expectedText.trim()) {
+        const failComments = this.appendMatchedLocatorInfo(
+          `Expected: '${expectedText}', Actual: '${actualText}'`,
+          resolved.matchedIndex,
+          resolved.matchedXPath
+        );
+        // const sc = await this.captureScreenshot(true);
+        return this.buildResult('FAIL', expected, failComments, startMs, startTime, step_name);
+      }
+
+      const comments = this.appendMatchedLocatorInfo(expected, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+  // ─── fileUpload ────────────────────────────────────────────────────────────
+
+  async file_upload(label: string, locators: string[], filePath: string, step_name: string = 'File upload'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+    const expected = `"${filePath}" should be uploaded in "${label}"`;
+
+    if (!fs.existsSync(filePath)) {
+      // const sc = await this.captureScreenshot(true);
+      return this.buildResult('FAIL', expected, `File not found: "${filePath}"`, startMs, startTime, step_name);
+    }
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+      await resolved.element.setInputFiles(filePath);
+
+      const comments = this.appendMatchedLocatorInfo(`Uploaded file "${filePath}" into "${label}"`, resolved.matchedIndex, resolved.matchedXPath);
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      const msg = (error?.message || String(error)).toLowerCase();
+
+      if (
+        msg.includes('waiting for locator') ||
+        msg.includes('timeout') ||
+        msg.includes('no element') ||
+        msg.includes('not found') ||
+        msg.includes('not visible') ||
+        msg.includes('not attached')
+      ) {
+        const captured = this.getLastApiResponse();
+        if (captured) {
+          const bodyText = typeof captured.body === 'object' ? JSON.stringify(captured.body, null, 2) : String(captured.body);
+          const comments = `Element "${label}" not found on page.\nNetwork response [HTTP ${captured.status}] from ${captured.url}:\n${bodyText}`;
+          return this.buildResult('FAIL', expected, comments, startMs, startTime, step_name);
+        }
+        return this.buildResult('FAIL', expected, `"${label}" not found`, startMs, startTime, step_name);
+      }
+
+      if (msg.includes('enoent') || msg.includes('no such file')) {
+        return this.buildResult('FAIL', expected, `File not found: "${filePath}"`, startMs, startTime, step_name);
+      }
+
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+  // ─── setSlider ─────────────────────────────────────────────────────────────
+
+  async setSlider(label: string, locators: string[], value: string, step_name: string = 'Set slider'): Promise<StepResult> {
+    const startMs = Date.now();
+    const startTime = this.getStartTime();
+
+    const targetValue = parseFloat(value);
+    if (isNaN(targetValue)) {
+      return this.buildResult('FAIL', `Slider "${label}" set successfully`, `Invalid slider value "${value}" — must be a number`, startMs, startTime, step_name);
+    }
+
+    const expected = `Slider "${label}" set to ${targetValue} successfully`;
+
+    try {
+      const resolved = await LocatorService.resolveElement(this.page, locators);
+
+      const { min, max, step, clamped } = await resolved.element.evaluate((node: Element, val: number) => {
+        const input = node as HTMLInputElement;
+        const min   = input.min  !== '' ? parseFloat(input.min)  : 0;
+        const max   = input.max  !== '' ? parseFloat(input.max)  : 100;
+        const step  = input.step !== '' && input.step !== 'any' ? parseFloat(input.step) : 1;
+        const clamped = Math.min(Math.max(val, min), max);
+        const snapped = Math.round((clamped - min) / step) * step + min;
+        return { min, max, step, clamped: parseFloat(snapped.toFixed(10)) };
+      }, targetValue);
+
+      await resolved.element.evaluate((node: Element, val: number) => {
+        const input = node as HTMLInputElement;
+        input.value = String(val);
+        input.dispatchEvent(new Event('input',  { bubbles: true }));
+        input.dispatchEvent(new Event('change', { bubbles: true }));
+      }, clamped);
+
+      const comments = this.appendMatchedLocatorInfo(
+        `Set slider "${label}" to ${clamped} (range: ${min}–${max}, step: ${step})`,
+        resolved.matchedIndex,
+        resolved.matchedXPath
+      );
+      return this.buildResult('PASS', expected, comments, startMs, startTime, step_name);
+
+    } catch (error: any) {
+      // const sc = await this.captureScreenshot(true);
+      const msg = (error?.message || String(error)).toLowerCase();
+
+      if (
+        msg.includes('waiting for locator') ||
+        msg.includes('timeout') ||
+        msg.includes('no element') ||
+        msg.includes('not found') ||
+        msg.includes('not visible') ||
+        msg.includes('not attached')
+      ) {
+        const captured = this.getLastApiResponse();
+        if (captured) {
+          const bodyText = typeof captured.body === 'object' ? JSON.stringify(captured.body, null, 2) : String(captured.body);
+          const comments = `Element "${label}" not found on page.\nNetwork response [HTTP ${captured.status}] from ${captured.url}:\n${bodyText}`;
+          return this.buildResult('FAIL', expected, comments, startMs, startTime, step_name);
+        }
+        return this.buildResult('FAIL', expected, `"${label}" not found`, startMs, startTime, step_name);
+      }
+
+      return this.buildResult('FAIL', expected, this.classifyError(error), startMs, startTime, step_name);
+    }
+  }
+}