1813164 - Add to the WebExtensions API in-tree docs a section with details helpful for webidl peer reviews and include it in all the webidl files generated and in the jinja template

Status: RESOLVED FIXED

(WebExtensions :: General, task, P2)

Description

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

As a followup to Bug 1724785, and as agreed in a brief discussion on the topic in phabricator (1, 2), we should include a new section specifically meant to help remind the details of the special setup, motivations for certain choices and the restriction applied to the webidl peer that will have to review and sign-off the webidl interfaces generated from the JSONSchema for the WebExtensions API.

In particular the following one would be helpful:

• how the interfaces defined in the webidl files related to the webextensions API are restricted to only the WebExtensions background service worker (and not made visible/available to web content)

• why all the interfaces for the WebExtensions API are using the LegacyNoInterfaceObject webidl extended attribute

This new section should then be linked in the preamble inline comment part of every of the webidl files related to WebExtensions API bindings (and also in the jinja template that is used by the python script that generates and refresh webidl bindings from the WebExtensions API JSONSchema, https://searchfox.org/mozilla-central/source/toolkit/components/extensions/webidl-api/ExtensionAPI.webidl.in, to make sure the link is going to be always included in all the webidl files we will generate in the future).

Comment 1

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

Attachment: Bug 1813164 - Add to WebExtensions API in-tree docs a section related to webidl bindings DOM peer review and sign-offs. r?willdurand!,smaug!

Depends on D167605

Comment 2

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

Attachment: Bug 1813164 - Add link to WebExtensions webidl docs to non-autogenerated WebExtensions webidl files. r?willdurand!,smaug!

Depends on D168376

Comment 3

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

Attachment: Bug 1813164 - Add link to WebExtensions webidl docs to existing autogenerated WebExtensions webidl files. r?willdurand!,smaug!

Depends on D168377

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/803f75a0ff78
Add to WebExtensions API in-tree docs a section related to webidl bindings DOM peer review and sign-offs. r=willdurand,smaug
https://hg.mozilla.org/integration/autoland/rev/3b263da63974
Add link to WebExtensions webidl docs to non-autogenerated WebExtensions webidl files. r=willdurand,smaug
https://hg.mozilla.org/integration/autoland/rev/5f3709acdf47
Add link to WebExtensions webidl docs to existing autogenerated WebExtensions webidl files. r=willdurand,smaug

Comment 5

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/803f75a0ff78
https://hg.mozilla.org/mozilla-central/rev/3b263da63974
https://hg.mozilla.org/mozilla-central/rev/5f3709acdf47