[Bug] [Python] StorageState TypedDict doesn't have credentials and opfs entries #42732

Activity

1. shubhambhar007 commented on Sep 15, 2026

   

   Shubham Bhardwaj (shubhambhar007)

   on Sep 15, 2026

   Last edited by shubhambhar007

   More actions

   Raphaël Vinot (@Rafiot) could you please assign this to me ,thanks! - raised PR microsoft/playwright-python#3201
2. Devin Rousso (dcrousso)

   added

   needs-triage

   on Sep 15, 2026
3. github-actions commented on Sep 15, 2026

   

   github-actionsBot

   on Sep 15, 2026 – with GitHub Actions

   Contributor

   More actions

   Hi, I'm the Playwright bot and I took a first look at this.

   Confirmed, and it's wider than the Python StorageState TypedDict — the declared storage state shape is stale in every language, because it's generated from the docs in this repo and those were never updated when the new options landed. BrowserContext.storageState() returns more than the type admits:

   • indexedDB per origin (option added in 1.51)
   • opfs per origin (1.63)
   • top-level credentials (1.61)

   The server fills all three in (browserContext.ts#L617-L632 — result.credentials = ... and script.collect({ indexedDB, opfs })), but the documented return type is still just cookies + origins.localStorage. Same on the input side, so a storageState(...) → newContext({ storageState }) round trip doesn't type-check against what it actually produces.

   So the Python fix needs the docs change here first, otherwise it drifts right back.

   Where the type is declared

   Source of truth (docs), both missing the new fields:

   • return type: docs/src/api/class-browsercontext.md#L1553-L1570
   • input type: js-python-context-option-storage-state in docs/src/api/params.md#L291-L307

   Which generates the equally stale types.d.ts:

   // packages/playwright-core/types/types.d.ts — BrowserContext.storageState()
   }): Promise<{
     cookies: Array<{ name: string; value: string; domain: string; path: string;
       expires: number; httpOnly: boolean; secure: boolean; sameSite: "Strict"|"Lax"|"None"; }>;
     origins: Array<{
       origin: string;
       localStorage: Array<{ name: string; value: string }>;
       // no indexedDB, no opfs
     }>;
     // no credentials
   }>;

   The client-side type does the omission explicitly, which is where the asymmetry shows up:

   // packages/playwright-core/src/client/types.ts
   export type StorageState = {
     cookies: channels.NetworkCookie[],
     origins: (Omit<channels.OriginStorage, 'indexedDB'>)[],
   };
   export type SetStorageState = {
     cookies?: channels.SetNetworkCookie[],
     origins?: (Omit<channels.SetOriginStorage, 'indexedDB'> & { indexedDB?: unknown[] })[],
     credentials?: unknown[],
   };

   And the Python mirror you linked, StorageState / OriginState in playwright/_impl/_api_structures.py, has the same two fields and nothing else.

   What I checked

   • tip-of-tree microsoft/playwright @ 9ae5377 — docs, generated types.d.ts, client types, server storageState() implementation
   • microsoft/playwright-python @ 40f7550 (the sha you linked) — _api_structures.py
   • no runtime repro run: this is a static typing gap, the values are present at runtime and the declaration is what's short

   One thing worth splitting out: indexedDB, opfs and credentials are opt-in, so they're optional keys on the emitted state — whether the type marks them optional or always-present changes how mypy treats the round trip, and that's a call for a maintainer.

   _{Triaged on Linux by the Playwright bot - agent run}
4. dcrousso commented on Sep 19, 2026

   

   Devin Rousso (dcrousso)

   on Sep 19, 2026

   Contributor

   More actions

   the incomplete storage state type is intentional microsoft/playwright-python#3094 (comment)

   for an unchanged round trip, use StorageState for both your stored value and result field rather than dict[str, Any]

   if you need to access the additional fields, define a local type and cast as suggested in microsoft/playwright-python#2796 (comment)
5. Devin Rousso (dcrousso)

   closed this as not plannedon Sep 19, 2026