Open Bug 1903306 Opened 3 months ago Updated 3 months ago

Complete Native messaging portal documentation at toolkit/components/extensions/docs/native-messaging-portal-design.rst

Categories

(WebExtensions :: General, task, P2)

task

Tracking

(Not tracked)

ASSIGNED

People

(Reporter: robwu, Assigned: bandali)

References

(Depends on 1 open bug)

Details

NativeMessaging on Snap builds of Firefox depend on two components, a portal that is added in https://github.com/flatpak/xdg-desktop-portal/pull/705 and the Firefox counterpart that was added in https://phabricator.services.mozilla.com/D140803

For the whole system to function as expected (as documented on MDN, Native Messaging), these two parts need to interact together. This implementation requires knowledge of WebExtensions, Firefox extension internals, D-Bus, XDG portals, including security considerations, lifetime model, states and state transitions, as well as the contract that exists between the browser side of the portal and the portal itself.

This is a complex system that requires good documentation for it to be maintainable. The documentation was started in the implementation in bug 1661935, but never reached the level of detail necessary that would enable new people to get a decent picture, especially when they are unfamiliar with parts of the system.

The purpose of this bug is to complete the documentation. There are some open review comments from me at https://phabricator.services.mozilla.com/D140803?id=809933#diff-change-9HfSkEzHsXuz

Assignee: nobody → bandali
Severity: -- → N/A
Status: NEW → ASSIGNED
Priority: -- → P2
You need to log in before you can comment on or make changes to this bug.