fix: make MongoBulkWriteError conform to CRUD spec #2621
Merged
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
HanaPearlman
requested review from
emadum,
mbroadst and
nbbeeken
and removed request for
mbroadst and
nbbeeken
emadum
suggested changes
Nov 17, 2020
Contributor
emadum
left a comment
emadum
left a comment
There was a problem hiding this comment.
LGTM! I think we can take this PR as an opportunity to tighten up some properties which are currently optional but don't need to be.
src/bulk/common.ts
Outdated
| upsertedIds?: { [key: number]: ObjectId }; | ||
|
|
||
| /** Creates a new MongoBulkWriteError */ | ||
| constructor(error?: AnyError, result?: BulkWriteResult) { |
Contributor
There was a problem hiding this comment.
I think we should make the error and result properties/constructor options non-optional. These errors are always constructed with both arguments.
src/bulk/common.ts
Outdated
|
|
||
| this.insertedCount = result?.insertedCount; | ||
| this.matchedCount = result?.matchedCount; | ||
| this.modifiedCount = result?.modifiedCount || 0; |
Contributor
There was a problem hiding this comment.
Don't need to provide a default here, modifiedCount is already guaranteed to be a number in BulkWriteResult.
src/bulk/common.ts
Outdated
|
|
||
| /** Creates a new BulkWriteError */ | ||
| /** Number of documents inserted. */ | ||
| insertedCount?: number; |
Contributor
There was a problem hiding this comment.
If result isn't optional (see lower comment) none of these new properties need to be optional either.
nbbeeken
approved these changes
Nov 17, 2020
Contributor
nbbeeken
left a comment
nbbeeken
left a comment
There was a problem hiding this comment.
Eric's suggestions seem to cover it, lgtm!
emadum
approved these changes
Nov 18, 2020
HanaPearlman
force-pushed
the
NODE-1989/master/bulk-write-error
branch
from
a832898 to
b806fa2
Compare
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.
This PR makes
BulkWriteErrorconform to the CRUD spec by adding the necessary fields required by the spec tests to the class and renamesBulkWriteErrortoMongoBulkWriteError.NODE-1989, NODE-2331