fix(instr-mongodb): fix instr to no longer break mongodb >=6.4.0 #3897
Conversation
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
Bumps [mongodb](https://github.com/mongodb/node-mongodb-native) from 6.3.0 to 6.4.0. - [Release notes](https://github.com/mongodb/node-mongodb-native/releases) - [Changelog](https://github.com/mongodb/node-mongodb-native/blob/main/HISTORY.md) - [Commits](mongodb/node-mongodb-native@v6.3.0...v6.4.0) --- updated-dependencies: - dependency-name: mongodb dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>
Member
|
run docs-build |
Member
symptomThe mongodb tests are failing here with: i.e. the bugIIUC, this is a bug caused by our instrumentation of class ConnectionPoolTraced extends mod.ConnectionPool {
checkOut(callback) {
return super.checkOut(AsyncResource.bind(callback));
}
}However, mongodb@6.4.0 includes mongodb/node-mongodb-native@ff8b5f5#diff-c464ff2f674f52c3696a24e1a90ef79e3f300a4fed92884a8c3cb6a1d0d143a5L353-R360 which changes the signature of that - checkOut(callback: Callback<Connection>): void {
+ async checkOut(): Promise<Connection> {fixI'd started out with this change: diff --git a/lib/instrumentation/modules/mongodb/lib/cmap/connection_pool.js b/lib/instrumentation/modules/mongodb/lib/cmap/connection_pool.js
index 22089015..a8a5b09a 100644
--- a/lib/instrumentation/modules/mongodb/lib/cmap/connection_pool.js
+++ b/lib/instrumentation/modules/mongodb/lib/cmap/connection_pool.js
@@ -23,7 +23,14 @@ module.exports = (mod, agent, { version, enabled }) => {
if (mod.ConnectionPool) {
class ConnectionPoolTraced extends mod.ConnectionPool {
checkOut(callback) {
- return super.checkOut(AsyncResource.bind(callback));
+ if (typeof callback === 'function') {
+ return super.checkOut(AsyncResource.bind(callback));
+ } else {
+ // mongodb@>=6.4.0
+ // - checkOut(callback: Callback<Connection>): void {
+ // + async checkOut(): Promise<Connection> {
+ return super.checkOut();
+ }
}
}
This fixes the crash, but I expected that we'd again then get the async context tracking issue that #3665 fixed. So now I think we should have that ConnectionPool instrumentation only apply to the earlier mongodb versions. - if (!semver.satisfies(version, '>=3.3 <7.0')) {
+ if (!semver.satisfies(version, '>=3.3 <6.4.0')) {Qs@david-luna Do you recall if you/we ever opened a node-mongodb-native issue about this AsyncResource.bind usage? I couldn't find anything searching https://jira.mongodb.org/projects/NODE/issues |
Member
|
run docs-build |
Member
|
run docs-build |
Member
|
Ah here it is: https://jira.mongodb.org/browse/NODE-5639 And TAV tests are failing for otel-js-contrib as well: open-telemetry/opentelemetry-js-contrib#1978 (comment) |
Member
david-luna
approved these changes
Mar 5, 2024
david-luna
approved these changes
Mar 5, 2024
PeterEinberger
pushed a commit
to fpm-git/apm-agent-nodejs
that referenced
this pull request
Aug 20, 2024
…stic#3897) * chore(deps-dev): bump mongodb from 6.3.0 to 6.4.0 Co-authored-by: Trent Mick <trent.mick@elastic.co>
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.
Bumps mongodb from 6.3.0 to 6.4.0.
Release notes
Sourced from mongodb's releases.
... (truncated)
Changelog
Sourced from mongodb's changelog.
Commits
9ac2e38chore(main): release 6.4.0 [skip-ci] (#3935)5f62f56docs: generate docs from latest main [skip-ci] (#3977)90f2f70feat(NODE-5978): upgrade BSON to ^6.4.0 (#4007)99a0059test(NODE-5731): add serverless proxy testing (#4003)1ca6269test(NODE-5929): convert txn legacy spec tests (#3987)f26de76fix(NODE-5944): make AWS session token optional (#4002)09c9b0bchore(NODE-5972): specify TS 5.0 in package.json and package-lock (#4004)eb5e2abchore(NODE-5829): update driver dependencies (#3994)233a2e0refactor(NODE-5964): clean up prepareHandshakeDocument (#4001)ff8b5f5refactor(NODE-5912): make server.command an async function (#3986)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebasewill rebase this PR@dependabot recreatewill recreate this PR, overwriting any edits that have been made to it@dependabot mergewill merge this PR after your CI passes on it@dependabot squash and mergewill squash and merge this PR after your CI passes on it@dependabot cancel mergewill cancel a previously requested merge and block automerging@dependabot reopenwill reopen this PR if it is closed@dependabot closewill close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot show <dependency name> ignore conditionswill show all of the ignore conditions of the specified dependency@dependabot ignore this major versionwill close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor versionwill close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependencywill close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)