Skip to content

Firestore and Swift Package Manager #6072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Aug 1, 2020
Merged

Firestore and Swift Package Manager #6072

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9e92df4
initial spm firestore
paulb777 Jul 17, 2020
52bfdb5
Update gRPC dep to resolve build time issue
paulb777 Jul 20, 2020
6fa8b44
Package.swift fixes
paulb777 Jul 23, 2020
f9616d8
post rebase update
paulb777 Jul 23, 2020
27ccd85
workaround nanopb imports to successfully build
paulb777 Jul 23, 2020
5219317
another post rebase fix
paulb777 Jul 23, 2020
8d6af14
swift test passes on iOS and macOS
paulb777 Jul 24, 2020
156e354
Build FirebaseFirestoreSwift
paulb777 Jul 24, 2020
f744881
Publish GoogleUtilities_UserDefaults for FirebaseUI
paulb777 Jul 29, 2020
78c9878
Revert "workaround nanopb imports to successfully build"
paulb777 Jul 29, 2020
0979f33
style
paulb777 Jul 30, 2020
48e5c0f
sort excludes and remove Protos/objc
paulb777 Jul 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 112 additions & 8 deletions Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ let package = Package(
name: "Firebase",
platforms: [.iOS(.v9), .macOS(.v10_11), .tvOS(.v10)],
products: [
// Products define the executables and libraries produced by a package, and make them visible to
// other packages.
.library(
name: "Firebase",
targets: ["Firebase"]
Expand All @@ -47,6 +45,14 @@ let package = Package(
name: "FirebaseDatabase",
targets: ["FirebaseDatabase"]
),
.library(
name: "FirebaseFirestore",
targets: ["FirebaseFirestore"]
),
.library(
name: "FirebaseFirestoreSwift",
targets: ["FirebaseFirestoreSwift"]
),
.library(
name: "FirebaseFunctions",
targets: ["FirebaseFunctions"]
Expand All @@ -71,6 +77,12 @@ let package = Package(
name: "FirebaseStorageSwift",
targets: ["FirebaseStorageSwift"]
),

// Not intended for public consumption, but needed for FirebaseUI.
.library(
name: "GoogleUtilities_UserDefaults",
targets: ["GoogleUtilities_UserDefaults"]
),
],
dependencies: [
.package(name: "Promises", url: "https://github.com/google/promises.git", "1.2.8" ..< "1.3.0"),
Expand All @@ -84,14 +96,18 @@ let package = Package(
url: "https://github.com/paulb777/nanopb.git",
.revision("82230e9998a35a3d2144884204db64f045c880c4")
),
.package(
name: "abseil",
url: "https://github.com/paulb777/abseil-cpp.git",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the purposes of internal experimentation this seems reasonable, but I don't think we should publish this to end users until we've settled how we're going to actually make these dependencies work. The outcome I don't want is that we end up stuck maintaining these ourselves because we've conditioned enough users to use Firestore via SPM that we can't call the experiment a failure.

Copy link

@nidegen nidegen Aug 1, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Side note: I wouldn't be surprised to see SPM establish itself as a C++ dependecy manager, even if it currently lacks features vs CMake. Looking forward to see how Windows support in 5.3 will push that. I also would love to see Android NDK support Swift/SPM..

.revision("7790dc1")
),
.package(name: "gRPC", url: "https://github.com/paulb777/grpc.git", .revision("37a9e06cd8")),
.package(name: "OCMock", url: "https://github.com/paulb777/ocmock.git", .revision("7291762")),
.package(name: "leveldb", url: "https://github.com/paulb777/leveldb.git", .revision("3f04697")),
// Branches need a force update with a run with the revision set like below.
// .package(url: "https://github.com/paulb777/nanopb.git", .revision("564392bd87bd093c308a3aaed3997466efb95f74"))
],
targets: [
// Targets are the basic building blocks of a package. A target can define a module or a test suite.
// Targets can depend on other targets in this package, and on products in packages which this package depends on.
.testTarget(
name: "firebase-test",
dependencies: [
Expand All @@ -102,6 +118,8 @@ let package = Package(
"FirebaseCrashlytics",
"FirebaseCore",
"FirebaseDatabase",
"FirebaseFirestore",
"FirebaseFirestoreSwift",
"FirebaseInstallations",
// "FirebaseInstanceID",
"FirebaseRemoteConfig",
Expand All @@ -117,7 +135,7 @@ let package = Package(
"GoogleUtilities_NSData",
"GoogleUtilities_Reachability",
"GoogleUtilities_UserDefaults",
"nanopb",
.product(name: "nanopb", package: "nanopb"),
]
),
.target(
Expand Down Expand Up @@ -323,9 +341,9 @@ let package = Package(
),
.target(
name: "FirebaseCrashlytics",
dependencies: ["FirebaseCore", "FirebaseInstallations",
dependencies: ["FirebaseCore", "FirebaseInstallations", "GoogleDataTransport",
.product(name: "FBLPromises", package: "Promises"),
"GoogleDataTransport", "nanopb"],
.product(name: "nanopb", package: "nanopb")],
path: "Crashlytics",
exclude: [
"run",
Expand Down Expand Up @@ -390,6 +408,90 @@ let package = Package(
]
),

.target(
name: "FirebaseFirestore",
dependencies: [
"FirebaseCore",
"leveldb",
.product(name: "nanopb", package: "nanopb"),
.product(name: "abseil", package: "abseil"),
.product(name: "gRPC-cpp", package: "gRPC"),
],
path: "Firestore",
exclude: [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are all these entries necessary? Shouldn't this only consist of things that would otherwise match the sources list?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's everything under Firestore that is not in sources. A better directory structure for SPM would be putting all sources in one directory. I've sorted the list now.

"CHANGELOG.md",
"CMakeLists.txt",
"Example/",
"Protos/CMakeLists.txt",
"Protos/Podfile",
"Protos/README.md",
"Protos/build_protos.py",
"Protos/cpp/",
"Protos/lib/",
"Protos/nanopb_cpp_generator.py",
"Protos/protos/",
"README.md",
"Source/CMakeLists.txt",
"Swift/",
"core/CMakeLists.txt",
"core/src/util/config_detected.h.in",
"core/test/",
"fuzzing/",
"test.sh",
"third_party/",

// Exclude alternate implementations for other platforms
"core/src/api/input_validation_std.cc",
"core/src/remote/connectivity_monitor_noop.cc",
"core/src/util/filesystem_win.cc",
"core/src/util/hard_assert_stdio.cc",
"core/src/util/log_stdio.cc",
"core/src/util/secure_random_openssl.cc",
],
sources: [
"Source/",
"Protos/nanopb/",
"core/include/",
"core/src",
],
publicHeadersPath: "Source/Public",
cSettings: [
.headerSearchPath("../"),
.headerSearchPath("Source/Public"),
.headerSearchPath("Protos/nanopb"),

.define("PB_FIELD_32BIT", to: "1"),
.define("PB_NO_PACKED_STRUCTS", to: "1"),
.define("PB_ENABLE_MALLOC", to: "1"),
.define("FIRFirestore_VERSION", to: "0.0.1"), // TODO: Fix version
]
),
.target(
name: "FirebaseFirestoreSwift",
dependencies: ["FirebaseFirestore"],
path: "Firestore",
exclude: [
"CHANGELOG.md",
"CMakeLists.txt",
"Example/",
"Protos/",
"README.md",
"Source/",
"core/",
"fuzzing/",
"test.sh",
"Swift/CHANGELOG.md",
"Swift/README.md",
"Swift/Tests/",
"third_party/FirestoreEncoder/LICENSE",
"third_party/FirestoreEncoder/METADATA",
],
sources: [
"Swift/Source/",
"third_party/FirestoreEncoder/",
]
),

.target(
name: "FirebaseFunctions",
dependencies: [
Expand Down Expand Up @@ -497,7 +599,9 @@ let package = Package(
),
.target(
name: "GoogleDataTransport",
dependencies: ["nanopb"],
dependencies: [
.product(name: "nanopb", package: "nanopb"),
],
path: "GoogleDataTransport",
exclude: [
"CHANGELOG.md",
Expand Down
2 changes: 2 additions & 0 deletions Tests/firebase-test/main.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ import FirebaseCore
import FirebaseAuth
import FirebaseABTesting
import FirebaseCrashlytics
import FirebaseFirestore
import FirebaseFirestoreSwift
import FirebaseFunctions
import FirebaseInstallations
// import FirebaseInstanceID
Expand Down