SWIFT-882 Convert extJSON properties to methods #496
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
Codecov Report
@@ Coverage Diff @@
## master #496 +/- ##
==========================================
+ Coverage 76.69% 76.71% +0.02%
==========================================
Files 127 127
Lines 13144 13157 +13
==========================================
+ Hits 10081 10094 +13
Misses 3063 3063
Continue to review full report at Codecov.
|
kmahar
reviewed
Jun 3, 2020
| /// Returns the relaxed extended JSON representation of this `BSONDocument`. | ||
| /// On error, an empty string will be returned. | ||
| public var extendedJSON: String { | ||
| public func toExtendedJSONString() -> String { |
Contributor
There was a problem hiding this comment.
I was going to say it would be better to throw than to return an empty string now that these are methods, but OTOH i think in the new library we don't expect JSON serialization to fail unless it's explicitly unvalidated BSON. in which case i think fatal error / empty string is acceptable
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
SWIFT-882
This PR converts the extJSON computed properties to methods, since they may be computationally expensive. @mbroadst noted that they would be superseded by
ExtendedJSONEncoder, and that we would probably deprecate them once that was introduced. Since these produceStrings, they could perhaps be useful as conveniences over invoking the encoder, so I also added "String" as a suffix to their method names.These changes are not release blockers, but if we do want to make them we need to do so today, so I just put up the PR now to get the discussion rolling.