[Firestore] Consolidate Firestore and FirestoreSwift #11806

ncooke3 · 2023-09-14T04:51:06Z

Context

The contents of FST's Swift extension SDK has been moved into the main FST module, and the FST Swift extension SDK now re-exports the API that used to live in it.
This change should be non-breaking.

Tasks

New Swift code moved into base SDK namespace should build on Firebase's minimum deployment version for each applicable platform (use client_app?)
The affected extension podspecs should be versioned to pin to the releasing version.
When this PR is merged, stage the affected podspecs and notify the Games team.

Important

This PR contains an assumption in the source code that docs will be at hosted at https://firebase.google.com/docs/ios/swift-migration cc: @morganchen12

github-actions · 2023-09-14T04:59:00Z

Apple API Diff Report

Commit: 8a27818
Last updated: Thu Oct 12 10:36 PDT 2023
View workflow logs & download artifacts

FirebaseFirestoreSwift

[REMOVED] Extensions

Swift:
-    public extension CollectionReference
-      @discardableResult func addDocument ( data : [ String : Any ]) async throws -> DocumentReference
-      @discardableResult func addDocument < T : Encodable > ( from value : T , encoder : Firestore . Encoder = Firestore . Encoder (), completion : (( Error ?) -> Void )? = nil ) throws -> DocumentReference
-    extension Date : ServerTimestampWrappable
-      public static func wrap ( _ timestamp : Timestamp ) throws -> Date
-      public static func unwrap ( _ value : ` Self ` ) throws -> Timestamp
-    extension DocumentReference : DocumentIDWrappable
-      public static func wrap ( _ documentReference : DocumentReference ) throws -> Self
-      func getDocument < T : Decodable > ( as type : T . Type , with serverTimestampBehavior : ServerTimestampBehavior = . none , decoder : Firestore . Decoder = . init (), completion : @escaping ( Result < T , Error > ) -> Void )
-      @available(iOS 13, tvOS 13, macOS 10.15, watchOS 7, *) func getDocument < T : Decodable > ( as type : T . Type , with serverTimestampBehavior : ServerTimestampBehavior = . none , decoder : Firestore . Decoder = . init ()) async throws -> T
-      func setData < T : Encodable > ( from value : T , encoder : Firestore . Encoder = Firestore . Encoder (), completion : (( Error ?) -> Void )? = nil ) throws
-      func setData < T : Encodable > ( from value : T , merge : Bool , encoder : Firestore . Encoder = Firestore . Encoder (), completion : (( Error ?) -> Void )? = nil ) throws
-      func setData < T : Encodable > ( from value : T , mergeFields : [ Any ], encoder : Firestore . Encoder = Firestore . Encoder (), completion : (( Error ?) -> Void )? = nil ) throws
-    public extension DocumentSnapshot
-      func data < T : Decodable > ( as type : T . Type , with serverTimestampBehavior : ServerTimestampBehavior = . none , decoder : Firestore . Decoder = . init ()) throws -> T
-    extension FieldValue : Encodable
-      public func encode ( to encoder : Encoder ) throws
-      public extension FirebaseDataDecoder . DateDecodingStrategy
-      static var timestamp : FirebaseDataDecoder . DateDecodingStrategy { get }
-      public extension FirebaseDataEncoder . DateEncodingStrategy
-      static var timestamp : FirebaseDataEncoder . DateEncodingStrategy { get }
-    public extension Firestore
-      func loadBundle ( _ bundleStream : InputStream ) async throws -> LoadBundleTaskProgress
-      func runTransaction ( _ updateBlock : @escaping ( Transaction , NSErrorPointer ) -> Any ?) async throws -> Any ?
-      class Encoder
-      class Decoder
-      public var dateEncodingStrategy : FirebaseDataEncoder . DateEncodingStrategy
-      public var dataEncodingStrategy : FirebaseDataEncoder . DataEncodingStrategy
-      public var nonConformingFloatEncodingStrategy : FirebaseDataEncoder . NonConformingFloatEncodingStrategy
-      public var keyEncodingStrategy : FirebaseDataEncoder . KeyEncodingStrategy
-      public var userInfo : [ CodingUserInfoKey : Any ]
-      public func encode < T > ( _ value : T ) throws -> [ String : Any ] where T : Encodable
-      public init ()
-      public var dateDecodingStrategy : FirebaseDataDecoder . DateDecodingStrategy
-      public var dataDecodingStrategy : FirebaseDataDecoder . DataDecodingStrategy
-      public var nonConformingFloatDecodingStrategy : FirebaseDataDecoder . NonConformingFloatDecodingStrategy
-      public var keyDecodingStrategy : FirebaseDataDecoder . KeyDecodingStrategy
-      public var userInfo : [ CodingUserInfoKey : Any ]
-      public func decode < T > ( _ t : T . Type , from data : Any ) throws -> T where T : Decodable
-      public func decode < T : Decodable > ( _ t : T . Type , from data : Any , in reference : DocumentReference ?) throws -> T
-      public init ()
-    extension String : DocumentIDWrappable
-      public static func wrap ( _ documentReference : DocumentReference ) throws -> String
-    extension Timestamp : ServerTimestampWrappable
-      public static func wrap ( _ timestamp : Timestamp ) throws -> Self
-      public static func unwrap ( _ value : Timestamp ) throws -> Timestamp
-    public extension Transaction
-      @discardableResult func setData < T : Encodable > ( from value : T , forDocument doc : DocumentReference , encoder : Firestore . Encoder = Firestore . Encoder ()) throws -> Transaction
-      @discardableResult func setData < T : Encodable > ( from value : T , forDocument doc : DocumentReference , merge : Bool , encoder : Firestore . Encoder = Firestore . Encoder ()) throws -> Transaction
-      @discardableResult func setData < T : Encodable > ( from value : T , forDocument doc : DocumentReference , mergeFields : [ Any ], encoder : Firestore . Encoder = Firestore . Encoder ()) throws -> Transaction
-    public extension WriteBatch
-      @discardableResult func setData < T : Encodable > ( from value : T , forDocument doc : DocumentReference , encoder : Firestore . Encoder = Firestore . Encoder ()) throws -> WriteBatch
-      @discardableResult func setData < T : Encodable > ( from value : T , forDocument doc : DocumentReference , merge : Bool , encoder : Firestore . Encoder = Firestore . Encoder ()) throws -> WriteBatch
-      @discardableResult func setData < T : Encodable > ( from value : T , forDocument doc : DocumentReference , mergeFields : [ Any ], encoder : Firestore . Encoder = Firestore . Encoder ()) throws -> WriteBatch

[REMOVED] Protocols

Swift:
-    public protocol DocumentIDWrappable
-      static func wrap ( _ documentReference : DocumentReference ) throws -> Self
-    public protocol ServerTimestampWrappable
-      static func wrap ( _ timestamp : Timestamp ) throws -> Self
-      static func unwrap ( _ value : Self ) throws -> Timestamp

[REMOVED] Enumerations

Swift:
-    public enum DecodingFailureStrategy
-      case ignore
-      case raise
-    public enum FirestoreDecodingError : Error
-      case decodingIsNotSupported ( String )
-      case fieldNameConflict ( String )
-    public enum FirestoreEncodingError : Error
-      case encodingIsNotSupported ( String )
-    public enum QueryPredicate
-      case isEqualTo ( _ : String , _ : Any )
-      case isIn ( _ : String , _ : [ Any ])
-      case isNotIn ( _ : String , _ : [ Any ])
-      case arrayContains ( _ : String , _ : Any )
-      case arrayContainsAny ( _ : String , _ : [ Any ])
-      case isLessThan ( _ : String , _ : Any )
-      case isGreaterThan ( _ : String , _ : Any )
-      case isLessThanOrEqualTo ( _ : String , _ : Any )
-      case isGreaterThanOrEqualTo ( _ : String , _ : Any )
-      case orderBy ( _ : String , _ : Bool )
-      case limitTo ( _ : Int )
-      case limitToLast ( _ : Int )
-      public static func whereField ( _ field : String , isEqualTo value : Any ) -> QueryPredicate
-      public static func whereField ( _ field : String , isIn values : [ Any ]) -> QueryPredicate
-      public static func whereField ( _ field : String , isNotIn values : [ Any ]) -> QueryPredicate
-      public static func whereField ( _ field : String , arrayContains value : Any ) -> QueryPredicate
-      public static func whereField ( _ field : String , arrayContainsAny values : [ Any ]) -> QueryPredicate
-      public static func whereField ( _ field : String , isLessThan value : Any ) -> QueryPredicate
-      public static func whereField ( _ field : String , isGreaterThan value : Any ) -> QueryPredicate
-      public static func whereField ( _ field : String , isLessThanOrEqualTo value : Any ) -> QueryPredicate
-      public static func whereField ( _ field : String , isGreaterThanOrEqualTo value : Any ) -> QueryPredicate
-      public static func order ( by field : String , descending value : Bool = false ) -> QueryPredicate
-      public static func limit ( to value : Int ) -> QueryPredicate
-      public static func limit ( toLast value : Int ) -> QueryPredicate
-      public static func ` where ` ( _ name : String , isEqualTo value : Any ) -> QueryPredicate
-      public static func ` where ` ( _ name : String , isIn values : [ Any ]) -> QueryPredicate
-      public static func ` where ` ( _ name : String , isNotIn values : [ Any ]) -> QueryPredicate
-      public static func ` where ` ( field name : String , arrayContains value : Any ) -> QueryPredicate
-      public static func ` where ` ( _ name : String , arrayContainsAny values : [ Any ]) -> QueryPredicate
-      public static func ` where ` ( _ name : String , isLessThan value : Any ) -> QueryPredicate
-      public static func ` where ` ( _ name : String , isGreaterThan value : Any ) -> QueryPredicate
-      public static func ` where ` ( _ name : String , isLessThanOrEqualTo value : Any ) -> QueryPredicate
-      public static func ` where ` ( _ name : String , isGreaterThanOrEqualTo value : Any ) -> QueryPredicate

[REMOVED] Structures

Swift:
-    @propertyWrapper public struct DocumentID < Value : DocumentIDWrappable & Codable > : StructureCodingUncodedUnkeyed extension DocumentID : Codable extension DocumentID : Equatable where Value : Equatable extension DocumentID : Hashable where Value : Hashable
-      public init ( wrappedValue value : Value ?)
-      public var wrappedValue : Value ? { get set }
-      public init ( from decoder : Decoder ) throws
-      public func encode ( to encoder : Encoder ) throws
-    @propertyWrapper public struct ExplicitNull < Value > extension ExplicitNull : Equatable where Value : Equatable extension ExplicitNull : Hashable where Value : Hashable extension ExplicitNull : Encodable where Value : Encodable extension ExplicitNull : Decodable where Value : Decodable
-      public init ( wrappedValue value : Value ?)
-      public var wrappedValue : Value ? { get set }
-      public func encode ( to encoder : Encoder ) throws
-      public init ( from decoder : Decoder ) throws
-    @available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *) @propertyWrapper public struct FirestoreQuery < T > : DynamicProperty
-      public struct Configuration
-      public var wrappedValue : T { get }
-      public var projectedValue : Configuration { get nonmutating set }
-      public init < U : Decodable > ( collectionPath : String , predicates : [ QueryPredicate ] = [], decodingFailureStrategy : DecodingFailureStrategy = . raise , animation : Animation ? = nil ) where T == Result < [ U ], Error >
-      public var path : String
-      public var predicates : [ QueryPredicate ]
-      public var decodingFailureStrategy : DecodingFailureStrategy
-      public var error : Error ?
-      public var animation : Animation ?
-    @propertyWrapper public struct ServerTimestamp < Value > : Codable where Value : ServerTimestampWrappable & Codable extension ServerTimestamp : Equatable where Value : Equatable extension ServerTimestamp : Hashable where Value : Hashable
-      public init ( wrappedValue value : Value ?)
-      public var wrappedValue : Value ? { get set }
-      public init ( from decoder : Decoder ) throws
-      public func encode ( to encoder : Encoder ) throws

google-oss-bot · 2023-09-14T05:47:27Z

Coverage Report ¹

Affected Products

`FirebaseFirestore-iOS-FirebaseFirestore.framework`

Overall coverage changed from 88.09% (1e0f294) to 86.48% (8a27818) by -1.61%.

26 individual files with coverage change

Filename	Base (`1e0f294`)	Merge (`8a27818`)	Diff
CodablePassThroughTypes.swift	?	100.00%	?
CollectionReference+AsyncAwait.swift	?	96.88%	?
CollectionReference+WriteEncodable.swift	?	100.00%	?
DocumentID.swift	?	86.44%	?
DocumentReference+Codable.swift	?	50.00%	?
DocumentReference+ReadDecodable.swift	?	0.00%	?
DocumentReference+WriteEncodable.swift	?	100.00%	?
DocumentSnapshot+ReadDecodable.swift	?	80.00%	?
EncoderDecoder.swift	?	100.00%	?
exception.cc	23.68%	84.21%	+60.53%
ExplicitNull.swift	?	90.48%	?
FieldValue+Encodable.swift	?	100.00%	?
Firestore+AsyncAwait.swift	?	97.75%	?
FirestoreQuery.swift	?	0.00%	?
FirestoreQueryObservable.swift	?	0.00%	?
GeoPoint+Codable.swift	?	100.00%	?
leveldb_key.cc	98.82%	98.14%	-0.69%
QueryPredicate.swift	?	0.00%	?
ServerTimestamp.swift	?	96.97%	?
task.cc	93.91%	94.78%	+0.87%
Timestamp+Codable.swift	?	100.00%	?
TimestampDecodingStrategy.swift	?	100.00%	?
TimestampEncodingStrategy.swift	?	100.00%	?
Transaction+WriteEncodable.swift	?	100.00%	?
WriteBatch+WriteEncodable.swift	?	100.00%	?
write_stream.cc	94.37%	91.55%	-2.82%

FirebaseFirestore-iOS-FirebaseFirestoreSwift.framework
Overall coverage changed from 40.79% (1e0f294) to 0.00% (8a27818) by -40.79%.

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/iiLNvPasCO.html

ncooke3 · 2023-09-15T11:56:56Z

fa1f3b9 fixed the qs zip failure with the undefined c++ symbols

ncooke3 · 2023-09-15T17:49:16Z

c33db0d should fix the remaining firestore/spm failure.

…3.3.1

Package.swift

This reverts commit a7e3720.

#11939)

google-oss-bot added api: firestore release-tooling labels Sep 14, 2023

github-actions bot added the public-api-change label Sep 14, 2023

This comment was marked as outdated.

Sign in to view

github-actions bot added public-api-change and removed public-api-change labels Sep 14, 2023

This comment was marked as outdated.

Sign in to view

github-actions bot added public-api-change and removed public-api-change labels Sep 14, 2023

github-actions bot added public-api-change and removed public-api-change labels Sep 15, 2023

ncooke3 mentioned this pull request Sep 15, 2023

[Infra] Break up env-dependent GHA steps into separate job to reduce artifact collisions #11814

Merged

github-actions bot added the public-api-change label Sep 15, 2023

ncooke3 force-pushed the firestore-swift-merged branch from 1a802e4 to 8ae1d3b Compare September 16, 2023 13:54

github-actions bot added public-api-change and removed public-api-change labels Sep 16, 2023

ncooke3 closed this Sep 16, 2023

ncooke3 reopened this Sep 16, 2023

ncooke3 and others added 13 commits October 12, 2023 13:30

Attempt to fix zip CI

c58c372

Build 'FirebaseSharedSwift.xcframework' with Xcode 14.1 rather than 1…

4cec184

…3.3.1

Add fixed zip to SPM target

3918947

Reduce CI running

f3d2fff

Disable xcpretty

a54862d

Break up steps into separate jobs to reduce build artifact collisions

0665248

Revert build.sh changes

863b4c3

Break up SPM cron steps into jobs

e411261

Revert CI changes made to narrow down problem

67bf7de

Fix spacing

81792a7

Update deprecation/documentation messages

e55ea30

Use abseil that 'master' is using

2488dfc

Update dependency version in podspec

b0be43c

ncooke3 force-pushed the firestore-swift-merged branch from b994dc5 to b0be43c Compare October 12, 2023 17:30

github-actions bot added public-api-change and removed public-api-change labels Oct 12, 2023

ncooke3 requested review from andrewheard and paulb777 October 12, 2023 18:13

andrewheard approved these changes Oct 12, 2023

View reviewed changes

paulb777 approved these changes Oct 12, 2023

View reviewed changes

paulb777 reviewed Oct 12, 2023

View reviewed changes

Package.swift Show resolved Hide resolved

ncooke3 enabled auto-merge (squash) October 13, 2023 18:52

ncooke3 merged commit a7e3720 into master Oct 13, 2023
61 checks passed

ncooke3 deleted the firestore-swift-merged branch October 13, 2023 18:52

ncooke3 added a commit that referenced this pull request Oct 13, 2023

Revert "[Firestore] Consolidate Firestore and FirestoreSwift (#11806)"

0b75f84

This reverts commit a7e3720.

ncooke3 added a commit that referenced this pull request Oct 13, 2023

Revert "[Firestore] Consolidate Firestore and FirestoreSwift (#11806)" (

0c8d143

#11939)

ncooke3 restored the firestore-swift-merged branch October 13, 2023 22:47

ncooke3 added a commit that referenced this pull request Oct 17, 2023

[Firestore] Consolidate Firestore and FirestoreSwift (#11806)

10db487

ncooke3 added a commit that referenced this pull request Oct 17, 2023

[Firestore] Consolidate Firestore and FirestoreSwift (#11806)

08b5cf0

firebase locked and limited conversation to collaborators Nov 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Firestore] Consolidate Firestore and FirestoreSwift #11806

[Firestore] Consolidate Firestore and FirestoreSwift #11806

ncooke3 commented Sep 14, 2023 •

edited

Loading

github-actions bot commented Sep 14, 2023 •

edited

Loading

This comment was marked as outdated.

google-oss-bot commented Sep 14, 2023 •

edited

Loading

`FirebaseFirestore-iOS-FirebaseFirestore.framework`

`FirebaseFirestore-iOS-FirebaseFirestoreSwift.framework`

This comment was marked as outdated.

This comment was marked as outdated.

ncooke3 commented Sep 15, 2023

ncooke3 commented Sep 15, 2023

[Firestore] Consolidate Firestore and FirestoreSwift #11806

[Firestore] Consolidate Firestore and FirestoreSwift #11806

Conversation

ncooke3 commented Sep 14, 2023 • edited Loading

github-actions bot commented Sep 14, 2023 • edited Loading

Apple API Diff Report

FirebaseFirestoreSwift

This comment was marked as outdated.

google-oss-bot commented Sep 14, 2023 • edited Loading

Coverage Report 1

Affected Products

FirebaseFirestore-iOS-FirebaseFirestore.framework

FirebaseFirestore-iOS-FirebaseFirestoreSwift.framework

Test Logs

This comment was marked as outdated.

This comment was marked as outdated.

ncooke3 commented Sep 15, 2023

ncooke3 commented Sep 15, 2023

ncooke3 commented Sep 14, 2023 •

edited

Loading

github-actions bot commented Sep 14, 2023 •

edited

Loading

google-oss-bot commented Sep 14, 2023 •

edited

Loading

Coverage Report ¹

`FirebaseFirestore-iOS-FirebaseFirestore.framework`

`FirebaseFirestore-iOS-FirebaseFirestoreSwift.framework`