Merge pull request #328 from android/bw/moreJankstats

Add more jank tracking

Author: keyboardsurfer

app/src/main/java/com/google/samples/apps/nowinandroid/ui/NiaAppState.kt

@@ -33,7 +33,7 @@ import com.google.samples.apps.nowinandroid.core.designsystem.icon.Icon.Drawable
 import com.google.samples.apps.nowinandroid.core.designsystem.icon.Icon.ImageVectorIcon
 import com.google.samples.apps.nowinandroid.core.designsystem.icon.NiaIcons
 import com.google.samples.apps.nowinandroid.core.navigation.NiaNavigationDestination
-import com.google.samples.apps.nowinandroid.core.ui.JankMetricDisposableEffect
+import com.google.samples.apps.nowinandroid.core.ui.TrackDisposableJank
 import com.google.samples.apps.nowinandroid.feature.bookmarks.R as bookmarksR
 import com.google.samples.apps.nowinandroid.feature.bookmarks.navigation.BookmarksDestination
 import com.google.samples.apps.nowinandroid.feature.foryou.R as forYouR
@@ -141,7 +141,7 @@ class NiaAppState(
  */
 @Composable
 private fun NavigationTrackingSideEffect(navController: NavHostController) {
-    JankMetricDisposableEffect(navController) { metricsHolder ->
+    TrackDisposableJank(navController) { metricsHolder ->
         val listener = NavController.OnDestinationChangedListener { _, destination, _ ->
             metricsHolder.state?.putState("Navigation", destination.route.toString())
         }

core/ui/src/main/java/com/google/samples/apps/nowinandroid/core/ui/JankStatsExtensions.kt

@@ -46,10 +46,10 @@ fun rememberMetricsStateHolder(): Holder {
 /**
  * Convenience function to work with [PerformanceMetricsState] state. The side effect is
  * re-launched if any of the [keys] value is not equal to the previous composition.
- * @see JankMetricDisposableEffect if you need to work with DisposableEffect to cleanup added state.
+ * @see TrackDisposableJank if you need to work with DisposableEffect to cleanup added state.
  */
 @Composable
-fun JankMetricEffect(
+fun TrackJank(
     vararg keys: Any?,
     reportMetric: suspend CoroutineScope.(state: Holder) -> Unit
 ) {
@@ -64,7 +64,7 @@ fun JankMetricEffect(
  * The side effect is re-launched if any of the [keys] value is not equal to the previous composition.
  */
 @Composable
-fun JankMetricDisposableEffect(
+fun TrackDisposableJank(
     vararg keys: Any?,
     reportMetric: DisposableEffectScope.(state: Holder) -> DisposableEffectResult
 ) {
@@ -74,9 +74,12 @@ fun JankMetricDisposableEffect(
     }
 }
 
+/**
+ * Track jank while scrolling anything that's scrollable.
+ */
 @Composable
 fun TrackScrollJank(scrollableState: ScrollableState, stateName: String) {
-    JankMetricEffect(scrollableState) { metricsHolder ->
+    TrackJank(scrollableState) { metricsHolder ->
         snapshotFlow { scrollableState.isScrollInProgress }.collect { isScrollInProgress ->
             metricsHolder.state?.apply {
                 if (isScrollInProgress) {

feature/author/src/main/java/com/google/samples/apps/nowinandroid/feature/author/AuthorScreen.kt

@@ -30,6 +30,7 @@ import androidx.compose.foundation.layout.windowInsetsBottomHeight
 import androidx.compose.foundation.layout.windowInsetsTopHeight
 import androidx.compose.foundation.lazy.LazyColumn
 import androidx.compose.foundation.lazy.LazyListScope
+import androidx.compose.foundation.lazy.rememberLazyListState
 import androidx.compose.foundation.shape.CircleShape
 import androidx.compose.material.icons.Icons.Filled
 import androidx.compose.material.icons.filled.ArrowBack
@@ -59,6 +60,7 @@ import com.google.samples.apps.nowinandroid.core.model.data.SaveableNewsResource
 import com.google.samples.apps.nowinandroid.core.model.data.previewAuthors
 import com.google.samples.apps.nowinandroid.core.model.data.previewNewsResources
 import com.google.samples.apps.nowinandroid.core.ui.DevicePreviews
+import com.google.samples.apps.nowinandroid.core.ui.TrackScrollJank
 import com.google.samples.apps.nowinandroid.core.ui.newsResourceCardItems
 
 @OptIn(ExperimentalLifecycleComposeApi::class)
@@ -91,9 +93,12 @@ internal fun AuthorScreen(
     onBookmarkChanged: (String, Boolean) -> Unit,
     modifier: Modifier = Modifier,
 ) {
+    val scrollableState = rememberLazyListState()
+    TrackScrollJank(scrollableState = scrollableState, stateName = "author:column")
     LazyColumn(
         modifier = modifier,
-        horizontalAlignment = Alignment.CenterHorizontally
+        horizontalAlignment = Alignment.CenterHorizontally,
+        state = scrollableState
     ) {
         item {
             Spacer(Modifier.windowInsetsTopHeight(WindowInsets.safeDrawing))

feature/bookmarks/src/main/java/com/google/samples/apps/nowinandroid/feature/bookmarks/BookmarksScreen.kt

@@ -31,6 +31,7 @@ import androidx.compose.foundation.layout.wrapContentSize
 import androidx.compose.foundation.lazy.grid.GridCells.Adaptive
 import androidx.compose.foundation.lazy.grid.GridItemSpan
 import androidx.compose.foundation.lazy.grid.LazyVerticalGrid
+import androidx.compose.foundation.lazy.grid.rememberLazyGridState
 import androidx.compose.material3.ExperimentalMaterial3Api
 import androidx.compose.material3.Scaffold
 import androidx.compose.material3.TopAppBarDefaults
@@ -48,6 +49,7 @@ import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaLoadi
 import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaTopAppBar
 import com.google.samples.apps.nowinandroid.core.designsystem.icon.NiaIcons
 import com.google.samples.apps.nowinandroid.core.ui.NewsFeedUiState
+import com.google.samples.apps.nowinandroid.core.ui.TrackScrollJank
 import com.google.samples.apps.nowinandroid.core.ui.newsFeed
 
 @OptIn(ExperimentalLifecycleComposeApi::class)
@@ -87,11 +89,14 @@ fun BookmarksScreen(
         containerColor = Color.Transparent,
         contentWindowInsets = WindowInsets(0, 0, 0, 0)
     ) { innerPadding ->
+        val scrollableState = rememberLazyGridState()
+        TrackScrollJank(scrollableState = scrollableState, stateName = "bookmarks:grid")
         LazyVerticalGrid(
             columns = Adaptive(300.dp),
             contentPadding = PaddingValues(16.dp),
             horizontalArrangement = Arrangement.spacedBy(32.dp),
             verticalArrangement = Arrangement.spacedBy(24.dp),
+            state = scrollableState,
             modifier = modifier
                 .fillMaxSize()
                 .testTag("bookmarks:feed")

feature/foryou/src/main/java/com/google/samples/apps/nowinandroid/feature/foryou/ForYouScreen.kt

@@ -175,10 +175,8 @@ fun ForYouScreen(
             }
         }
 
-        val tag = "forYou:feed"
-
-        val lazyGridState = rememberLazyGridState()
-        TrackScrollJank(scrollableState = lazyGridState, stateName = tag)
+        val state = rememberLazyGridState()
+        TrackScrollJank(scrollableState = state, stateName = "forYou:feed")
 
         val notConnected = stringResource(R.string.for_you_not_connected)
         LaunchedEffect(isOffline) {
@@ -198,7 +196,7 @@ fun ForYouScreen(
                 .consumedWindowInsets(innerPadding)
                 .fillMaxSize()
                 .testTag("forYou:feed"),
-            state = lazyGridState
+            state = state
         ) {
             interestsSelection(
                 interestsSelectionState = interestsSelectionState,

feature/interests/src/main/java/com/google/samples/apps/nowinandroid/feature/interests/InterestsScreen.kt

@@ -41,7 +41,7 @@ import com.google.samples.apps.nowinandroid.core.model.data.FollowableTopic
 import com.google.samples.apps.nowinandroid.core.model.data.previewAuthors
 import com.google.samples.apps.nowinandroid.core.model.data.previewTopics
 import com.google.samples.apps.nowinandroid.core.ui.DevicePreviews
-import com.google.samples.apps.nowinandroid.core.ui.JankMetricDisposableEffect
+import com.google.samples.apps.nowinandroid.core.ui.TrackDisposableJank
 
 @OptIn(ExperimentalLifecycleComposeApi::class)
 @Composable
@@ -65,7 +65,7 @@ fun InterestsRoute(
         modifier = modifier
     )
 
-    JankMetricDisposableEffect(tabState) { metricsHolder ->
+    TrackDisposableJank(tabState) { metricsHolder ->
         metricsHolder.state?.putState("Interests:TabState", "currentIndex:${tabState.currentIndex}")
 
         onDispose {

feature/topic/src/main/java/com/google/samples/apps/nowinandroid/feature/topic/TopicScreen.kt

@@ -30,6 +30,7 @@ import androidx.compose.foundation.layout.windowInsetsBottomHeight
 import androidx.compose.foundation.layout.windowInsetsTopHeight
 import androidx.compose.foundation.lazy.LazyColumn
 import androidx.compose.foundation.lazy.LazyListScope
+import androidx.compose.foundation.lazy.rememberLazyListState
 import androidx.compose.material.icons.Icons.Filled
 import androidx.compose.material.icons.filled.ArrowBack
 import androidx.compose.material3.Icon
@@ -56,6 +57,7 @@ import com.google.samples.apps.nowinandroid.core.model.data.SaveableNewsResource
 import com.google.samples.apps.nowinandroid.core.model.data.previewNewsResources
 import com.google.samples.apps.nowinandroid.core.model.data.previewTopics
 import com.google.samples.apps.nowinandroid.core.ui.DevicePreviews
+import com.google.samples.apps.nowinandroid.core.ui.TrackScrollJank
 import com.google.samples.apps.nowinandroid.core.ui.newsResourceCardItems
 import com.google.samples.apps.nowinandroid.feature.topic.R.string
 import com.google.samples.apps.nowinandroid.feature.topic.TopicUiState.Loading
@@ -90,7 +92,10 @@ internal fun TopicScreen(
     onBookmarkChanged: (String, Boolean) -> Unit,
     modifier: Modifier = Modifier,
 ) {
+    val state = rememberLazyListState()
+    TrackScrollJank(scrollableState = state, stateName = "topic:screen")
     LazyColumn(
+        state = state,
         modifier = modifier,
         horizontalAlignment = Alignment.CenterHorizontally
     ) {