1641735 - Improve extension testing framework for GeckoView to not require useAddonManager in ExtensionTestUtils.loadExtension

Status: RESOLVED FIXED

(WebExtensions :: Android, enhancement, P2)

Description

[Rob Wu [:robwu]]

ExtensionTestUtils.loadExtension is used to load extensions in tests. Many extension tests on desktop (and Fennec) did not depend on the addon manager, so to reduce the overhead in tests, the utility generates an add-on without addon manager by default. useAddonManager is only used in tests where the addon manager is significant.

In GeckoView, various UI-related APIs (tabs, browserAction, pageAction) only work when the extension has been registered via the Addon Manager. Unfortunately, this results in lots of boilerplate in extension tests, where every test that uses UI on Android includes useAddonManager: "permanent" plus an extension ID, see e.g. bug 1615329 and bug 1599580.

We should improve ExtensionTestUtils.loadExtension (the mochitest one, not the one for xpcshell tests) to not require useAddonManager for it to work.
There are several ways to do that. It could be done by adding useAddonManager to every loadExtension call on Android/GeckoView, by providing a minimal mock of the AddonWrapper from the addon manager internals, or maybe even modifying GeckoView internals to account for this.

Comment 1

[[ex-Mozilla] Agi Sferro | :agi]

I don't think there's much we can do on the GV side to circumvent that, I don't think a mock AddonManager is worth either, unless we have a very compelling reason to do that.

Comment 2

[Rob Wu [:robwu]]

Attachment: Bug 1641735 - Set useAddonManager by default on Android in mochitests

This patch introduces the androidBrowserTest option to offer an
alternative to adding a boilerplate useAddonManager + extension ID in
mochitests that use certain extension APIs.

Comment 3

[Rob Wu [:robwu]]

Attachment: Bug 1641735 - Replace unnecessary uses of useAddonManager of ExtensionTestUtils.loadExtension

The androidBrowserTest option of ExtensionTestUtils.loadExtension exists
to allow Android tests to correctly register with the AddonManager
without unnecessarily forcing this registration on desktop.

This patch replaces all unnecessary uses of useAddonManager with the
androidBrowserTest option, which is essentially the same but only
enables the "useAddonManager" option on Android. This is to make it more
obvious when a test really depends on the AddonManager (on desktop),
opposed to only depending on it indirectly as part of the GeckoView
implementation.

In some tests, useAddonManager was not used before because the test is
marked as skipped, but I've added the option regardless for the future.

Comment 4

[Rob Wu [:robwu]]

Attachment: Bug 1641735 - Code cleanup of some extension tests

In the past, add_task was generator-based, and tests were automatically
rewritten to use Promises. Some tests have weird constructs such as the
use of Promise.all+await or still using generators. These have been
fixed.

Some tests request the tabs permission without actually needing it.

This patch does not affect the behavior of the tests.

Comment 5

[Rob Wu [:robwu]]

Attachment: Bug 1641735 - Re-enable some tabs tests on Android

test_ext_tab_runtimeConnect.html can be re-enabled since bug 1534640 got fixed.
test_ext_tabs_reload.html had a race condition.
test_ext_tabs_reload_bypass_cache.html fix similar to bug 1335180.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/90d683f96928
Set useAddonManager by default on Android in mochitests r=zombie
https://hg.mozilla.org/integration/autoland/rev/ba58b88f06ff
Replace unnecessary uses of useAddonManager of ExtensionTestUtils.loadExtension r=zombie,agi,extension-reviewers
https://hg.mozilla.org/integration/autoland/rev/2dc275e3cc0f
Code cleanup of some extension tests r=geckoview-reviewers,agi,mixedpuppy
https://hg.mozilla.org/integration/autoland/rev/f5d6ae6aea44
Re-enable some tabs tests on Android r=agi,extension-reviewers,zombie

Comment 7

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/90d683f96928
https://hg.mozilla.org/mozilla-central/rev/ba58b88f06ff
https://hg.mozilla.org/mozilla-central/rev/2dc275e3cc0f
https://hg.mozilla.org/mozilla-central/rev/f5d6ae6aea44