1371879 - Add API to clear registered proxy script

Status: RESOLVED FIXED

(WebExtensions :: Untriaged, defect)

Description

[61.1p57]

User Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:54.0) Gecko/20100101 Firefox/54.0
Build ID: 20170605134926

Steps to reproduce:

The proxy support in Firefox is different from Chrome, and there is currently no functionally equivalent API for chrome.proxy.settings.clear

https://developer.chrome.com/extensions/proxy#method-settings-clear

Comment 2

[erosman]

I have made the following edits to 'proxy.json' & 'ext-proxy.js'
They include suggestions and function name changes but they are only suggestion.

proxy.json
https://pastebin.mozilla.org/9025785

ext-proxy.js
https://pastebin.mozilla.org/9025786

Comment 3

[erosman]

Here are the same as above with register & unregister as function names


https://pastebin.mozilla.org/9025799
https://pastebin.mozilla.org/9025800

Comment 4

[Matthew Wein [:mattw]]

Attachment: Bug 1371879 - Add support for unregistering proxy scripts

This patch suggests deprecating proxy.registerProxyScript and replacing it with proxy.register since this API won't support registering anything other than proxy scripts. I normally would be hesitant to suggest making a name change after an API is released, but this API is one that is still in development, and for that reason I think changes like this should be somewhat expected until the API becomes more stable.

Review commit: https://reviewboard.mozilla.org/r/152464/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/152464/

Comment 5

[Matthew Wein [:mattw]]

Erosman, thank you for the contribution!

Comment 6

[erosman]

ref: review board API name change

While you are at it, you might as well consider proxy.onProxyError changing/aliasing to proxy.onError/onerror

proxy.register
proxy.unregister
proxy.onerror (for better harmony with other APIs)

eg:
https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/onerror
https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequestEventTarget/onerror

Comment 7

[Shane Caraveo (:mixedpuppy)]

Comment on attachment 8881197 [details]
Bug 1371879 - Add support for unregistering proxy scripts

https://reviewboard.mozilla.org/r/152464/#review157714

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/11962cdf2078
Add support for unregistering proxy scripts r=mixedpuppy

Comment 9

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/11962cdf2078

Comment 10

[erosman]

What happened to proxy.onerror?!

Comment 11

[Matthew Wein [:mattw]]

Sorry for not explaining - I'd okay with renaming to onError, but I'd rather make than change in a separate bug.

Comment 12

[erosman]

I realise that this bug is closed but I didnt want to open a new bug (unless it is needed).

I am unsure about how the API is implemented.

Looking at the following example:
https://github.com/mdn/webextensions-examples/tree/master/proxy-blocker


- It seems 'proxy-script.js' is initiated at browser start. Is it cached?
It makes sense to cache the proxy script, but then ...

- New preferences are sent to 'proxy-script.js' via 'runtime.onMessage'
What happens then?
If the 'proxy-script.js' is cached, how would it affect the change?
Does the 'proxy-script.js' automatically unregistered and registers every time new data is sent via 'runtime.onMessage'?
What happens to the new preference data passed to 'proxy-script.js' once 'proxy-script.js' is unloaded/unregistered?


With the addition of the unregister, developers can now manually stop and restart the 'proxy-script.js' every time they need to update the rules.

How would the API work in FF55? (since unrgister is due for FF56)

Comment 13

[Will Bamberg [:wbamberg]]

I've updated the docs for the addition of unregister() and the rename of registerProxyScript() to just register():

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

Please let me now if this covers it!

Comment 14

[erosman]

re: comment 10-11
Was proxy.onError ever filed?

Comment 15

[Eric Jung [:ericjung]]

> Was proxy.onError ever filed?

Not to my knowledge. Please do so if you want that change.

Comment 16

[erosman]

Filed: Bug 1388619