Open Bug 1724785 Opened 2 months ago Updated 6 days ago

Add to the WebExtensions API in-tree docs new content related to the WebIDL bindings

Categories

(WebExtensions :: General, task, P1)

task

Tracking

(Not tracked)

ASSIGNED

People

(Reporter: rpl, Assigned: rpl)

References

(Blocks 1 open bug)

Details

(Keywords: leave-open, Whiteboard: [mv3-m2])

Attachments

(1 file)

Workflow for creating a new WebIDL bindings for an extension API

As part of Bug 1688040 we are introducing a python script to simplify the workflow to bootstrap a new WebIDL bindings from an API namespace JSONSchema, but to fully wiring up the new WebIDL bindings there are some more steps, e.g.:

  • adding a new entry to dom/bindings/Bindings.conf
  • changes to moz.build files to include the new webidl and cpp files to the build
  • adding the new API to ExtensionBrowser.webidl and ExtensionBrowser.h/ExtensionBrowser.cpp

The python script part of Bug 1688040 may help by doing some more sanity checks automatically (e.g. just checking if the necessary content seems to be already there, parsing the file if possible without increasing the script complexity too much) and suggest what seems to still be missing, but fully automate these final steps in a non-fragile way may be tricky if we want to keep that python script as simple as possible (e.g. those files contain comment which would need to be preserved, also the moz.build files wants the entries to be alphabetically ordered).

Some in-tree docs would be useful to describe these steps in enough detail (and update them when necessary), the script would instead do the sanity checks and provide links to the relevant in-tree doc pages.

High level view of the WebIDL API request handling

Besides documenting the workflow for adding or changing the WebIDL bindings for a WebExtensions API, the in-tree docs should also provide an high level view of the architecture, in particular how the WebExtensions APIs called from the extension code running on the service worker thread are received and handled by the WebExtensions framework internals.

Attachment #9242547 - Attachment description: WIP: - Bug 1724785 - Add to WebExtensions API Development in-tree docs a new section for the webidl bindings. → Bug 1724785 - Add to WebExtensions API Development in-tree docs a new section for the webidl bindings. r?mixedpuppy!
Keywords: leave-open
Pushed by luca.greco@alcacoop.it:
https://hg.mozilla.org/integration/autoland/rev/fdcd6e2672ee
Add to WebExtensions API Development in-tree docs a new section for the webidl bindings. r=mixedpuppy
You need to log in before you can comment on or make changes to this bug.