Closes #7023 - Add HistoryState to content state

mozilla-mobile · May 22, 2020 · 1a84e76 · 1a84e76
1 parent 9be6690
commit 1a84e76
Show file tree

Hide file tree

Showing 17 changed files with 296 additions and 1 deletion.
diff --git a/...ne-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt b/...ne-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt
@@ -22,6 +22,7 @@ import mozilla.components.concept.engine.EngineSessionState
 import mozilla.components.concept.engine.HitResult
 import mozilla.components.concept.engine.Settings
 import mozilla.components.concept.engine.content.blocking.Tracker
+import mozilla.components.concept.engine.history.HistoryItem
 import mozilla.components.concept.engine.history.HistoryTrackingDelegate
 import mozilla.components.concept.engine.manifest.WebAppManifestParser
 import mozilla.components.concept.engine.request.RequestInterceptor
@@ -567,6 +568,14 @@ class GeckoEngineSession(
                 visits.toBooleanArray()
             }
         }
+
+        override fun onHistoryStateChange(
+            session: GeckoSession,
+            historyList: GeckoSession.HistoryDelegate.HistoryList
+        ) {
+            val items = historyList.map { HistoryItem(title = it.title, uri = it.uri) }
+            notifyObservers { onHistoryStateChanged(items, historyList.currentIndex) }
+        }
     }
 
     @Suppress("ComplexMethod")

diff --git a/...ecko-beta/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionTest.kt b/...ecko-beta/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionTest.kt
@@ -22,6 +22,7 @@ import mozilla.components.concept.engine.EngineSession.SafeBrowsingPolicy
 import mozilla.components.concept.engine.HitResult
 import mozilla.components.concept.engine.UnsupportedSettingException
 import mozilla.components.concept.engine.content.blocking.Tracker
+import mozilla.components.concept.engine.history.HistoryItem
 import mozilla.components.concept.engine.history.HistoryTrackingDelegate
 import mozilla.components.concept.engine.manifest.WebAppManifest
 import mozilla.components.concept.engine.permission.PermissionRequest
@@ -869,6 +870,43 @@ class GeckoEngineSessionTest {
             verify(historyTrackingDelegate, never()).getVisited(anyList())
     }
 
+    @Test
+    fun `notifies configured history delegate of state changes`() = runBlockingTest {
+        val engineSession = GeckoEngineSession(mock(),
+            geckoSessionProvider = geckoSessionProvider,
+            context = coroutineContext)
+        val observer = mock<EngineSession.Observer>()
+        engineSession.register(observer)
+
+        captureDelegates()
+
+        class MockHistoryList(
+            items: List<GeckoSession.HistoryDelegate.HistoryItem>,
+            private val currentIndex: Int
+        ) : ArrayList<GeckoSession.HistoryDelegate.HistoryItem>(items), GeckoSession.HistoryDelegate.HistoryList {
+            override fun getCurrentIndex() = currentIndex
+        }
+
+        fun mockHistoryItem(title: String, uri: String): GeckoSession.HistoryDelegate.HistoryItem {
+            val item = mock<GeckoSession.HistoryDelegate.HistoryItem>()
+            whenever(item.title).thenReturn(title)
+            whenever(item.uri).thenReturn(uri)
+            return item
+        }
+
+        historyDelegate.value.onHistoryStateChange(mock(), MockHistoryList(emptyList(), 0))
+        verify(observer).onHistoryStateChanged(emptyList(), 0)
+
+        historyDelegate.value.onHistoryStateChange(mock(), MockHistoryList(listOf(
+            mockHistoryItem("Firefox", "https://firefox.com"),
+            mockHistoryItem("Mozilla", "http://mozilla.org")
+        ), 1))
+        verify(observer).onHistoryStateChanged(listOf(
+            HistoryItem("Firefox", "https://firefox.com"),
+            HistoryItem("Mozilla", "http://mozilla.org")
+        ), 1)
+    }
+
     @Test
     fun websiteTitleUpdates() {
         val engineSession = GeckoEngineSession(mock(),

diff --git a/...gecko-nightly/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt b/...gecko-nightly/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt
@@ -22,6 +22,7 @@ import mozilla.components.concept.engine.EngineSessionState
 import mozilla.components.concept.engine.HitResult
 import mozilla.components.concept.engine.Settings
 import mozilla.components.concept.engine.content.blocking.Tracker
+import mozilla.components.concept.engine.history.HistoryItem
 import mozilla.components.concept.engine.history.HistoryTrackingDelegate
 import mozilla.components.concept.engine.manifest.WebAppManifestParser
 import mozilla.components.concept.engine.request.RequestInterceptor
@@ -579,6 +580,14 @@ class GeckoEngineSession(
                 visits.toBooleanArray()
             }
         }
+
+        override fun onHistoryStateChange(
+            session: GeckoSession,
+            historyList: GeckoSession.HistoryDelegate.HistoryList
+        ) {
+            val items = historyList.map { HistoryItem(title = it.title, uri = it.uri) }
+            notifyObservers { onHistoryStateChanged(items, historyList.currentIndex) }
+        }
     }
 
     @Suppress("ComplexMethod")

