Optimize the push/replace history for navigation.

square · Feb 9, 2025 · 372bc7c · 372bc7c
1 parent 8cc2f73
commit 372bc7c
Show file tree

Hide file tree

Showing 23 changed files with 89 additions and 75 deletions.
diff --git a/invert-report/src/jsMain/kotlin/com/squareup/invert/common/navigation/NavRouteRepo.kt b/invert-report/src/jsMain/kotlin/com/squareup/invert/common/navigation/NavRouteRepo.kt
@@ -9,20 +9,31 @@ import kotlinx.coroutines.flow.MutableStateFlow
  */
 class NavRouteRepo(initialRoute: NavRoute) {
 
-  private val _navRoute = MutableStateFlow(NavChangeEvent(initialRoute))
+  private val _navRoute = MutableStateFlow(
+    NavChangeEvent(
+      initialRoute,
+      PushOrReplaceState.PUSH
+    )
+  )
 
   val navRoute: Flow<NavChangeEvent> = _navRoute
 
-  fun updateNavRoute(navRoute: NavRoute) {
-    this._navRoute.tryEmit(NavChangeEvent(navRoute))
+  /**
+   * Adds new item to browser history stack.
+   */
+  fun pushNavRoute(navRoute: NavRoute) {
+    this._navRoute.tryEmit(NavChangeEvent(navRoute, PushOrReplaceState.PUSH))
   }
 
+  /**
+   * Updates/Replaces the URL in the browser history, but does NOT add a new item to browser history stack.
+   */
   fun replaceNavRoute(navRoute: NavRoute) {
     this._navRoute.tryEmit(NavChangeEvent(navRoute, PushOrReplaceState.REPLACE))
   }
 
   class NavChangeEvent(
     val navRoute: NavRoute,
-    val pushOrReplaceState: PushOrReplaceState = PushOrReplaceState.PUSH
+    val pushOrReplaceState: PushOrReplaceState,
   )
 }
diff --git a/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/AllModulesReportPage.kt b/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/AllModulesReportPage.kt
@@ -104,10 +104,10 @@ fun ModulesComposable(
       query = query ?: "",
       placeholderText = "Module Query...",
     ) {
-      navRouteRepo.updateNavRoute(modulesNavRoute.copy(query = it))
+      navRouteRepo.replaceNavRoute(modulesNavRoute.copy(query = it))
     }
     ModulesByNameComposable(allModulesWithOwnerMatchingQuery) {
-      navRouteRepo.updateNavRoute(ModuleDetailNavRoute(it))
+      navRouteRepo.pushNavRoute(ModuleDetailNavRoute(it))
     }
   })
   BootstrapTabPane(

diff --git a/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/AllStatsReportPage.kt b/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/AllStatsReportPage.kt
@@ -101,7 +101,7 @@ fun AllStatsComposable(
     val statsOfType = statTotals.statTotals.values.filter { it.metadata.dataType == statDataType }
     if (statsOfType.isNotEmpty()) {
       H1 { Text("${statDataType.displayName} Stats") }
-      StatTiles(statsOfType, navRouteRepo::updateNavRoute)
+      StatTiles(statsOfType, navRouteRepo::pushNavRoute)
     }
   }
 
@@ -129,7 +129,7 @@ fun AllStatsComposable(
     onItemClickCallback = { cellValues ->
       val statKey = cellValues[0]
       val statDataType = StatDataType.fromString(cellValues[2])
-      navRouteRepo.updateNavRoute(
+      navRouteRepo.pushNavRoute(
         if (statDataType == StatDataType.CODE_REFERENCES) {
           CodeReferencesNavRoute(
             statKey = statKey,
@@ -149,7 +149,7 @@ fun AllStatsComposable(
     "View All, Grouped By Module",
     BootstrapButtonType.SECONDARY,
     onClick = {
-      navRouteRepo.updateNavRoute(
+      navRouteRepo.pushNavRoute(
         StatDetailNavRoute(
           pluginIds = listOf(),
           statKeys = statInfos.map { it.metadata.key }

diff --git a/...port/src/jsMain/kotlin/com/squareup/invert/common/pages/AnnotationProcessorsReportPage.kt b/...port/src/jsMain/kotlin/com/squareup/invert/common/pages/AnnotationProcessorsReportPage.kt
@@ -109,7 +109,7 @@ fun AnnotationProcessorsComposable(
                         types = listOf(String::class),
                         maxResultsLimitConstant = PagingConstants.MAX_RESULTS
                     ) {
-                        navRouteRepo.updateNavRoute(
+                        navRouteRepo.pushNavRoute(
                             ModuleDetailNavRoute(
                                 path = it[0]
                             )

diff --git a/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/ArtifactDetailReportPage.kt b/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/ArtifactDetailReportPage.kt
@@ -118,7 +118,7 @@ fun ArtifactDetailComposable(
             types = listOf(String::class, String::class),
             maxResultsLimitConstant = PagingConstants.MAX_RESULTS,
             onItemClickCallback = {
-                navRouteRepo.updateNavRoute(ModuleDetailNavRoute(it[0]))
+                navRouteRepo.pushNavRoute(ModuleDetailNavRoute(it[0]))
             }
         )
     }

diff --git a/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/ArtifactsReportPage.kt b/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/ArtifactsReportPage.kt
@@ -121,7 +121,7 @@ fun ArtifactsComposable(
                 navRoute.query ?: "",
                 "Search For Artifact..."
             ) {
-                navRouteRepo.updateNavRoute(
+                navRouteRepo.pushNavRoute(
                     ArtifactsNavRoute(it)
                 )
             }
@@ -140,7 +140,7 @@ fun ArtifactsComposable(
                     )
                 ),
                 onClick = { label, value ->
-                    navRouteRepo.updateNavRoute(
+                    navRouteRepo.pushNavRoute(
                         ArtifactsNavRoute(
                             query = "$label:"
                         )
@@ -169,7 +169,7 @@ fun ArtifactsComposable(
         types = artifactsMatchingQuery.map { String::class },
         maxResultsLimitConstant = MAX_RESULTS,
         onItemClickCallback = {
-            navRouteRepo.updateNavRoute(
+            navRouteRepo.pushNavRoute(
                 ArtifactDetailNavRoute(
                     group = it[0],
                     artifact = it[1],

diff --git a/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/CodeReferencesReportPage.kt b/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/CodeReferencesReportPage.kt
@@ -160,7 +160,7 @@ fun CodeReferencesComposable(
   if (currentStatMetadata == null) {
     H1 { Text("No stat with key '${codeReferencesNavRoute.statKey}' found") }
     BootstrapButton("View All Stats") {
-      navRouteRepo.updateNavRoute(AllStatsNavRoute())
+      navRouteRepo.pushNavRoute(AllStatsNavRoute())
     }
     return
   }
@@ -183,7 +183,7 @@ fun CodeReferencesComposable(
             Li {
               NavRouteLink(
                 StatDetailNavRoute(statKeys = listOf(statKey)),
-                navRouteRepo::updateNavRoute
+                navRouteRepo::pushNavRoute
               ) {
                 Text("View Grouped by Module")
               }
@@ -198,7 +198,7 @@ fun CodeReferencesComposable(
                       true
                     }
                   ),
-                  navRouteRepo::updateNavRoute
+                  navRouteRepo::pushNavRoute
                 ) {
                   if (codeReferencesNavRoute.chart == true) {
                     Text("Hide Chart")
@@ -217,7 +217,7 @@ fun CodeReferencesComposable(
                     true
                   }
                 ),
-                navRouteRepo::updateNavRoute,
+                navRouteRepo::pushNavRoute,
               ) {
                 if (codeReferencesNavRoute.treemap == true) {
                   Text("Hide Treemap")
@@ -232,7 +232,7 @@ fun CodeReferencesComposable(
                   statKey = codeReferencesNavRoute.statKey,
                   owner = codeReferencesNavRoute.owner,
                 ),
-                navRouteRepo::updateNavRoute
+                navRouteRepo::pushNavRoute
               ) {
                 Text("View Owner Breakdown")
               }
@@ -354,7 +354,7 @@ fun CodeReferencesComposable(
             )
           }.sortedBy { it.displayText }
         ) {
-          navRouteRepo.updateNavRoute(
+          navRouteRepo.pushNavRoute(
             codeReferencesNavRoute.copy(
               owner = it?.value,
             )
@@ -377,7 +377,7 @@ fun CodeReferencesComposable(
             )
           }.sortedBy { it.displayText }
         ) {
-          navRouteRepo.updateNavRoute(
+          navRouteRepo.pushNavRoute(
             codeReferencesNavRoute.copy(
               module = it?.value
             )

diff --git a/...eport/src/jsMain/kotlin/com/squareup/invert/common/pages/ConfigurationDetailReportPage.kt b/...eport/src/jsMain/kotlin/com/squareup/invert/common/pages/ConfigurationDetailReportPage.kt
@@ -97,7 +97,7 @@ fun ConfigurationDetailComposable(
         types = listOf(String::class),
         maxResultsLimitConstant = MAX_RESULTS,
         onItemClickCallback = {
-            navRouteRepo.updateNavRoute(
+            navRouteRepo.pushNavRoute(
                 ModuleDetailNavRoute(
                     it[0]
                 )

diff --git a/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/ConfigurationsReportPage.kt b/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/ConfigurationsReportPage.kt
@@ -60,7 +60,7 @@ fun ConfigurationsComposable(
     BootstrapRow {
         BootstrapColumn(12) {
             BootstrapClickableList("Analyzed Configurations", list, MAX_RESULTS) { item ->
-                navRouteRepo.updateNavRoute(ConfigurationDetailNavRoute(item))
+                navRouteRepo.pushNavRoute(ConfigurationDetailNavRoute(item))
             }
         }
     }

diff --git a/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/DependencyDiffReportPage.kt b/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/DependencyDiffReportPage.kt
@@ -139,19 +139,19 @@ fun ModuleDependencyDiffComposable(
                 placeholderText = "Module A...",
                 dataListId = ALL_MODULES_DATALIST_ID,
             ) {
-                navRouteRepo.updateNavRoute(navRoute.copy(moduleA = it))
+                navRouteRepo.replaceNavRoute(navRoute.copy(moduleA = it))
             }
             BootstrapSearchBox(
                 query = navRoute.configurationA ?: "",
                 placeholderText = "Configuration A...",
                 dataListId = MODULE_A_CONFIGURATIONS_DATALIST,
             ) {
-                navRouteRepo.updateNavRoute(navRoute.copy(configurationA = it))
+                navRouteRepo.replaceNavRoute(navRoute.copy(configurationA = it))
             }
         }
         BootstrapColumn(2) {
             BootstrapButton("↔️") {
-                navRouteRepo.updateNavRoute(
+                navRouteRepo.replaceNavRoute(
                     navRoute.copy(
                         moduleA = navRoute.moduleB,
                         moduleB = navRoute.moduleA,
@@ -167,23 +167,23 @@ fun ModuleDependencyDiffComposable(
                 placeholderText = "Module B...",
                 dataListId = ALL_MODULES_DATALIST_ID,
             ) {
-                navRouteRepo.updateNavRoute(navRoute.copy(moduleB = it))
+                navRouteRepo.replaceNavRoute(navRoute.copy(moduleB = it))
             }
             BootstrapSearchBox(
                 query = navRoute.configurationB ?: "",
                 placeholderText = "Configuration B...",
                 dataListId = MODULE_A_CONFIGURATIONS_DATALIST,
             ) {
-                navRouteRepo.updateNavRoute(navRoute.copy(configurationB = it))
+                navRouteRepo.replaceNavRoute(navRoute.copy(configurationB = it))
             }
         }
     }
 
     BootstrapSettingsCheckbox("Include Artifacts", navRoute.includeArtifacts) {
-        navRouteRepo.updateNavRoute(navRoute.copy(includeArtifacts = it))
+        navRouteRepo.replaceNavRoute(navRoute.copy(includeArtifacts = it))
     }
     BootstrapSettingsCheckbox("Show Matching", navRoute.showMatching) {
-        navRouteRepo.updateNavRoute(navRoute.copy(showMatching = it))
+        navRouteRepo.replaceNavRoute(navRoute.copy(showMatching = it))
     }
 
     Br()

diff --git a/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/GradlePluginsReportPage.kt b/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/GradlePluginsReportPage.kt
@@ -87,14 +87,14 @@ fun PluginsComposable(
         navRoute.query ?: "",
         "Search For Artifact..."
     ) {
-        navRouteRepo.updateNavRoute(
+        navRouteRepo.pushNavRoute(
             ArtifactsNavRoute(it)
         )
     }
     BootstrapRow {
         BootstrapColumn(6) {
             BootstrapClickableList("Plugins", allPluginIds!!, MAX_RESULTS) { gradlePluginId ->
-                navRouteRepo.updateNavRoute(PluginDetailNavRoute(gradlePluginId))
+                navRouteRepo.pushNavRoute(PluginDetailNavRoute(gradlePluginId))
             }
         }
         BootstrapColumn(6) {
@@ -110,7 +110,7 @@ fun PluginsComposable(
                     )
                 ),
                 onClick = { label, value ->
-                    navRouteRepo.updateNavRoute(
+                    navRouteRepo.pushNavRoute(
                         PluginDetailNavRoute(
                             pluginId = label,
                         )

diff --git a/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/HomeReportPage.kt b/invert-report/src/jsMain/kotlin/com/squareup/invert/common/pages/HomeReportPage.kt
@@ -120,25 +120,25 @@ fun HomeComposable(
       moduleCount,
       AllModulesReportPage.navPage,
       AllModulesNavRoute(),
-    ) { navRouteRepo.updateNavRoute(it) }
+    ) { navRouteRepo.pushNavRoute(it) }
 
     HomeCountComposable(
       artifactCount,
       ArtifactsReportPage.navPage,
       AllModulesNavRoute()
-    ) { navRouteRepo.updateNavRoute(ArtifactsNavRoute()) }
+    ) { navRouteRepo.pushNavRoute(ArtifactsNavRoute()) }
 
     HomeCountComposable(
       pluginIdsCount,
       GradlePluginsReportPage.navPage,
       AllModulesNavRoute()
-    ) { navRouteRepo.updateNavRoute(GradlePluginsNavRoute(null)) }
+    ) { navRouteRepo.pushNavRoute(GradlePluginsNavRoute(null)) }
 
     HomeCountComposable(
       ownersCount,
       OwnersReportPage.navPage,
       AllModulesNavRoute()
-    ) { navRouteRepo.updateNavRoute(OwnersNavRoute) }
+    ) { navRouteRepo.pushNavRoute(OwnersNavRoute) }
 
     statTotals.statTotals.values.forEach { statTotalAndMetadata ->
       BootstrapColumn(3) {
@@ -159,7 +159,7 @@ fun HomeComposable(
           }
           A(href = destRoute.toQueryString(), {
             onClick {
-              navRouteRepo.updateNavRoute(destRoute)
+              navRouteRepo.pushNavRoute(destRoute)
             }
           }) {
             Small {
@@ -177,7 +177,7 @@ fun HomeComposable(
     "View All",
     BootstrapButtonType.PRIMARY,
     onClick = {
-      navRouteRepo.updateNavRoute(
+      navRouteRepo.pushNavRoute(
         AllStatsNavRoute()
       )
     }