chore: unship context.setStorageState (#37021)

dgozman · web-flow · commit 3680dc55d844 · 2025-08-13T21:35:20.000+01:00
diff --git a/docs/src/api/class-browsercontext.md b/docs/src/api/class-browsercontext.md
@@ -1496,28 +1496,6 @@ its geolocation.
 Whether to emulate network being offline for the browser context.
 
 
-## async method: BrowserContext.setStorageState
-* since: v1.55
-
-Resets storage state in the context by clearing cookies, cache and storage, and then applying the new storage state.
-
-### param: BrowserContext.setStorageState.storageState = %%-js-python-context-option-storage-state-%%
-* since: v1.55
-
-### param: BrowserContext.setStorageState.storageState = %%-csharp-java-context-option-storage-state-%%
-* since: v1.55
-
-
-## async method: BrowserContext.setStorageStatePath
-* since: v1.55
-* langs: csharp, java
-
-Resets storage state in the context by clearing cookies, cache and storage, and then applying the new storage state from a file.
-
-### param: BrowserContext.setStorageStatePath.storageStatePath = %%-csharp-java-context-option-storage-state-path-%%
-* since: v1.55
-
-
 ## async method: BrowserContext.storageState
 * since: v1.8
 - returns: <[Object]>
diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.ts
@@ -9273,64 +9273,6 @@ export interface BrowserContext {
    */
   setOffline(offline: boolean): Promise<void>;
 
-  /**
-   * Resets storage state in the context by clearing cookies, cache and storage, and then applying the new storage
-   * state.
-   * @param storageState Learn more about [storage state and auth](https://playwright.dev/docs/auth).
-   *
-   * Populates context with given storage state. This option can be used to initialize context with logged-in
-   * information obtained via
-   * [browserContext.storageState([options])](https://playwright.dev/docs/api/class-browsercontext#browser-context-storage-state).
-   */
-  setStorageState(storageState: string|{
-    /**
-     * Cookies to set for context
-     */
-    cookies: Array<{
-      name: string;
-
-      value: string;
-
-      /**
-       * Domain and path are required. For the cookie to apply to all subdomains as well, prefix domain with a dot, like
-       * this: ".example.com"
-       */
-      domain: string;
-
-      /**
-       * Domain and path are required
-       */
-      path: string;
-
-      /**
-       * Unix time in seconds.
-       */
-      expires: number;
-
-      httpOnly: boolean;
-
-      secure: boolean;
-
-      /**
-       * sameSite flag
-       */
-      sameSite: "Strict"|"Lax"|"None";
-    }>;
-
-    origins: Array<{
-      origin: string;
-
-      /**
-       * localStorage to set for context
-       */
-      localStorage: Array<{
-        name: string;
-
-        value: string;
-      }>;
-    }>;
-  }): Promise<void>;
-
   /**
    * Returns storage state for this browser context, contains current cookies, local storage snapshot and IndexedDB
    * snapshot.
diff --git a/packages/playwright-core/src/client/browserContext.ts b/packages/playwright-core/src/client/browserContext.ts
@@ -455,10 +455,6 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
     return state;
   }
 
-  async setStorageState(storageState: string | SetStorageState) {
-    await this._channel.setStorageState({ storageState: await prepareStorageState(this._platform, storageState) });
-  }
-
   backgroundPages(): Page[] {
     return [...this._backgroundPages];
   }
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
@@ -1071,13 +1071,6 @@ scheme.BrowserContextStorageStateResult = tObject({
   cookies: tArray(tType('NetworkCookie')),
   origins: tArray(tType('OriginStorage')),
 });
-scheme.BrowserContextSetStorageStateParams = tObject({
-  storageState: tObject({
-    cookies: tOptional(tArray(tType('SetNetworkCookie'))),
-    origins: tOptional(tArray(tType('SetOriginStorage'))),
-  }),
-});
-scheme.BrowserContextSetStorageStateResult = tOptional(tObject({}));
 scheme.BrowserContextPauseParams = tOptional(tObject({}));
 scheme.BrowserContextPauseResult = tOptional(tObject({}));
 scheme.BrowserContextEnableRecorderParams = tObject({
diff --git a/packages/playwright-core/src/server/browserContext.ts b/packages/playwright-core/src/server/browserContext.ts
@@ -616,7 +616,7 @@ export abstract class BrowserContext extends SdkObject {
     return this._creatingStorageStatePage;
   }
 
-  async setStorageState(progress: Progress, state: channels.BrowserNewContextParams['storageState'], mode: 'initial' | 'resetForReuse' | 'update') {
+  async setStorageState(progress: Progress, state: channels.BrowserNewContextParams['storageState'], mode: 'initial' | 'resetForReuse') {
     let page: Page | undefined;
     let interceptor: network.RouteHandler | undefined;
     try {
diff --git a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
@@ -330,10 +330,6 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
     return await progress.race(this._context.storageState(progress, params.indexedDB));
   }
 
-  async setStorageState(params: channels.BrowserContextSetStorageStateParams, progress: Progress): Promise<channels.BrowserContextSetStorageStateResult> {
-    await this._context.setStorageState(progress, params.storageState, 'update');
-  }
-
   async close(params: channels.BrowserContextCloseParams, progress: Progress): Promise<void> {
     progress.metadata.potentiallyClosesScope = true;
     await this._context.close(params);
diff --git a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
@@ -82,7 +82,6 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
   ['BrowserContext.setWebSocketInterceptionPatterns', { title: 'Route WebSockets', group: 'route', }],
   ['BrowserContext.setOffline', { title: 'Set offline mode', }],
   ['BrowserContext.storageState', { title: 'Get storage state', }],
-  ['BrowserContext.setStorageState', { title: 'Set storage state', group: 'configuration', }],
   ['BrowserContext.pause', { title: 'Pause', }],
   ['BrowserContext.enableRecorder', { internal: true, }],
   ['BrowserContext.disableRecorder', { internal: true, }],
diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
@@ -9273,64 +9273,6 @@ export interface BrowserContext {
    */
   setOffline(offline: boolean): Promise<void>;
 
-  /**
-   * Resets storage state in the context by clearing cookies, cache and storage, and then applying the new storage
-   * state.
-   * @param storageState Learn more about [storage state and auth](https://playwright.dev/docs/auth).
-   *
-   * Populates context with given storage state. This option can be used to initialize context with logged-in
-   * information obtained via
-   * [browserContext.storageState([options])](https://playwright.dev/docs/api/class-browsercontext#browser-context-storage-state).
-   */
-  setStorageState(storageState: string|{
-    /**
-     * Cookies to set for context
-     */
-    cookies: Array<{
-      name: string;
-
-      value: string;
-
-      /**
-       * Domain and path are required. For the cookie to apply to all subdomains as well, prefix domain with a dot, like
-       * this: ".example.com"
-       */
-      domain: string;
-
-      /**
-       * Domain and path are required
-       */
-      path: string;
-
-      /**
-       * Unix time in seconds.
-       */
-      expires: number;
-
-      httpOnly: boolean;
-
-      secure: boolean;
-
-      /**
-       * sameSite flag
-       */
-      sameSite: "Strict"|"Lax"|"None";
-    }>;
-
-    origins: Array<{
-      origin: string;
-
-      /**
-       * localStorage to set for context
-       */
-      localStorage: Array<{
-        name: string;
-
-        value: string;
-      }>;
-    }>;
-  }): Promise<void>;
-
   /**
    * Returns storage state for this browser context, contains current cookies, local storage snapshot and IndexedDB
    * snapshot.
diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.ts
@@ -1612,7 +1612,6 @@ export interface BrowserContextChannel extends BrowserContextEventTarget, EventT
   setWebSocketInterceptionPatterns(params: BrowserContextSetWebSocketInterceptionPatternsParams, progress?: Progress): Promise<BrowserContextSetWebSocketInterceptionPatternsResult>;
   setOffline(params: BrowserContextSetOfflineParams, progress?: Progress): Promise<BrowserContextSetOfflineResult>;
   storageState(params: BrowserContextStorageStateParams, progress?: Progress): Promise<BrowserContextStorageStateResult>;
-  setStorageState(params: BrowserContextSetStorageStateParams, progress?: Progress): Promise<BrowserContextSetStorageStateResult>;
   pause(params?: BrowserContextPauseParams, progress?: Progress): Promise<BrowserContextPauseResult>;
   enableRecorder(params: BrowserContextEnableRecorderParams, progress?: Progress): Promise<BrowserContextEnableRecorderResult>;
   disableRecorder(params?: BrowserContextDisableRecorderParams, progress?: Progress): Promise<BrowserContextDisableRecorderResult>;
@@ -1863,16 +1862,6 @@ export type BrowserContextStorageStateResult = {
   cookies: NetworkCookie[],
   origins: OriginStorage[],
 };
-export type BrowserContextSetStorageStateParams = {
-  storageState: {
-    cookies?: SetNetworkCookie[],
-    origins?: SetOriginStorage[],
-  },
-};
-export type BrowserContextSetStorageStateOptions = {
-
-};
-export type BrowserContextSetStorageStateResult = void;
 export type BrowserContextPauseParams = {};
 export type BrowserContextPauseOptions = {};
 export type BrowserContextPauseResult = void;
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
@@ -1346,20 +1346,6 @@ BrowserContext:
           type: array
           items: OriginStorage
 
-    setStorageState:
-      title: Set storage state
-      group: configuration
-      parameters:
-        storageState:
-          type: object
-          properties:
-            cookies:
-              type: array?
-              items: SetNetworkCookie
-            origins:
-              type: array?
-              items: SetOriginStorage
-
     pause:
       title: Pause
 
diff --git a/tests/library/browsercontext-storage-state.spec.ts b/tests/library/browsercontext-storage-state.spec.ts
@@ -500,74 +500,3 @@ it('should support empty indexedDB', { annotation: { type: 'issue', description:
   const context = await contextFactory({ storageState });
   expect(await context.storageState({ indexedDB: true })).toEqual(storageState);
 });
-
-it('should cleanup existing and set new storage state', async ({ contextFactory }, testInfo) => {
-  const context = await contextFactory();
-  const page = await context.newPage();
-  await page.route('**/*', route => {
-    route.fulfill({ body: '<html></html>' }).catch(() => {});
-  });
-  await page.goto('https://www.example.com');
-  await page.evaluate(async () => {
-    localStorage['name1'] = 'value1';
-    document.cookie = 'username=John Doe';
-    return document.cookie;
-  });
-
-  const state = await context.storageState();
-  expect(state).toEqual({
-    cookies: [
-      expect.objectContaining({
-        domain: 'www.example.com',
-        name: 'username',
-        value: 'John Doe',
-      }),
-    ],
-    origins: [
-      {
-        origin: 'https://www.example.com',
-        localStorage: [{
-          name: 'name1',
-          value: 'value1',
-        }],
-      },
-    ],
-  });
-
-  await context.setStorageState({
-    cookies: [
-      {
-        domain: 'www.example.com',
-        name: 'foo',
-        value: 'bar',
-        path: '/',
-        expires: -1,
-        httpOnly: false,
-        secure: false,
-        sameSite: 'Lax',
-      },
-    ],
-    origins: [
-      {
-        origin: 'https://www.another.com',
-        localStorage: [{
-          name: 'name2',
-          value: 'value2',
-        }],
-      },
-    ],
-  });
-
-  expect(context.pages()).toHaveLength(1);
-  await expect(page).toHaveURL('https://www.example.com/');
-
-  await page.goto('https://www.another.com');
-  expect(await page.evaluate(() => document.cookie)).toBe('');
-  expect(await page.evaluate(() => window.localStorage['name1'])).toBe(undefined);
-  expect(await page.evaluate(() => window.localStorage['name2'])).toBe('value2');
-
-  await page.goto('https://www.example.com');
-  expect(await page.evaluate(() => document.cookie)).toBe('foo=bar');
-  expect(await page.evaluate(() => window.localStorage['name1'])).toBe(undefined);
-  expect(await page.evaluate(() => window.localStorage['name2'])).toBe(undefined);
-});

