Experimental support for AsyncSequence on Firestore snapshot listeners

Example/FirestoreSample/FirestoreSample.xcodeproj/project.pbxproj

@@ -11,11 +11,12 @@
  8817084926B95A63009E9281 /* FirebaseFirestoreSwift in Frameworks */ = {isa = PBXBuildFile; productRef = 8817084826B95A63009E9281 /* FirebaseFirestoreSwift */; };
  88327B8826D62908002AA6D9 /* FavouriteFruitsView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88327B8726D62908002AA6D9 /* FavouriteFruitsView.swift */; };
  8844BA6126E0DD3F000786F0 /* FavouriteFruitsMappingErrorView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8844BA6026E0DD3F000786F0 /* FavouriteFruitsMappingErrorView.swift */; };
+ 887FEFE32A5574EB00FB2756 /* GoogleService-Info.plist in Resources */ = {isa = PBXBuildFile; fileRef = 887FEFE22A5574EA00FB2756 /* GoogleService-Info.plist */; };
+ 887FEFE52A5576FA00FB2756 /* FavouriteFruitsAsyncSequenceView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 887FEFE42A5576FA00FB2756 /* FavouriteFruitsAsyncSequenceView.swift */; };
  88D5E37826EBD2F200808AFF /* FavouriteFruitsMappingErrorView2.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88D5E37726EBD2F200808AFF /* FavouriteFruitsMappingErrorView2.swift */; };
  88D9354A2A39CB3E00FD8AFF /* FavouriteFruitsAnimationView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88D935492A39CB3E00FD8AFF /* FavouriteFruitsAnimationView.swift */; };
  88D9354C2A39D72300FD8AFF /* FirebaseAuth in Frameworks */ = {isa = PBXBuildFile; productRef = 88D9354B2A39D72300FD8AFF /* FirebaseAuth */; };
  88E5A79A2A39DDE400462B64 /* FavouriteFruitsNoAnimationsView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88E5A7992A39DDE400462B64 /* FavouriteFruitsNoAnimationsView.swift */; };
- 88E5A79C2A39E11A00462B64 /* GoogleService-Info.plist in Resources */ = {isa = PBXBuildFile; fileRef = 88E5A79B2A39E11A00462B64 /* GoogleService-Info.plist */; };
  88FBD98826B9485F00982BF2 /* FirestoreSampleApp.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88FBD98726B9485F00982BF2 /* FirestoreSampleApp.swift */; };
  88FBD98C26B9486100982BF2 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 88FBD98B26B9486100982BF2 /* Assets.xcassets */; };
  88FBD98F26B9486100982BF2 /* Preview Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 88FBD98E26B9486100982BF2 /* Preview Assets.xcassets */; };
@@ -26,10 +27,11 @@
  8809D0AE26B9520B00DE7864 /* firebase-ios-sdk */ = {isa = PBXFileReference; lastKnownFileType = folder; name = "firebase-ios-sdk"; path = ../..; sourceTree = "<group>"; };
  88327B8726D62908002AA6D9 /* FavouriteFruitsView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FavouriteFruitsView.swift; sourceTree = "<group>"; };
  8844BA6026E0DD3F000786F0 /* FavouriteFruitsMappingErrorView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FavouriteFruitsMappingErrorView.swift; sourceTree = "<group>"; };
+ 887FEFE22A5574EA00FB2756 /* GoogleService-Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = "GoogleService-Info.plist"; sourceTree = "<group>"; };
+ 887FEFE42A5576FA00FB2756 /* FavouriteFruitsAsyncSequenceView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FavouriteFruitsAsyncSequenceView.swift; sourceTree = "<group>"; };
  88D5E37726EBD2F200808AFF /* FavouriteFruitsMappingErrorView2.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FavouriteFruitsMappingErrorView2.swift; sourceTree = "<group>"; };
  88D935492A39CB3E00FD8AFF /* FavouriteFruitsAnimationView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FavouriteFruitsAnimationView.swift; sourceTree = "<group>"; };
  88E5A7992A39DDE400462B64 /* FavouriteFruitsNoAnimationsView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FavouriteFruitsNoAnimationsView.swift; sourceTree = "<group>"; };
- 88E5A79B2A39E11A00462B64 /* GoogleService-Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = "GoogleService-Info.plist"; sourceTree = "<group>"; };
  88FBD98426B9485F00982BF2 /* FirestoreSample.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = FirestoreSample.app; sourceTree = BUILT_PRODUCTS_DIR; };
  88FBD98726B9485F00982BF2 /* FirestoreSampleApp.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FirestoreSampleApp.swift; sourceTree = "<group>"; };
  88FBD98B26B9486100982BF2 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
@@ -90,7 +92,7 @@
  88FBD99526B948A100982BF2 /* App */,
  88FBD99626B948A900982BF2 /* Views */,
  88FBD98B26B9486100982BF2 /* Assets.xcassets */,
