docs: introduce doc on authentication #3404
Merged
Conversation
This file contains 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
dgozman
approved these changes
Aug 12, 2020
docs/auth.md
Outdated
| window.localStorage.setItem(key, entries[key]); | ||
| }); | ||
| } | ||
| }, [localStorage]); |
There was a problem hiding this comment.
nit: can just pass localStorage without an array wrap. The function would be easier as well: storage => {...}.
docs/auth.md
Outdated
| window.sessionStorage.setItem(key, entries[key]); | ||
| }); | ||
| } | ||
| }, [sessionStorage]); |
docs/auth.md
Outdated
| * In Jest, this can be executed in [`globalSetup`](https://jestjs.io/docs/en/configuration#globalsetup-string). | ||
| 3. In each test, load authentication state in `beforeEach` or `beforeAll` step. | ||
|
|
||
| This lifecycle can be extended to cache authentication state across test runs. |
There was a problem hiding this comment.
I didn't quite understand this sentence.
docs/auth.md
Outdated
|
|
||
| ## Persistent authentication | ||
| Web browsers use a directory on disk to store user history, cookies and other local | ||
| state. This is directory is called the [User data directory](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md). |
docs/auth.md
Outdated
| Web browsers use a directory on disk to store user history, cookies and other local | ||
| state. This is directory is called the [User data directory](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md). | ||
|
|
||
| User data directory is an alternate approach to reusing authentication state. It |
There was a problem hiding this comment.
I'd rather advertise persistent context for persisting storage, e.g. IndexedDB. I think we should push towards non-persistent auth when we can.
docs/auth.md
Outdated
| - [class `BrowserContext`](./api.md#class-browsercontext) | ||
| - [`browserType.launchPersistentContext`](./api.md#browsertypelaunchpersistentcontextuserdatadir-options) | ||
|
|
||
| ## Multi-factor authentication |
There was a problem hiding this comment.
This sounds like a better sell for persistent context. Let's merge with previous section?
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.
(needs some more word-smithing - especially in the intro section, but ready for feedback)
This PR introduces a new doc on authentication, covering scenarios that I've seen come up frequently.
Drive-by: clean-up for
context.setHTTPCredentialssince we don't recommend using it anymore.