diff --git a/...o-nightly/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionTest.kt b/...o-nightly/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionTest.kt
@@ -22,6 +22,7 @@ import mozilla.components.concept.engine.EngineSession.SafeBrowsingPolicy
 import mozilla.components.concept.engine.HitResult
 import mozilla.components.concept.engine.UnsupportedSettingException
 import mozilla.components.concept.engine.content.blocking.Tracker
+import mozilla.components.concept.engine.history.HistoryItem
 import mozilla.components.concept.engine.history.HistoryTrackingDelegate
 import mozilla.components.concept.engine.manifest.WebAppManifest
 import mozilla.components.concept.engine.permission.PermissionRequest
@@ -900,6 +901,43 @@ class GeckoEngineSessionTest {
             verify(historyTrackingDelegate, never()).getVisited(anyList())
     }
 
+    @Test
+    fun `notifies configured history delegate of state changes`() = runBlockingTest {
+        val engineSession = GeckoEngineSession(mock(),
+            geckoSessionProvider = geckoSessionProvider,
+            context = coroutineContext)
+        val observer = mock<EngineSession.Observer>()
+        engineSession.register(observer)
+
+        captureDelegates()
+
+        class MockHistoryList(
+            items: List<GeckoSession.HistoryDelegate.HistoryItem>,
+            private val currentIndex: Int
+        ) : ArrayList<GeckoSession.HistoryDelegate.HistoryItem>(items), GeckoSession.HistoryDelegate.HistoryList {
+            override fun getCurrentIndex() = currentIndex
+        }
+
+        fun mockHistoryItem(title: String, uri: String): GeckoSession.HistoryDelegate.HistoryItem {
+            val item = mock<GeckoSession.HistoryDelegate.HistoryItem>()
+            whenever(item.title).thenReturn(title)
+            whenever(item.uri).thenReturn(uri)
+            return item
+        }
+
+        historyDelegate.value.onHistoryStateChange(mock(), MockHistoryList(emptyList(), 0))
+        verify(observer).onHistoryStateChanged(emptyList(), 0)
+
+        historyDelegate.value.onHistoryStateChange(mock(), MockHistoryList(listOf(
+            mockHistoryItem("Firefox", "https://firefox.com"),
+            mockHistoryItem("Mozilla", "http://mozilla.org")
+        ), 1))
+        verify(observer).onHistoryStateChanged(listOf(
+            HistoryItem("Firefox", "https://firefox.com"),
+            HistoryItem("Mozilla", "http://mozilla.org")
+        ), 1)
+    }
+
     @Test
     fun websiteTitleUpdates() {
         val engineSession = GeckoEngineSession(mock(),

diff --git a/.../engine-gecko/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt b/.../engine-gecko/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt
@@ -20,6 +20,7 @@ import mozilla.components.concept.engine.EngineSessionState
 import mozilla.components.concept.engine.HitResult
 import mozilla.components.concept.engine.Settings
 import mozilla.components.concept.engine.content.blocking.Tracker
+import mozilla.components.concept.engine.history.HistoryItem
 import mozilla.components.concept.engine.history.HistoryTrackingDelegate
 import mozilla.components.concept.engine.manifest.WebAppManifestParser
 import mozilla.components.concept.engine.request.RequestInterceptor
@@ -565,6 +566,14 @@ class GeckoEngineSession(
                 visits.toBooleanArray()
             }
         }
+
+        override fun onHistoryStateChange(
+            session: GeckoSession,
+            historyList: GeckoSession.HistoryDelegate.HistoryList
+        ) {
+            val items = historyList.map { HistoryItem(title = it.title, uri = it.uri) }
+            notifyObservers { onHistoryStateChanged(items, historyList.currentIndex) }
+        }
     }
 
     @Suppress("ComplexMethod")

