lexxit-automation-framework 2.0.20 → 3.0.1

package/src/actions/customcodehandler.ts

@@ -0,0 +1,251 @@
+
+// import { Page } from 'playwright';
+// import { StepResult, ScreenshotMode } from '../types/types';
+// import { TestDataStore } from '../store/testDataStore';
+// import { BaseHandler } from './baseHandler';
+
+// export class CustomCodeHandler extends BaseHandler {
+//   private page: Page;
+//   private testData: TestDataStore;
+
+//   constructor(page: Page,testData: TestDataStore) {
+//     super();
+//     this.page = page;
+//     this.testData = testData;
+//   }
+
+//   // ─── 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;
+//   //   }
+//   // }
+
+//   // ─── runCustomCode ─────────────────────────────────────────────────────────
+//   //
+//   // step_script format:
+//   //   tSetup.runCustomCode('<JS code>', '<returnVariable>', '<optional xpath>')
+//   //
+//   // The returnVariable name is used as the key in TestDataStore.
+//   // Later steps can reference it as:  testData["returnVariable"]
+//   //
+//   // Examples:
+//   //   tSetup.runCustomCode('const RN_randomEmail=...;', 'RN_randomEmail')
+//   //   tSetup.runCustomCode('const otp=...;', 'otp', '//input[@id="lname"]')
+//   //   tSetup.runCustomCode('await page.waitForTimeout(2000);')
+
+//   async runCustomCode(
+//     codeStr: string,
+//     returnVariable?: string,
+//     xpath?: string,
+//     step_name: string = 'Run custom code'
+//   ): Promise<StepResult> {
+//     const startMs   = Date.now();
+//     const startTime = this.getStartTime();
+//     const expected  = 'Custom code executed successfully';
+
+//     if (!codeStr || !codeStr.trim()) {
+//       // const sc = await this.captureScreenshot(true);
+//       return this.buildResult('FAIL', expected, 'runCustomCode: codeStr (first argument) is required', startMs, startTime, step_name);
+//     }
+
+//     try {
+//       const context = {
+//         page:     this.page,
+//         tSetup:   this.page,
+//         testData: this.testData,
+//       };
+
+//       const wrappedCode = `
+//         "use strict";
+//         const { page, tSetup, testData } = __ctx__;
+//         ${codeStr}
+//         return typeof ${returnVariable || '__undefined__'} !== 'undefined'
+//           ? ${returnVariable || 'undefined'}
+//           : undefined;
+//       `;
+
+//       // eslint-disable-next-line no-new-func
+//       const fn    = new Function('__ctx__', `return (async (__ctx__) => { ${wrappedCode} })(__ctx__)`);
+//       const value = await fn(context);
+
+//       // ── Capture return value → write to TestDataStore ─────────────────────
+//       if (returnVariable && value !== undefined && value !== null) {
+//         const strValue = String(value);
+
+//         // Store so later steps can use testData["returnVariable"]
+//         this.testData.set(returnVariable, strValue);
+
+//         // If xpath provided, also type directly into the field
+//         if (xpath && xpath.trim()) {
+//           try {
+//             const el = this.page.locator(`xpath=${xpath}`);
+//             await el.waitFor({ state: 'visible', timeout: 10000 });
+//             await el.clear();
+//             await el.fill(strValue);
+//           } catch (fillErr: any) {
+//             // const sc = await this.captureScreenshot(true);
+//             return this.buildResult(
+//               'FAIL',
+//               expected,
+//               `Custom code ran OK (${returnVariable}="${strValue}") but failed to type into [xpath=${xpath}] — ${fillErr.message}`,
+//               startMs, startTime, step_name
+//             );
+//           }
+//         }
+
+//         // const sc = await this.captureScreenshot(false);
+//         return this.buildResult(
+//           'PASS',
+//           expected,
+//           `Custom code executed. ${returnVariable} = ${strValue}`,
+//           startMs, startTime, step_name
+//         );
+//       }
+
+//       // ── No return variable — side-effects only ────────────────────────────
+//       // const sc = await this.captureScreenshot(false);
+//       return this.buildResult('PASS', expected, expected, startMs, startTime, step_name);
+
+//     } catch (error: any) {
+//       // const sc      = await this.captureScreenshot(true);
+//       const snippet = String(codeStr).slice(0, 200);
+//       return this.buildResult(
+//         'FAIL',
+//         expected,
+//         `Exception during custom code execution — ${error.message} | code: ${snippet}`,
+//         startMs, startTime, step_name
+//       );
+//     }
+//   }
+// }
+import { Page } from 'playwright';
+import { StepResult } from '../types/types';
+import { TestDataStore } from '../store/testDataStore';
+import { BaseHandler } from './baseHandler';
+
+export class CustomCodeHandler extends BaseHandler {
+  protected page: Page;
+  private testData: TestDataStore;
+
+  constructor(page: Page, testData: TestDataStore) {
+    super();
+    this.page = page;
+    this.testData = testData;
+  }
+
+  async runCustomCode(
+    codeStr: string,
+    returnVariable?: string,
+    xpath?: string,
+    step_name: string = 'Run custom code'
+  ): Promise<StepResult> {
+    const startMs   = Date.now();
+    const startTime = this.getStartTime();
+    const expected  = 'Custom code executed successfully';
+
+    if (!codeStr || !codeStr.trim()) {
+      return this.buildResult('FAIL', expected, 'runCustomCode: codeStr (first argument) is required', startMs, startTime, step_name);
+    }
+
+    try {
+      const context = {
+        page:     this.page,
+        tSetup:   this.page,
+        testData: this.testData,
+      };
+
+      const wrappedCode = `
+        "use strict";
+        const { page, tSetup, testData } = __ctx__;
+        ${codeStr}
+        return typeof ${returnVariable || '__undefined__'} !== 'undefined'
+          ? ${returnVariable || 'undefined'}
+          : undefined;
+      `;
+
+      const fn    = new Function('__ctx__', `return (async (__ctx__) => { ${wrappedCode} })(__ctx__)`);
+      const value = await fn(context);
+
+      if (returnVariable && value !== undefined && value !== null) {
+        const strValue = String(value);
+
+        this.testData.set(returnVariable, strValue);
+
+        if (xpath && xpath.trim()) {
+          try {
+            const el = this.page.locator(`xpath=${xpath}`);
+            await el.waitFor({ state: 'visible', timeout: 10000 });
+            await el.clear();
+            await el.fill(strValue);
+          } catch (fillErr: any) {
+            return this.buildResult(
+              'FAIL',
+              expected,
+              `Custom code ran OK (${returnVariable}="${strValue}") but failed to type into [xpath=${xpath}] — ${fillErr.message}`,
+              startMs, startTime, step_name
+            );
+          }
+        }
+
+        return this.buildResult(
+          'PASS',
+          expected,
+          `Custom code executed. ${returnVariable} = ${strValue}`,
+          startMs, startTime, step_name
+        );
+      }
+
+      return this.buildResult('PASS', expected, expected, startMs, startTime, step_name);
+
+    } catch (error: any) {
+      const snippet = String(codeStr).slice(0, 200);
+      return this.buildResult(
+        'FAIL',
+        expected,
+        `Exception during custom code execution — ${error.message} | code: ${snippet}`,
+        startMs, startTime, step_name
+      );
+    }
+  }
+}