Refactor navigation state so core is impl agnostic

[bidetofevil]

Goal

Made the interfaces for navigation tracking implementation agnostic. That way, the NavigationStateDataSourcecode can live in its own module and code that updates states that have specific dependencies like Compose Navigation can live it its own module. All the wiring will be done via a new interface NavigationTrackingService which will have an implemenation exposed in InstrumentationArgs so the listeners and event producers can be wired up when they load (via datasources).

This offers better encapsulation and allows us to create modules with different dependencies and not have to push those onto SDK users.

Testing

Refactored existing test to ensure the rewiring still works.

[bidetofevil]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• Refactor navigation state so core is impl agnostic #3208 👈 (View in Graphite)
• Support NavController navigation when tracking navigation state #3188
• Track state for activity to activity navigation #3181
• Add featutre flag for navigation state #3180
• Fix misc race conditions found #3174
• Delete the NetworkStatus concept #3173
• Migrate SchedulingServiceImpl to ConnectivityStatus #3172
• Streamline post-intake cleanup #3167
• Delete payloads that fail to be resurrected #3166
• Treat non-429 HTTP failure codes as transient #3165
• Add additional exceptions to list that triggers connect block #3164
• Keep in-memory cache consistent when file deletion fails #3163
• Deliver payload types in order that they were received #3160 : 1 other dependent PR (#3161 )
• Block sending of non-crash payloads on resurrection #3159
• main

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

[bidetofevil]

Not sure if this is a good way to to use the data source interface because it doesn't actually provide a datasource, but it allows for the dynamic loading of the compose navigation tracking via a new module. Is there a better way to do this?

[bidetofevil]

I think there is potentially additional refactoring that can be done to clean this datasource up so it doesn't also fire the controller attachment events. But it's convenient right and I can do this later.

[codecov]

Codecov Report

❌ Patch coverage is 89.09091% with 6 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (hho/nav-state-navcontroller@ce31e62). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
...ternal/navigation/NavigationTrackingServiceImpl.kt	72.72%	3 Missing ⚠️
...ntation/compose/navigation/NavControllerTracker.kt	89.28%	0 Missing and 3 partials ⚠️

Additional details and impacted files

@@                      Coverage Diff                       @@
##             hho/nav-state-navcontroller    #3208   +/-   ##
==============================================================
  Coverage                               ?   78.15%           
==============================================================
  Files                                  ?      583           
  Lines                                  ?    12186           
  Branches                               ?     1831           
==============================================================
  Hits                                   ?     9524           
  Misses                                 ?     1936           
  Partials                               ?      726           

Files with missing lines	Coverage Δ
...oid/embracesdk/internal/InstrumentationArgsImpl.kt	86.66% <100.00%> (ø)
...k/internal/injection/EssentialServiceModuleImpl.kt	70.45% <100.00%> (ø)
...dk/internal/injection/InstrumentationModuleImpl.kt	100.00% <100.00%> (ø)
.../arch/navigation/NavigationTrackingInitListener.kt	100.00% <100.00%> (ø)
...gation/ComposeNavigationInstrumentationProvider.kt	100.00% <100.00%> (ø)
...umentation/navigation/ActivityNavigationTracker.kt	74.07% <100.00%> (ø)
...umentation/navigation/NavigationStateDataSource.kt	95.00% <100.00%> (ø)
...vigation/NavigationStateInstrumentationProvider.kt	100.00% <100.00%> (ø)
...ternal/navigation/NavigationTrackingServiceImpl.kt	72.72% <72.72%> (ø)
...ntation/compose/navigation/NavControllerTracker.kt	89.28% <89.28%> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[fractalwrench]

LGTM although it'd be good to make the controller parameter a more specific type if possible

[fractalwrench]

What type do we expect the controller to be? Is there any way to make it more specific than Any??

[bidetofevil]

For now, it's NavController. And I'd be happy to have that explicitly until there's another type, but then that means we'll have to expose this Compose Navigation dependency at the public API level.

I started out with way, but then went to this generic method. It'll be more obvious in my next PR.