Component to map lifecycle events to the activity open events

[bidetofevil]

Goal

Listen to activity lifecycle callback events and map them to UiLoadEvents. With this, activities can go through its lifecycle and the relevant data will be tracked by UiLoadTraceEmitter so it can log traces when it receives a terminal event.

Note: the activity render event is NOT part of the Activity lifecycle, so the mapping isn't complete

Testing

Unit tests added to map the lifecycle events to the UI load events

[bidetofevil]

• Create OS-specific implementations of the ActivityLoadEventEmitter #1683
• Rename the interfaces, methods, and objects to be somewhat Activity agnostic #1682
• Hook up Activity Open tracing component #1348
• Remove startup trace recording callback once it's logged startup #1347
• Create callback mechanism to run code post app startup #1346
• Create annotation to opt into activity open tracing #1345
• Component to map lifecycle events to the activity open events #1320 👈 (View in Graphite)
• Add comopnent to create an activity open trace based on a sequence of events #1319
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.33%. Comparing base (6bc8e94) to head (b27c99c).
Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1320      +/-   ##
==========================================
+ Coverage   85.26%   85.33%   +0.07%     
==========================================
  Files         461      462       +1     
  Lines       10606    10658      +52     
  Branches     1586     1590       +4     
==========================================
+ Hits         9043     9095      +52     
  Misses        848      848              
  Partials      715      715              

Files with missing lines	Coverage Δ
...dk/internal/capture/activity/UiLoadEventEmitter.kt	100.00% <100.00%> (ø)

... and 2 files with indirect coverage changes

[fractalwrench]

Why is there a version check for activityCreated but not activityPostCreated? (This function and others are only available in API 29)

[bidetofevil]

So this is the reason why I did the changes further down the stack to separate the implementation between OS versions - this won't be called in pre-29 lifecycles, and having it called implies it's 29+.

Yeah. Not great. Which is why this was refactored out in #1683 lol

[fractalwrench]

I find the naming of these functions tricky to follow. I think readability would be improved by naming them onActivityStarted or something similar. Alternatively there might be scope for representing the potential states with an enum/sealed class hierarchy and routing events through one function?

[bidetofevil]

So these get moved around in this PR

While the names haven't change, not mixing up two implementations in one make them a little more clear.

And this was a half-hearted effort to decouple the UILoad events from the activity lifecycle events - these stages SHOULD be generic so we can support different view loading lifecycles (e.g. compose), so I've made it possible to genericize it without actually doing all the work right now (because it's not needed).

For stacking an merging reasons, I'd like to merge this as is, and we can look at #1683 to see if there's a better way of naming these things, or maybe even doing the genericization there?

[fractalwrench]

Why is the trace abandoned?

[bidetofevil]

This is in case the activity didn't go through its entirely lifecycle before being backgrounded. If the trace was recorded, it's a no-op - if it hasn't, it will be marked as failed.

[fractalwrench]

Are these values sent to the backend? I have similar feedback to the naming in UiLoadEventEmitter that this feels tricky to understand & I wouldn't like to communicate those names when debugging something on a call with a customer

[bidetofevil]

Nope. These are effective points where we create or end child spans. We can look at improving the naming in #1683 for these generic stages, even if the child spans they create map (right now) only to activity lifecycle stages.

[fractalwrench]

LGTM

[github-actions]

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

Package	Version	Score	Details

Scanned Files

[bidetofevil]

Merge activity

• Nov 29, 1:34 PM EST: A user merged this pull request with Graphite.