fix(testplane): fix save/restore state

sonic16x · web-flow · commit 37396e12570a · 2025-11-11T16:44:51.000+07:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -101,7 +101,6 @@
     "png-validator": "1.1.0",
     "recast": "0.23.6",
     "resolve.exports": "2.0.2",
-    "set-cookie-parser": "2.7.1",
     "sizzle": "2.3.6",
     "socket.io": "4.7.5",
     "socket.io-client": "4.7.5",
diff --git a/src/browser/commands/restoreState/index.ts b/src/browser/commands/restoreState/index.ts
@@ -7,7 +7,7 @@ import type { Browser } from "../../types";
 import { DEVTOOLS_PROTOCOL, WEBDRIVER_PROTOCOL } from "../../../constants/config";
 import {
     defaultOptions,
-    getCalculatedProtocol,
+    getOverridesProtocol,
     getWebdriverFrames,
     SaveStateData,
     SaveStateOptions,
@@ -48,7 +48,7 @@ export default (browser: Browser): void => {
             restoreState.cookies = restoreState?.cookies.filter(options.cookieFilter);
         }
 
-        switch (getCalculatedProtocol(browser)) {
+        switch (getOverridesProtocol(browser)) {
             case WEBDRIVER_PROTOCOL: {
                 await session.switchToParentFrame();
 
diff --git a/src/browser/commands/saveState/index.ts b/src/browser/commands/saveState/index.ts
@@ -1,13 +1,12 @@
 import fs from "fs-extra";
 
 import _ from "lodash";
-import type { Browser } from "../../types";
 import { dumpStorage, StorageData } from "./dumpStorage";
 import { DEVTOOLS_PROTOCOL, WEBDRIVER_PROTOCOL } from "../../../constants/config";
-import { isSupportIsolation } from "../../../utils/browser";
 import { ExistingBrowser, getActivePuppeteerPage } from "../../existing-browser";
 import * as logger from "../../../utils/logger";
 import { Cookie } from "../../../types";
+import type { Browser } from "../../types";
 
 export type SaveStateOptions = {
     path?: string;
@@ -32,23 +31,13 @@ export const defaultOptions = {
     sessionStorage: true,
 };
 
-export const getCalculatedProtocol = (browser: Browser): typeof DEVTOOLS_PROTOCOL | typeof WEBDRIVER_PROTOCOL => {
-    const protocol = browser.config.automationProtocol;
-
-    if (protocol === DEVTOOLS_PROTOCOL) {
-        return DEVTOOLS_PROTOCOL;
-    }
-
-    if (
-        protocol === WEBDRIVER_PROTOCOL &&
-        browser.config.isolation &&
-        isSupportIsolation(browser.publicAPI.capabilities.browserName!, browser.publicAPI.capabilities.browserVersion!)
-    ) {
-        return DEVTOOLS_PROTOCOL;
-    }
-
-    return protocol;
-};
+// in case when we use webdriver protocol, bidi and isolation
+// we have to force change protocol to devtools, for use puppeteer,
+// because we use it for create incognito window
+export const getOverridesProtocol = (browser: Browser): typeof WEBDRIVER_PROTOCOL | typeof DEVTOOLS_PROTOCOL =>
+    browser.config.automationProtocol === WEBDRIVER_PROTOCOL && browser.publicAPI.isBidi && browser.config.isolation
+        ? DEVTOOLS_PROTOCOL
+        : browser.config.automationProtocol;
 
 export const getWebdriverFrames = async (session: WebdriverIO.Browser): Promise<string[]> =>
     session.execute<string[], []>(() =>
@@ -74,10 +63,10 @@ export default (browser: ExistingBrowser): void => {
             framesData: {},
         };
 
-        switch (getCalculatedProtocol(browser)) {
+        switch (getOverridesProtocol(browser)) {
             case WEBDRIVER_PROTOCOL: {
                 if (options.cookies) {
-                    const cookies = await session.getCookies();
+                    const cookies = await session.getAllCookies();
 
                     data.cookies = cookies.map(
                         cookie =>
@@ -133,7 +122,7 @@ export default (browser: ExistingBrowser): void => {
             }
             case DEVTOOLS_PROTOCOL: {
                 if (options.cookies) {
-                    const cookies = await browser.getAllRequestsCookies();
+                    const cookies = await session.getAllCookies();
 
                     data.cookies = cookies.map(
                         cookie =>
diff --git a/src/browser/existing-browser.ts b/src/browser/existing-browser.ts
@@ -1,6 +1,5 @@
 import url from "url";
 import _ from "lodash";
-import { parse as parseCookiesString, Cookie } from "set-cookie-parser";
 import { attach, type AttachOptions, type ElementArray } from "@testplane/webdriverio";
 import { sessionEnvironmentDetector } from "@testplane/wdio-utils";
 import { Browser, BrowserOpts } from "./browser";
@@ -9,7 +8,7 @@ import { Camera, PageMeta } from "./camera";
 import { type ClientBridge, build as buildClientBridge } from "./client-bridge";
 import * as history from "./history";
 import * as logger from "../utils/logger";
-import { DEVTOOLS_PROTOCOL, WEBDRIVER_PROTOCOL } from "../constants/config";
+import { WEBDRIVER_PROTOCOL } from "../constants/config";
 import { MIN_CHROME_VERSION_SUPPORT_ISOLATION } from "../constants/browser";
 import { isSupportIsolation } from "../utils/browser";
 import { isRunInNodeJsEnv } from "../utils/config";
@@ -19,8 +18,6 @@ import type { CalibrationResult, Calibrator } from "./calibrator";
 import { NEW_ISSUE_LINK } from "../constants/help";
 import { runWithoutHistory } from "./history";
 import type { SessionOptions } from "./types";
-import { Protocol } from "devtools-protocol";
-import { getCalculatedProtocol } from "./commands/saveState";
 import { Page } from "puppeteer-core";
 import { CDP } from "./cdp";
 import type { ElementReference } from "@testplane/wdio-protocols";
@@ -94,7 +91,6 @@ export class ExistingBrowser extends Browser {
     protected _calibration?: CalibrationResult;
     protected _clientBridge?: ClientBridge;
     protected _cdp: CDP | null = null;
-    private _allCookies: Map<string, Protocol.Network.CookieParam> = new Map();
 
     constructor(config: Config, opts: BrowserOpts) {
         super(config, opts);
@@ -134,10 +130,6 @@ export class ExistingBrowser extends Browser {
 
                 await isolationPromise;
 
-                if (getCalculatedProtocol(this) === DEVTOOLS_PROTOCOL) {
-                    await this.startCollectCookies();
-                }
-
                 this._callstackHistory?.clear();
 
                 try {
@@ -155,72 +147,6 @@ export class ExistingBrowser extends Browser {
         return this;
     }
 
-    getCookieIndex(cookie: Cookie): string {
-        return [cookie.name, cookie.domain, cookie.path].join("-");
-    }
-
-    async getAllRequestsCookies(): Promise<Array<Protocol.Network.CookieParam>> {
-        if (this._session) {
-            const cookies = await this._session.getAllCookies();
-
-            if (cookies) {
-                cookies.forEach(cookie => {
-                    this._allCookies.set(this.getCookieIndex(cookie), cookie as Protocol.Network.CookieParam);
-                });
-            }
-        }
-
-        return [...this._allCookies.values()].map(cookie => ({
-            name: cookie.name,
-            value: cookie.value,
-            domain: cookie.domain,
-            path: cookie.path,
-            expires: cookie.expires ? cookie.expires : undefined,
-            httpOnly: cookie.httpOnly,
-            secure: cookie.secure,
-            sameSite: cookie.sameSite,
-        }));
-    }
-
-    async startCollectCookies(): Promise<void> {
-        if (!this._session) {
-            return;
-        }
-
-        this._allCookies = new Map();
-
-        const page = await getActivePuppeteerPage(this._session);
-
-        if (!page) {
-            return;
-        }
-
-        page.on("response", async res => {
-            try {
-                const headers = res.headers();
-
-                if (headers["set-cookie"]) {
-                    headers["set-cookie"].split("\n").forEach(str => {
-                        parseCookiesString(str, { map: false }).forEach((cookie: Cookie) => {
-                            const index = this.getCookieIndex(cookie);
-                            const expires = cookie.expires
-                                ? Math.floor(new Date(cookie.expires).getTime() / 1000)
-                                : undefined;
-
-                            this._allCookies.set(index, {
-                                ...cookie,
-                                domain: cookie.domain ?? new URL(res.url()).hostname,
-                                expires,
-                            } as Protocol.Network.CookieParam);
-                        });
-                    });
-                }
-            } catch (err) {
-                console.error(err);
-            }
-        });
-    }
-
     markAsBroken(): void {
         if (this.state.isBroken) {
             return;
diff --git a/src/browser/standalone/types.ts b/src/browser/standalone/types.ts
@@ -5,6 +5,7 @@ export type StandaloneBrowserOptions = Pick<
     | "automationProtocol"
     | "desiredCapabilities"
     | "gridUrl"
+    | "isolation"
     | "baseUrl"
     | "httpTimeout"
     | "pageLoadTimeout"
diff --git a/src/testplane.ts b/src/testplane.ts
@@ -209,6 +209,7 @@ export class Testplane extends BaseTestplane {
             keepBrowserMode,
             runnableOpts,
         });
+
         const collection = TestCollection.create(specs);
 
         collection.getBrowsers().forEach(bro => {
diff --git a/test/integration/standalone/constants.ts b/test/integration/standalone/constants.ts
@@ -1,7 +1,6 @@
 import _ from "lodash";
-import { BrowserName } from "../../../src/browser/types";
 
-export const BROWSER_NAME = (process.env.BROWSER || "chrome").toLowerCase() as keyof typeof BrowserName;
+export const BROWSER_NAME = (process.env.BROWSER || "chrome").toLowerCase();
 
 export const BROWSER_CONFIG = {
     desiredCapabilities: {
diff --git a/test/integration/standalone/standalone-save-state.test.ts b/test/integration/standalone/standalone-save-state.test.ts
