docs(NODE-4990): comment about serverNonce format #3547
Merged
+3
−1
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
dariakp
requested changes
Jan 30, 2023
src/cmap/auth/mongodb_aws.ts
Outdated
| if (!ByteUtils.equals(serverNonce.subarray(0, nonce.byteLength), nonce)) { | ||
| // The serverNonce's leading 32 bytes must equal the client nonce's 32 bytes |
There was a problem hiding this comment.
should this comment be above this block? and also, I thought you were going to at least mention the spec in case someone else is wondering where this comes from
There was a problem hiding this comment.
I usually prefer to put comments inside the if, just a habit, trying to make the code read like "if X is true, do Y" so if I'm following my own practice I should write something more like: // throw because the server's nonce must begin with... kinda like how mocha test the "it" is supposed to imply "the function under test should..."
will add a link to the spec
There was a problem hiding this comment.
I used the latest commit hash incase a future version changes the header link
dariakp
added
the
Primary Review
dariakp
approved these changes
Jan 31, 2023
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.
Description
What is changing?
Add a comment for a confusing bit of code
Double check the following
npm run check:lintscripttype(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript