Code reorg to move all public headers under src/api

[wu-hui]

This PR re-organize the code structure to better support Firestore's Swift/Cpp interop.

For SPM we will have 3 targets:

• FirebaseFirestoreCpp is the core Cpp SDK implementation.
• FirebaseFirestoreObjCpp is the ObjectiveC API layer providing most of Firestore's APIs today. It depends on FirebaseFirestoreCpp.
• FirebaseFirestore is the user facing target that depends on above two, and adds swift APIs on top of them. It currently provides Async/Await and codable support on top of ObjCpp, and in the future it will provide new APIs by utilizing FirebaseFirestoreCpp directly, skipping ObjCpp.

For cocoapods the structure stays unchanged, we will continue to two targets:

• FirebaseFirestoreInternal is the combination of FirebaseFirestoreCpp and FirebaseFirestoreObjCpp above.
• FirebaseFirestore is the user facing target on top of FirebaseFirestoreInternal.

This PR also eliminates interfaceForSwift folder for Cpp code exposed to Swift, and use existing src/api instead. There is also changes to allow using absolute path (from SDK repo root) as opposed to relative path.

cocoapods integration tests failures:

AggregationIntegrationTests.testThrowsAnErrorWhenGettingTheResultOfAnUnrequestedAggregation()
AsyncAwaitIntegrationTests.testAutoIndexCreationAfterFailsTermination()
PipelineTests.testCreatePipeline()

[google-oss-bot]

	1 Warning
⚠️	Did you forget to add a changelog entry? (Add #no-changelog to the PR description to silence this warning.)

Generated by 🚫 Danger

[github-actions]

Apple API Diff Report

Commit: 0cfe3e5
Last updated: Fri Jan 31 13:24 PST 2025
View workflow logs & download artifacts

---

[BUILD ERROR] FirebaseFirestore

---

[BUILD ERROR] FirebaseFirestoreInternal

---

[paulb777]

CI is showing multiple build failures. Are you stuck on solving those?

The general direction looks fine - although I need to think harder about the new SPM structure - and that might be fresher for @ncooke3.

It might be easier to get CocoaPods working first and then address SPM.

[paulb777]

Why is this needed when interfaceForSwift did not need to be here before?

[wu-hui]

I am not sure exactly why, I suspect it is because headers under interfaceForSwift were using relative paths before. After the move, they are using absolute paths from SRCROOT. But we need the second search path here because the umbrella header still include FirebaseFirestoreCpp.h without absolute path.

[wu-hui]

CI is showing multiple build failures. Are you stuck on solving those?

I am not stuck, but it will take some time to resolve all of them. I intend to merge to cheryl's branch first, just so she can start using the new structure, while i fix the rest of failures.

The general direction looks fine - although I need to think harder about the new SPM structure - and that might be fresher for @ncooke3.

It might be easier to get CocoaPods working first and then address SPM.

FWIW, cocoapods build is "working", in that it builds fine. There are 3 test failures i listed in the PR description. They might have something to do with the actual changes Cheryl is doing.

[cherylEnkidu]

One of the main reasons for restructuring the iOS SDK is to enable Swift source files to access all C++ APIs. Are there any technical limitations or restrictions in moving the existing API headers, like document reference header, into this file?

[cherylEnkidu]

Could you please add a todo here to remind me to change the binary building process?