search

mdn / sprints

Archived: MDN Web Docs issues are tracked in the content repository.
https://github.com/mdn/content
Creative Commons Zero v1.0 Universal
149 stars 142 forks source link

Warn of deprecated WebExtension proxy APIs #1364

Closed mconca closed 5 years ago

mconca commented 5 years ago

Request type

Details

The proxy.register() and proxy.unregister() APIs are being deprecated in Firefox 68 and will be removed in Firefox 71. MDN should immediately mark those API as deprecated. The following pages need updating:

https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/proxy https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/proxy/register https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/proxy/unregister

The progress of this issue for Firefox can be followed on bugzilla: https://bugzilla.mozilla.org/show_bug.cgi?id=1545811

Acceptance criteria

mconca commented 5 years ago

In addition to marking these API as deprecated, the content near the top of the main proxy page will need to be cleaned up so as to only refer to the proxy.onRequest API.

mconca commented 5 years ago

The content at the top of the proxy.onError page as well as the example at the bottom of the page also refer to the deprecated API (PAC script). We need to explain that the error can be triggered by throwing or returning an invalid value in the proxy.onRequest event handler.

irenesmith commented 5 years ago

@mconca I have updated the pages appropriately. I removed the example from the proxy.onError page since it only refers to the deprecated methods and I also added the comment that the error can be triggered by throwing or returning an invalid value in the proxy.onRequest event handler.

irenesmith commented 5 years ago

I have created an Epic which includes this issue and the two related issues mentioned in the acceptance criteria for release notes for Firefox 68 and Firefox 71.

mconca commented 5 years ago

Looks good.