review nits and fixes

Author: skhamis

.gitignore

@@ -10,6 +10,7 @@ logins.jwk
 *~
 .vscode/
 credentials.json
+.venv
 
 # Android stuff.
 *.iml
@@ -34,17 +35,16 @@ components/**/ios/Generated
 # We don't car about Cargo.lock for our tests.
 testing/sync-test/Cargo.lock
 
-# XCFramework artifact
+# iOS Building & XCFramework artifacts
 megazords/ios-rust/MozillaRustComponents.xcframework*
 megazords/ios-rust/focus/FocusRustComponents.xcframework*
 megazords/ios-rust/include*
 megazords/ios-rust/.build*
 megazords/ios-rust/sources/MozillaRustComponentsWrapper/generated*
-
+megazords/ios-rust/.swiftpm
 
 # Glean generated artifacts
-megazords/ios-rust/MozillaTestServices/MozillaTestServices/Generated
-megazords/ios-rust/MozillaTestServices/.venv
+megazords/ios-rust/.venv
 
 # Carthage generated artifacts
 # We no longer use Carthage, but those

automation/run_ios_tests.sh

@@ -37,7 +37,7 @@ if [ "$SKIP_BUILDING" != true ]; then
     "${SOURCE_ROOT}"/components/sync_manager/pings.yaml
 
   # Build the XCFramework
-  ./megazords/ios-rust/build-xcframework.sh --build-profile release
+  ./megazords/ios-rust/build-xcframework.sh --generate-swift-sources --build-profile release
 else
   echo "Skipping xcframework & glean metrics generation as --test-only was passed."
 fi
@@ -52,7 +52,7 @@ set -o pipefail
 xcodebuild \
   -scheme MozillaRustComponents \
   -sdk iphonesimulator \
-  -destination 'platform=iOS Simulator,name=iPhone 15' \
+  -destination 'platform=iOS Simulator,OS=17.2,name=iPhone 15' \
   test | tee raw_xcodetest.log | xcpretty
 result=${PIPESTATUS[0]}
 set -e
@@ -67,5 +67,4 @@ else
   echo "❌ Swift tests failed!"
 fi
 
-
-exit "${result}"
+exit "${result}"

libs/verify-ios-environment.sh

@@ -25,4 +25,4 @@ echo "    ./automation/run_ios_tests.sh"
 echo ""
 echo " If you want to just generate the rust binaries"
 echo "- Build the XCFramework:"
-echo "    ./megazords/ios-rust/build-xcframework.sh"
+echo "    ./megazords/ios-rust/build-xcframework.sh"

megazords/ios-rust/build-xcframework.sh

@@ -5,6 +5,8 @@
 BUILD_PROFILE="release"
 FRAMEWORK_NAME="MozillaRustComponents"
 IS_FOCUS=
+# Optional flags to pass on to generate-files.sh
+GENERATE_ARGS=()
 # FRAMEWORK_FILENAME exist purely because we would like to ship
 # multiple frameworks that have the same swift code
 # namely for focus. However, components that use
@@ -14,6 +16,9 @@ IS_FOCUS=
 # under different file names.
 FRAMEWORK_FILENAME=$FRAMEWORK_NAME
 while [[ "$#" -gt 0 ]]; do case $1 in
+  --generate-swift-sources)
+    GENERATE_ARGS+=(--generate-swift-sources)
+    shift;;
   --build-profile) BUILD_PROFILE="$2"; shift;shift;;
   --focus) IS_FOCUS="true"; FRAMEWORK_FILENAME="FocusRustComponents";shift;;
   --framework-name) FRAMEWORK_NAME="$2"; shift;shift;;
@@ -146,8 +151,17 @@ UNIFFI_BINDGEN_LIBRARY="$TARGET_DIR/aarch64-apple-ios/$BUILD_PROFILE/$LIB_NAME"
 cp "$WORKING_DIR/$FRAMEWORK_NAME.h" "$COMMON/Headers"
 cp "$REPO_ROOT/components/viaduct/ios/RustViaductFFI.h" "$COMMON/Headers"
 
-# Next, generate files with uniffi-bindgen
-"$THIS_DIR/generate-files.sh" "$UNIFFI_BINDGEN_LIBRARY" "$COMMON"
+# Next, generate files with uniffi-bindgen (forward --generate-swift-sources if present)
+# You generally want to generate the swift sources if you want to see/test the generated uniffi code
+if (( ${#GENERATE_ARGS[@]:-0} )); then
+  # we have at least one flag in the array
+  "$THIS_DIR/generate-files.sh" "${GENERATE_ARGS[@]}" \
+    "$UNIFFI_BINDGEN_LIBRARY" "$COMMON"
+else
+  # no extra flags
+  "$THIS_DIR/generate-files.sh" \
+    "$UNIFFI_BINDGEN_LIBRARY" "$COMMON"
+fi
 
 # Flesh out the framework for each architecture based on the common files.
 # It's a little fiddly, because we apparently need to put all the simulator targets

megazords/ios-rust/generate-files.sh

@@ -2,8 +2,28 @@
 
 set -ex
 
-if [[ $# -ne 2 ]] ; then
-    echo "USAGE megazords/ios-rust/generate-files.sh [UNIFFI_BINDGEN_LIBRARY] [COMMON]"
+BUILD_SOURCES=false
+
+# parse optional flags
+while [[ $# -gt 0 ]]; do
+    case "$1" in
+        --generate-swift-sources)
+            BUILD_SOURCES=true
+            shift
+            ;;
+        --help|-h)
+            echo "USAGE: $0 [--generate-swift-sources] UNIFFI_BINDGEN_LIBRARY COMMON"
+            exit 0
+            ;;
+        *)
+            break
+            ;;
+    esac
+done
+
+# expect only two args after optional
+if [[ $# -ne 2 ]]; then
+    echo "USAGE: $0 [--generate-swift-sources] UNIFFI_BINDGEN_LIBRARY COMMON"
     exit 1
 fi
 
@@ -26,10 +46,12 @@ CARGO="$HOME/.cargo/bin/cargo"
 "$CARGO" uniffi-bindgen-library-mode -l "$UNIFFI_BINDGEN_LIBRARY" swift --modulemap "$COMMON/Modules" --xcframework --modulemap-filename module.modulemap
 
 ## Tests will need the generated swift files from uniffi
-# TODO: Should we wrap this around an argument? we'd only need this for tests
-GENERATED_SWIFT_OUT_DIR="$THIS_DIR/Sources/MozillaRustComponentsWrapper/Generated"
-mkdir -p "$GENERATED_SWIFT_OUT_DIR"
-"$CARGO" uniffi-bindgen-library-mode -l "$UNIFFI_BINDGEN_LIBRARY" swift --swift-sources "$GENERATED_SWIFT_OUT_DIR"
+if [[ "$BUILD_SOURCES" == true ]]; then
+    echo "Generating uniffi Swift sources..."
+    GENERATED_SWIFT_OUT_DIR="$THIS_DIR/Sources/MozillaRustComponentsWrapper/Generated"
+    mkdir -p "$GENERATED_SWIFT_OUT_DIR"
+    "$CARGO" uniffi-bindgen-library-mode -l "$UNIFFI_BINDGEN_LIBRARY" swift --swift-sources "$GENERATED_SWIFT_OUT_DIR"
+fi
 
 # Hack to copy in the RustViaductFFI.h (https://bugzilla.mozilla.org/show_bug.cgi?id=1925601)
 cp "$THIS_DIR/../../components/viaduct/ios/RustViaductFFI.h" "$COMMON/Headers"