refactor(instrumentation-xhr): fix eslint warnings #5402
Merged
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/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/types.ts 66:28 warning Don't use `Function` as a type @typescript-eslint/ban-types /home/runner/work/opentelemetry-js/opentelemetry-js/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/utils.ts 44:16 warning Unexpected any. Specify a different type @typescript-eslint/no-explicit-any 45:21 warning Unexpected any. Specify a different type @typescript-eslint/no-explicit-any /home/runner/work/opentelemetry-js/opentelemetry-js/experimental/packages/opentelemetry-instrumentation-xml-http-request/test/xhr.test.ts 69:22 warning Don't use `Function` as a type @typescript-eslint/ban-types 104:22 warning Don't use `Function` as a type @typescript-eslint/ban-types ``` The middle ones are the same as open-telemetry#5401, the rest are replacing `Function` with a more specific call signature, and they are either in tests or private API, so no breakages expected. Ref open-telemetry#5365
25 tasks
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5402 +/- ##
=======================================
Coverage 94.64% 94.64%
=======================================
Files 318 318
Lines 8033 8033
Branches 1688 1688
=======================================
Hits 7603 7603
Misses 430 430 |
|
@chancancode I'm adding the |
david-luna
reviewed
Feb 5, 2025
| @@ -53,8 +57,9 @@ export function getXHRBodyLength( | |||
| return getByteLength(body.toString()); | |||
| } | |||
|
|
|||
| if (typeof body === 'string') { | |||
| return getByteLength(body); | |||
| // ArrayBuffer | ArrayBufferView | |||
There was a problem hiding this comment.
any particular reason you moved the order of the checks?
There was a problem hiding this comment.
Hi yes, it's notionally the same change from #5401. The type started out (for TypeScript) as a bunch of possibilities union-ed together (string | ... | ArrayBuffer | ArrayBufferView) so by arranging the branches in a strategic order (eliminating those possibilities in order) we will get the desired result without having to explicitly tell TypeScript what's up
david-luna
approved these changes
Feb 6, 2025
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?
Ref #5365
Short description of the changes
The middle ones are the same as #5401, the rest are replacing
Functionwith a more specific call signature, and they are either in tests or private API, so no breakages expected.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: