Skip to content
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

refactor(instrumentation-fetch): fix eslint warnings #5401

Merged

Conversation

chancancode
Copy link
Contributor

@chancancode chancancode commented Jan 30, 2025

Which problem is this PR solving?

Fix the following eslint warnings:

/home/runner/work/opentelemetry-js/opentelemetry-js/experimental/packages/opentelemetry-instrumentation-fetch/src/utils.ts
  137:16  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
  138:21  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any

Ref #5365

Short description of the changes

This can be avoided by re-ordering the branches so that TypeScript can narrow the type of the value progressively.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

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

  • eslint

Checklist:

  • Followed the style guidelines of this project
  • Unit tests have been added
  • Documentation has been updated

```
/home/runner/work/opentelemetry-js/opentelemetry-js/experimental/packages/opentelemetry-instrumentation-fetch/src/utils.ts
  137:16  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
  138:21  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
```

This can be avoided by re-ordering the branches so that TypeScript
can narrow the type of the value progressively.

Ref open-telemetry#5365
@chancancode chancancode requested a review from a team as a code owner January 30, 2025 02:16
@chancancode chancancode mentioned this pull request Jan 30, 2025
25 tasks
Copy link

codecov bot commented Jan 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.63%. Comparing base (3c040c4) to head (c1fb762).
Report is 7 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5401   +/-   ##
=======================================
  Coverage   94.63%   94.63%           
=======================================
  Files         318      318           
  Lines        8032     8032           
  Branches     1685     1685           
=======================================
  Hits         7601     7601           
  Misses        431      431           

chancancode added a commit to tildeio/opentelemetry-js that referenced this pull request Jan 30, 2025
```
/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.
chancancode added a commit to tildeio/opentelemetry-js that referenced this pull request Jan 30, 2025
```
/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
Copy link
Member

@pichlermarc pichlermarc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

neat!

@pichlermarc pichlermarc added this pull request to the merge queue Jan 30, 2025
Merged via the queue into open-telemetry:main with commit 29d0da5 Jan 30, 2025
15 of 16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants