Add Wrapper around binary target to ensure it gets built before other targets (#4)

* Version 0.0.3

Author: skhamis

MozillaRustComponentsWrapper/dummy.m

@@ -0,0 +1,6 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+// Swift Package Manager needs at least one source file.

MozillaRustComponentsWrapper/include/dummy.h

@@ -0,0 +1,7 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+// Swift Package Manager needs at least one header to prevent a warning. See
+// https://github.com/mozilla/application-services/issues/4422.

Package.swift

@@ -21,53 +21,65 @@ let package = Package(
         //.package(name: "SwiftKeychainWrapper", url: "https://github.com/jrendel/SwiftKeychainWrapper", from: "4.0.1")
     ],
     targets: [
+        /*
+        * A placeholder wrapper for our binaryTarget so that Xcode will ensure this is
+        * downloaded/built before trying to use it in the build process
+        * A bit hacky but necessary for now https://github.com/mozilla/application-services/issues/4422
+        */
+        .target(
+            name: "MozillaRustComponentsWrapper",
+            dependencies: [
+                .target(name: "MozillaRustComponents", condition: .when(platforms: [.iOS]))
+            ],
+            path: "MozillaRustComponentsWrapper"
+        ),
+        .binaryTarget(
+            name: "MozillaRustComponents",
+            //
+            // For release artifacts, reference the MozillaRustComponents as a URL with checksum.
+            //
+            url: "https://112912-129966583-gh.circle-artifacts.com/0/dist/MozillaRustComponents.xcframework.zip",
+            checksum: "a67cfdab5e9a52eeb93435b20a4fc2813fe0486113c6eab5d7fa77fcbcb4fa07"
+            //
+            // For local testing, you can point at an (unzipped) XCFramework that's part of the repo.
+            // Note that you have to actually check it in and make a tag for it to work correctly.
+            //
+            //path: "./MozillaRustComponents.xcframework"
+        ),
         .target(
             name: "Sync15",
             path: "external/application-services/components/sync15/ios"
         ),
         .target(
             name: "RustLog",
-            dependencies: ["MozillaRustComponents"],
+            dependencies: ["MozillaRustComponentsWrapper"],
             path: "external/application-services/components/rc_log/ios"
         ),
         .target(
             name: "Viaduct",
-            dependencies: ["MozillaRustComponents"],
+            dependencies: ["MozillaRustComponentsWrapper"],
             path: "external/application-services/components/viaduct/ios"
         ),
         .target(
             name: "Nimbus",
-            dependencies: ["MozillaRustComponents", "Glean"],
+            dependencies: ["MozillaRustComponentsWrapper", "Glean"],
             path: "generated/nimbus"
         ),
         .target(
             name: "CrashTest",
-            dependencies: ["MozillaRustComponents"],
+            dependencies: ["MozillaRustComponentsWrapper"],
             path: "generated/crashtest"
-        ),
+        )
         // TODO: other components will go here over time.
         //.target(
         //    name: "Logins",
-        //    dependencies: ["MozillaRustComponents", "Sync15"],
+        //    dependencies: ["MozillaRustComponentsWrapper", "Sync15"],
         //    path: "external/application-services/components/logins/ios"
         //),
         //.target(
         //    name: "FxAClient",
-        //    dependencies: ["MozillaRustComponents", "SwiftKeychainWrapper"],
+        //    dependencies: ["MozillaRustComponentsWrapper", "SwiftKeychainWrapper"],
         //    path: "external/application-services/components/fxa-client/ios"
         //),
-        .binaryTarget(
-            name: "MozillaRustComponents",
-            //
-            // For release artifacts, reference the MozillaRustComponents as a URL with checksum.
-            //
-            url: "https://112912-129966583-gh.circle-artifacts.com/0/dist/MozillaRustComponents.xcframework.zip",
-            checksum: "a67cfdab5e9a52eeb93435b20a4fc2813fe0486113c6eab5d7fa77fcbcb4fa07"
-            //
-            // For local testing, you can point at an (unzipped) XCFramework that's part of the repo.
-            // Note that you have to actually check it in and make a tag for it to work correctly.
-            //
-            //path: "./MozillaRustComponents.xcframework"
-        )
     ]
 )

README.md

@@ -36,7 +36,7 @@ Key points:
 * The `Package.swift` file references `MozillaRustComponents.xcframework.zip` as a Swift binary target.
 * The `Package.swift` file defines an individual module for the Swift wrapper code of each component.
     * Each module references its Swift source code directly as files in the repo.
-    * Each module depends on `MozillaRustComponents` to provide the pre-compiled Rust code.
+    * Each module depends on `MozillaRustComponentsWrapper` which wraps `MozillaRustComponents` to provide the pre-compiled Rust code.
 
 ## Cutting a new release
 
@@ -62,7 +62,7 @@ To add a new component to be distributed via this repo, you'll need to:
 * Edit `./Package.swift` to add the new component.
     * Add a new library product for the component under "products".
     * Add a corresponding target for the component under "targets".
-        * Make sure it depends on "MozillaRustComponents" to pull in the pre-compiled Rust code,
+        * Make sure it depends on "MozillaRustComponentsWrapper" to pull in the pre-compiled Rust code,
           as well as on any third-party Swift packages that it may require.
 * Follow the instructions below to test it out locally.