FirestoreSwift: Make DocumentID setter internal #10304
Closed
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
Made the @documentid property wrapper's value setter internal. DocumentID is currently read-only and is only populated when reading from Firestore. This limits access to the setter since the value is ignored when writing to Firestore. Updated the constructor to always set nil, regardless of the wrappedValue provided. Developers are notified of this via an existing log message warning them that the value is ignored. Added conformance tests to verify (and demonstrate) the functionality change.
Coverage Report 1Affected Products
Test Logs |
peterfriese
reviewed
Oct 5, 2022
| } | ||
|
|
||
| public var wrappedValue: Value? { | ||
| /// Gets the document identifier if populated; `nil` otherwise. |
There was a problem hiding this comment.
I think we always call it document ID (not document identifier)
|
Please close, merge, or comment. We plan to close stale PRs on November 28, 2023. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 is an alternative to the warning-only approach proposed in the latest
DocumentIDAPI review.Made the
@DocumentIDproperty wrapper's value setter internal.DocumentIDis currently read-only and is only populated when reading from Firestore. This PR limits access to the setter since the value is ignored when writing to Firestore.Updated the constructor to always set
nil, regardless of thewrappedValueprovided. Developers are notified of this via an existing log message warning them that the value is ignored.Added conformance tests to verify (and demonstrate) the functionality change.