1762592 - Consider supporting mapping to AsyncAmbiguous through GenerateWebIDLBindings.py config file

Status: RESOLVED FIXED

(WebExtensions :: General, task, P3)

Description

[Luca Greco [:rpl] [:luca] [:lgreco]]

While working on the WebIDL bindings for the scripting WebExtensions API (Bug 1748315) we noticed that the type signatures currently being generated by the GenerateWebIDLBindings.py script based on the scripting API JSONSchema definitions for the methods getRegisteredContentScripts and unregisterContentScripts are not all distinguishable from a WebIDL perspective.

As an example for the getRegisteredContentScript we would be generating 2 methods with the following parameters:

   [Throws, WebExtensionStub="Async"]
   any getRegisteredContentScripts(any filter, optional Function callback);
   [Throws, WebExtensionStub="Async"]
   any getRegisteredContentScripts(optional Function callback);

which are not distinguishable when getRegisteredContentScript is called with a single parameter (e.g. with only one undefined value passed as call parameters, both the type signatures would match).

As a short term solution, we are considering to use a single method with the "AsyncAmbiguous" WebExtensionStub (which we already support and currently use for browser.runtime.sendMessage):

   [Throws, WebExtensionStub="AsyncAmbiguous"]
   any getRegisteredContentScripts(any... args);

The CallWebExtMethodAsyncAmbiguous stub does take care internally of removing the optional chrome-compatible callback parameter before serializing and forwarding the rest of the parameters to the ExtensionAPIRequestHandler defined on the main thread, and so it would technically be the same as if a webidl method defined as any getRegisteredContentScripts(any filter, optional Function callback).

Comment 1

[Luca Greco [:rpl] [:luca] [:lgreco]]

Attachment: Bug 1762592 - Support mapping to AsyncAmbiguous through GenerateWebIDLBindings.py config file. r?willdurand!

Comment 2

[Luca Greco [:rpl] [:luca] [:lgreco]]

Attachment: Bug 1762592 - Remove unnecessary trailing whitespace from extension API generated webidl filed.

Depends on D142682

Comment 3

[Phabricator Automation]

Comment on attachment 9270421 [details]
Bug 1762592 - Remove unnecessary trailing whitespace from extension API generated webidl filed.

Revision D142683 was moved to bug 1779561. Setting attachment 9270421 [details] to obsolete.

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/cf8d44dbecdc
Support mapping to AsyncAmbiguous through GenerateWebIDLBindings.py config file. r=willdurand

Comment 5

[Cristina Cozmuta (:CrissCozmuta)]

https://hg.mozilla.org/mozilla-central/rev/cf8d44dbecdc