-
Notifications
You must be signed in to change notification settings - Fork 934
Add arch test to detect usage of shared internal code #6978
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add arch test to detect usage of shared internal code #6978
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6978 +/- ##
=========================================
Coverage 90.15% 90.15%
Complexity 7476 7476
=========================================
Files 836 836
Lines 22550 22550
Branches 2224 2224
=========================================
Hits 20331 20331
Misses 1515 1515
Partials 704 704 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Resurrecting this and marking ready for review @open-telemetry/java-approvers. There have been a number of topics coming up lately that reinforce the need to avoid shared internal code. A couple that come to mind:
|
| "opentelemetry-exporter-otlp-common", | ||
| "opentelemetry-exporter-sender-grpc-managed-channel", | ||
| "opentelemetry-exporter-sender-jdk", | ||
| "opentelemetry-exporter-sender-okhttp")); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here's the TODO list. All these modules use shared internal code.
In contrast, the list of modules which DO NOT use shared internal code is small:
opentelemetry-commonopentelemetry-contextopentelemetry-tracing-shimopentelemetry-apiopentelemetry-extension-kotlinopentelemetry-sdk
Related to #6970.
This test prints out instances of shared internal code use. We could eventually remove all the detected instances, at which point we could fail the build instead of just printing.
But there's a long way to go. See this gist for the current state of affairs.
Note: I don't currently have a good way to tell when internal code is referenced for things like the SDK's implementation of of
opentelemetry-api-incubating, which is switched to a compile dependency in #6944.