For mozilla-mobile#9417 - Add support for sharing actual website images (mozilla-mobile#9420)

Prior to this when the user selected to share an image from the contextual menu
the apps would only share the URL, not the actual resource.

This patch adds a new `ShareDownloadFeature` that will listen for
`AddShareAction` and download, cache locally and then share the Internet
resource contained in Action's state.

Giving the time needed to actually download these resources this feature is
only used for image sharing, not for other types of potentially bigger
resource types.

This is a breaking change with clients expected to create and register a new
instance of the this new feature otherwise the "Share image" from the
browser contextual menu will do nothing.

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Author: Mugurell

components/browser/state/src/main/java/mozilla/components/browser/state/action/BrowserAction.kt

@@ -17,17 +17,18 @@ import mozilla.components.browser.state.state.EngineState
 import mozilla.components.browser.state.state.LoadRequestState
 import mozilla.components.browser.state.state.MediaSessionState
 import mozilla.components.browser.state.state.MediaState
-import mozilla.components.browser.state.state.content.PermissionHighlightsState
 import mozilla.components.browser.state.state.ReaderState
+import mozilla.components.browser.state.state.SearchState
 import mozilla.components.browser.state.state.SecurityInfoState
 import mozilla.components.browser.state.state.SessionState
 import mozilla.components.browser.state.state.TabSessionState
 import mozilla.components.browser.state.state.TrackingProtectionState
+import mozilla.components.browser.state.state.UndoHistoryState
 import mozilla.components.browser.state.state.WebExtensionState
 import mozilla.components.browser.state.state.content.DownloadState
 import mozilla.components.browser.state.state.content.FindResultState
-import mozilla.components.browser.state.state.SearchState
-import mozilla.components.browser.state.state.UndoHistoryState
+import mozilla.components.browser.state.state.content.PermissionHighlightsState
+import mozilla.components.browser.state.state.content.ShareInternetResourceState
 import mozilla.components.browser.state.state.recover.RecoverableTab
 import mozilla.components.concept.engine.Engine
 import mozilla.components.concept.engine.EngineSession
@@ -38,8 +39,8 @@ import mozilla.components.concept.engine.history.HistoryItem
 import mozilla.components.concept.engine.manifest.WebAppManifest
 import mozilla.components.concept.engine.media.Media
 import mozilla.components.concept.engine.media.RecordingDevice
-import mozilla.components.concept.engine.permission.PermissionRequest
 import mozilla.components.concept.engine.mediasession.MediaSession
+import mozilla.components.concept.engine.permission.PermissionRequest
 import mozilla.components.concept.engine.prompt.PromptRequest
 import mozilla.components.concept.engine.search.SearchRequest
 import mozilla.components.concept.engine.webextension.WebExtensionBrowserAction
@@ -1035,6 +1036,28 @@ sealed class DownloadAction : BrowserAction() {
     data class RestoreDownloadStateAction(val download: DownloadState) : DownloadAction()
 }
 
+/**
+ * [BrowserAction] implementations related to updating the session state of internet resources to be shared.
+ */
+sealed class ShareInternetResourceAction : BrowserAction() {
+    /**
+     * Starts the sharing process of an Internet resource.
+     */
+    data class AddShareAction(
+        val tabId: String,
+        val internetResource: ShareInternetResourceState
+    ) : ShareInternetResourceAction()
+
+    /**
+     * Previous share request is considered completed.
+     * File was successfully shared with other apps / user may have aborted the process or the operation
+     * may have failed. In either case the previous share request is considered completed.
+     */
+    data class ConsumeShareAction(
+        val tabId: String
+    ) : ShareInternetResourceAction()
+}
+
 /**
  * [BrowserAction] implementations related to updating [BrowserState.containers]
  */

components/browser/state/src/main/java/mozilla/components/browser/state/reducer/BrowserStateReducer.kt

@@ -12,15 +12,16 @@ import mozilla.components.browser.state.action.CustomTabListAction
 import mozilla.components.browser.state.action.DownloadAction
 import mozilla.components.browser.state.action.EngineAction
 import mozilla.components.browser.state.action.InitAction
+import mozilla.components.browser.state.action.LastAccessAction
 import mozilla.components.browser.state.action.MediaAction
+import mozilla.components.browser.state.action.MediaSessionAction
 import mozilla.components.browser.state.action.ReaderAction
+import mozilla.components.browser.state.action.RecentlyClosedAction
+import mozilla.components.browser.state.action.RestoreCompleteAction
 import mozilla.components.browser.state.action.SearchAction
+import mozilla.components.browser.state.action.ShareInternetResourceAction
 import mozilla.components.browser.state.action.SystemAction
 import mozilla.components.browser.state.action.TabListAction
-import mozilla.components.browser.state.action.LastAccessAction
-import mozilla.components.browser.state.action.MediaSessionAction
-import mozilla.components.browser.state.action.RecentlyClosedAction
-import mozilla.components.browser.state.action.RestoreCompleteAction
 import mozilla.components.browser.state.action.TrackingProtectionAction
 import mozilla.components.browser.state.action.UndoAction
 import mozilla.components.browser.state.action.WebExtensionAction
@@ -59,6 +60,7 @@ internal object BrowserStateReducer {
             is CrashAction -> CrashReducer.reduce(state, action)
             is LastAccessAction -> LastAccessReducer.reduce(state, action)
             is UndoAction -> UndoReducer.reduce(state, action)
+            is ShareInternetResourceAction -> ShareInternetResourceStateReducer.reduce(state, action)
         }
     }
 }

components/browser/state/src/main/java/mozilla/components/browser/state/reducer/ShareInternetResourceStateReducer.kt

@@ -0,0 +1,34 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package mozilla.components.browser.state.reducer
+
+import androidx.annotation.VisibleForTesting
+import mozilla.components.browser.state.action.ShareInternetResourceAction
+import mozilla.components.browser.state.state.BrowserState
+import mozilla.components.browser.state.state.ContentState
+
+internal object ShareInternetResourceStateReducer {
+    fun reduce(state: BrowserState, action: ShareInternetResourceAction): BrowserState {
+        return when (action) {
+            is ShareInternetResourceAction.AddShareAction -> updateTheContentState(state, action.tabId) {
+                it.copy(share = action.internetResource)
+            }
+            is ShareInternetResourceAction.ConsumeShareAction -> updateTheContentState(state, action.tabId) {
+                it.copy(share = null)
+            }
+        }
+    }
+}
+
+@VisibleForTesting
+internal inline fun updateTheContentState(
+    state: BrowserState,
+    tabId: String,
+    crossinline update: (ContentState) -> ContentState
+): BrowserState {
+    return state.updateTabState(tabId) { current ->
+        current.createCopy(content = update(current.content))
+    }
+}

components/browser/state/src/main/java/mozilla/components/browser/state/state/ContentState.kt

@@ -9,6 +9,7 @@ import mozilla.components.browser.state.state.content.DownloadState
 import mozilla.components.browser.state.state.content.FindResultState
 import mozilla.components.browser.state.state.content.HistoryState
 import mozilla.components.browser.state.state.content.PermissionHighlightsState
+import mozilla.components.browser.state.state.content.ShareInternetResourceState
 import mozilla.components.concept.engine.HitResult
 import mozilla.components.concept.engine.manifest.WebAppManifest
 import mozilla.components.concept.engine.media.RecordingDevice
@@ -33,6 +34,7 @@ import mozilla.components.concept.engine.window.WindowRequest
  * be used as a preview in e.g. a tab switcher.
  * @property icon the icon of the page currently loaded by this session.
  * @property download Last unhandled download request.
+ * @property share Last unhandled request to share an internet resource that first needs to be downloaded.
  * @property hitResult the target of the latest long click operation.
  * @property promptRequest the last received [PromptRequest].
  * @property findResults the list of results of the latest "find in page" operation.
