RUM-9511: RumAuto scenario for android benchmark app by aleksandr-gringauz · Pull Request #2689 · DataDog/dd-sdk-android

aleksandr-gringauz · 2025-05-30T14:08:03Z

What does this PR do?

Implemented RUM Auto scenario for Android benchmark app, described here.

Created a synthetic test using this scenario link. I checked that it runs well for my local build.

RUM Session from the synthetic test: link

Sorry for a big pr. I split it into multiple commits, each containing a more or less independent part, so that it is easier to view. Also look at comments in the pr.

About the app.

Uses OkHttp + Ktor 2.3.13 + kotlinx.serialization for requests to the api. Not Ktor3, because it lead to update of kotlin stdlib version for the benchmark app (now we have 1.9.24, it became 2.something). Most likely it is fine, but I decided to be cautious here.
Some screens are implemented in jetpack compose. For image loading Coil is used with the OkHttp client that has DatadogInterceptor installed in it.
Some screens are implemented using Android Views. For image loading Glide is used with the OkHttp client that has DatadogInterceptor installed in it. For more convenient RecyclerView implementation AdapterDelegates4 library is used. Also ViewBinding is used.

Motivation

What inspired you to submit this pull request?

Additional Notes

Anything else we should know when reviewing?

Review checklist (to be filled by reviewers)

Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
Make sure you discussed the feature or bugfix with the maintaining team in an Issue
Make sure each commit and the PR mention the Issue number (cf the CONTRIBUTING doc)

datadog-datadog-prod-us1 · 2025-05-30T14:08:39Z

