feat: add get state

Author: rocketraccoon

src/browser/commands/getState.ts

@@ -0,0 +1,12 @@
+import fs from "fs-extra";
+
+import type { Browser } from "../types";
+import { SaveStateData, SaveStateOptions } from "./saveState";
+
+export type GetStateOptions = Required<Pick<SaveStateOptions, "path">>;
+
+export default (browser: Browser): void => {
+    const { publicAPI: session } = browser;
+
+    session.addCommand("getState", async ({ path }: GetStateOptions): Promise<SaveStateData> => fs.readJson(path));
+};

src/browser/commands/index.ts

@@ -12,5 +12,6 @@ export const customCommandFileNames = [
     "waitForStaticToLoad",
     "saveState",
     "restoreState",
+    "getState",
     "unstable_getCdp",
 ];

src/browser/types.ts

@@ -10,6 +10,7 @@ import type { Test, Hook } from "../test-reader/test-object";
 import type { CaptureSnapshotOptions, CaptureSnapshotResult } from "./commands/captureDomSnapshot";
 import type { Options } from "@testplane/wdio-types";
 import type { SaveStateData, SaveStateOptions } from "./commands/saveState";
+import type { GetStateOptions } from "./commands/getState";
 import type { RestoreStateOptions } from "./commands/restoreState";
 import type { WaitForStaticToLoadResult } from "./commands/waitForStaticToLoad";
 import type { CDP } from "./cdp";
@@ -83,6 +84,7 @@ declare global {
 
             saveState(options?: SaveStateOptions): Promise<SaveStateData>;
             restoreState(options: RestoreStateOptions): Promise<void>;
+            getState(options: GetStateOptions): Promise<SaveStateData>;
 
             overwriteCommand<CommandName extends BrowserCommand>(
                 name: CommandName,

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

@@ -8,7 +8,7 @@ import { DEVTOOLS_PROTOCOL, WEBDRIVER_PROTOCOL } from "../../../src/constants/co
 import { AuthServer } from "./mock-auth-page/server";
 import process from "node:process";
 
-const TIMEOUT = 180000;
+const TIMEOUT = 320000;
 
 // fix for ff, he doesn't like localhost in domain
 const removeDomainFromCookies = (loginState: SaveStateData): void => {
@@ -137,6 +137,17 @@ type AutomationProtocol = typeof DEVTOOLS_PROTOCOL | typeof WEBDRIVER_PROTOCOL;
                     assert.strictEqual(fileExist, false);
                 });
 
+                it("getState", async function () {
+                    const options = {
+                        path: "./state.json",
+                    };
+
+                    const saveResult = await browser.saveState(options);
+                    const getResult = await browser.getState(options);
+
+                    assert.deepEqual(saveResult, getResult);
+                });
+
                 it("restoreState", async function () {
                     if (loginState) {
                         removeDomainFromCookies(loginState);