ff-automationv2 2.1.3-beta.5 → 2.1.3-beta.7

package/RELEASE_GUIDE.md

@@ -3,7 +3,7 @@
 git checkout feature/your-feature-name
 git add .
 git commit -m "feat: new changes"
-git pull --rebase
+git pull 
 npm version prerelease --preid=beta
 git push --follow-tags
 

package/eslint.config.ts

@@ -4,6 +4,9 @@ import tseslint from "typescript-eslint";
 import { defineConfig } from "eslint/config";
 
 export default defineConfig([
+  {
+    ignores: ["src/tests/**", "dist/**", "node_modules/**"]
+  },
   {
     files: ["**/*.{js,mjs,cjs,ts,mts,cts}"],
     plugins: { js },
@@ -15,6 +18,7 @@ export default defineConfig([
 
   {
     rules: {
+      "no-useless-escape": "off",
       "no-console": ["error", { allow: ["warn", "error"] }],
       "@typescript-eslint/no-explicit-any": "off",
       "@typescript-eslint/no-unused-vars": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ff-automationv2",
-  "version": "2.1.3-beta.5",
+  "version": "2.1.3-beta.7",
   "private": false,
   "type": "module",
   "description": "This lib is used to automate the manual testcase",
@@ -14,7 +14,7 @@
   },
   "scripts": {
     "builds": "npm run lint && tsc",
-    "build": "tsc --pretty --listEmittedFiles && echo Build Successful",
+    "build": "npm run lint && tsc --pretty --listEmittedFiles && echo Build Successful",
     "prepare": "npm run build",
     "lint": "eslint src --max-warnings=0",
     "test": "npm run build && node dist/tests/test12.js",

package/src/ai/llmprompts/systemPrompts/verifyActionExtractorPrompt.ts

@@ -1,7 +1,5 @@
-type verifyActionArgs = {
-    extractedDomJson: string;
-    priorAndNextSteps: string[];
-}
+import { verifyActionArgs } from "../../../core/types/promptType.js"
+
 
 export async function verifyActionExtractorPrompt({
     extractedDomJson,
@@ -41,7 +39,7 @@ export async function verifyActionExtractorPrompt({
 
     const elementType = ['link', 'textfield', 'icon', 'button', 'radioButton', 'text', 'textarea', 'image', 'dropdown', 'checkbox', 'tab', 'action overflow button', 'hamburger icon', 'toggle button', 'suggestion', 'time picker', 'date picker', 'toaster message', 'card', 'tooltip', 'option', 'calender', 'sliders', 'visual testing'];
     const prompt = `You are an intelligent assistant that extracts structured UI action data.
-Given the step, the simplified DOM: ${extractedDomJson}, and the list of NLP names: {nlp_list}.
+Given the step, the simplified DOM: ${extractedDomJson}, and the list of NLP names: ${nlpList}.
 
 Select the perfect matching NLP name from the list that best fits the step's intent.
 **The NLP name must match exactly one value from the approved NLP list. Do not generate or suggest any new NLP names under any condition.**

package/src/automation/actions/executor.ts

@@ -10,6 +10,7 @@ import { clear } from "./interaction/clear/clear.js";
 import { clearAndEnter } from "./interaction/clear/clearAndEnter.js";
 import { ScriptDataAppender } from "../../fireflinkData/fireflinkScript/scriptGenrationData.js";
 import { ElementGetter } from "../../fireflinkData/fireflinkLocators/getListOfLocators.js";
+import { logger } from "../../utils/logger/logData.js"
 export class ActionExecutor implements IActionExecutor {
     constructor(private readonly browser: WebdriverIO.Browser,
         private scriptDataAppender: ScriptDataAppender,
@@ -27,7 +28,9 @@ export class ActionExecutor implements IActionExecutor {
             });
         }
         catch (error) {
-            throw new Error(`Click action failed ${error}`);
+            logger.error("Error in [ActionExecutor]", error)
+
+            throw error;
         }
     }
 
@@ -39,7 +42,9 @@ export class ActionExecutor implements IActionExecutor {
             });
         }
         catch (error) {
-            throw new Error(`Click action failed ${error}`);
+            logger.error("Error in [ActionExecutor]", error)
+
+            throw error;
         }
     }
 
@@ -51,7 +56,9 @@ export class ActionExecutor implements IActionExecutor {
             });
         }
         catch (error) {
-            throw new Error(`Click action failed ${error}`);
+            logger.error("Error in [ActionExecutor]", error)
+
+            throw error;
         }
     }
 
@@ -65,7 +72,9 @@ export class ActionExecutor implements IActionExecutor {
             });
         }
         catch (error) {
-            throw new Error(`Click action failed ${error}`);
+            logger.error("Error in [ActionExecutor]", error)
+
+            throw error;
         }
     }
     async click(pageDOM: string, selector: string, fireflinkIndex: string, elementName: string, elementType: string): Promise<void> {
@@ -83,7 +92,9 @@ export class ActionExecutor implements IActionExecutor {
             });
         }
         catch (error) {
-            throw new Error(`Click action failed ${error}`);
+            logger.error("Error in [ActionExecutor]", error)
+
+            throw error;
         }
     }
     async enterInput(selector: string, value: string, fireflinkIndex: string, pageDOM: string, elementName: string, elementType: string): Promise<void> {
@@ -102,7 +113,9 @@ export class ActionExecutor implements IActionExecutor {
             });
         }
         catch (error) {
-            throw new Error(`Click action failed ${error}`);
+            logger.error("Error in [ActionExecutor]", error)
+
+            throw error;
         }
     }
     async maximize(): Promise<void> {
@@ -113,7 +126,9 @@ export class ActionExecutor implements IActionExecutor {
             });
         }
         catch (error) {
-            throw new Error(`Click action failed ${error}`);
+            logger.error("Error in [ActionExecutor]", error)
+
+            throw error;
         }
     }
 
@@ -132,7 +147,9 @@ export class ActionExecutor implements IActionExecutor {
             });
         }
         catch (error) {
-            throw new Error(`Click action failed ${error}`);
+            logger.error("Error in [ActionExecutor]", error)
+
+            throw error;
         }
     }
 
@@ -152,7 +169,9 @@ export class ActionExecutor implements IActionExecutor {
             });
         }
         catch (error) {
-            throw new Error(`Click action failed ${error}`);
+            logger.error("Error in [ActionExecutor]", error)
+
+            throw error;
         }
     }
 

package/src/automation/actions/interaction/clear/clear.ts

@@ -22,7 +22,6 @@ export async function clear(args: clearActionInterface): Promise<void> {
 
     }
     catch (error: any) {
-        console.log(error);
         throw new Error("clear action failed", { cause: error });
 
     }

package/src/automation/actions/interaction/clear/clearAndEnter.ts

@@ -1,6 +1,4 @@
 import { clearAndEnterActionInterface } from "../../interface/clearActionInterface.js";
-import { logger } from "../../../../utils/logger/logData.js";
-
 export async function clearAndEnter(args: clearAndEnterActionInterface): Promise<void> {
     try {
 
@@ -25,7 +23,6 @@ export async function clearAndEnter(args: clearAndEnterActionInterface): Promise
         });
 
     } catch (error: any) {
-        console.log(error);
         throw new Error("clear and enter action failed", { cause: error });
     }
 }

package/src/automation/actions/interaction/click.ts

@@ -20,6 +20,6 @@ export async function click(args: ClickInterface): Promise<void> {
                 }]
             });
     } catch (error: any) {
-        throw new Error(`Click action failed ${error}`);
+        throw new Error(`Click action failed :`, { cause: error });
     }
 }

package/src/automation/actions/interaction/enterInput.ts

@@ -29,7 +29,7 @@ export async function enterInput(args: EnterInputInterface): Promise<void> {
 
     }
     catch (error: any) {
-        throw new Error(`enter action failed ${error}`);
+        throw new Error(`enter action failed:`, { cause: error });
     }
 
 }

package/src/core/constants/allAction.ts

@@ -0,0 +1,14 @@
+export const allKeywordAction =
+    ["enter",
+        "wait",
+        "verify",
+        "scroll",
+        "navigate",
+        "click",
+        "maximize",
+        "get",
+        "upload",
+        "close", "open",
+        "drag_and_drop",
+        "switch",
+        "cleartext"];

package/src/core/interfaces/automationRunnerInterface.ts

@@ -1,3 +1,4 @@
+import { AutomationRequest } from "../../core/interfaces/executionDetails.js";
 export interface IAutomationRunner {
-  run(): Promise<void>;
+  run(args:AutomationRequest): Promise<void>;
 }

package/src/core/main/actionHandlerFactory.ts

@@ -1,6 +1,6 @@
 import { ExecutionContext } from "../main/executionContext.js";
 import { ActionExecutor } from "../../automation/actions/executor.js";
-
+import { logger } from "../../utils/logger/logData.js"
 type ActionHandler = (result?: any) => Promise<void>;
 
 export function createActionHandlers(
@@ -24,12 +24,12 @@ export function createActionHandlers(
                     await fn(executor, result);
                 }
                 catch (error) {
-                    throw new Error(`Error occuried in createActionHandlers , error : ${error}`)
+                    logger.error("Error in createActionHandlers", error)
+                    throw error
                 }
             };
 
     return {
-
         open: async () => {
             try {
                 await context.session.open({
@@ -52,7 +52,10 @@ export function createActionHandlers(
                 });
             }
             catch (error) {
-                throw new Error(`Error occuried in createActionHandlers , error : ${error}`)
+
+                logger.error("Error in createActionHandlers", error)
+
+                throw error;
             }
         },
 
@@ -61,7 +64,9 @@ export function createActionHandlers(
                 await context.session.close();
             }
             catch (error) {
-                throw new Error(`Error occuried in createActionHandlers , error : ${error}`)
+                logger.error("Error in createActionHandlers", error)
+
+                throw error;
             }
         },
 

package/src/core/main/runAutomationScript.ts

@@ -13,15 +13,14 @@ import { INPUTLESS_ACTIONS, ELEMENTLESS_ACTION } from "../constants/supportedAct
 import { DomProcessingEngine } from "../../domAnalysis/getRelaventElements.js"
 import { getAnnotatedDOM } from "../../utils/DomExtraction/jsForAttributeInjection.js"
 import { logger } from "../../utils/logger/logData.js"
+import { allKeywordAction } from "../constants/allAction.js";
 export class AutomationRunner implements IAutomationRunner {
   static sessionTerminationDetails: Record<string, boolean> = {};
   constructor(
-    private readonly request: AutomationRequest,
     private pageLoad: number = 20000,
     private implicit: number = 15000,
-    private tokensConsumed: number = 0
 
-  ) { AutomationRunner.sessionTerminationDetails[request.testCaseId] = false }
+  ) { }
 
   static getSessionTerminationInfo(testCaseId: string): boolean {
     return AutomationRunner.sessionTerminationDetails[testCaseId]
@@ -35,18 +34,17 @@ export class AutomationRunner implements IAutomationRunner {
     domInfo: any,
     extractedRelevantDom: any,
     stepProcessor: StepProcessor,
-    scriptRunner: ScriptRunner
+    scriptRunner: ScriptRunner,
+    request: AutomationRequest
   ) {
     try {
       logger.info("Starting cleanup process...");
       if (context?.session) {
         try {
           const browser = await context.session.getCurrentBrowser();
-          // if (browser) {
-          //   await browser.deleteSession?.();
-          // }
-        } catch (e) {
-          logger.error("Browser cleanup failed:", e);
+          logger.info("Still browser session is active, session id :", browser.sessionId)
+        } catch (error) {
+          logger.error("Browser cleanup failed:", error);
         }
       }
 
@@ -59,7 +57,7 @@ export class AutomationRunner implements IAutomationRunner {
 
       scriptRunner = null as any;
 
-      delete AutomationRunner.sessionTerminationDetails[this.request.testCaseId];
+      delete AutomationRunner.sessionTerminationDetails[request.testCaseId];
 
       if (global.gc) {
         global.gc();
@@ -73,18 +71,19 @@ export class AutomationRunner implements IAutomationRunner {
   }
 
 
-  async run(): Promise<void> {
+  async run(request: AutomationRequest): Promise<void> {
+    AutomationRunner.sessionTerminationDetails[request.testCaseId] = false;
     const apiService = new FireFlinkApiService();
     const scriptRunner = new ScriptRunner(apiService);
-    const context = new ExecutionContext(this.request);
+    const context = new ExecutionContext(request);
     const configProvider = new ServiceProviderBaseUrlProvider();
-    const baseUrl = configProvider.getBaseUrl(this.request.serviceProvider);
+    const baseUrl = configProvider.getBaseUrl(request.serviceProvider);
     let domInfo: any = null;
     let extractedRelevantDom: any = null;
-    const llm = new llmAction(this.request.apiKey, baseUrl, this.request.model, this.request.visionApikey);
+    const llm = new llmAction(request.apiKey, baseUrl, request.model, request.visionApikey);
     const stepProcessor = new StepProcessor(llm);
 
-    const stepResult = await stepProcessor.getLLMResponse({ type: PromptType.USER_STORY_TO_LIST, args: {}, input: { userStory: this.request.userStory } });
+    const stepResult = await stepProcessor.getLLMResponse({ type: PromptType.USER_STORY_TO_LIST, args: {}, input: { userStory: request.userStory } });
 
     const actionHandlers = createActionHandlers(
       context,
@@ -97,40 +96,25 @@ export class AutomationRunner implements IAutomationRunner {
     if (listOfSteps.length == 0) {
       throw new Error("No executable manual steps were returned by the LLM.");
     }
-
-    logger.info(listOfSteps)
-    const allKeywordAction = ["enter", "wait", "verify", "scroll", "navigate", "click", "maximize", "get", "upload", "close", "open", "drag_and_drop", "switch", "cleartext"];
-
+    logger.info("Test steps for execution ", listOfSteps)
     for (const step of listOfSteps) {
       try {
-        if (AutomationRunner.getSessionTerminationInfo(this.request.testCaseId)) { break; }
-
-        logger.info
-          (
-            `Processing step ${stepCount}: "${step}"`
-          );
-
+        if (AutomationRunner.getSessionTerminationInfo(request.testCaseId)) { break; }
+        logger.info(`Processing step ${stepCount}: ${step}`);
         const start = Math.max(0, stepCount - 3);
         const end = Math.min(listOfSteps.length, stepCount + 3);
         const priorAndNextSteps = listOfSteps.slice(start, end);
-
         const result = await stepProcessor.getLLMResponse({
           type: PromptType.KEYWORD_EXTRACTOR,
           args: { priorAndNextSteps },
           input: { currentStep: step }
         });
-
         logger.info(JSON.stringify(result, null, 2))
-
         const action = result.response.action?.toLowerCase();
-
         if (!allKeywordAction.includes(action)) {
           throw new Error(`Unsupported action at action or keyword exracter: ${action}`);
         }
-
         let handler = actionHandlers[action];
-
-
         if (INPUTLESS_ACTIONS.includes(action)) {
           await handler(result);
           stepCount++;
@@ -156,18 +140,16 @@ export class AutomationRunner implements IAutomationRunner {
         }
         const driver = await context.session.getCurrentBrowser();
         domInfo = await getAnnotatedDOM(driver);
-        await logger.saveDOM(domInfo.dom, `annotated-dom-${stepCount}`);
-
+        logger.saveDOM(domInfo.dom, `annotated-dom-${stepCount}`);
         extractedRelevantDom = domProcessor.process({
           keywords: result.response.keywords,
           rawDom: domInfo.dom,
           stepCount: stepCount
         });
-
-        await logger.saveJSON(extractedRelevantDom, `relevant-dom-${stepCount}`);
+        logger.saveJSON(extractedRelevantDom, `relevant-dom-${stepCount}`);
         let stepResult: any;
         if (action == "verify") {
-          const stepResult = await stepProcessor.getLLMResponse({
+          stepResult = await stepProcessor.getLLMResponse({
             type: PromptType.VERIFY_PROMPT,
             args: {
               extractedDomJson: JSON.stringify(extractedRelevantDom, null, 2),
@@ -224,35 +206,35 @@ export class AutomationRunner implements IAutomationRunner {
           elementsData: [],
           stepInputs: []
         });
-
         logger.error(`Error executing step "${step}":`, error);
         break;
       }
     }
     const payload: IPayload = {
-      scriptName: this.request.scriptName,
-      scriptType: this.request.scriptType,
-      projectId: this.request.projectId,
-      testCaseId: this.request.testCaseId,
-      promptId: this.request.promptId,
-      pageDetails: this.request.pageDetails,
-      generatedBy: this.request.generatedBy,
-      webSocketId: this.request.webSocketId,
-      licenseType: this.request.licenseType,
-      licenseId: this.request.licenseId,
-      userId: this.request.userId,
-      topic: this.request.topic,
-      projectType: this.request.projectType,
+      scriptName: request.scriptName,
+      scriptType: request.scriptType,
+      projectId: request.projectId,
+      testCaseId: request.testCaseId,
+      promptId: request.promptId,
+      pageDetails: request.pageDetails,
+      generatedBy: request.generatedBy,
+      webSocketId: request.webSocketId,
+      licenseType: request.licenseType,
+      licenseId: request.licenseId,
+      userId: request.userId,
+      topic: request.topic,
+      projectType: request.projectType,
       tokensConsumed: (await stepProcessor.getResultTokenUsage()).totalTokens,
     }
     try {
-      // await scriptRunner.runScriptFromPayload(
-      //   context.scriptAppender.getData(),
-      //   payload,
-      //   this.request.token,
-      //   this.request.serverHost
-      // );
+      await scriptRunner.runScriptFromPayload(
+        context.scriptAppender.getData(),
+        payload,
+        request.token,
+        request.serverHost
+      );
     } catch (error: any) {
+
       throw new Error(
         "Failed to send payload to FireFlink API:", { cause: error }
       );
@@ -263,7 +245,8 @@ export class AutomationRunner implements IAutomationRunner {
         domInfo,
         extractedRelevantDom,
         stepProcessor,
-        scriptRunner
+        scriptRunner,
+        request
       );
     }
   }

package/src/core/types/promptType.ts

@@ -6,3 +6,9 @@ export enum PromptType {
     VISION_PROMPT = "visionPrompt",
     VERIFY_PROMPT = "verifyActionExtractorPrompt"
 }
+
+
+export type verifyActionArgs = {
+    extractedDomJson: string;
+    priorAndNextSteps: string[];
+}

package/src/domAnalysis/searchBest.ts

@@ -1,3 +1,4 @@
+
 import * as fuzz from "fuzzball";
 
 import { FlatNode } from "./simplifyAndFlatten.js";

package/src/utils/DomExtraction/jsForAttributeInjection.ts

@@ -1,12 +1,11 @@
-import type { Browser } from "webdriverio";
-
+import { logger } from "../../utils/logger/logData.js"
 export interface AnnotatedDOMResult {
     dom: string;
     selectors: Record<string, string>;
 }
 
 export async function getAnnotatedDOM(
-    browser: Browser
+    browser: WebdriverIO.Browser
 ): Promise<AnnotatedDOMResult> {
 
     return await browser.execute<AnnotatedDOMResult, []>(() => {
@@ -32,9 +31,9 @@ export async function getAnnotatedDOM(
                 [rect.left + rect.width / 2, rect.top + rect.height / 2]
             ];
 
-            for (let [x, y] of testPoints) {
+            for (const [x, y] of testPoints) {
 
-                let topEl = document.elementFromPoint(x, y);
+                const topEl = document.elementFromPoint(x, y);
                 if (!topEl) continue;
 
                 if (topEl === el || el.contains(topEl)) continue;
@@ -115,7 +114,7 @@ export async function getAnnotatedDOM(
 
             if (!node || node.nodeType !== 1) return "";
 
-            let segments: string[] = [];
+            const segments: string[] = [];
             let current: Element | null = node;
 
             while (current && current.nodeType === 1) {
@@ -300,7 +299,10 @@ export async function getAnnotatedDOM(
                             doc.documentElement
                         );
                     }
-                } catch { }
+                } catch (error) {
+
+                    logger.error("Attribute injection failed", error)
+                }
             }
 
             el.childNodes.forEach(child => {

package/src/utils/helpers/enterActionHelper.ts

@@ -32,7 +32,7 @@ export const enterActionHelper = (
         return el?.getAttribute("ff-xpath") || "";
     };
 
-    let element = doc.querySelector(
+    const element = doc.querySelector(
         `[ff-inspect="Fire-Flink-${numericFF}"]`
     );
 

package/src/utils/logger/logData.ts

@@ -40,15 +40,38 @@ export const logger = {
 
         fs.appendFileSync(logFilePath, message, "utf-8");
     },
-
     error: (...args: any[]) => {
-        const formattedArgs = args.map(arg =>
-            typeof arg === "object"
-                ? JSON.stringify(arg, null, 2)
-                : arg
-        );
+        const formatted = args.map(arg => {
+            if (arg instanceof Error) {
+                let output = arg.stack || `${arg.name}: ${arg.message}`;
+                output = output.replace(
+                    /invalid session id:\s*invalid session id:/gi,
+                    "invalid session id:"
+                );
+
+                if (arg.cause instanceof Error) {
+                    let causeStack = arg.cause.stack || "";
+
+                    causeStack = causeStack.replace(
+                        /invalid session id:\s*invalid session id:/gi,
+                        "invalid session id:"
+                    );
+
+                    output += `\nCaused by: ${causeStack}`;
+                }
+
+                return output;
+            }
+
+            if (typeof arg === "object") {
+                return JSON.stringify(arg, null, 2);
+            }
+
+            return String(arg);
+        });
 
-        const message = `[ERROR] ${istDate}+05:30 - ${formattedArgs.join(" ")}\n`;
+        const message =
+            `[ERROR] ${new Date().toISOString()} - ${formatted.join(" ")}\n`;
 
         fs.appendFileSync(logFilePath, message, "utf-8");
     },