feat: add tests + fix for standalone

Author: rocketraccoon

src/browser/commands/saveState/index.ts

@@ -190,11 +190,15 @@ export default (browser: ExistingBrowser): void => {
                 logger.warn(
                     "\x1b[31mPlease be aware that the file containing authorization data will not be automatically deleted after the tests are completed!!!\x1b[0m",
                 );
-            } else if (process.send) {
-                process.send({
-                    event: MasterEvents.ADD_FILE_TO_REMOVE,
-                    data: options.path,
-                });
+            } else {
+                if (process.send) {
+                    process.send({
+                        event: MasterEvents.ADD_FILE_TO_REMOVE,
+                        data: options.path,
+                    });
+                }
+
+                browser.emitter.emit(MasterEvents.ADD_FILE_TO_REMOVE, options.path);
             }
         }
 

src/browser/standalone/attachToBrowser.ts

@@ -1,9 +1,10 @@
 import { Config } from "../../config";
 import { ExistingBrowser } from "./../existing-browser";
 import { Calibrator } from "./../calibrator";
-import { AsyncEmitter } from "../../events";
+import { AsyncEmitter, MasterEvents } from "../../events";
 import { BrowserName, type W3CBrowserName, type SessionOptions } from "./../types";
 import { getNormalizedBrowserName } from "../../utils/browser";
+import fs from "fs-extra";
 
 export async function attachToBrowser(session: SessionOptions): Promise<WebdriverIO.Browser> {
     const browserName = session.sessionCaps?.browserName || BrowserName.CHROME;
@@ -24,6 +25,8 @@ export async function attachToBrowser(session: SessionOptions): Promise<Webdrive
         },
     };
 
+    const filesToRemove: string[] = [];
+
     const config = new Config({
         browsers: {
             [browserName]: browserConfig,
@@ -36,6 +39,10 @@ export async function attachToBrowser(session: SessionOptions): Promise<Webdrive
 
     const emitter = new AsyncEmitter();
 
+    emitter.on(MasterEvents.ADD_FILE_TO_REMOVE, (path: string) => {
+        filesToRemove.push(path);
+    });
+
     const existingBrowser = new ExistingBrowser(config, {
         id: browserName,
         version: session.sessionCaps?.browserVersion,
@@ -54,6 +61,10 @@ export async function attachToBrowser(session: SessionOptions): Promise<Webdrive
         if (session.driverPid) {
             process.kill(session.driverPid, 9);
         }
+
+        if (filesToRemove.length > 0) {
+            await Promise.all(filesToRemove.map(path => fs.remove(path)));
+        }
     });
 
     return existingBrowser.publicAPI;

src/browser/standalone/launchBrowser.ts

@@ -2,12 +2,13 @@ import { Config } from "../../config";
 import { NewBrowser } from "./../new-browser";
 import { ExistingBrowser } from "./../existing-browser";
 import { Calibrator } from "./../calibrator";
-import { AsyncEmitter } from "../../events";
+import { AsyncEmitter, MasterEvents } from "../../events";
 import { BrowserName, type W3CBrowserName } from "./../types";
 import { getNormalizedBrowserName } from "../../utils/browser";
 import { LOCAL_GRID_URL } from "../../constants/config";
 import { WebdriverPool } from "../../browser-pool/webdriver-pool";
 import type { StandaloneBrowserOptionsInput } from "./types";
+import fs from "fs-extra";
 
 const webdriverPool = new WebdriverPool();
 
@@ -50,6 +51,8 @@ export async function launchBrowser(
         prepareBrowser: options.prepareBrowser,
     };
 
+    const filesToRemove: string[] = [];
+
     const config = new Config({
         browsers: {
             [browserName]: browserConfig,
@@ -62,6 +65,10 @@ export async function launchBrowser(
 
     const emitter = new AsyncEmitter();
 
+    emitter.on(MasterEvents.ADD_FILE_TO_REMOVE, (path: string) => {
+        filesToRemove.push(path);
+    });
+
     const newBrowser = new NewBrowser(config, {
         id: browserName,
         version: desiredCapabilities.browserVersion,
@@ -97,6 +104,10 @@ export async function launchBrowser(
     existingBrowser.publicAPI.overwriteCommand("deleteSession", async function () {
         await existingBrowser.quit();
         await newBrowser.kill();
+
+        if (filesToRemove.length > 0) {
+            await Promise.all(filesToRemove.map(path => fs.remove(path)));
+        }
     });
 
     existingBrowser.publicAPI.addCommand("getDriverPid", () => newBrowser.getDriverPid());

test/integration/standalone/standalone-save-state.test.ts

@@ -1,3 +1,4 @@
+import fs from "fs";
 import { strict as assert } from "assert";
 import { launchBrowser } from "../../../src/browser/standalone";
 import { BROWSER_CONFIG, BROWSER_NAME } from "./constants";
@@ -96,6 +97,46 @@ type AutomationProtocol = typeof DEVTOOLS_PROTOCOL | typeof WEBDRIVER_PROTOCOL;
                     assert.strictEqual(await status.getText(), "You are logged in");
                 });
 
+                it("saveState: {keepFile: true}", async function () {
+                    await browser.saveState({
+                        keepFile: true,
+                        path: "./state.json",
+                    });
+
+                    await browser.deleteSession();
+
+                    const fileExist = fs.existsSync("./state.json");
+                    assert.strictEqual(fileExist, true);
+                    fs.rmSync("./state.json");
+                });
+
+                it("saveState: {keepFile: false}", async function () {
+                    await browser.saveState({
+                        keepFile: false,
+                        path: "./state.json",
+                    });
+
+                    await browser.deleteSession();
+
+                    const fileExist = fs.existsSync("./state.json");
+                    assert.strictEqual(fileExist, false);
+                });
+
+                it("saveState: emptyState", async function () {
+                    await browser.saveState({
+                        keepFile: true,
+                        cookieFilter: () => false,
+                        path: "./state.json",
+                        localStorage: false,
+                        sessionStorage: false,
+                    });
+
+                    await browser.deleteSession();
+
+                    const fileExist = fs.existsSync("./state.json");
+                    assert.strictEqual(fileExist, false);
+                });
+
                 it("restoreState", async function () {
                     if (loginState) {
                         removeDomainFromCookies(loginState);