feat(codegen): add user-data-dir option #35814
Open
+102
−43
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
agg23
commented
Apr 30, 2025
docs/src/codegen.md
Outdated
| @@ -414,6 +414,26 @@ pwsh bin/Debug/netX/playwright.ps1 codegen --load-storage=auth.json github.com/m | |||
|
|
|||
| <img width="1394" alt="github signed in showing use of load storage scharp" src="https://user-images.githubusercontent.com/13063165/220928354-caa0e958-fe09-4125-9b54-67483064da51.png" /> | |||
|
|
|||
| #### Use existing userDataDir | |||
|
|
|||
| Run `codegen` with `--user-data-dir` to set a fixed [user data directory](https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context-option-user-data-dir) for the browser session. If you point this at your existing browser's user data directory, codegen will use your existing browser profile and have access to your authentication state. Remember that any authentication that codegen receives from using your browser configuration must be replicated at test time using [fixtures](./test-fixtures.md) or `before*` hooks, otherwise the UI you're trying to evaluate might not be available when executing the test. | |||
There was a problem hiding this comment.
I'm unsure what our practice is for pages like test-fixtures.md as it only exists in JS.
There was a problem hiding this comment.
I ended up removing the link.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
mxschmitt
reviewed
Apr 30, 2025
| Run `codegen` with `--user-data-dir` to set a fixed [user data directory](https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context-option-user-data-dir) for the browser session. If you point this at your existing browser's user data directory, codegen will use your existing browser profile and have access to your authentication state. Remember that any authentication that codegen receives from using your browser configuration must be replicated at test time using fixtures or `before*` hooks, otherwise the UI you're trying to evaluate might not be available when executing the test. | ||
|
|
||
| ```bash js | ||
| npx playwright codegen --user-data-dir=/path/to/your/browser/data/ github.com/microsoft/playwright |
There was a problem hiding this comment.
This won't work for a user who has a different profile than 'Default'. The story is a bit more complicated there that we should teach them how to get this path, what is 'Default' etc. I wonder if we want to enter this territory or if we should rely on third-party blog posts like this one. The main customers of this are Chromium anyways and doing this with page.pause() seems to have worked fine in the past.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Test results for "tests 1"1 failed 3 flaky39126 passed, 803 skipped Merge workflow run. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduces
codegen --user-data-diroption to allow specification of an existing browser profile directory to use during codegen.Resolves #35617.