Closed
Bug 1453522
Opened 6 years ago
Closed 6 years ago
document bundled experiments
Categories
(WebExtensions :: Experiments, enhancement)
WebExtensions
Experiments
Tracking
(firefox61 fixed)
RESOLVED
FIXED
mozilla61
Tracking | Status | |
---|---|---|
firefox61 | --- | fixed |
People
(Reporter: aswan, Assigned: aswan)
Details
Attachments
(1 file)
No description provided.
Comment hidden (mozreview-request) |
Assignee | ||
Updated•6 years ago
|
Attachment #8967210 -
Flags: review?(kmaglione+bmo)
Comment 2•6 years ago
|
||
mozreview-review |
Comment on attachment 8967210 [details] Bug 1453522 Document bundled webextension experiments https://reviewboard.mozilla.org/r/235878/#review241654 ::: toolkit/components/extensions/docs/basics.rst:144 (Diff revision 1) > lifecycle. These are listed in the ``events`` property and described in > more detail in :ref:`lifecycle`. > > WebExtensions Experiments > ------------------------- > -(*This section left blank pending some coming experiments changes*) > +A new API may also be implemented within an extension, an API implemented Comma splice. ::: toolkit/components/extensions/docs/basics.rst:146 (Diff revision 1) > > WebExtensions Experiments > ------------------------- > -(*This section left blank pending some coming experiments changes*) > +A new API may also be implemented within an extension, an API implemented > +this way is called a WebExtension Experiment. Experiments can be useful > +when actively developing a new API as they do not require doing a local build s/API as/API, as/ *building Firefox locally ::: toolkit/components/extensions/docs/basics.rst:147 (Diff revision 1) > WebExtensions Experiments > ------------------------- > -(*This section left blank pending some coming experiments changes*) > +A new API may also be implemented within an extension, an API implemented > +this way is called a WebExtension Experiment. Experiments can be useful > +when actively developing a new API as they do not require doing a local build > +of Firefox. Note that extensions that include experiments will not be s/will not/cannot/ ::: toolkit/components/extensions/docs/basics.rst:149 (Diff revision 1) > -(*This section left blank pending some coming experiments changes*) > +A new API may also be implemented within an extension, an API implemented > +this way is called a WebExtension Experiment. Experiments can be useful > +when actively developing a new API as they do not require doing a local build > +of Firefox. Note that extensions that include experiments will not be > +signed by addons.mozilla.org. They may be installed temporarily via > +``about:debugging`` or permanently by setting the preference * or, on browsers that support it (currently ...), by setting... ::: toolkit/components/extensions/docs/basics.rst:158 (Diff revision 1) > +Experimental APIs have a few limitations compared with built-in APIs: > + > +- Experimental APIs can (currently) only be exposed to extension pages, > + not to devtools pages or to content scripts. > +- Experimental APIs cannot handle manifest keys (since the extension manifest > + needs to be parsed and validated before experimental APIs are loaded). Just FYI, I've been considering adding an `experiments` object to the top-level manifest that can be used for manifest directives that apply to experiment APIs. Not sure at this point whether it should be validated after the experiment schemas are loaded or just a free-for-all. ::: toolkit/components/extensions/docs/basics.rst:159 (Diff revision 1) > + > +- Experimental APIs can (currently) only be exposed to extension pages, > + not to devtools pages or to content scripts. > +- Experimental APIs cannot handle manifest keys (since the extension manifest > + needs to be parsed and validated before experimental APIs are loaded). > +- Experimental APIs cannot handle extension lifecycle events (since Whould be nice to clarify what this means. They can handle startup and shutdown events, and installs/upgrades/uninstalls from those handlers. They just don't get static install/uninstall handler calls. ::: toolkit/components/extensions/docs/basics.rst:160 (Diff revision 1) > +- Experimental APIs can (currently) only be exposed to extension pages, > + not to devtools pages or to content scripts. > +- Experimental APIs cannot handle manifest keys (since the extension manifest > + needs to be parsed and validated before experimental APIs are loaded). > +- Experimental APIs cannot handle extension lifecycle events (since > + in general those may occurs when an affected extension is not active s/occurs/occur/ ::: toolkit/components/extensions/docs/basics.rst:196 (Diff revision 1) > +to a file inside the extension containing the API schema. The actual > +implementation details for the parent process and for child processes > +are defined in the ``parent`` and ``child`` properties of the API > +definition respectively. Inside these sections, the ``scope`` and ``paths`` > +properties have the same meaning as those properties in the definition > +of a built-in API (though see the note above about limitations, the Comma splice.
Attachment #8967210 -
Flags: review?(kmaglione+bmo) → review+
Comment hidden (mozreview-request) |
Pushed by aswan@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/b0553a9a967c Document bundled webextension experiments r=kmag
Comment 5•6 years ago
|
||
bugherder |
https://hg.mozilla.org/mozilla-central/rev/b0553a9a967c
Status: NEW → RESOLVED
Closed: 6 years ago
status-firefox61:
--- → fixed
Resolution: --- → FIXED
Target Milestone: --- → mozilla61
Comment 6•6 years ago
|
||
Please let us know if any testing is needed here or mark the bug as "qe-verify-"
Flags: needinfo?(aswan)
Assignee | ||
Updated•6 years ago
|
Flags: needinfo?(aswan) → qe-verify-
Updated•6 years ago
|
Product: Toolkit → WebExtensions
You need to log in
before you can comment on or make changes to this bug.
Description
•