@@ -70,6 +72,7 @@ data class ContentState(
     val thumbnail: Bitmap? = null,
     val icon: Bitmap? = null,
     val download: DownloadState? = null,
+    val share: ShareInternetResourceState? = null,
     val hitResult: HitResult? = null,
     val promptRequest: PromptRequest? = null,
     val findResults: List<FindResultState> = emptyList(),

components/browser/state/src/main/java/mozilla/components/browser/state/state/content/ShareInternetResourceState.kt

@@ -0,0 +1,23 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package mozilla.components.browser.state.state.content
+
+import mozilla.components.concept.fetch.Response
+
+/**
+ * Value type that represents an Internet resource selected to be shared.
+ *
+ * @property url The full url to the content that should be shared.
+ * @property contentType Content type (MIME type) to indicate the media type of the resource.
+ * @property private Indicates if the share operation initiated from a private session.
+ * @property response A response object associated with this request, when provided can be
+ * used instead of performing a manual a download.
+ */
+data class ShareInternetResourceState(
+    val url: String,
+    val contentType: String? = null,
+    val private: Boolean = false,
+    val response: Response? = null
+)

components/browser/state/src/test/java/mozilla/components/browser/state/reducer/ShareInternetResourceStateReducerTest.kt

@@ -0,0 +1,72 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package mozilla.components.browser.state.reducer
+
+import mozilla.components.browser.state.action.ShareInternetResourceAction
+import mozilla.components.browser.state.state.BrowserState
+import mozilla.components.browser.state.state.ContentState
+import mozilla.components.browser.state.state.TabSessionState
+import mozilla.components.browser.state.state.content.ShareInternetResourceState
+import mozilla.components.concept.fetch.Response
+import mozilla.components.support.test.mock
+import org.junit.Assert.assertEquals
+import org.junit.Assert.assertFalse
+import org.junit.Assert.assertNotNull
+import org.junit.Assert.assertNull
+import org.junit.Assert.assertTrue
+import org.junit.Test
+
+class ShareInternetResourceStateReducerTest {
+
+    @Test
+    fun `reduce - AddShareAction should add the internetResource in the ContentState`() {
+        val reducer = ShareInternetResourceStateReducer
+        val state = BrowserState(tabs = listOf(TabSessionState("tabId", ContentState("contentStateUrl"))))
+        val response: Response = mock()
+        val action = ShareInternetResourceAction.AddShareAction(
+            "tabId",
+            ShareInternetResourceState("internetResourceUrl", "type", true, response)
+        )
+
+        assertNull(state.tabs[0].content.share)
+
+        val result = reducer.reduce(state, action)
+
+        val shareState = result.tabs[0].content.share!!
+        assertEquals("internetResourceUrl", shareState.url)
+        assertEquals("type", shareState.contentType)
+        assertTrue(shareState.private)
+        assertEquals(response, shareState.response)
+    }
+
+    @Test
+    fun `reduce - ConsumeShareAction should remove the ShareInternetResourceState ContentState`() {
+        val reducer = ShareInternetResourceStateReducer
+        val shareState: ShareInternetResourceState = mock()
+        val state = BrowserState(
+            tabs = listOf(
+                TabSessionState("tabId", ContentState("contentStateUrl", share = shareState))
+            )
+        )
+        val action = ShareInternetResourceAction.ConsumeShareAction("tabId")
+
+        assertNotNull(state.tabs[0].content.share)
+
+        val result = reducer.reduce(state, action)
+
+        assertNull(result.tabs[0].content.share)
+    }
+
+    @Test
+    fun `updateTheContentState will return a new BrowserState with updated ContentState`() {
+        val initialContentState = ContentState("emptyStateUrl")
+        val browserState = BrowserState(tabs = listOf(TabSessionState("tabId", initialContentState)))
+
+        val result = updateTheContentState(browserState, "tabId") { it.copy(url = "updatedUrl") }
+
+        assertFalse(browserState == result)
+        assertEquals("updatedUrl", result.tabs[0].content.url)
+    }
+}

components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt

@@ -12,10 +12,11 @@ import android.view.View
 import com.google.android.material.snackbar.Snackbar
 import mozilla.components.browser.state.state.SessionState
 import mozilla.components.browser.state.state.content.DownloadState
+import mozilla.components.browser.state.state.content.ShareInternetResourceState
 import mozilla.components.concept.engine.HitResult
-import mozilla.components.feature.tabs.TabsUseCases
 import mozilla.components.feature.app.links.AppLinksUseCases
 import mozilla.components.feature.contextmenu.ContextMenuCandidate.Companion.MAX_TITLE_LENGTH
+import mozilla.components.feature.tabs.TabsUseCases
 import mozilla.components.support.ktx.android.content.addContact
 import mozilla.components.support.ktx.android.content.share
 import mozilla.components.support.ktx.kotlin.stripMailToProtocol
@@ -69,7 +70,7 @@ data class ContextMenuCandidate(
             createCopyLinkCandidate(context, snackBarParentView, snackbarDelegate),
             createDownloadLinkCandidate(context, contextMenuUseCases),
             createShareLinkCandidate(context),
-            createShareImageCandidate(context),
+            createShareImageCandidate(context, contextMenuUseCases),
             createOpenImageInNewTabCandidate(
                 context,
                 tabsUseCases,
@@ -335,12 +336,20 @@ data class ContextMenuCandidate(
          */
         fun createShareImageCandidate(
             context: Context,
-            action: (SessionState, HitResult) -> Unit = { _, hitResult -> context.share(hitResult.src) }
+            contextMenuUseCases: ContextMenuUseCases
         ) = ContextMenuCandidate(
             id = "mozac.feature.contextmenu.share_image",
             label = context.getString(R.string.mozac_feature_contextmenu_share_image),
             showFor = { _, hitResult -> hitResult.isImage() },
-            action = action
+            action = { tab, hitResult ->
+                contextMenuUseCases.injectShareFromInternet(
+                    tab.id,
+                    ShareInternetResourceState(
+                        url = hitResult.src,
+                        private = tab.content.private
+                    )
+                )
+            }
         )
 
         /**

components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuUseCases.kt

@@ -5,7 +5,9 @@
 package mozilla.components.feature.contextmenu
 
 import mozilla.components.browser.state.action.ContentAction
+import mozilla.components.browser.state.action.ShareInternetResourceAction
 import mozilla.components.browser.state.state.content.DownloadState
+import mozilla.components.browser.state.state.content.ShareInternetResourceState
 import mozilla.components.browser.state.store.BrowserStore
 import mozilla.components.concept.engine.HitResult
 
@@ -44,6 +46,21 @@ class ContextMenuUseCases(
         }
     }
 
+    /**
+     * Usecase allowing adding a new [ShareInternetResourceState] to the [BrowserStore]
+     */
+    class InjectShareInternetResourceUseCase(
+        private val store: BrowserStore
+    ) {
+        /**
+         * Adds a specific [ShareInternetResourceState] to the [BrowserStore].
+         */
+        operator fun invoke(tabId: String, internetResource: ShareInternetResourceState) {
+            store.dispatch(ShareInternetResourceAction.AddShareAction(tabId, internetResource))
+        }
+    }
+
     val consumeHitResult = ConsumeHitResultUseCase(store)
     val injectDownload = InjectDownloadUseCase(store)
+    val injectShareFromInternet = InjectShareInternetResourceUseCase(store)
 }

components/feature/contextmenu/src/test/java/mozilla/components/feature/contextmenu/ContextMenuCandidateTest.kt

@@ -17,13 +17,15 @@ import mozilla.components.browser.state.selector.selectedTab
 import mozilla.components.browser.state.state.BrowserState
 import mozilla.components.browser.state.state.ContentState
 import mozilla.components.browser.state.state.TabSessionState
+import mozilla.components.browser.state.state.content.ShareInternetResourceState
 import mozilla.components.browser.state.state.createTab
 import mozilla.components.browser.state.store.BrowserStore
 import mozilla.components.concept.engine.HitResult
 import mozilla.components.feature.app.links.AppLinkRedirect
 import mozilla.components.feature.app.links.AppLinksUseCases
 import mozilla.components.feature.tabs.TabsUseCases
 import mozilla.components.support.test.any
+import mozilla.components.support.test.argumentCaptor
 import mozilla.components.support.test.eq
 import mozilla.components.support.test.libstate.ext.waitUntilIdle
 import mozilla.components.support.test.mock
@@ -693,10 +695,16 @@ class ContextMenuCandidateTest {
 
     @Test
     fun `Candidate 'Share image'`() {
+        val store = BrowserStore(initialState = BrowserState(
+            tabs = listOf(TabSessionState("123", ContentState(url = "https://www.mozilla.org")))
+        ))
         val context = spy(testContext)
 
-        val shareImage = ContextMenuCandidate.createShareImageCandidate(context)
-
+        val usecases = spy(ContextMenuUseCases(store))
+        val shareUsecase: ContextMenuUseCases.InjectShareInternetResourceUseCase = mock()
+        doReturn(shareUsecase).`when`(usecases).injectShareFromInternet
+        val shareImage = ContextMenuCandidate.createShareImageCandidate(context, usecases)
+        val shareStateCaptor = argumentCaptor<ShareInternetResourceState>()
         // showFor
 
         assertTrue(shareImage.showFor(
@@ -713,16 +721,14 @@ class ContextMenuCandidateTest {
 
         // action
 
-        val store = BrowserStore(initialState = BrowserState(
-            tabs = listOf(TabSessionState("123", ContentState("https://www.mozilla.org")))
-        ))
-
         shareImage.action.invoke(
             store.state.tabs.first(),
             HitResult.IMAGE_SRC("https://firefox.com", "https://getpocket.com")
         )
 
-        verify(context).startActivity(any())
+        verify(shareUsecase).invoke(eq("123"), shareStateCaptor.capture())
+        assertEquals("https://firefox.com", shareStateCaptor.value.url)
+        assertEquals(store.state.tabs.first().content.private, shareStateCaptor.value.private)
     }
 
     @Test