Add `opfs=` argument to `Save Storage State`
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 54/100
調査の方向性
Read Browser/keywords/playwright_state.py methods save_storage_state and _save_storage_state, then trace the request through protobuf/playwright.proto and node/playwright-wrapper/playwright-state.ts. Add the named opfs option and pass it to Playwright's storageState() call, update the Set Storage State docstring, and add OPFS cases to atest/test/01_Browser_Management/storage_state.robot for save, restore through both APIs, and saving without OPFS; skip or tag ephemeral WebKit contexts.
索引モデルが issue の本文から書いたものです。
説明
Use case
Save Storage State saves cookies and local storage, and with indexedDB=True and credentials=True also IndexedDB and virtual WebAuthn credentials (#5117). Some applications keep their data in the origin private file system (OPFS) instead: offline-first apps, apps that run SQLite in the browser (SQLite WASM persists to OPFS), and editors that store drafts as files. For those, the saved state misses the data the app needs, and the "set up once, reuse in every test" pattern does not work.
Playwright 1.63 added an opfs option to browserContext.storageState(). The state file then carries the OPFS entries of each origin, and both browser.newContext({ storageState }) and browserContext.setStorageState() restore them.
Proposed keyword / arguments
Save Storage State path=None * indexedDB=False credentials=False opfs=False
opfs: named-only, defaults toFalse. Also saves the origin private file system of every origin in the state.
*** Test Cases ***
Prepare Offline Data Once
New Context
New Page ${APP_URL}
Click id=download-for-offline
Get Text id=offline-status == Ready
Save Storage State ${CURDIR}/state/offline.json opfs=True
Use Offline Data
New Context storageState=${CURDIR}/state/offline.json
New Page ${APP_URL}
Get Text id=offline-status == Ready
New Context storageState= and Set Storage State need no new argument. They restore whatever the file contains.
Playwright API
browserContext.storageState({ opfs }), since 1.63 (opfs?: booleanappears intypes.d.tsof 1.63.0, not in 1.62.0). The docs note: "OPFS is currently not supported in ephemeral WebKit contexts."browserContext.setStorageState(storageState): since 1.63 its description says it clears "origin private file system entries" along with cookies, local storage, IndexedDB and credentials.browser.newContext({ storageState }).
Checked with Playwright 1.65.0 and Chromium: with opfs: true each origin in the state gets an opfs list of {path, type: "directory"} and {path, type: "file", base64} entries. A new context created with that state, and an existing context after setStorageState(), both read the file back. Without opfs: true no opfs key is written.
Implementation notes
All references are to upstream main (5e350998).
protobuf/playwright.proto:137-141Request.StorageState: addbool opfs = 4;. The rpc staysSaveStorageState(:713).node/playwright-wrapper/playwright-state.ts:1384-1388saveStorageState: passopfs: request.opfstocontext.c.storageState(), next toindexedDBandcredentials.Browser/keywords/playwright_state.py:2106-2112save_storage_state: add named-onlyopfs: bool = False; pass it through_save_storage_state(:2176-2185) intoRequest().StorageState(...). Docstring: one line in Arguments, plus the WebKit limitation.New Contextis an ephemeral context, so in WebKitopfs=Trueworks only afterNew Persistent Context.Browser/keywords/playwright_state.py:2196-2197set_storage_statedocstring: "Clears the cookies, local storage, IndexedDB and virtual WebAuthn credentials" should name OPFS too. Playwright clears it on everysetStorageState(), also when the file has noopfsentries: in the check above, restoring a state saved withoutopfsremoved the file the page had written. That is Playwright's behaviour since 1.63 and already happens with the current keyword, so the docstring fix stands on its own even withoutopfs=.Set Storage Statehas IndexedDB-specific handling (reload_pages,indexedDbOriginsatplaywright-state.ts:1392-1402, the open-connection probe at:1412-1432) because deleting an IndexedDB database waits for open connections. Playwright clears OPFS withremoveEntry(name, { recursive: true })and writes files withcreateWritable(). I have not found or tested a similar blocking case for OPFS. A file locked by aFileSystemSyncAccessHandlein a worker might make the clear fail instead of hang; worth one acceptance test before deciding whetherreload_pagesneeds to cover OPFS origins. Until then, no change there.- Tests:
atest/test/01_Browser_Management/storage_state.robothas the IndexedDB cases asEvaluate JavaScriptsnippets in its Variables (:9-14). Add matching OPFS write and read snippets and test: save withopfs=True, restore withNew Context storageState=, restore withSet Storage State, and save withoutopfsleaves noopfskey in the file. Skip or tag the WebKit case, since the suite runs in ephemeral contexts.
Backwards compatibility
Additive, named-only argument that defaults to False. State files written without it are unchanged. The docstring change to Set Storage State documents behaviour that is already there.
- 主要言語
- Python
- スター
- 662
- フォーク
- 149
- 平均マージ
- 6時間 13分
- マージ済み PR(30日)
- 121
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
MarketSquare/robotframework-browser のほかの issue
-
priority: high
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
MarketSquare/robotframework-browser#5306 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
MarketSquare/robotframework-browser#5153 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
MarketSquare/robotframework-browser#5503 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 78/100
MarketSquare/robotframework-browser#5502 ·
メンテナーはふだん 1 日以内に返信
-
Accept a list of credentials in `httpCredentials` of `New Context` and `New Persistent Context`オープン
難易度 3/5 1〜2日 初心者へのやさしさ 76/100
MarketSquare/robotframework-browser#5500 ·
メンテナーはふだん 1 日以内に返信
MarketSquare/robotframework-browser の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
igormcsouza/tether#278 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 91/100
aws-samples/sample-per-model-bedrock#803 ·
メンテナーはふだん 1 日以内に返信
-
documentation p1
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
huggingface/accelerate#4511 ·
メンテナーはふだん 1 日以内に返信
-
follow-up
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信