pw-automation-framework 2.0.1

package/src/controllers/controller.ts

@@ -0,0 +1,282 @@
+import { Request, Response } from "express";
+import { executionQueue } from "../queue/ExecutionQueue";
+import { sseManager } from "../utils/sseManager";
+import { formatExecutionResult, formatScriptResult } from "../utils/responseFormatter";
+import { Logger } from "../utils/logger";
+
+const log = Logger.create("ApiController");
+
+export class ApiController {
+
+  /**
+   * POST /api/run-test
+   * ------------------
+   * Enqueues execution, returns 202 + executionId immediately.
+   * The caller opens the dashboard and subscribes to SSE for live updates.
+   * Call GET /api/result/:executionId when done to get the full formatted result.
+   */
+  static async runTest(req: Request, res: Response): Promise<void> {
+    const payload = req.body;
+    if (!payload?.scripts?.length) {
+      res.status(400).json({ error: "'scripts' array is required." });
+      return;
+    }
+
+    // Validate that steps have step_script
+    const missingSteps: string[] = [];
+    for (const script of payload.scripts) {
+      for (const step of (script.steps || [])) {
+        if (!step.step_script || step.step_script.trim() === "") {
+          missingSteps.push(step.step_name || "unnamed step");
+        }
+      }
+    }
+    if (missingSteps.length > 0) {
+      res.status(400).json({
+        error: "Steps are missing step_script field.",
+        detail: `Steps without step_script: ${missingSteps.slice(0, 5).join(", ")}`,
+        fix: "Call prepareSteps(uid) in your main app to resolve obj_uid → step_script before sending to the framework.",
+      });
+      return;
+    }
+
+    const executionId  = executionQueue.enqueue(payload);
+    const dashboardURL = `http://localhost:${process.env.PORT || 3000}/dashboard/${executionId}`;
+    const resultURL    = `http://localhost:${process.env.PORT || 3000}/api/result/${executionId}`;
+    const streamURL    = `http://localhost:${process.env.PORT || 3000}/api/stream/${executionId}`;
+    // const videoURL = `http://localhost:${process.env.PORT || 3000}/api/video/${executionId}`;
+
+    log.info(`Enqueued: ${executionId} | scripts=${payload.scripts.length}`);
+
+    res.status(202).json({
+      executionId,
+      dashboardURL,
+      resultURL,    // Poll this for final result
+      streamURL,    // Subscribe to this for live events
+      //  videoURL,
+      status:       "queued",
+      message:      "Execution queued. Dashboard opening. Subscribe to streamURL for live updates, or poll resultURL for final result.",
+    });
+  }
+
+  /**
+   * GET /api/stream/:executionId
+   * ----------------------------
+   * SSE endpoint — dashboard subscribes here for live step events.
+   * Replays all past events immediately for late-connecting clients.
+   */
+  static stream(req: Request, res: Response): void {
+    const { executionId } = req.params;
+    sseManager.addClient(executionId, res);
+  }
+
+  /**
+   * GET /api/result/:executionId
+   * ----------------------------
+   * Returns the FULL formatted result once execution is complete.
+   * Returns 202 if still running (poll until 200).
+   *
+   * Response matches the standard format:
+   * {
+   *   "status": "pass|fail",
+   *   "results": [{ "test_script_uid": "...", "status": "...", "results": [...] }]
+   * }
+   */
+  static getResult(req: Request, res: Response): void {
+    const { executionId } = req.params;
+    const job = executionQueue.getJob(executionId);
+
+    if (!job) {
+      res.status(404).json({ error: `Execution ${executionId} not found` });
+      return;
+    }
+
+    if (job.status === "queued" || job.status === "running") {
+      res.status(202).json({
+        executionId,
+        status:   job.status,
+        message:  "Execution still in progress",
+        progress: job.progress,
+      });
+      return;
+    }
+
+    if (job.status === "cancelled") {
+      res.status(200).json({
+        executionId,
+        status:  "cancelled",
+        message: "Execution was cancelled",
+      });
+      return;
+    }
+
+    if (!job.result) {
+      res.status(500).json({
+        executionId,
+        status: "failed",
+        error:  job.error || "Execution failed with no result",
+      });
+      return;
+    }
+
+    // Return formatted result matching the standard API format
+    res.status(200).json(formatExecutionResult(job.result));
+    // console.log(formatExecutionResult(job.result));
+  }
+
+  /**
+   * GET /api/status/:executionId
+   * ----------------------------
+   * Lightweight status check (progress only, no full results).
+   */
+  static getStatus(req: Request, res: Response): void {
+    const { executionId } = req.params;
+    const job = executionQueue.getJob(executionId);
+
+    if (!job) {
+      res.status(404).json({ error: `Execution ${executionId} not found` });
+      return;
+    }
+
+    res.json({
+      executionId:     job.executionId,
+      status:          job.status,
+      queuedAt:        job.queuedAt,
+      startedAt:       job.startedAt,
+      completedAt:     job.completedAt,
+      cancelledAt:     job.cancelledAt,
+      progress:        job.progress,
+      cancelRequested: job.cancelRequested,
+      error:           job.error,
+    });
+  }
+
+  /**
+   * DELETE /api/cancel/:executionId
+   */
+  static cancelExecution(req: Request, res: Response): void {
+    const { executionId } = req.params;
+    const result = executionQueue.cancel(executionId);
+    res.status(result.success ? 200 : 400).json({ executionId, ...result });
+  }
+
+  /**
+   * DELETE /api/cancel-all
+   */
+  static cancelAll(_req: Request, res: Response): void {
+    res.json(executionQueue.cancelAll());
+  }
+
+  /**
+   * GET /api/queue
+   */
+  static getQueue(_req: Request, res: Response): void {
+    res.json(executionQueue.getQueueStats());
+  }
+
+  /**
+   * GET /api/health
+   */
+  static health(_req: Request, res: Response): void {
+    res.json({
+      status:  "ok",
+      version: "2.0.0",
+      ts:      new Date().toISOString(),
+      queue:   executionQueue.getQueueStats(),
+    });
+  }
+
+  /**
+   * GET /api/actions
+   */
+  static listActions(_req: Request, res: Response): void {
+    res.json({ total: ALL_ACTIONS.length, actions: ALL_ACTIONS });
+  }
+}
+
+const ALL_ACTIONS = [
+  // Browser
+  { name: "openBrowser",           category: "browser",   example: "tSetup.openBrowser('chrome')" },
+  { name: "closeBrowser",          category: "browser",   example: "tSetup.closeBrowser()" },
+  { name: "navigateToURL",         category: "browser",   example: "tSetup.navigateToURL('https://example.com')" },
+  { name: "navigateBack",          category: "browser",   example: "tSetup.navigateBack()" },
+  { name: "navigateForward",       category: "browser",   example: "tSetup.navigateForward()" },
+  { name: "refreshPage",           category: "browser",   example: "tSetup.refreshPage()" },
+  { name: "maximizeWindow",        category: "browser",   example: "tSetup.maximizeWindow()" },
+  { name: "setWindowSize",         category: "browser",   example: "tSetup.setWindowSize('1920', '1080')" },
+  { name: "switchToTab",           category: "browser",   example: "tSetup.switchToTab('1')" },
+  { name: "openNewTab",            category: "browser",   example: "tSetup.openNewTab('https://example.com')" },
+  { name: "closeCurrentTab",       category: "browser",   example: "tSetup.closeCurrentTab()" },
+  { name: "acceptAlert",           category: "browser",   example: "tSetup.acceptAlert()" },
+  { name: "dismissAlert",          category: "browser",   example: "tSetup.dismissAlert()" },
+  { name: "getAlertText",          category: "browser",   example: "tSetup.getAlertText('storeKey')" },
+  { name: "switchToFrame",         category: "browser",   example: "tSetup.switchToFrame('frameName')" },
+  { name: "executeScript",         category: "browser",   example: "tSetup.executeScript('return document.title')" },
+  { name: "scrollToBottom",        category: "browser",   example: "tSetup.scrollToBottom()" },
+  { name: "scrollToTop",           category: "browser",   example: "tSetup.scrollToTop()" },
+  { name: "deleteAllCookies",      category: "browser",   example: "tSetup.deleteAllCookies()" },
+  { name: "clearLocalStorage",     category: "browser",   example: "tSetup.clearLocalStorage()" },
+  { name: "clearSessionStorage",   category: "browser",   example: "tSetup.clearSessionStorage()" },
+  { name: "takeScreenshot",        category: "browser",   example: "tSetup.takeScreenshot()" },
+  { name: "getTitle",              category: "browser",   example: "tSetup.getTitle('storeKey')" },
+  { name: "verifyTitle",           category: "browser",   example: "tSetup.verifyTitle('Expected Title')" },
+  { name: "verifyPartialTitle",    category: "browser",   example: "tSetup.verifyPartialTitle('Expected')" },
+  { name: "getCurrentURL",         category: "browser",   example: "tSetup.getCurrentURL()" },
+  // Input
+  { name: "enterText",             category: "input",     example: "tSetup.enterText('xpath', '//input[...]', 'value')" },
+  { name: "typeText",              category: "input",     example: "tSetup.typeText('xpath', '//input[...]', 'value', '50')" },
+  { name: "clearText",             category: "input",     example: "tSetup.clearText('xpath', '//input[...]')" },
+  { name: "appendText",            category: "input",     example: "tSetup.appendText('xpath', '//input[...]', ' extra')" },
+  { name: "getInputValue",         category: "input",     example: "tSetup.getInputValue('xpath', '//input', 'storeKey')" },
+  { name: "setInputValue",         category: "input",     example: "tSetup.setInputValue('xpath', '//input', 'value')" },
+  { name: "uploadFile",            category: "input",     example: "tSetup.uploadFile('xpath', '//input[@type=\"file\"]', '/path/file.pdf')" },
+  // Click
+  { name: "clickElement",          category: "click",     example: "tSetup.clickElement('xpath', '//button[...]')" },
+  { name: "doubleClick",           category: "click",     example: "tSetup.doubleClick('xpath', '//div[...]')" },
+  { name: "rightClick",            category: "click",     example: "tSetup.rightClick('xpath', '//div[...]')" },
+  { name: "hover",                 category: "click",     example: "tSetup.hover('xpath', '//div[...]')" },
+  { name: "clickByJS",             category: "click",     example: "tSetup.clickByJS('xpath', '//button[...]')" },
+  { name: "clickIfPresent",        category: "click",     example: "tSetup.clickIfPresent('xpath', '//button[...]')" },
+  { name: "dragAndDrop",           category: "click",     example: "tSetup.dragAndDrop('xpath', '//src', 'xpath', '//target')" },
+  { name: "clickByText",           category: "click",     example: "tSetup.clickByText('Sign In')" },
+  { name: "clickNthElement",       category: "click",     example: "tSetup.clickNthElement('xpath', '//li', '2')" },
+  { name: "scrollAndClick",        category: "click",     example: "tSetup.scrollAndClick('xpath', '//button[...]')" },
+  // Dropdown
+  { name: "selectDropdown",        category: "dropdown",  example: "tSetup.selectDropdown('xpath', '//select', 'Option Label')" },
+  { name: "selectByIndex",         category: "dropdown",  example: "tSetup.selectByIndex('xpath', '//select', '2')" },
+  { name: "selectByValue",         category: "dropdown",  example: "tSetup.selectByValue('xpath', '//select', 'optValue')" },
+  { name: "selectCustomDropdown",  category: "dropdown",  example: "tSetup.selectCustomDropdown('xpath', '//div.dd', 'xpath', '//li')" },
+  { name: "selectAutocomplete",    category: "dropdown",  example: "tSetup.selectAutocomplete('xpath', '//input', 'New York', 'xpath', '//li')" },
+  // Assertion
+  { name: "verifyText",            category: "assertion", example: "tSetup.verifyText('xpath', '//h1', 'Welcome')" },
+  { name: "verifyTextContains",    category: "assertion", example: "tSetup.verifyTextContains('xpath', '//p', 'success')" },
+  { name: "verifyVisible",         category: "assertion", example: "tSetup.verifyVisible('xpath', '//div[...]')" },
+  { name: "verifyHidden",          category: "assertion", example: "tSetup.verifyHidden('xpath', '//div[...]')" },
+  { name: "verifyEnabled",         category: "assertion", example: "tSetup.verifyEnabled('xpath', '//button[...]')" },
+  { name: "verifyDisabled",        category: "assertion", example: "tSetup.verifyDisabled('xpath', '//button[...]')" },
+  { name: "verifyURL",             category: "assertion", example: "tSetup.verifyURL('https://example.com/dashboard')" },
+  { name: "verifyPartialURL",      category: "assertion", example: "tSetup.verifyPartialURL('dashboard')" },
+  { name: "verifyElementCount",    category: "assertion", example: "tSetup.verifyElementCount('xpath', '//li', '5')" },
+  { name: "verifyAttribute",       category: "assertion", example: "tSetup.verifyAttribute('xpath', '//input', 'placeholder', 'Email')" },
+  { name: "getText",               category: "assertion", example: "tSetup.getText('xpath', '//h1', 'storeKey')" },
+  // Wait
+  { name: "waitForElement",        category: "wait",      example: "tSetup.waitForElement('xpath', '//div', '10000')" },
+  { name: "waitForElementHidden",  category: "wait",      example: "tSetup.waitForElementHidden('xpath', '//div[@id=\"loader\"]', '10000')" },
+  { name: "waitForURL",            category: "wait",      example: "tSetup.waitForURL('dashboard', '10000')" },
+  { name: "waitForPageLoad",       category: "wait",      example: "tSetup.waitForPageLoad('10000')" },
+  { name: "waitForNetworkIdle",    category: "wait",      example: "tSetup.waitForNetworkIdle('10000')" },
+  { name: "sleep",                 category: "wait",      example: "tSetup.sleep('2000')" },
+  // Keyboard
+  { name: "pressKey",              category: "keyboard",  example: "tSetup.pressKey('Enter')" },
+  { name: "pressKeyOn",            category: "keyboard",  example: "tSetup.pressKeyOn('xpath', '//input', 'Enter')" },
+  { name: "keyCombo",              category: "keyboard",  example: "tSetup.keyCombo('Control+A')" },
+  // Checkbox
+  { name: "checkCheckbox",         category: "checkbox",  example: "tSetup.checkCheckbox('xpath', '//input[@type=\"checkbox\"]')" },
+  { name: "uncheckCheckbox",       category: "checkbox",  example: "tSetup.uncheckCheckbox('xpath', '//input[@type=\"checkbox\"]')" },
+  { name: "selectRadio",           category: "checkbox",  example: "tSetup.selectRadio('xpath', '//input[@type=\"radio\"][@value=\"opt1\"]')" },
+  // Table
+  { name: "getTableRowCount",      category: "table",     example: "tSetup.getTableRowCount('xpath', '//table/tbody/tr', 'rowCount')" },
+  { name: "verifyTableCell",       category: "table",     example: "tSetup.verifyTableCell('xpath', '//table/tbody/tr[1]/td[2]', 'Expected')" },
+  { name: "clickTableRow",         category: "table",     example: "tSetup.clickTableRow('xpath', '//table/tbody/tr', '3')" },
+   { name: "runCustomCode",         category: "customcode",  example: "tSetup.runCustomCode('const result = \"LN\" + Math.floor(Math.random()*1000);', 'result', '//input[@id=\"ref\"]')" },,
+];