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

deps(instrumentation): Move @types/shimmer into devDependencies #4835

Closed
wants to merge 1 commit into from

Conversation

lforst
Copy link
Contributor

@lforst lforst commented Jul 1, 2024

Which problem is this PR solving?

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes getsentry/sentry-javascript#12682

Short description of the changes

Shimmer has a harmful type definition (DefinitelyTyped/DefinitelyTyped#69966) which conflicts with typings in certain situations (getsentry/sentry-javascript#12682) but in general, typings should not end up in the normal dependencies.

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?

No tests necessary I think.

Checklist:

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

@lforst lforst requested a review from a team July 1, 2024 12:44
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.

Thanks for opening this PR.

@types/shimmer is part of the public API (which is bad and is also blocking marking @opentelemetry/instrumentation as stable). In the current state this PR will break any user that has skipLibCheck: false.

I think what we'd have to do here is to wrap the shimmer functionality and providing our own types for it. Some details in #4837 (i just created this earlier based on this PR).

@lforst
Copy link
Contributor Author

lforst commented Jul 2, 2024

@pichlermarc Thanks for the heads-up! I didn't properly check whether the dependency was used. I assumed it was put there by mistake 😄

I hope the "hostile" typedef change gets merged soon: DefinitelyTyped/DefinitelyTyped#69966 which would make shimming shimmer less important.

@lforst
Copy link
Contributor Author

lforst commented Jul 8, 2024

Closed in favor of #4854 now that DefinitelyTyped/DefinitelyTyped#69966 was merged and released.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sentry sdk adds "__wrapped"-properties to types, which prevents nestjs project from building
2 participants