- 88E5A79B2A39E11A00462B64 /* GoogleService-Info.plist */,
+ 887FEFE22A5574EA00FB2756 /* GoogleService-Info.plist */,
  88FBD98D26B9486100982BF2 /* Preview Content */,
  );
  path = FirestoreSample;
@@ -120,6 +122,7 @@
  88D5E37726EBD2F200808AFF /* FavouriteFruitsMappingErrorView2.swift */,
  88E5A7992A39DDE400462B64 /* FavouriteFruitsNoAnimationsView.swift */,
  88D935492A39CB3E00FD8AFF /* FavouriteFruitsAnimationView.swift */,
+ 887FEFE42A5576FA00FB2756 /* FavouriteFruitsAsyncSequenceView.swift */,
  88FBD99726B948E200982BF2 /* MenuView.swift */,
  );
  path = Views;
@@ -188,8 +191,8 @@
  isa = PBXResourcesBuildPhase;
  buildActionMask = 2147483647;
  files = (
- 88E5A79C2A39E11A00462B64 /* GoogleService-Info.plist in Resources */,
  88FBD98F26B9486100982BF2 /* Preview Assets.xcassets in Resources */,
+ 887FEFE32A5574EB00FB2756 /* GoogleService-Info.plist in Resources */,
  88FBD98C26B9486100982BF2 /* Assets.xcassets in Resources */,
  );
  runOnlyForDeploymentPostprocessing = 0;
@@ -206,6 +209,7 @@
  88327B8826D62908002AA6D9 /* FavouriteFruitsView.swift in Sources */,
  88D9354A2A39CB3E00FD8AFF /* FavouriteFruitsAnimationView.swift in Sources */,
  88FBD98826B9485F00982BF2 /* FirestoreSampleApp.swift in Sources */,
+ 887FEFE52A5576FA00FB2756 /* FavouriteFruitsAsyncSequenceView.swift in Sources */,
  88D5E37826EBD2F200808AFF /* FavouriteFruitsMappingErrorView2.swift in Sources */,
  8844BA6126E0DD3F000786F0 /* FavouriteFruitsMappingErrorView.swift in Sources */,
  );

Example/FirestoreSample/FirestoreSample/Views/FavouriteFruitView.swift

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import SwiftUI
+import FirebaseFirestore
+import FirebaseFirestoreSwift
+
+private struct Fruit: Codable, Identifiable, Equatable {
+ @DocumentID var id: String?
+ var name: String
+ var isFavourite: Bool
+}
+
+extension Fruit {
+ static let empty = Fruit(name: "", isFavourite: false)
+}
+
+struct FavouriteFruitView: View {
+ @State fileprivate var fruit: Fruit = .empty
+
+ var body: some View {
+ VStack {
+ Text(fruit.name)
+ Toggle(isOn: $fruit.isFavourite, label: {
+ Text("Is favourite")
+ })
+ }
+ .task {
+ do {
+ let doc = Firestore.firestore().collection("fruits").document("1uxSAlCvYWmfrXN7rn2s")
+ for try await fruit in doc.snapshotSequence(Fruit.self) {
+ self.fruit = fruit
+ }
+ } catch {
+ print(error)
+ }
+ }
+ .navigationTitle("Fruit")
+ }
+}
+
+struct FavouriteFruitView_Previews: PreviewProvider {
+ static var previews: some View {
+ FavouriteFruitView()
+ }
+}

