SWIFT-779 Funnel all bson_t access through helper methods #453
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
Codecov Report
@@ Coverage Diff @@
## master #453 +/- ##
==========================================
+ Coverage 76.21% 76.35% +0.14%
==========================================
Files 117 117
Lines 12820 12896 +76
==========================================
+ Hits 9771 9847 +76
Misses 3049 3049
Continue to review full report at Codecov.
|
Contributor
Author
|
made a few changes in my latest commit:
|
patrickfreed
approved these changes
Apr 21, 2020
Contributor
patrickfreed
left a comment
patrickfreed
left a comment
There was a problem hiding this comment.
looks great!
By the way, this also closes SWIFT-739 since the pointers are all accessed from Document.
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.
Putting this up as a draft as we should probably talk through the approach more but I figured I'd let you all talk a look.
This seems like a mostly reasonable approach to me aside from the fact that we really end up in nested closure hell in places where a libmongoc method takes in 3+ arguments.
I think there is more work to do to ensure these problems don't plague any other types. for example I think we might be vulnerable to similar issues with
ReadPreferenceas it follows the same "struct backed by a private class wrapping a C type" pattern.To summarize main changes here:
BSONValueprotocol'sencodemethod now takes in aninout Documentrather than aDocumentStorageDocumentStorageis aprivatetype, and its property_bsonis nowfileprivate. this means both are only accessible withinDocument.swift.Document's underlyingbson_tis via helpers, all of which usewithExtendedLifetimeto guarantee theDocumentstays valid for the duration of the provided closure. These are:withMutableBSONPointerwithBSONPointer, same as the previous but the pointer is immutablewithOptionalBSONPointer, which is to simplify usage in places where we have an optional document we may need to pass to a libmongoc API (basically this is just used for options documents)DocumentIteratorpreviously stored a reference to theDocumentStorageit came from. however I don't think this is really different than it just storing a copy of theDocumentit's iterating over -- in both cases we should get CoW behavior if someone tries to modify a copy of that document which is backed by the same storage. changing this this enabled me to make the change in the previous bullet point.