Expose trace as api dependency in okhttp module

[kikoveiga]

What does this PR do?

Exposes dd-sdk-android-trace as an api dependency of dd-sdk-android-okhttp, fixing the following Kotlin compiler warning in consumer modules that don't independently depend on dd-sdk-android-trace (namely dd-sdk android-glide and sample/tv):

Cannot access class 'DatadogSpan' in the expression type. This may be forbidden soon.
Check the module classpath for missing or conflicting dependencies.

The warning is triggered when calling TracingInterceptor.BaseBuilder#setTraceSampler(Sampler<DatadogSpan>), since DatadogSpan (from trace-api) was only reachable transitively through implementation(dd-sdk-android-trace), which Gradle hides from consumers' compile classpath.

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)

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.83%. Comparing base (06f7f75) to head (e9f1a7a).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3366      +/-   ##
===========================================
+ Coverage    71.81%   71.83%   +0.02%     
===========================================
  Files          948      948              
  Lines        34952    34952              
  Branches      5804     5804              
===========================================
+ Hits         25100    25106       +6     
+ Misses        8257     8248       -9     
- Partials      1595     1598       +3     

see 35 files with indirect coverage changes

🚀 New features to boost your workflow:

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

[0xnm]

We have one more problem of that kind: setTraceContextInjection is using the symbol which is declared in dd-sdk-android-trace.

dd-sdk-android/integrations/dd-sdk-android-okhttp/src/main/kotlin/com/datadog/android/okhttp/trace/TracingInterceptor.kt

Line 836 in d19a14a

fun setTraceContextInjection(traceContextInjection: TraceContextInjection): R {

it is declared here

https://github.com/DataDog/dd-sdk-android/blob/d19a14a0bb1f24a0f5a6f7827952d176a50e602c/features/dd-sdk-android-trace/src/main/kotlin/com/datadog/android/trace/TraceContextInjection.kt

I'm wondering if we can move it to the -api module, but then it will be a breaking API change 🤔

@satween wdyt?

[satween]

We have one more problem of that kind: setTraceContextInjection is using the symbol which is declared in dd-sdk-android-trace.

dd-sdk-android/integrations/dd-sdk-android-okhttp/src/main/kotlin/com/datadog/android/okhttp/trace/TracingInterceptor.kt

Line 836 in d19a14a

fun setTraceContextInjection(traceContextInjection: TraceContextInjection): R {

it is declared here

https://github.com/DataDog/dd-sdk-android/blob/d19a14a0bb1f24a0f5a6f7827952d176a50e602c/features/dd-sdk-android-trace/src/main/kotlin/com/datadog/android/trace/TraceContextInjection.kt

I'm wondering if we can move it to the -api module, but then it will be a breaking API change 🤔

@satween wdyt?

We discussed with @0xnm in person, and it's seems like the best solution for now is the following:

• replace api("-trace-api") with api("-trace") till the next major release.
• add a JIRA ticket linked to v4 scope, that states that TraceContextInjection.kt has to be moved into -trace-api module and api("-trace") should be replaced with api("-trace-api").
• Add TODO comment to that ticket

[kikoveiga]

Thank you @satween and @0xnm, created the ticket and added as TODO note in the code.