diff --git a/...ine-gecko/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionTest.kt b/...ine-gecko/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionTest.kt
@@ -21,6 +21,7 @@ import mozilla.components.concept.engine.EngineSession.SafeBrowsingPolicy
 import mozilla.components.concept.engine.HitResult
 import mozilla.components.concept.engine.UnsupportedSettingException
 import mozilla.components.concept.engine.content.blocking.Tracker
+import mozilla.components.concept.engine.history.HistoryItem
 import mozilla.components.concept.engine.history.HistoryTrackingDelegate
 import mozilla.components.concept.engine.manifest.WebAppManifest
 import mozilla.components.concept.engine.permission.PermissionRequest
@@ -844,6 +845,43 @@ class GeckoEngineSessionTest {
             verify(historyTrackingDelegate, never()).getVisited(anyList())
     }
 
+    @Test
+    fun `notifies configured history delegate of state changes`() = runBlockingTest {
+        val engineSession = GeckoEngineSession(mock(),
+            geckoSessionProvider = geckoSessionProvider,
+            context = coroutineContext)
+        val observer = mock<EngineSession.Observer>()
+        engineSession.register(observer)
+
+        captureDelegates()
+
+        class MockHistoryList(
+            items: List<GeckoSession.HistoryDelegate.HistoryItem>,
+            private val currentIndex: Int
+        ) : ArrayList<GeckoSession.HistoryDelegate.HistoryItem>(items), GeckoSession.HistoryDelegate.HistoryList {
+            override fun getCurrentIndex() = currentIndex
+        }
+
+        fun mockHistoryItem(title: String, uri: String): GeckoSession.HistoryDelegate.HistoryItem {
+            val item = mock<GeckoSession.HistoryDelegate.HistoryItem>()
+            whenever(item.title).thenReturn(title)
+            whenever(item.uri).thenReturn(uri)
+            return item
+        }
+
+        historyDelegate.value.onHistoryStateChange(mock(), MockHistoryList(emptyList(), 0))
+        verify(observer).onHistoryStateChanged(emptyList(), 0)
+
+        historyDelegate.value.onHistoryStateChange(mock(), MockHistoryList(listOf(
+            mockHistoryItem("Firefox", "https://firefox.com"),
+            mockHistoryItem("Mozilla", "http://mozilla.org")
+        ), 1))
+        verify(observer).onHistoryStateChanged(listOf(
+            HistoryItem("Firefox", "https://firefox.com"),
+            HistoryItem("Mozilla", "http://mozilla.org")
+        ), 1)
+    }
+
     @Test
     fun websiteTitleUpdates() {
         val engineSession = GeckoEngineSession(mock(),

diff --git a/...browser/session/src/main/java/mozilla/components/browser/session/engine/EngineObserver.kt b/...browser/session/src/main/java/mozilla/components/browser/session/engine/EngineObserver.kt
@@ -23,6 +23,7 @@ import mozilla.components.browser.state.store.BrowserStore
 import mozilla.components.concept.engine.EngineSession
 import mozilla.components.concept.engine.HitResult
 import mozilla.components.concept.engine.content.blocking.Tracker
+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
@@ -285,4 +286,12 @@ internal class EngineObserver(
     override fun onRecordingStateChanged(devices: List<RecordingDevice>) {
         session.recordingDevices = devices
     }
+
+    override fun onHistoryStateChanged(historyList: List<HistoryItem>, currentIndex: Int) {
+        store?.dispatch(ContentAction.UpdateHistoryStateAction(
+            session.id,
+            historyList,
+            currentIndex
+        ))
+    }
 }
diff --git a/...ser/session/src/test/java/mozilla/components/browser/session/engine/EngineObserverTest.kt b/...ser/session/src/test/java/mozilla/components/browser/session/engine/EngineObserverTest.kt
@@ -18,6 +18,7 @@ import mozilla.components.concept.engine.EngineSessionState
 import mozilla.components.concept.engine.HitResult
 import mozilla.components.concept.engine.Settings
 import mozilla.components.concept.engine.content.blocking.Tracker
+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.permission.PermissionRequest
@@ -704,4 +705,36 @@ class EngineObserverTest {
 
         assertEquals("", session.searchTerms)
     }
+
+    @Test
+    fun `onHistoryStateChanged dispatches UpdateHistoryStateAction`() {
+        val session = Session("")
+        val store = mock(BrowserStore::class.java)
+        val observer = EngineObserver(session, store)
+        whenever(store.dispatch(any())).thenReturn(mock())
+
+        observer.onHistoryStateChanged(emptyList(), 0)
+        verify(store).dispatch(
+            ContentAction.UpdateHistoryStateAction(
+                session.id,
+                emptyList(),
+                currentIndex = 0
+            )
+        )
+
+        observer.onHistoryStateChanged(listOf(
+            HistoryItem("Firefox", "https://firefox.com"),
+            HistoryItem("Mozilla", "http://mozilla.org")
+        ), 1)
+        verify(store).dispatch(
+            ContentAction.UpdateHistoryStateAction(
+                session.id,
+                listOf(
+                    HistoryItem("Firefox", "https://firefox.com"),
+                    HistoryItem("Mozilla", "http://mozilla.org")
+                ),
+                currentIndex = 1
+            )
+        )
+    }
 }
diff --git a/...ents/browser/state/src/main/java/mozilla/components/browser/state/action/BrowserAction.kt b/...ents/browser/state/src/main/java/mozilla/components/browser/state/action/BrowserAction.kt
@@ -22,6 +22,7 @@ import mozilla.components.concept.engine.EngineSession
 import mozilla.components.concept.engine.EngineSessionState
 import mozilla.components.concept.engine.HitResult
 import mozilla.components.concept.engine.content.blocking.Tracker
+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.prompt.PromptRequest
@@ -288,6 +289,15 @@ sealed class ContentAction : BrowserAction() {
      * Removes the [WebAppManifest] of the [ContentState] with the given [sessionId].
      */
     data class RemoveWebAppManifestAction(val sessionId: String) : ContentAction()
+
+    /**
+     * Updates the [ContentState] of the given [sessionId] to indicate the current history state.
+     */
+    data class UpdateHistoryStateAction(
+        val sessionId: String,
+        val historyList: List<HistoryItem>,
+        val currentIndex: Int
+    ) : ContentAction()
 }
 
 /**

diff --git a/...owser/state/src/main/java/mozilla/components/browser/state/reducer/ContentStateReducer.kt b/...owser/state/src/main/java/mozilla/components/browser/state/reducer/ContentStateReducer.kt
@@ -9,6 +9,7 @@ import mozilla.components.browser.state.action.ContentAction
 import mozilla.components.browser.state.state.BrowserState
 import mozilla.components.browser.state.state.ContentState
 import mozilla.components.browser.state.state.SessionState
+import mozilla.components.browser.state.state.content.HistoryState
 
 internal object ContentStateReducer {
     /**
@@ -120,6 +121,9 @@ internal object ContentStateReducer {
             is ContentAction.UpdateFirstContentfulPaintStateAction -> updateContentState(state, action.sessionId) {
                 it.copy(firstContentfulPaint = action.firstContentfulPaint)
             }
+            is ContentAction.UpdateHistoryStateAction -> updateContentState(state, action.sessionId) {
+                it.copy(history = HistoryState(action.historyList, action.currentIndex))
+            }
         }
     }
 }

diff --git a/...onents/browser/state/src/main/java/mozilla/components/browser/state/state/ContentState.kt b/...onents/browser/state/src/main/java/mozilla/components/browser/state/state/ContentState.kt
@@ -7,6 +7,7 @@ package mozilla.components.browser.state.state
 import android.graphics.Bitmap
 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.concept.engine.HitResult
 import mozilla.components.concept.engine.manifest.WebAppManifest
 import mozilla.components.concept.engine.prompt.PromptRequest
@@ -62,5 +63,6 @@ data class ContentState(
     val canGoBack: Boolean = false,
     val canGoForward: Boolean = false,
     val webAppManifest: WebAppManifest? = null,
-    val firstContentfulPaint: Boolean = false
+    val firstContentfulPaint: Boolean = false,
+    val history: HistoryState = HistoryState()
 )
diff --git a/...rowser/state/src/main/java/mozilla/components/browser/state/state/content/HistoryState.kt b/...rowser/state/src/main/java/mozilla/components/browser/state/state/content/HistoryState.kt
@@ -0,0 +1,20 @@
+/* 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.engine.history.HistoryItem
+
+/**
+ * Value type that represents browser history.
+ *
+ * @property items All the items in the browser history.
+ * @property currentIndex The index of the currently selected [HistoryItem].
+ * If this is equal to lastIndex, then there are no pages to go "forward" to.
+ * If this is 0, then there are no pages to go "back" to.
+ */
+data class HistoryState(
+    val items: List<HistoryItem> = emptyList(),
+    val currentIndex: Int = 0
+)