Example/FirestoreSample/FirestoreSample/Views/FavouriteFruitsAsyncSequenceView.swift

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import SwiftUI
+import FirebaseFirestore
+import FirebaseFirestoreSwift
+
+private struct Fruit: Codable, Identifiable, Equatable {
+ @DocumentID var id: String?
+ var name: String
+ var isFavourite: Bool
+}
+
+struct FavouriteFruitsAsyncSequenceView: View {
+ @State fileprivate var fruits: [Fruit] = []
+
+ @State var showOnlyFavourites = true
+
+ var body: some View {
+ List(fruits) { fruit in
+ Text(fruit.name)
+ }
+ .task {
+ do {
+ let collection = Firestore.firestore().collection("fruits")
+ for try await fruits in collection.snapshotSequence(Fruit.self) {
+ self.fruits = fruits
+ }
+ } catch {
+ print(error)
+ }
+ }
+ .animation(.default, value: fruits)
+ .navigationTitle("Fruits")
+ .toolbar {
+ ToolbarItem(placement: .navigationBarTrailing) {
+ Button(action: toggleFilter) {
+ Image(systemName: showOnlyFavourites
+ ? "line.3.horizontal.decrease.circle.fill"
+ : "line.3.horizontal.decrease.circle")
+ }
+ }
+ }
+ }
+
+ func toggleFilter() {
+ showOnlyFavourites.toggle()
+ }
+}
+
+struct FavouriteFruitsAsyncSequenceView_Previews: PreviewProvider {
+ static var previews: some View {
+ FavouriteFruitsAsyncSequenceView()
+ }
+}

Example/FirestoreSample/FirestoreSample/Views/MenuView.swift

@@ -36,6 +36,14 @@ struct MenuView: View {
  Label("With Animations", systemImage: "shippingbox")
  }
  }
+ Section(header: Text("Async")) {
+ NavigationLink(destination: FavouriteFruitsAsyncSequenceView()) {
+ Label("AsyncSequence (Collection)", systemImage: "shippingbox")
+ }
+ NavigationLink(destination: FavouriteFruitView()) {
+ Label("AsyncSequence (Document)", systemImage: "shippingbox")
+ }
+ }
  }
  .listStyle(InsetGroupedListStyle())
  .navigationTitle("Firestore")

Firestore/Swift/Source/AsyncAwait/DocumentReference+AsyncStream.swift

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import FirebaseFirestore
+import Foundation
+
+@available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
+public extension DocumentReference {
+ func snapshotSequence<T>(_ type: T.Type,
+ includeMetadataChanges: Bool = false)
+ -> AsyncThrowingStream<T, Error> where T: Decodable {
+ .init { continuation in
+ let listener = addSnapshotListener(includeMetadataChanges: false) { documentSnapshot, error in
+ do {
+ if let result = try documentSnapshot?.data(as: T.self) {
+ continuation.yield(result)
+ }
+ } catch {
+ continuation.finish(throwing: error)
+ }
+ }
+
+ continuation.onTermination = { @Sendable _ in
+ listener.remove()
+ }
+ }
+ }
+}

Firestore/Swift/Source/AsyncAwait/Query+AsyncStream.swift

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import FirebaseFirestore
+import Foundation
+
+@available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
+public extension Query {
+ func snapshotSequence<T>(_ type: T.Type,
+ includeMetadataChanges: Bool = false) -> AsyncThrowingStream<
+ [T],
+ Error
+ > where T: Decodable {
+ .init { continuation in
+ let listener =
+ addSnapshotListener(includeMetadataChanges: includeMetadataChanges) { querySnapshot, error in
+ do {
+ guard let documents = querySnapshot?.documents else {
+ continuation.yield([])
+ return
+ }
+ let results = try documents.map { try $0.data(as: T.self) }
+ continuation.yield(results)
+ } catch {
+ continuation.finish(throwing: error)
+ }
+ }
+
+ continuation.onTermination = { @Sendable _ in
+ listener.remove()
+ }
+ }
+ }
+}