refactor(api): fix eslint warnings #5366
Open
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
/home/runner/work/opentelemetry-js/opentelemetry-js/api/src/diag/ComponentLogger.ts
36:25 warning Unexpected any. Specify a different type @typescript-eslint/no-explicit-any
40:25 warning Unexpected any. Specify a different type @typescript-eslint/no-explicit-any
44:24 warning Unexpected any. Specify a different type @typescript-eslint/no-explicit-any
48:24 warning Unexpected any. Specify a different type @typescript-eslint/no-explicit-any
52:27 warning Unexpected any. Specify a different type @typescript-eslint/no-explicit-any
60:9 warning Unexpected any. Specify a different type @typescript-eslint/no-explicit-any
/home/runner/work/opentelemetry-js/opentelemetry-js/api/src/experimental/trace/SugaredTracer.ts
80:5 warning 'context' is already declared in the upper scope on line 17 column 10 @typescript-eslint/no-shadow
129:5 warning 'context' is already declared in the upper scope on line 17 column 10 @typescript-eslint/no-shadow
135:5 warning 'context' is already declared in the upper scope on line 17 column 10 @typescript-eslint/no-shadow
/home/runner/work/opentelemetry-js/opentelemetry-js/api/src/trace/NoopTracer.ts
102:37 warning Unexpected any. Specify a different type @typescript-eslint/no-explicit-any
Ref open-telemetry#5365
chancancode
commented
Jan 24, 2025
| typeof spanContext['traceId'] === 'string' && | ||
| 'traceFlags' in spanContext && | ||
| typeof spanContext['traceFlags'] === 'number' | ||
| ); |
There was a problem hiding this comment.
This imposes a very slight runtime cost from the additional check. If that is undesirable here, there are plenty of alternative factoring that would accomplish the same without runtime code, this is just the most readable IMO.
Alternatively, if we trust the types, this function can be deleted altogether. It's only ever called from L47; the input came from getSpanContext(), which is typed to return SpanContext | undefined. If that is accurate (looks like it to me), then all we really needed to check is !== undefined and it can be done inline.
25 tasks
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5366 +/- ##
=======================================
Coverage 94.54% 94.54%
=======================================
Files 318 318
Lines 8052 8055 +3
Branches 1694 1698 +4
=======================================
+ Hits 7613 7616 +3
Misses 439 439
|
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?
Fixes the following eslint warnings:
Ref #5365
Fixing
TextMapPropagator.tsis a breaking change, so that will be submitted separately.Short description of the changes
Refactor to avoid the patterns being flagged.
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Checklist: