Support for configuring the browser fetch credentials mode in BrowserClient.#1937
Open
mauriceraguseinit wants to merge 2 commits into
Open
Support for configuring the browser fetch credentials mode in BrowserClient.#1937mauriceraguseinit wants to merge 2 commits into
fetch credentials mode in BrowserClient.#1937mauriceraguseinit wants to merge 2 commits into
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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
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.
This PR adds support for configuring the browser
fetchcredentials mode inBrowserClient.Currently
BrowserClientonly exposes a booleanwithCredentialsoption, which maps to eithersame-origin(whenfalse) orinclude(whentrue). The browserfetchAPI, however, supports a third credentials mode,omit, which cannot be expressed through the existing boolean API. The only way to useomittoday is to fork or copyBrowserClientand change theRequestInitmanually.Closes #1936.
What this changes
BrowserCredentialsModeenum with the valuesomit,sameOrigin, andinclude, matching the three credentials modes defined by the [Fetch standard](https://fetch.spec.whatwg.org/#requestcredentials).credentialsModeproperty and constructor parameter toBrowserClient, defaulting toBrowserCredentialsMode.sameOriginto preserve the existing default behavior.RequestInit.credentialsvalue is now derived fromcredentialsMode.Backward compatibility
withCredentialsproperty is kept and continues to work, but is now deprecated because a boolean cannot represent all three credentials modes.credentialsMode:trueonly whencredentialsModeisinclude;truetoincludeandfalsetosameOrigin.BrowserClient()..withCredentials = truekeeps producing the samefetchbehavior as before.New usage