fix(NODE-3358): Command monitoring objects hold internal state references #2858
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
…leak internal state
W-A-James
changed the title
W-A-James
added
the
Primary Review
…-internal-state-references
dariakp
requested changes
Jun 24, 2021
test/functional/apm.test.js
Outdated
| expect(started[0].commandName).to.equal('insert'); | ||
| expect(started[0].command.insert).to.equal('apm_test'); | ||
| expect(succeeded).to.have.lengthOf(1); | ||
| return client.close(); |
There was a problem hiding this comment.
sorry for not catching this in the 4.0 PR, but, since this belongs in the clean up, the ideal way to do it would be to have this in an afterEach block with the creation of the client in a beforeEach; to avoid refactoring too much, it's fine to wrap this in its own describe for that purpose
dariakp
approved these changes
Jun 24, 2021
dariakp
added
Team Review
emadum
suggested changes
Jun 24, 2021
lib/command_utils.js
Outdated
| @@ -106,7 +108,7 @@ const extractCommand = command => { | |||
| extractedCommand = result; | |||
| } | |||
| } else { | |||
| extractedCommand = command.query || command; | |||
| extractedCommand = command.query ? deepCopy(command.query) : deepCopy(command); | |||
There was a problem hiding this comment.
Suggested change
| extractedCommand = command.query ? deepCopy(command.query) : deepCopy(command); | |
| extractedCommand = deepCopy(command.query || command); |
I'd keep the more concise || syntax from the original code.
lib/utils.js
Outdated
| @@ -871,6 +871,85 @@ function emitWarningOnce(message) { | |||
| } | |||
| } | |||
|
|
|||
| // Copied from https://github.com/mongodb/node-mongodb-native/blob/70cace8343bead2f3c1a6d0cf07e20a8c4a9f45f/src/utils.ts | |||
There was a problem hiding this comment.
I don't think these "copied from" comments are necessary.
test/functional/apm.test.js
Outdated
| describe('Internal state references', function() { | ||
| let client; | ||
|
|
||
| beforeEach(function(done) { |
There was a problem hiding this comment.
Since newClient is synchronous, you can just pass a function() without a done argument and omit the the done() below.
test/functional/apm.test.js
Outdated
| }); | ||
|
|
||
| afterEach(function(done) { | ||
| client.close(() => done()); |
There was a problem hiding this comment.
Suggested change
| client.close(() => done()); | |
| client.close(done); |
emadum
approved these changes
Jun 25, 2021
nbbeeken
approved these changes
Jun 25, 2021
dariakp
deleted the
NODE-3358/3.6/Command-monitoring-objects-hold-internal-state-references
branch
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.
Modify extractCommand function used in apm event constructors to make deep copies of the command passed in
What changed?