Remove the mysql2 package peer dependency #695
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
tombruijn
force-pushed
the
mysql2-dependency
branch
from
dcc8be8 to
378b3d6
Compare
tombruijn
force-pushed
the
mysql2-dependency
branch
from
378b3d6 to
d9fde59
Compare
unflxw
approved these changes
Jun 21, 2022
This peer dependency was previously added to fix the build for the OpenTelemetry mysql2 package instrumentation. In the TypeScript build of this package it would import the mysql2 types in the `@opentelemetry/instrumentation-mysql2` package, which we import. The `@opentelemetry/instrumentation-mysql2` package itself has no runtime dependency on the mysql2 package, and neither does `@opentelemetry/auto-instrumentations-node`. Which got me interested to find out how that package works if we're experiencing the problem described in PR #688 > Control packages peer dependencies > We need mysql2 as a peer dependency of the package because the > OpenTelemetry instrumentation library requires it. This could be fixed > with introspection using require-in-the-middle. Instead I've moved it to the devDependencies list to fix the build and remove the dependency for users that do not use the mysql2 package in their app. I've then tested it in a TypeScript example app appsignal/opentelemetry#29 that doesn't use mysql2. The AppSignal package works without mysql2 as a peer dependency in this scenario.
tombruijn
force-pushed
the
mysql2-dependency
branch
from
d9fde59 to
68ab71b
Compare
tombruijn
changed the base branch from
opentelemetry-koa-instrumentation
to
opentelemetry
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.
This peer dependency was added to fix the build for the OpenTelemetry
mysql2 package instrumentation. In the TypeScript build it would import
the mysql2 types in the
@opentelemetry/instrumentation-mysql2package.The
@opentelemetry/instrumentation-mysql2package itself has nodependency on the mysql2 package, and neither does
@opentelemetry/auto-instrumentations-node. Which got me interested tofind out how that package works if we're experiencing the problem
described in PR #688
Instead I've moved it to the devDependencies list to fix the build and
remove the dependency for users that do not use the mysql2 package in
their app.
The AppSignal package works without it as a peer dependency, even if the
mysql2 package is not a dependency of the user's app. I've also tested
this in a TypeScript app without any conditional loading for the
@opentelemetry/instrumentation-mysql2package.