fix(instrumentation-fastify): stop using fastify types in public api #1267
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
|
|
blumamir
reviewed
Nov 3, 2022
plugins/node/opentelemetry-instrumentation-fastify/src/internal-types.ts
Outdated
Show resolved
Hide resolved
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #1267 +/- ##
==========================================
- Coverage 96.08% 96.06% -0.02%
==========================================
Files 14 19 +5
Lines 893 1117 +224
Branches 191 230 +39
==========================================
+ Hits 858 1073 +215
- Misses 35 44 +9
|
Prior to this commit, the Fastify instrumentation used to expose a few types from the `fastify` lib directly. Exposing these types leads to issues for TypeScript users who depend on the integration but don't depend on `fastify` itself where their TypeScript compilation would fail while complaining that it couldn't find any definitions for `fastify`. This scenario is pretty common when using the auto-instrumentation packages.5 Signed-off-by: Boris Bera <[email protected]>
dyladan
approved these changes
Nov 3, 2022
Merged
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?
Related to #1266
Prior to this fix, typescript users that have the fastify instrumentation installed but do not have the
fastifypackage installed would get compilation errors because typescript was expecting thefastifypackage to be present. This issue is bound to happen for anyone using the auto instrumentation feature.Short description of the changes
fastifyas private ininstrumentation.ts.