feat(sdk-trace-*):! drop unintentional/unnecessary exports #5405
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pichlermarc
commented
Jan 30, 2025
pichlermarc
commented
Jan 30, 2025
| @@ -316,37 +317,4 @@ describe('SimpleSpanProcessor', () => { | |||
| assert.equal(exporterCreatedSpans.length, 0); | |||
| }); | |||
| }); | |||
|
|
|||
| // TODO: https://github.com/open-telemetry/opentelemetry-js/pull/4238#issuecomment-1788516773 | |||
There was a problem hiding this comment.
reviewer note: this is not applicable since 2.x does not need to be compatible with 1.x packages.
pichlermarc
commented
Jan 30, 2025
| @@ -84,7 +81,7 @@ export class BasicTracerProvider implements TracerProvider { | |||
| name: string, | |||
| version?: string, | |||
| options?: { schemaUrl?: string } | |||
| ): Tracer { | |||
| ): ApiTracer { | |||
There was a problem hiding this comment.
Note: if there's time, I'll also follow-up with renaming the now internal tracer to SdkTracer to avoid having to do this and to have the code be more readable.
I've opted to not do this in this PR to keep the diff somewhat contained.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5405 +/- ##
=======================================
Coverage 94.64% 94.64%
=======================================
Files 317 317
Lines 8025 8025
Branches 1687 1687
=======================================
Hits 7595 7595
Misses 430 430
|
pichlermarc
commented
Jan 30, 2025
| @@ -137,7 +138,9 @@ describe('BasicTracerProvider', () => { | |||
| describe('generalLimits', () => { | |||
| describe('when not defined default values', () => { | |||
| it('should have tracer with default values', () => { | |||
| const tracer = new BasicTracerProvider({}).getTracer('default'); | |||
| const tracer = new BasicTracerProvider({}).getTracer( | |||
There was a problem hiding this comment.
note for reviewers: there are quite a few of these as we assert on internals.
pichlermarc
added
pkg:core
target:next-major-release
pichlermarc
changed the title
trentm
approved these changes
Jan 30, 2025
github-merge-queue
bot
removed this pull request from the merge queue due to a conflict with the base branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
Drops unintentional exports from the
@opentelemetry/sdk-trace-basepackage and dependents.This PR removes:
Tracer- this was never intended to be used by end-users directly, should only be used asTracerfrom@opentelemetry/apiEXPORTER_FACTORY- unused since feat(sdk-trace)!: remove ability to have BasicTracerProvider instantiate exporters #5239PROPAGATOR_FACTORY- unused since feat(sdk-trace-base)!: drop ability to auto-instantiate propagators beyond defaults #5355ForceFlushState- this was never intended to be used by end-users directly and was only used internallyRefs #5290 (for removing
*_FACTORY)Refs #5283 (for removing the export of the
Tracerclass)Type of change
How Has This Been Tested?