Experimental support for AsyncSequence on Firestore snapshot listeners #11508
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
…ners Signed-off-by: Peter Friese <peter@peterfriese.de>
Generated by 🚫 Danger |
Apple API Diff ReportCommit: f9781a0 FirebaseFirestoreSwiftExtensions[ADDED] Query[ADDED] QuerySwift:
+ public extension Query
+ func snapshotSequence < T > ( _ type : T . Type , includeMetadataChanges : Bool = false ) -> AsyncThrowingStream < [ T ], Error > where T : Decodable[MODIFIED] DocumentReference[MODIFIED] DocumentReferenceSwift:
+ public extension DocumentReference extension DocumentReference : DocumentIDWrappable
- extension DocumentReference : DocumentIDWrappable
+ func snapshotSequence < T > ( _ type : T . Type , includeMetadataChanges : Bool = false ) -> AsyncThrowingStream < T , Error > where T : Decodable |
Signed-off-by: Peter Friese <peter@peterfriese.de>
Signed-off-by: Peter Friese <peter@peterfriese.de>
Signed-off-by: Peter Friese <peter@peterfriese.de>
Coverage Report 1Affected Products
Test Logs |
paulb777
reviewed
Jul 6, 2023
| import FirebaseFirestore | ||
| import Foundation | ||
|
|
||
| #if compiler(>=5.5.2) && canImport(_Concurrency) |
There was a problem hiding this comment.
We don't need this check anymore with our current Xcode supported versions
paulb777
reviewed
Jul 6, 2023
Example/FirestoreSample/FirestoreSample/Views/FavouriteFruitsAsyncSequenceView.swift
Outdated
Show resolved
Hide resolved
|
It could also make sense to have a similar abstraction for a document rather than a query. |
Signed-off-by: Peter Friese <peter@peterfriese.de>
Good point. Added! |
Signed-off-by: Peter Friese <peter@peterfriese.de>
peterfriese
changed the title
| includeMetadataChanges: Bool = false) | ||
| -> AsyncThrowingStream<T, Error> where T: Decodable { | ||
| .init { continuation in | ||
| let listener = addSnapshotListener(includeMetadataChanges: false) { documentSnapshot, error in |
There was a problem hiding this comment.
Should probably use the argument passed to the method.
Signed-off-by: Peter Friese <peter@peterfriese.de>
Signed-off-by: Peter Friese <peter@peterfriese.de>
* Rewrite Auth RPC types using Swift types. This largely stems from the unsafe casting that occurs. Current state: all types have been converted, almost no calls using those types have been converted, ran into an issue with TwitterAuthCredential where it takes a parameter that's an RPC type, but can't be visible in ObjC. This may result in an API change unfortunately, or a rethinking of how the AuthCredential and Providers work. --------- Co-authored-by: Ryan Wilson <wilsonryan@google.com>
Signed-off-by: Peter Friese <peter@peterfriese.de>
Signed-off-by: Peter Friese <peter@peterfriese.de>
|
Looks likes you might have had an out of date |
|
Please close, merge, or comment. We plan to close stale PRs on November 28, 2023. |
|
I'd like to land this in Q4. Will rebase on the latest |
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.
This PR adds support for using Swift's
AsyncSequenceto listen to changes on Firestore collections and documents.Here is how to use it:
Listening to updates on a single document
Listening to updates on a collection
See
Example/FirestoreSample/FirestoreSample/Views/FavouriteFruitsAsyncSequenceView.swiftandExample/FirestoreSample/FirestoreSample/Views/FavouriteFruitView.swiftfor more complete examples how to use this.