+
+        Spacer(modifier = Modifier.width(8.dp))
+
+        Column() {


⚪ Code Quality Violation

Suggested change

Column() {

Column {

An empty parentheses block before a lambda is redundant. (...read more)

If a function has a lambda parameter and you're passing a lambda expression, parentheses are unnecessary. Including unnecessary syntax makes the code less readable.

codecov-commenter · 2025-06-02T07:49:02Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.00%. Comparing base (faae92a) to head (415d233).
⚠️ Report is 2055 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2689      +/-   ##
===========================================
+ Coverage    69.91%   70.00%   +0.09%     
===========================================
  Files          822      822              
  Lines        30693    30693              
  Branches      5169     5169              
===========================================
+ Hits         21456    21484      +28     
+ Misses        7794     7761      -33     
- Partials      1443     1448       +5

see 41 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

aleksandr-gringauz · 2025-06-02T08:31:08Z

+import javax.inject.Inject
+
+@SuppressLint("CustomSplashScreen")
+internal class LaunchActivity : AppCompatActivity() {


Important place.

Now the first activity that is launched is this LaunchActivity and then we launch a different activity with actual UI of the benchmarking scenario.

I had to do this, because automatic tracking of gestures in RUM is initialized here before Activity.onCreate is called. We have to know that need to enable RUM feature before Activity.onCreate.

The solution is to introduce this LaunchActivity which determines which scenario we run, initializes all necessary Datadog features and then launch the activity with the scenario itself.

Thanks @ambushwork for suggesting this idea.

aleksandr-gringauz · 2025-06-02T08:33:30Z

    val context: Context
+    val benchmarkConfig: BenchmarkConfig
+
+    val sdkCore: SdkCore


All Datadog stuff moved to application component, because we initialize Datadog in LaunchActivity.onCreate and it only has access to BenchmarkAppComponent.

BenchmarkActivityComponent corresponds to the activity with scenario UI.

aleksandr-gringauz · 2025-06-02T08:34:50Z

+        }
+    }
+
+    private fun NavGraphBuilder.navGraphRumAutoScenario() {


Only this navGraphRumAutoScenario is new here, other code just moved and didn't change.

aleksandr-gringauz · 2025-06-02T08:36:44Z

+    }
+
+    private fun initializeCoil() {
+        Coil.setImageLoader(ImageLoader(applicationContext).newBuilder().okHttpClient(okHttpClient.get()).build())


Initializing Coil with OkHttp client that already exists in dagger graph and is used everywhere (in Glide and for rickandmorty api requests).

aleksandr-gringauz · 2025-06-02T08:40:06Z

+import com.datadog.sample.benchmark.R
+import javax.inject.Inject
+
+internal class SessionReplayNavigationManagerImpl @Inject constructor() :


This is FragmentsNavigationManagerImpl that I renamed to SessionReplayNavigationManagerImpl.

To me it looks better that each scenario has its own "NavigationManager", I created RumAutoScenarioNavigator for rumAuto. This one is for session replay.

aleksandr-gringauz · 2025-06-02T10:05:40Z

+) {
+    val lazyListState: LazyListState = rememberLazyListState()
+
+    LastItemTracker(


Tracking then last item appears, so that we can load more items.

aleksandr-gringauz · 2025-06-02T10:06:03Z

+    }
+}
+
+@AssistedFactory


https://dagger.dev/dev-guide/assisted-injection.html

aleksandr-gringauz · 2025-06-02T10:08:02Z

+            }
+            .launchIn(lifecycleScope)
+
+        trackRecyclerViewVisibleItems(


tracking visible items, so that we can load more items when end is reached

aleksandr-gringauz · 2025-06-02T10:09:31Z

 ktorServerNetty = { module = "io.ktor:ktor-server-netty", version.ref = "ktorServer" }
 ktorServerSSE = { module = "io.ktor:ktor-server-sse", version.ref = "ktorServer" }

+# ktor client


this should have been in another commit, sorry

aleksandr-gringauz · 2025-06-02T10:10:09Z

+    sdkInstanceName = DATADOG_SDK_INSTANCE_NAME
+) {
+    @Inject
+    lateinit var okHttpClient: OkHttpClient


reusing okhttpclient that is already in dagger graph

0xnm

nice job!

0xnm · 2025-06-02T10:24:05Z

+ktorClient = "2.3.13"
 ktor = "1.6.8"


should we simply do ktor = 2.3.13, without introducing ktorClient option?

0xnm · 2025-06-02T10:30:23Z

+        setContentView(binding.root)
+
+        binding.rumAutoBottomNavbar.setContent {
+            val currentTab: RumAutoScenarioTab? by rumAutoScenarioNavigator.currentTab.collectAsStateWithLifecycle(null)


is explicit type needed here?

removed the explicit type, not needed

0xnm · 2025-06-02T10:31:50Z

+        fun provideBenchmarkConfig(
+            holder: BenchmarkConfigHolder
+        ): BenchmarkConfig {
+            return holder.config!!


is there a way to avoid !! call?

changed to config field to be lateinit

0xnm · 2025-06-02T10:43:26Z

+    ExtendWith(ForgeExtension::class)
+)
+@MockitoSettings(strictness = Strictness.LENIENT)
+class KtorHttpClientUtilsTest {


minor: let's add given / when / then blocks to the tests for the readability

0xnm · 2025-06-02T10:43:51Z

+@Extensions(
+    ExtendWith(MockitoExtension::class),
+    ExtendWith(ForgeExtension::class)
+)
+@MockitoSettings(strictness = Strictness.LENIENT)


this is unnecessary it seems

removed these annotations, not needed

0xnm · 2025-06-02T10:44:23Z

do we need this file?

I added the transitive dependencies plugin here just for my own convenience to look at the dependencies I am using. Not very important.

f

aleksandr-gringauz · 2025-06-02T12:34:28Z

 # Local Server
 ktorCore = { module = "io.ktor:ktor", version.ref = "ktor" }
-ktorGson = { module = "io.ktor:ktor-gson", version.ref = "ktor" }
+ktorGson = { module = "io.ktor:ktor-serialization-gson", version.ref = "ktor" }


the name of the artifact changed when I changed to ktor=2.3.13, that is why sample:vendor-lib didn't compile

datadog-datadog-prod-us1 Bot reviewed May 30, 2025

View reviewed changes

aleksandr-gringauz force-pushed the aleksandr-gringauz/RUM-9511/rum-auto-scenario-benchmark-move-to-app-save branch 3 times, most recently from 9c246f2 to 5a7f10a Compare June 2, 2025 07:18

aleksandr-gringauz force-pushed the aleksandr-gringauz/RUM-9511/rum-auto-scenario-benchmark-move-to-app-save branch 2 times, most recently from b853349 to ce4e10c Compare June 2, 2025 09:47

aleksandr-gringauz commented Jun 2, 2025

View reviewed changes

aleksandr-gringauz marked this pull request as ready for review June 2, 2025 10:10

aleksandr-gringauz requested review from a team as code owners June 2, 2025 10:10

0xnm previously approved these changes Jun 2, 2025

View reviewed changes

aleksandr-gringauz dismissed 0xnm’s stale review via 36234a6 June 2, 2025 12:09

0xnm previously approved these changes Jun 2, 2025

View reviewed changes

aleksandr-gringauz added 7 commits June 2, 2025 14:17

RUM-9511: Rick and Morty Api requests implementation

6508209

RUM-9511: Refactor navigation and empty RumAuto scenario fragment

827666e

f

RUM-9511: Characters and CharacterDetails screens

03e1549

RUM-9511: Locations and LocationDetails screens

35410ba

RUM-9511: Episodes and EpisodeDetails screens

c466e20

RUM-9511: Transitive dependencies plugin and some more dependencies work

cbec8ea

RUM-9511: Pr fixes

3655f68

aleksandr-gringauz force-pushed the aleksandr-gringauz/RUM-9511/rum-auto-scenario-benchmark-move-to-app-save branch from 36234a6 to 3655f68 Compare June 2, 2025 12:17

RUM-9511: vendor-lib build fix

415d233

aleksandr-gringauz dismissed 0xnm’s stale review via 415d233 June 2, 2025 12:33

aleksandr-gringauz commented Jun 2, 2025

View reviewed changes

aleksandr-gringauz requested a review from 0xnm June 2, 2025 14:16

0xnm approved these changes Jun 2, 2025

View reviewed changes

aleksandr-gringauz merged commit 581d7ca into develop Jun 2, 2025

aleksandr-gringauz deleted the aleksandr-gringauz/RUM-9511/rum-auto-scenario-benchmark-move-to-app-save branch June 2, 2025 14:47

aleksandr-gringauz mentioned this pull request Jun 18, 2025

Fix Jetpack compose auto instrumentation telemetry in benchmark app #2737

Merged

3 tasks

Uh oh!

Conversation

aleksandr-gringauz commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Motivation

Additional Notes

Review checklist (to be filled by reviewers)

Uh oh!

datadog-datadog-prod-us1 Bot May 30, 2025

Choose a reason for hiding this comment

⚪ Code Quality Violation

Uh oh!

codecov-commenter commented Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

0xnm left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

aleksandr-gringauz commented May 30, 2025 •

edited

Loading

codecov-commenter commented Jun 2, 2025 •

edited

Loading