ref(core): Mark internal utils as @ApiStatus.Internal - #6017
ref(core): Mark internal utils as @ApiStatus.Internal#6017sentry-junior[bot] wants to merge 2 commits into
Conversation
SDK utility helpers in io.sentry.util and a few module-local Utils are plumbing, not public API. Mark them internal so a future major can move them without implying customer support. Leave intentional public helpers like CheckInUtils and SentryReactorUtils alone. Co-Authored-By: Nelson Osacky <nelson.osacky@sentry.io>
📲 Install BuildsAndroid
|
runningcode
added
the
sanity-check
0xadam-brown
left a comment
0xadam-brown
left a comment
There was a problem hiding this comment.
Thanks for this too 👍
Git history suggests that LoadClass and TracingUtils were made public so they could be consumed by our hybrid SDKs. We should probably exclude them from this PR.
My clanker didn't find any evidence that the same was true for the remaining classes, but I'm no expert on the history here – so feel free to check in with others if you're also unsure.
Exclude these from the Internal pass; git history suggests they were kept public for hybrid SDK consumption.
|
Good catch — excluded |
0xadam-brown
left a comment
0xadam-brown
left a comment
There was a problem hiding this comment.
...I'm no expert on the history here – so feel free to check in with others if you're also unsure.
Approving with that^^ proviso, so feel free to check with others / dig deeper as needed. Otherwise, lgtm on its face.
|
jr did that automatically. I guess we can just go mark those later to unblock this PR. IMO, we should have a separate marker for classes used by hybrid SDKs so that we don't make breaking changes to them. |
2 participants
📜 Description
Mark remaining SDK-only utility types with class-level
@ApiStatus.Internal.19 types across:
io.sentry.utilhelpers (ClassLoaderUtils,LoadClass,LifecycleHelper,SentryRandom,SpanUtils,TracingUtils, UUID helpers, …)io.sentry.util.networkreplay/network capture helpersNativeEventUtils,DatabaseUtils,OtelSpanUtilsLeft public on purpose:
CheckInUtils(@ApiStatus.Experimentalcrons helper)SentryReactorUtils(documented reactor integration API)ReactorUtils(already@Deprecated; migration path to reactor utils)Annotation-only — no package moves.
💡 Motivation and Context
Follow-up to #6016. Most of
io.sentry.utilwas already@Internal; this finishes the unmarked SDK plumbing so a later major can relocate it without implying customer support.💚 How did you test it?
./gradlew :sentry:spotlessJavaApply :sentry:apiDump :sentry-jdbc:spotlessJavaApply :sentry-jdbc:apiDump :sentry-opentelemetry:sentry-opentelemetry-core:spotlessJavaApply :sentry-opentelemetry:sentry-opentelemetry-core:apiDump:sentry-android-corespotless/apiDump not run here (no Android SDK); import order fixed manually onNativeEventUtils.apidumps unchanged for:sentry(expected for Internal marks)📝 Checklist
sendDefaultPIIis enabled.🔮 Next steps
Next batch could mark docs-internal impl types (
SentryClient,Scope/Scopes, json engine, etc.).#skip-changelog
Requested by no.
--
View Junior Session [Sentry]