fix: wrap mysql2 addCommand only once#7459
Merged
Merged
Conversation
Prepare calls would currently cause the method to be rewrapped frequently. This is now only done a single time. In addition this adds types to the instrumentation and adds a few more safe guards for type safety.
The database plugin has a few intermediate objects that are not necessary as well as calling methods when they do not have to be called. This is not a huge difference but it is not needed. In addition, add types and make private methods actually privat.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #7459 +/- ##
=======================================
Coverage 80.34% 80.34%
=======================================
Files 731 731
Lines 31093 31100 +7
=======================================
+ Hits 24981 24988 +7
Misses 6112 6112
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Overall package sizeSelf size: 4.58 MB Dependency sizes| name | version | self size | total size | |------|---------|-----------|------------| | import-in-the-middle | 2.0.6 | 81.92 kB | 813.08 kB | | dc-polyfill | 0.1.10 | 26.73 kB | 26.73 kB |🤖 This report was automatically generated by heaviest-objects-in-the-universe |
This comment has been minimized.
This comment has been minimized.
BenchmarksBenchmark execution time: 2026-02-09 13:17:26 Comparing candidate commit 85fa607 in PR branch Found 0 performance improvements and 0 performance regressions! Performance is the same for 226 metrics, 34 unstable metrics. |
BridgeAR
marked this pull request as ready for review
February 7, 2026 19:58
uurien
reviewed
Feb 9, 2026
bengl
reviewed
Feb 10, 2026
| errorCh.publish(ctx) | ||
| }) | ||
| this.once('end', () => finishCh.publish(ctx)) | ||
| const command = /** @type {{ once?: Function }} */ (this) |
Collaborator
There was a problem hiding this comment.
Does TS not provide a nice way to do this, say on line 164, so that you don't need to do this kinda weird re-assignment?
Member
Author
There was a problem hiding this comment.
Yes, the issue here is something else: we actually truly do not know about the type because they might change in any version. Due to that, we have to 'detect' each individual type and even when we detect it, we have to cast that part so that this access is accepted.
| }) | ||
| if (typeof cb === 'function') { | ||
| process.nextTick(() => { | ||
| /** @type {Function} */ (cb)(abortController.signal.reason) |
Collaborator
There was a problem hiding this comment.
Does line 270 not make this type comment unnecessary?
Member
Author
There was a problem hiding this comment.
Somehow the types detect that the cb might have changed its content due to the async operation in between.
| addHook({ name: 'mysql2', file: 'lib/pool.js', versions: ['1 - 3.11.4'] }, wrapPool) | ||
| addHook( | ||
| { name: 'mysql2', file: 'lib/base/connection.js', versions: ['>=3.11.5'] }, | ||
| /** @type {(moduleExports: unknown, version: string) => unknown} */ (wrapConnection) |
Collaborator
There was a problem hiding this comment.
This is pretty repetitive. Can we not make this implicit via addHooks's definition?
Member
Author
There was a problem hiding this comment.
This is already the definition in addHook. The reason is that the receiving method defines more concrete types that do not match these 1-to-1. Thus the need for the cast.
uurien
reviewed
Feb 12, 2026
uurien
approved these changes
Feb 12, 2026
crysmags
reviewed
Feb 12, 2026
crysmags
left a comment
crysmags
left a comment
Collaborator
There was a problem hiding this comment.
Did a quick review, good to go!
dd-octo-sts Bot
pushed a commit
that referenced
this pull request
Feb 13, 2026
* fix: wrap mysql2 addCommand only once Prepare calls would currently cause the method to be rewrapped frequently. This is now only done a single time. In addition this adds types to the instrumentation and adds a few more safe guards for type safety. * perf: improve database plugin performance The database plugin has a few intermediate objects that are not necessary as well as calling methods when they do not have to be called. This is not a huge difference but it is not needed. * chore: make private methods actually private * chore: add types to tracing and outbound plugins * test: add regression test for single addCommand wrapping Fixes: #7074
Merged
juan-fernandez
pushed a commit
that referenced
this pull request
Feb 18, 2026
* fix: wrap mysql2 addCommand only once Prepare calls would currently cause the method to be rewrapped frequently. This is now only done a single time. In addition this adds types to the instrumentation and adds a few more safe guards for type safety. * perf: improve database plugin performance The database plugin has a few intermediate objects that are not necessary as well as calling methods when they do not have to be called. This is not a huge difference but it is not needed. * chore: make private methods actually private * chore: add types to tracing and outbound plugins * test: add regression test for single addCommand wrapping Fixes: #7074
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
fix: wrap mysql2 addCommand only once
Prepare calls would currently cause the method to be rewrapped
frequently. This is now only done a single time.
In addition this adds types to the instrumentation and adds a few
more safe guards for type safety.
perf: improve database plugin performance
The database plugin has a few intermediate objects that are not
necessary as well as calling methods when they do not have to be
called.
This is not a huge difference but it is not needed.
In addition, add types and make private methods actually privat.
chore: add types to tracing and outbound plugins
Fixes: #7074