Skip to content

Commit

Permalink
Bug 1859585 - Update GeckoView changelog and docs to mention changes …
Browse files Browse the repository at this point in the history
…to expectated behaviors on calls to WebExtensionController.install. r=willdurand,owlish,amejiamarmol

Depends on D193085

Differential Revision: https://phabricator.services.mozilla.com/D193325
  • Loading branch information
rpl committed Nov 14, 2023
1 parent 7f3ba5d commit 7614729
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
9 changes: 9 additions & 0 deletions mobile/android/docs/geckoview/design/managing-extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ bookmarks, “sessions” gives access to recently closed sessions. The full lis
of permissions that are currently shown to the UI in Firefox Desktop is
available at: ``chrome/browser/browser.properties``

``WebExtension.MetaData`` properties expected to be set to absolute moz-extension urls
(e.g. ``baseUrl`` and ``optionsPageUrl``) are not available yet right after installing
a new extension. Once the extension has been fully started, the delegate method
``WebExtensionController.AddonManagerDelegate.onReady`` will be providing to the
embedder app a new instance of the `MetaData` object where ``baseUrl`` is expected
to be set to a ``"moz-extension://..."`` url (and ``optionsPageUrl`` as well if an
options page was declared in the extension manifest.json file).

Updating
^^^^^^^^

Expand Down Expand Up @@ -193,6 +201,7 @@ rename ``ActionIcon`` to Icon to represent its generic use as the
final String creatorName;
final String creatorUrl;
final String homepageUrl;
final String baseUrl;
final String optionsPageUrl;
final boolean openOptionsPageInTab;
final boolean isRecommended;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ exclude: true
- Added support for controlling `privacy.query_stripping.enabled` and `privacy.query_stripping.enabled.pbmode` via [`GeckoSession.ContentDelegate.queryParameterStrippingEnabled`][121.6] and [`GeckoSession.ContentDelegate.queryParameterStrippingPrivateBrowsingEnabled`][121.7].
- Added support for controlling `privacy.query_stripping.allow_list` and `privacy.query_stripping.strip_list` via [`GeckoSession.ContentDelegate.queryParameterStrippingAllowList`][121.8] and [`GeckoSession.ContentDelegate.queryParameterStrippingStripList`][121.9].
- Add [`WebExtensionController.AddonManagerDelegate.onReady`][121.10] ([bug 1859585]({{bugzilla}}1859585).
- ⚠️ `WebExtensionController.install` method will not be implicitly awaiting for the installed extension to be fully started anymore, callers of the install method should now expect the `WebExtension.MetaData` properties `baseUrl` and `optionsPageUrl` to be not be
defined yet until the `WebExtensionController.AddonManagerDelegate.onReady` delegated method has been called ([bug 1859585]({{bugzilla}}1859585).

[121.1]: {{javadoc_uri}}/TranslationsController.RuntimeTranslation.html
[121.2]: {{javadoc_uri}}/ContentBlocking.Settings.Builder.html#cookieBannerGlobalRulesEnabled(boolean)
Expand Down

0 comments on commit 7614729

Please sign in to comment.