Original file line number	Diff line number	Diff line change
`@@ -455,10 +455,6 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>`
`455`	`455`	`return state;`
`456`	`456`	`}`
`457`	`457`
`458`		`- async setStorageState(storageState: string \| SetStorageState) {`
`459`		`- await this._channel.setStorageState({ storageState: await prepareStorageState(this._platform, storageState) });`
`460`		`- }`
`461`		`-`
`462`	`458`	`backgroundPages(): Page[] {`
`463`	`459`	`return [...this._backgroundPages];`
`464`	`460`	`}`
Original file line number	Diff line number	Diff line change
`@@ -616,7 +616,7 @@ export abstract class BrowserContext extends SdkObject {`
`616`	`616`	`return this._creatingStorageStatePage;`
`617`	`617`	`}`
`618`	`618`
`619`		`- async setStorageState(progress: Progress, state: channels.BrowserNewContextParams['storageState'], mode: 'initial' \| 'resetForReuse' \| 'update') {`
	`619`	`+ async setStorageState(progress: Progress, state: channels.BrowserNewContextParams['storageState'], mode: 'initial' \| 'resetForReuse') {`
`620`	`620`	`let page: Page \| undefined;`
`621`	`621`	`let interceptor: network.RouteHandler \| undefined;`
`622`	`622`	`try {`