Merge mozilla-mobile#5327

5327: Issue mozilla-mobile#4500: Wire up AddonManager -> Engine r=Amejia481,psymoon a=csadilek

Next 🧩. Wiring Up AddonManager and Engine.

Next step after that: Wiring up UI and AddonManager.

Co-authored-by: Christian Sadilek <[email protected]>

Author: MozLando

components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/webextension/GeckoWebExtension.kt

@@ -222,6 +222,7 @@ class GeckoWebExtension(
 
     // Not yet supported
     override fun getMetadata(): Metadata? = null
+    override fun isEnabled(): Boolean = true
 }
 
 /**

components/browser/engine-gecko-nightly/src/main/java/mozilla/components/browser/engine/gecko/webextension/GeckoWebExtension.kt

@@ -242,6 +242,11 @@ class GeckoWebExtension(
             )
         }
     }
+
+    override fun isEnabled(): Boolean {
+        // TODO https://bugzilla.mozilla.org/show_bug.cgi?id=1599585
+        return true
+    }
 }
 
 /**

components/browser/engine-gecko-nightly/src/test/java/mozilla/components/browser/engine/gecko/webextension/GeckoWebExtensionTest.kt

@@ -362,4 +362,10 @@ class GeckoWebExtensionTest {
         val externalExtension = GeckoWebExtension(WebExtension("https://url", "id", WebExtension.Flags.NONE))
         assertFalse(externalExtension.isBuiltIn())
     }
+
+    @Test
+    fun `isEnabled depends on native state`() {
+        val extension = GeckoWebExtension(WebExtension("resource://url", "id", WebExtension.Flags.NONE))
+        assertTrue(extension.isEnabled())
+    }
 }

components/browser/engine-gecko/src/main/java/mozilla/components/browser/engine/gecko/webextension/GeckoWebExtension.kt

@@ -151,6 +151,7 @@ class GeckoWebExtension(
     override fun registerActionHandler(session: EngineSession, actionHandler: ActionHandler) = Unit
     override fun hasActionHandler(session: EngineSession) = false
     override fun getMetadata(): Metadata? = null
+    override fun isEnabled(): Boolean = true
 }
 
 /**

components/concept/engine/src/main/java/mozilla/components/concept/engine/webextension/WebExtension.kt

@@ -18,6 +18,7 @@ import org.json.JSONObject
  * @property supportActions whether or not browser and page actions are handled when
  * received from the web extension
  */
