feat: saveState improvements

Author: rocketraccoon

src/browser/commands/restoreState/index.ts

@@ -15,7 +15,7 @@ import {
 import { getActivePuppeteerPage } from "../../existing-browser";
 import { Cookie } from "@testplane/wdio-protocols";
 
-export type RestoreStateOptions = SaveStateOptions & {
+export type RestoreStateOptions = Omit<SaveStateOptions, "keepFile"> & {
     data?: SaveStateData;
     refresh?: boolean;
 };

src/browser/commands/saveState/index.ts

@@ -7,6 +7,7 @@ import { ExistingBrowser, getActivePuppeteerPage } from "../../existing-browser"
 import * as logger from "../../../utils/logger";
 import { Cookie } from "../../../types";
 import type { Browser } from "../../types";
+import { MasterEvents } from "../../../events";
 
 export type SaveStateOptions = {
     path?: string;
@@ -16,6 +17,7 @@ export type SaveStateOptions = {
     sessionStorage?: boolean;
 
     cookieFilter?: (cookie: Cookie) => boolean;
+    keepFile?: boolean;
 };
 
 export type FrameData = StorageData;
@@ -29,6 +31,7 @@ export const defaultOptions = {
     cookies: true,
     localStorage: true,
     sessionStorage: true,
+    keepFile: false,
 };
 
 // in case when we use webdriver protocol, bidi and isolation
@@ -178,8 +181,21 @@ export default (browser: ExistingBrowser): void => {
             data.cookies = data.cookies.filter(options.cookieFilter);
         }
 
-        if (options && options.path) {
-            await fs.writeJson(options.path, data, { spaces: 2 });
+        const dataIsEmpty = data.cookies?.length === 0 && _.isEmpty(data.framesData);
+
+        if (options && options.path && !dataIsEmpty) {
+            await fs.outputJson(options.path, data, { spaces: 2 });
+
+            if (options.keepFile) {
+                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,
+                });
+            }
         }
 
         return data;

src/events/index.ts

@@ -44,6 +44,8 @@ export const RunnerSyncEvents = {
 
     DOM_SNAPSHOTS: "domSnapshots",
 
+    ADD_FILE_TO_REMOVE: "addFileToRemove",
+
     TEST_DEPENDENCIES: "testDependencies",
 } as const;
 

src/runner/index.ts

@@ -75,6 +75,7 @@ export class MainRunner extends RunnableEmitter {
             MasterEvents.NEW_WORKER_PROCESS,
             MasterEvents.ERROR,
             MasterEvents.DOM_SNAPSHOTS,
+            MasterEvents.ADD_FILE_TO_REMOVE,
             MasterEvents.TEST_DEPENDENCIES,
         ]);
 

src/testplane.ts

@@ -77,19 +77,28 @@ export class Testplane extends BaseTestplane {
     protected runner: MainRunner | null;
     protected viteServer: ViteServer | null;
 
+    private _filesToRemove: string[];
+
     constructor(config?: string | ConfigInput) {
         super(config);
 
         this.failed = false;
         this.failedList = [];
         this.runner = null;
         this.viteServer = null;
+
+        this._filesToRemove = [];
     }
 
     extendCli(parser: Command): void {
         this.emit(MasterEvents.CLI, parser);
     }
 
+    addFileToRemove(path: string): void {
+        this._filesToRemove.push(path);
+    }
+
+
     protected async _init(): Promise<void> {
         await initDevServer({
             testplane: this,
@@ -155,6 +164,8 @@ export class Testplane extends BaseTestplane {
 
         this.on(MasterEvents.RUNNER_END, async () => await this._saveFailed());
 
+        this.on(MasterEvents.ADD_FILE_TO_REMOVE, this.addFileToRemove);
+
         await initReporters(reporters, this);
 
         eventsUtils.passthroughEvent(this.runner, this, _.values(MasterSyncEvents));
@@ -189,6 +200,10 @@ export class Testplane extends BaseTestplane {
             await this.config.afterAll.call({ config: this.config }, { config: this.config });
         }
 
+        if (this._filesToRemove.length > 0) {
+            await Promise.all(this._filesToRemove.map(path => fs.remove(path)));
+        }
+
         return !this.isFailed();
     }
 

src/types/index.ts

@@ -258,6 +258,7 @@ export type MasterEventHandler<T extends BaseTestplane> = {
     (event: Events["ERROR"], callback: (err: Error) => void): T;
 
     (event: Events["UPDATE_REFERENCE"], callback: (data: { state: string; refImg: RefImageInfo }) => void): T;
+    (event: Events["ADD_FILE_TO_REMOVE"], callback: (path: string) => void): T;
     (event: Events["NEW_BROWSER"], callback: SyncSessionEventCallback): T;
 };
 

src/utils/workers-registry.js

@@ -139,6 +139,10 @@ module.exports = class WorkersRegistry extends EventEmitter {
                     this.emit(MasterEvents.DOM_SNAPSHOTS, data.context, data.data);
                     break;
                 }
+                case MasterEvents.ADD_FILE_TO_REMOVE: {
+                    this.emit(MasterEvents.ADD_FILE_TO_REMOVE, data.data);
+                    break;
+                }
                 case MasterEvents.TEST_DEPENDENCIES: {
                     this.emit(MasterEvents.TEST_DEPENDENCIES, data.context, data.data);
                     break;