document high-level client-side implementation details for system add-ons

RESOLVED FIXED in Firefox 54

Status

()

Toolkit
Add-ons Manager
RESOLVED FIXED
a year ago
a year ago

People

(Reporter: rhelmer, Assigned: rhelmer)

Tracking

unspecified
mozilla54
Points:
---

Firefox Tracking Flags

(firefox54 fixed)

Details

(Whiteboard: [documentation] triaged)

MozReview Requests

()

Submitter Diff Changes Open Issues Last Updated
Loading...
Error loading review requests:

Attachments

(1 attachment)

(Assignee)

Description

a year ago
Right now https://gecko.readthedocs.io/en/latest/toolkit/mozapps/extensions/addon-manager/SystemAddons.html (which lives in m-c as an RST file) focuses on the update mechanism.

We should also document some high-level details about the client-side implementation as well, such as details on the install locations and signing etc.
Comment hidden (mozreview-request)
(Assignee)

Updated

a year ago
Attachment #8839683 - Flags: feedback?(6a68)
Comment hidden (mozreview-request)
(Assignee)

Updated

a year ago
Attachment #8839683 - Flags: feedback?(6a68)
Comment on attachment 8839683 [details]
Bug 1341434 - document high-level client-side implementation details for system add-ons

:+1: Thanks for writing this up! I don't know the details well enough to tell if you've missed anything, but seems like a solid overview to me.
Attachment #8839683 - Flags: feedback?(6a68) → feedback+

Updated

a year ago
Whiteboard: [documentation] triaged
(Assignee)

Updated

a year ago
Attachment #8839683 - Flags: review?(kmaglione+bmo) → review?(aswan)

Comment 4

a year ago
mozreview-review
Comment on attachment 8839683 [details]
Bug 1341434 - document high-level client-side implementation details for system add-ons

https://reviewboard.mozilla.org/r/114262/#review118062

::: toolkit/mozapps/extensions/docs/SystemAddons.rst:18
(Diff revision 2)
> +
> +The add-ons themselves are either legacy Firefox add-ons or WebExtensions.
> +They must be:
> +
> +* restartless
> +* signed by Mozilla (with the Components key, not the standard AMO key)

This is actually only true of updates right?
Additionally, perhaps a further reference here?  I expect anybody reading this who isn't already familiar with system add-ons won't have any idea what the Components key is or how to get an update signed with it.

::: toolkit/mozapps/extensions/docs/SystemAddons.rst:24
(Diff revision 2)
> +* multi-process compatible
> +
> +Other than these restrictions there is nothing special or different about
> +the extensions themselves.
> +
> +It is possible to override installed system add-ons based on precedence 

trailing space

::: toolkit/mozapps/extensions/docs/SystemAddons.rst:24
(Diff revision 2)
> +It is possible to override installed system add-ons based on precedence 
> +of install locations:

This is kind of opaque.  Maybe reword to something like "It is possible to override an installed system add-on by installing a different version in a higher priority location.  Available locations, starting from the highest priority include:"
Attachment #8839683 - Flags: review?(aswan) → review+
Comment hidden (mozreview-request)
Comment hidden (mozreview-request)
Comment hidden (mozreview-request)
(Assignee)

Comment 8

a year ago
mozreview-review-reply
Comment on attachment 8839683 [details]
Bug 1341434 - document high-level client-side implementation details for system add-ons

https://reviewboard.mozilla.org/r/114262/#review118062

> This is actually only true of updates right?
> Additionally, perhaps a further reference here?  I expect anybody reading this who isn't already familiar with system add-ons won't have any idea what the Components key is or how to get an update signed with it.

Good point... we're actually working on the process here so I'll move this to the updates section below with a little more explanation and suggest contacting the gofaster team if you have an update you'd like to ship.
Comment hidden (mozreview-request)

Comment 10

a year ago
Pushed by rhelmer@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/ab41a61ca37b
document high-level client-side implementation details for system add-ons r=aswan

Comment 11

a year ago
bugherder
https://hg.mozilla.org/mozilla-central/rev/ab41a61ca37b
Status: NEW → RESOLVED
Last Resolved: a year ago
status-firefox54: --- → fixed
Resolution: --- → FIXED
Target Milestone: --- → mozilla54
You need to log in before you can comment on or make changes to this bug.