+@Suppress("TooManyFunctions")
 abstract class WebExtension(
     val id: String,
     val url: String,
@@ -127,6 +128,11 @@ abstract class WebExtension(
      * APK file) or coming from an external source.
      */
     fun isBuiltIn(): Boolean = Uri.parse(url).scheme == "resource"
+
+    /**
+     * Checks whether or not this extension is enabled.
+     */
+    abstract fun isEnabled(): Boolean
 }
 
 /**

components/feature/addons/src/main/java/mozilla/components/feature/addons/AddonManager.kt

@@ -4,21 +4,24 @@
 
 package mozilla.components.feature.addons
 
-import mozilla.components.browser.state.action.WebExtensionAction
-import mozilla.components.browser.state.state.WebExtensionState
 import mozilla.components.browser.state.store.BrowserStore
 import mozilla.components.concept.engine.Engine
 import mozilla.components.concept.engine.webextension.WebExtension
 import mozilla.components.feature.addons.update.AddonUpdater
 import mozilla.components.feature.addons.update.AddonUpdater.Status
 import mozilla.components.feature.addons.update.GlobalAddonManagerProvider
 import mozilla.components.support.webextensions.WebExtensionSupport
+import mozilla.components.support.webextensions.WebExtensionSupport.installedExtensions
+import java.lang.IllegalStateException
 
 /**
  * Provides access to installed and recommended [Addon]s and manages their states.
  *
  * @property store The application's [BrowserStore].
+ * @property engine The application's browser [Engine].
  * @property addonsProvider The [AddonsProvider] to query available [Addon]s.
+ * @property addonUpdater The [AddonUpdater] instance to use when checking / triggering
+ * updates.
  */
 class AddonManager(
     private val store: BrowserStore,
@@ -45,28 +48,131 @@ class AddonManager(
             // Make sure extension support is initialized, i.e. the state of all installed extensions is known.
             WebExtensionSupport.awaitInitialization()
 
-            // TODO for testing purposes -> remove once management API lands
-            val ublockId = "607454"
-            store.dispatch(WebExtensionAction.InstallWebExtensionAction(WebExtensionState(ublockId))).join()
-
             return addonsProvider.getAvailableAddons().map { addon ->
-                store.state.extensions[addon.id]?.let { installedAddon ->
-                    // TODO Add fields once we get the management API:
-                    // https://github.com/mozilla-mobile/android-components/issues/4500
-                    addon.copy(installedState = Addon.InstalledState(installedAddon.id, "1.0", "https://mozilla.org"))
-                } ?: addon
+                installedExtensions[addon.id]?.let { addon.copy(installedState = it.toInstalledState()) } ?: addon
             }
         } catch (throwable: Throwable) {
             throw AddonManagerException(throwable)
         }
     }
 
     /**
-     * Try updates the addon with the provided [id] by updating it in the the [store] and re-attaching
-     * all the handlers. If there is no update available nothing will happen.
+     * Installs the provided [Addon].
+     *
+     * @param addon the addon to install.
+     * @param onSuccess (optional) callback invoked if the addon was installed successfully,
+     * providing access to the [Addon] object.
+     * @param onError (optional) callback invoked if there was an error installing the addon.
+     */
+    fun installAddon(
+        addon: Addon,
+        onSuccess: ((Addon) -> Unit) = { },
+        onError: ((String, Throwable) -> Unit) = { _, _ -> }
+    ) {
+        engine.installWebExtension(
+            id = addon.id,
+            url = addon.downloadUrl,
+            onSuccess = { ext ->
+                val installedAddon = addon.copy(installedState = ext.toInstalledState())
+                addonUpdater.registerForFutureUpdates(installedAddon.id)
+                onSuccess(installedAddon)
+            },
+            onError = onError
+        )
+    }
+
+    /**
+     * Uninstalls the provided [Addon].
+     *
+     * @param addon the addon to uninstall.
+     * @param onSuccess (optional) callback invoked if the addon was uninstalled successfully.
+     * @param onError (optional) callback invoked if there was an error installing the addon.
+     */
+    fun uninstallAddon(
+        addon: Addon,
+        onSuccess: (() -> Unit) = { },
+        onError: ((String, Throwable) -> Unit) = { _, _ -> }
+    ) {
+        val extension = addon.installedState?.let { installedExtensions[it.id] }
+        if (extension == null) {
+            onError(addon.id, IllegalStateException("Addon is not installed"))
+            return
+        }
+
+        engine.uninstallWebExtension(
+            extension,
+            onSuccess = {
+                addonUpdater.unregisterForFutureUpdates(addon.id)
+                onSuccess()
+            },
+            onError = onError
+        )
+    }
+
+    /**
+     * Enables the provided [Addon].
+     *
+     * @param addon the [Addon] to enable.
+     * @param onSuccess (optional) callback invoked with the enabled [Addon].
+     * @param onError (optional) callback invoked if there was an error enabling
+     */
+    fun enableAddon(
+        addon: Addon,
+        onSuccess: ((Addon) -> Unit) = { },
+        onError: ((Throwable) -> Unit) = { }
+    ) {
+        val extension = addon.installedState?.let { installedExtensions[it.id] }
+        if (extension == null) {
+            onError(IllegalStateException("Addon is not installed"))
+            return
+        }
+
+        engine.enableWebExtension(
+            extension,
+            onSuccess = { ext ->
+                val enabledAddon = addon.copy(installedState = ext.toInstalledState())
+                onSuccess(enabledAddon)
+            },
+            onError = onError
+        )
+    }
+
+    /**
+     * Disables the provided [Addon].
+     *
+     * @param addon the [Addon] to disable.
+     * @param onSuccess (optional) callback invoked with the enabled [Addon].
+     * @param onError (optional) callback invoked if there was an error enabling
+     */
+    fun disableAddon(
+        addon: Addon,
+        onSuccess: ((Addon) -> Unit) = { },
+        onError: ((Throwable) -> Unit) = { }
+    ) {
+        val extension = addon.installedState?.let { installedExtensions[it.id] }
+        if (extension == null) {
+            onError(IllegalStateException("Addon is not installed"))
+            return
+        }
+
+        engine.disableWebExtension(
+            extension,
+            onSuccess = { ext ->
+                val disabledAddon = addon.copy(installedState = ext.toInstalledState())
+                onSuccess(disabledAddon)
+            },
+            onError = onError
+        )
+    }
+
+    /**
+     * Updates the addon with the provided [id] if an update is available.
+     *
+     * @param id the ID of the addon
+     * @param onFinish callback invoked with the [Status] of the update once complete.
      */
     fun updateAddon(id: String, onFinish: ((Status) -> Unit)) {
-        val extension = WebExtensionSupport.installedExtensions[id]
+        val extension = installedExtensions[id]
 
         if (extension == null) {
             onFinish(Status.NotInstalled)
@@ -95,3 +201,8 @@ class AddonManager(
  * Wraps exceptions thrown by either the initialization process or an [AddonsProvider].
  */
 class AddonManagerException(throwable: Throwable) : Exception(throwable)
+
+private fun WebExtension.toInstalledState() =
+    // TODO Add optionsUrl
+    // TODO https://bugzilla.mozilla.org/show_bug.cgi?id=1598792
+    Addon.InstalledState(id, getMetadata()?.version ?: "", "https://mozilla.org", isEnabled())