ff-automationv2 2.1.1 → 2.1.3-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ff-automationv2",
-  "version": "2.1.1",
+  "version": "2.1.3-beta.0",
   "private": false,
   "type": "module",
   "description": "This lib is used to automate the manual testcase",

package/src/automation/actions/executor.ts

@@ -17,7 +17,7 @@ export class ActionExecutor implements IActionExecutor {
 
     async navigate(url: string): Promise<void> {
         await navigate({
-            browser: this.browser,
+            driver: this.browser,
             url,
             scriptDataAppender: this.scriptDataAppender
         });
@@ -25,14 +25,14 @@ export class ActionExecutor implements IActionExecutor {
 
     async goBack(): Promise<void> {
         await goBack({
-            browser: this.browser,
+            driver: this.browser,
             scriptDataAppender: this.scriptDataAppender
         });
     }
 
     async refresh(): Promise<void> {
         await pageRefresh({
-            browser: this.browser,
+            driver: this.browser,
             scriptDataAppender: this.scriptDataAppender
         });
     }
@@ -40,14 +40,14 @@ export class ActionExecutor implements IActionExecutor {
 
     async wait(time: string): Promise<void> {
         await wait({
-            browser: this.browser,
+            driver: this.browser,
             time,
             scriptDataAppender: this.scriptDataAppender
         });
     }
     async click(pageDOM: string, selector: string, fireflinkIndex: string, elementName: string, elementType: string): Promise<void> {
         await click({
-            browser: this.browser,
+            driver: this.browser,
             selector,
             scriptDataAppender: this.scriptDataAppender,
             elementGetter: this.elementGetter,
@@ -60,7 +60,7 @@ export class ActionExecutor implements IActionExecutor {
     }
     async enterInput(selector: string, value: string, fireflinkIndex: string, pageDOM: string, elementName: string, elementType: string): Promise<void> {
         await enterInput({
-            browser: this.browser,
+            driver: this.browser,
             selector: selector,
             value,
             scriptDataAppender: this.scriptDataAppender,

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

@@ -1,7 +1,7 @@
 import { ClickInterface } from "../interface/interactionActionInterface.js";
 export async function click(args: ClickInterface): Promise<void> {
     try {
-        const element = await args.browser.$(args.selector);
+        const element = await args.driver.$(args.selector);
         await element.scrollIntoView({ block: 'center', inline: 'center' });
         await element.click();
         const ffElement: any = await args.elementGetter.getFireFlinkElement(

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

@@ -1,7 +1,7 @@
 import { EnterInputInterface } from "../interface/interactionActionInterface.js";
 export async function enterInput(args: EnterInputInterface): Promise<void> {
     try {
-        const element = args.browser.$(args.selector);
+        const element = args.driver.$(args.selector);
         await element.scrollIntoView({ block: 'center', inline: 'center' });
         await element.setValue(args.value);
         const ffElement: any = await args.elementGetter.getFireFlinkElement(

package/src/automation/actions/interface/interactionActionInterface.ts

@@ -1,7 +1,7 @@
 import { ScriptDataAppender } from "../../../fireflinkData/fireflinkScript/scriptGenrationData.js";
 import { ElementGetter } from "../../../fireflinkData/fireflinkLocators/getListOfLocators.js";
 export interface ClickInterface {
-  browser: WebdriverIO.Browser;
+  driver: WebdriverIO.Browser;
   selector: string;
   scriptDataAppender: ScriptDataAppender;
   elementGetter: ElementGetter;
@@ -14,7 +14,7 @@ export interface ClickInterface {
 
 
 export interface EnterInputInterface {
-  browser: WebdriverIO.Browser;
+  driver: WebdriverIO.Browser;
   selector: string;
   value: string;
   scriptDataAppender: ScriptDataAppender;

package/src/automation/actions/interface/navigationActionInterface.ts

@@ -1,22 +1,22 @@
 import { ScriptDataAppender } from "../../../fireflinkData/fireflinkScript/scriptGenrationData.js";
 
 export interface getTitleInterface {
-  browser: WebdriverIO.Browser;
+  driver: WebdriverIO.Browser;
   scriptDataAppender: ScriptDataAppender;
 }
 
 export interface goBackInterface {
-  browser: WebdriverIO.Browser;
+  driver: WebdriverIO.Browser;
   scriptDataAppender: ScriptDataAppender;
 }
 
 export interface navigateToUrlInterface {
-  browser: WebdriverIO.Browser;
+  driver: WebdriverIO.Browser;
   scriptDataAppender: ScriptDataAppender;
     url: string;
 }
 
 export interface refreshInterface {
-  browser: WebdriverIO.Browser;
+  driver: WebdriverIO.Browser;
   scriptDataAppender: ScriptDataAppender;
 }

package/src/automation/actions/interface/waitActionInterface.ts

@@ -1,6 +1,6 @@
 import { ScriptDataAppender } from "../../../fireflinkData/fireflinkScript/scriptGenrationData.js";
 export interface waitInterface {
-    browser: WebdriverIO.Browser;
+    driver: WebdriverIO.Browser;
     scriptDataAppender: ScriptDataAppender;
     time: string;
 }

package/src/automation/actions/navigation/getTitle.ts

@@ -1,7 +1,7 @@
 import { getTitleInterface } from "../interface/navigationActionInterface.js";
 export async function getTitle(args: getTitleInterface): Promise<void> {
     try {
-        const title = await args.browser.getTitle();
+        const title = await args.driver.getTitle();
         args.scriptDataAppender.add({ nlpName: 'getTitle', elementsData: [], stepInputs: [title] });
     } catch (error: any) {
         throw new Error("Get title action failed", { cause: error });

package/src/automation/actions/navigation/goBack.ts

@@ -1,7 +1,7 @@
 import { goBackInterface } from "../interface/navigationActionInterface.js";
 export async function goBack(args: goBackInterface): Promise<void> {
     try {
-        await args.browser.back();
+        await args.driver.back();
         args.scriptDataAppender.add({ nlpName: 'goBack', elementsData: [], stepInputs: [] });
     } catch (error: any) {
         throw new Error("Navigate action failed", { cause: error });

package/src/automation/actions/navigation/navigate.ts

@@ -1,7 +1,7 @@
 import { navigateToUrlInterface } from "../interface/navigationActionInterface.js";
 export async function navigate(args: navigateToUrlInterface): Promise<void> {
     try {
-        await args.browser.url(args.url);
+        await args.driver.url(args.url);
         args.scriptDataAppender.add({ nlpName: 'NavigateToURL', elementsData: [], stepInputs: [args.url] });
 
     } catch (error: any) {

package/src/automation/actions/navigation/refresh.ts

@@ -1,7 +1,7 @@
 import { refreshInterface } from "../interface/navigationActionInterface.js";
 export async function pageRefresh(args: refreshInterface): Promise<void> {
     try {
-        await args.browser.refresh();
+        await args.driver.refresh();
         args.scriptDataAppender.add({ nlpName: 'refresh', elementsData: [], stepInputs: [] });
     } catch (error: any) {
         throw new Error("Refresh action failed", { cause: error });

package/src/automation/actions/wait/wait.ts

@@ -1,7 +1,7 @@
 import { waitInterface } from "../interface/waitActionInterface.js";
 export async function wait(args: waitInterface): Promise<void> {
     try {
-        await args.browser.pause(Number(args.time) * 1000);
+        await args.driver.pause(Number(args.time) * 1000);
         args.scriptDataAppender.add({ nlpName: 'Sleep', elementsData: [], stepInputs: [args.time] });
 
     } catch (error: any) {

package/src/automation/browserSession/initiateBrowserSession.ts

@@ -6,7 +6,7 @@ export class BrowserSession {
 
     private async openBrowser(capabilities: browserCapabilities): Promise<WebdriverIO.Browser> {
         try {
-            const browser = await remote(
+            const driver = await remote(
                 {
                     capabilities: {
                         browserName: capabilities.browserName,
@@ -14,13 +14,13 @@ export class BrowserSession {
                     logLevel: "silent"
                 }
             );
-            browser.setTimeout({ 'pageLoad': capabilities.pageLoad, 'implicit': capabilities.implicit });
-            await browser.waitUntil(async () => {
-                const state = await browser.execute(() => document.readyState);
+            driver.setTimeout({ 'pageLoad': capabilities.pageLoad, 'implicit': capabilities.implicit });
+            await driver.waitUntil(async () => {
+                const state = await driver.execute(() => document.readyState);
                 return state === "complete";
             });
 
-            return browser;
+            return driver;
         } catch (error: any) {
             throw new Error("Browser failed to open", { cause: error });
         }

package/src/core/main/runAutomationScript.ts

@@ -14,12 +14,64 @@ import { DomProcessingEngine } from "../../domAnalysis/getRelaventElements.js"
 import { getAnnotatedDOM } from "../../utils/DomExtraction/jsForAttributeInjection.js"
 import { logger } from "../../utils/logger/logData.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]
+  }
+  static updateSessionTerminationInfo(testCaseId: string): void {
+    AutomationRunner.sessionTerminationDetails[testCaseId] = true
+  }
+
+  private async cleanup(
+    context: ExecutionContext,
+    domInfo: any,
+    extractedRelevantDom: any,
+    stepProcessor: StepProcessor,
+    scriptRunner: ScriptRunner
+  ) {
+    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);
+        }
+      }
+
+      domInfo = null;
+      extractedRelevantDom = null;
+
+      if (stepProcessor) {
+        (stepProcessor as any).llm = null;
+      }
+
+      scriptRunner = null as any;
+
+      delete AutomationRunner.sessionTerminationDetails[this.request.testCaseId];
+
+      if (global.gc) {
+        global.gc();
+      }
+
+      logger.info("Cleanup completed successfully.");
+    }
+    catch (error) {
+      logger.error("Cleanup error:", error);
+    }
+  }
+
 
   async run(): Promise<void> {
     const apiService = new FireFlinkApiService();
@@ -47,6 +99,8 @@ export class AutomationRunner implements IAutomationRunner {
     }
     for (const step of listOfSteps) {
       try {
+        if (AutomationRunner.getSessionTerminationInfo(this.request.testCaseId)) { break; }
+
         const start = Math.max(0, stepCount - 3);
         const end = Math.min(listOfSteps.length, stepCount + 3);
         const priorAndNextSteps = listOfSteps.slice(start, end);
@@ -96,8 +150,8 @@ export class AutomationRunner implements IAutomationRunner {
         }
 
 
-        const browser = await context.session.getCurrentBrowser();
-        domInfo = await getAnnotatedDOM(browser);
+        const driver = await context.session.getCurrentBrowser();
+        domInfo = await getAnnotatedDOM(driver);
         await logger.saveDOM(domInfo.dom, `annotated-dom-${stepCount}`);
 
         extractedRelevantDom = domProcessor.process({
@@ -184,5 +238,14 @@ export class AutomationRunner implements IAutomationRunner {
         "Failed to send payload to FireFlink API:", { cause: error }
       );
     }
+    finally {
+      await this.cleanup(
+        context,
+        domInfo,
+        extractedRelevantDom,
+        stepProcessor,
+        scriptRunner
+      );
+    }
   }
 }