asyncBlocking in webRequest.onAuthRequired #34137
Conversation
|
Preview URLs
External URLs (1)URL:
(comment last updated: 2024-06-18 04:25:27) |
There was a problem hiding this comment.
It looks like there may have been a miscommunication around how async handling of onAuthRequired events work in Firefox 128+. The version of this PR I'm reviewing seems to say that Firefox 128 and later no longer support asynchronous response handling in "blocking" listeners. Based on my reading of Firefox source, it appears that blocking listeners can still return return promises to asynchronously settle an onAuthRequired event. What has changed is that Firefox now supports registering onAuthRequired listeners with "asyncBlocking" and these listeners match the behavior seen in Chrome.
All changes suggested in this review are for illustrative purposes. I'm happy to defer to your judgement on how best to structure the related content.
files/en-us/mozilla/add-ons/webextensions/api/webrequest/onauthrequired/index.md
Outdated
Show resolved
Hide resolved
| - in addListener, pass `"asyncBlocking"` in the `extraInfoSpec` parameter | ||
| - in the listener, return a `Promise` that resolves with an object containing an `authCredentials` property, set to the credentials to supply | ||
| > **Note:** Chrome does not support a Promise as a return value ([Chromium issue 1510405](https://crbug.com/1510405)). For alternatives, see [the return value of the `listener`](#listener). |
There was a problem hiding this comment.
Per comment 3 on bug 1889897 and the implementation (changeset), Firefox supports either "blocking" or "asyncBlocking". Chrome only supports "asyncBlocking".
- If
"blocking"is provided, the extension may either return awebRequest.BlockingResponseobject or a Promise that resolves to awebRequest.BlockingResponseobject. - If
"asyncBlocking"is provided, the event listener function will receive aasyncCallbackfunction as it's second parameter.asyncCallbackmay be called asynchronously and takes awebRequest.BlockingResponseobject as it's only parameter.
files/en-us/mozilla/add-ons/webextensions/api/webrequest/onauthrequired/index.md
Show resolved
Hide resolved
files/en-us/mozilla/add-ons/webextensions/api/webrequest/onauthrequired/index.md
Show resolved
Hide resolved
files/en-us/mozilla/add-ons/webextensions/api/webrequest/onauthrequired/index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Simeon Vincent <[email protected]>
| @@ -82,22 +82,29 @@ Events have three functions: | |||
|
|
|||
| - `details` | |||
| - : `object`. Details about the request. See the [details](#details_2) section for more information. | |||
| - `asyncCallback` {{optional_inline}} | |||
| - : A function to call, at most once, to asynchronously modify the request object. | |||
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
| - : A function to call, at most once, to asynchronously modify the request object. | |
| - : A function to call, at most once, to asynchronously modify the request object. |
| @@ -82,22 +82,29 @@ Events have three functions: | |||
|
|
|||
| - `details` | |||
| - : `object`. Details about the request. See the [details](#details_2) section for more information. | |||
| - `asyncCallback` {{optional_inline}} | |||
| - : A function to call, at most once, to asynchronously modify the request object. | |||
|
|
|||
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
|
|
||
| - In Firefox, the event listener may return a Promise that resolves to a `BlockingResponse` object to respond to the event asynchronously. |
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
| - In Firefox, the event listener may return a Promise that resolves to a `BlockingResponse` object to respond to the event asynchronously. | |
| - In Firefox, the event listener may return a Promise that resolves to a `BlockingResponse` object to respond to the event asynchronously. | |
|
|
||
| - In Firefox, the event listener may return a Promise that resolves to a `BlockingResponse` object to respond to the event asynchronously. | ||
| - `"asyncBlocking"`: handle the request asynchronously. The return value of the event listener is ignored. To resolve the event, pass the `asyncCallback` parameter a `BlockingResponse` result, with its `cancel` or `authCredentials` properties set. | ||
| - Supported in Chrome 120 and later. |
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
| - Supported in Chrome 120 and later. | |
| - Supported in Chrome 120 and later. |
Description
Addresses the documentation requirements of Bug 1889897 Implement asyncBlocking support for webRequest.onAuthRequired, including: