Parse Document Fields & Create Minimally Viable Codable Implementation #26
Conversation
| @@ -79,6 +83,8 @@ let SwiftFirebase = | |||
| "-Lthird_party/firebase-development/usr/libs/windows", | |||
| "-Lthird_party/firebase-development/usr/libs/windows/deps/app", | |||
| "-Lthird_party/firebase-development/usr/libs/windows/deps/app/external", | |||
| "-Xlinker", | |||
| "-ignore:4217" | |||
There was a problem hiding this comment.
Was mostly getting annoyed seeing these in the build logs. I see we ignore them on other builds so I felt it was safe to do it here.
| public typealias ServerTimestampBehavior = firebase.firestore.DocumentSnapshot.ServerTimestampBehavior | ||
| public typealias MapFieldValue = firebase.firestore.MapFieldValue | ||
|
|
||
| public typealias GeoPoint = firebase.firestore.GeoPoint | ||
| public typealias FieldValue = firebase.firestore.FieldValue |
There was a problem hiding this comment.
These all had to become public types due to the surface area of the new set of codable APIs we've added.
| return nil | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Oops need to fix the missing newlines
|
|
||
| public enum FirestoreEncodingError: Error { | ||
| case encodingIsNotSupported(String) | ||
| } |
| t is FieldValue || | ||
| t is DocumentReference | ||
| } | ||
| } |
There was a problem hiding this comment.
Needs missing newline
|
|
||
| extension DocumentID: Equatable where Value: Equatable {} | ||
|
|
||
| extension DocumentID: Hashable where Value: Hashable {} |
There was a problem hiding this comment.
needs missing newline
| let debugDescription = "Unable to encode \(valueDescription) directly in JSON. Use JSONEncoder.NonConformingFloatEncodingStrategy.convertToString to specify how the value should be encoded." | ||
| return .invalidValue(value, EncodingError.Context(codingPath: codingPath, debugDescription: debugDescription)) | ||
| } | ||
| } |
There was a problem hiding this comment.
Needs missing newline
| func dataValue() -> Data | ||
| func arrayValue() -> [AnyHashable]? | ||
| func dictionaryValue() -> [String: AnyHashable]? | ||
| } |
There was a problem hiding this comment.
needs missing newline
| struct MapFieldValue_Workaround { | ||
| std::vector<std::string> keys; | ||
| std::vector<::firebase::firestore::FieldValue> values; | ||
| }; |
There was a problem hiding this comment.
This type and the resulting _workaround apis are here because it seems that CxxDictionary conformance doesn't work well in Swift for Windows yet. I have a sample repo that shows the problem and need to file an issue on the Swift repo https://github.com/brianmichel/swift-cpp-interop-map-compatibility.
These are kind of ugly, but the MapFieldValue_Workaround type just breaks out the keys/values of a regular map into accessible vectors.
In order to effectively use the documents that come back from Firebase, we need to ensure that w can read the values out of the document and map them to Swift types as needed, but also need to make sure that we have a way to easily map the Firebase document into a Codable struct.
This was a little challenging as there is a seemingly reusable Firebase document parser in the
FirebaseSharedSwifttarget within the Firebase iOS SDK package. However, due to an issue with SPM we can't easily access those file due to the way that binary targets are handled when adding a dependency (even if you aren't using any targets that requires those binary objects). Additionally, the Firebase team does not seem to want to entertain the work to break this target into it's own repo/package firebase/firebase-ios-sdk#12062.The most straightforward solution seemed to be to copy the files we need into the project and annotate where things get copied in. I'd love a more stable way to do this (if folks have idea how to do this with CMake in a way that would be durable for folks cloning this package down I'm all ears!)
How To Test
data(as ...)api to try to map the document to the struct.Open Questions
swift-firebase?