feat(xtask): build xcframework

* Move swift build scripts into xtask (#1201)
* fix(ffi): use target_path from `cargo metadata` rather than guessing
* ci(ffi): install necessary target arch for build-framework test
* feat(xtask): copy to target without rsync.

.github/workflows/bindings_ci.yml

@@ -243,6 +243,9 @@ jobs:
           profile: minimal
           override: true
 
+      - name: Install aarch64-apple-ios target
+        run: rustup target install aarch64-apple-ios
+
       - name: Load cache
         uses: Swatinem/rust-cache@v1
 
@@ -252,15 +255,12 @@ jobs:
           path: target/debug/xtask
           key: xtask-macos-${{ hashFiles('Cargo.toml', 'xtask/**') }}
 
-      - name: Install Uniffi
-        uses: actions-rs/cargo@v1
-        with:
-          command: install
-          args: uniffi_bindgen --git https://github.com/mozilla/uniffi-rs --rev ${{ env.UNIFFI_REV }}
-
       - name: Build library & bindings
         run: target/debug/xtask swift build-library
 
       - name: Run XCTests
         working-directory: bindings/apple
         run: swift test
+
+      - name: Build Framework
+        run: cargo xtask swift build-framework --only-target=aarch64-apple-ios

bindings/apple/build_xcframework.sh

@@ -2,89 +2,6 @@
 set -eEu
 
 cd "$(dirname "$0")"
+cd ../..
 
-# Path to the repo root
-SRC_ROOT=../..
-
-TARGET_DIR="${SRC_ROOT}/target"
-
-GENERATED_DIR="${SRC_ROOT}/generated"
-mkdir -p ${GENERATED_DIR}
-
-REL_FLAG="--release"
-REL_TYPE_DIR="release"
-
-# Build static libs for all the different architectures
-
-# iOS
-echo -e "Building for iOS [1/5]"
-cargo build -p matrix-sdk-ffi ${REL_FLAG} --target "aarch64-apple-ios"
-
-# MacOS
-echo -e "\nBuilding for macOS (Apple Silicon) [2/5]"
-cargo build -p matrix-sdk-ffi ${REL_FLAG} --target "aarch64-apple-darwin"
-echo -e "\nBuilding for macOS (Intel) [3/5]"
-cargo build -p matrix-sdk-ffi ${REL_FLAG} --target "x86_64-apple-darwin"
-
-# iOS Simulator
-echo -e "\nBuilding for iOS Simulator (Apple Silicon) [4/5]"
-cargo build -p matrix-sdk-ffi ${REL_FLAG} --target "aarch64-apple-ios-sim"
-echo -e "\nBuilding for iOS Simulator (Intel) [5/5]"
-cargo build -p matrix-sdk-ffi ${REL_FLAG} --target "x86_64-apple-ios"
-
-echo -e "\nCreating XCFramework"
-# Lipo together the libraries for the same platform
-
-# MacOS
-lipo -create \
-  "${TARGET_DIR}/x86_64-apple-darwin/${REL_TYPE_DIR}/libmatrix_sdk_ffi.a" \
-  "${TARGET_DIR}/aarch64-apple-darwin/${REL_TYPE_DIR}/libmatrix_sdk_ffi.a" \
-  -output "${GENERATED_DIR}/libmatrix_sdk_ffi_macos.a"
-
-# iOS Simulator
-lipo -create \
-  "${TARGET_DIR}/x86_64-apple-ios/${REL_TYPE_DIR}/libmatrix_sdk_ffi.a" \
-  "${TARGET_DIR}/aarch64-apple-ios-sim/${REL_TYPE_DIR}/libmatrix_sdk_ffi.a" \
-  -output "${GENERATED_DIR}/libmatrix_sdk_ffi_iossimulator.a"
-
-
-# Generate uniffi files
-# Architecture for the .a file argument doesn't matter, since the API is the same on all
-uniffi-bindgen generate \
-  --language swift \
-  --lib-file "${TARGET_DIR}/x86_64-apple-darwin/${REL_TYPE_DIR}/libmatrix_sdk_ffi.a" \
-  --out-dir ${GENERATED_DIR} \
-  "${SRC_ROOT}/bindings/matrix-sdk-ffi/src/api.udl"
-
-# Move them to the right place
-HEADERS_DIR=${GENERATED_DIR}/headers
-mkdir -p ${HEADERS_DIR}
-
-mv ${GENERATED_DIR}/*.h ${HEADERS_DIR}
-
-# Rename and move modulemap to the right place
-mv ${GENERATED_DIR}/*.modulemap ${HEADERS_DIR}/module.modulemap
-
-SWIFT_DIR="${GENERATED_DIR}/swift"
-mkdir -p ${SWIFT_DIR}
-
-mv ${GENERATED_DIR}/*.swift ${SWIFT_DIR}
-
-# Build the xcframework
-
-if [ -d "${GENERATED_DIR}/MatrixSDKFFI.xcframework" ]; then rm -rf "${GENERATED_DIR}/MatrixSDKFFI.xcframework"; fi
-
-xcodebuild -create-xcframework \
-  -library "${GENERATED_DIR}/libmatrix_sdk_ffi_macos.a" \
-  -headers ${HEADERS_DIR} \
-  -library "${GENERATED_DIR}/libmatrix_sdk_ffi_iossimulator.a" \
-  -headers ${HEADERS_DIR} \
-  -library "${TARGET_DIR}/aarch64-apple-ios/${REL_TYPE_DIR}/libmatrix_sdk_ffi.a" \
-  -headers ${HEADERS_DIR} \
-  -output "${GENERATED_DIR}/MatrixSDKFFI.xcframework"
-
-# Cleanup
-
-if [ -f "${GENERATED_DIR}/libmatrix_sdk_ffi_macos.a" ]; then rm -rf "${GENERATED_DIR}/libmatrix_sdk_ffi_macos.a"; fi
-if [ -f "${GENERATED_DIR}/libmatrix_sdk_ffi_iossimulator.a" ]; then rm -rf "${GENERATED_DIR}/libmatrix_sdk_ffi_iossimulator.a"; fi
-if [ -d ${HEADERS_DIR} ]; then rm -rf ${HEADERS_DIR}; fi
+cargo xtask swift build-framework --release $*

bindings/apple/debug_build_xcframework.sh

@@ -19,72 +19,13 @@ else
   echo "Running debug build"
 fi
 
-echo "Active architecture ${ACTIVE_ARCH}"
-
-# Path to the repo root
-SRC_ROOT=../..
-
-TARGET_DIR="${SRC_ROOT}/target"
-
-GENERATED_DIR="${SRC_ROOT}/bindings/apple/generated"
-mkdir -p ${GENERATED_DIR}
-
-REL_FLAG=""
-REL_TYPE_DIR="debug"
-
 # iOS Simulator arm64
 if [ "$ACTIVE_ARCH" = "arm64" ]; then
   TARGET="aarch64-apple-ios-sim"
 # iOS Simulator intel
 else
   TARGET="x86_64-apple-ios"
 fi
+echo "Active architecture ${ACTIVE_ARCH}"
 
-cargo build -p matrix-sdk-ffi ${REL_FLAG} --target "$TARGET"
-
-lipo -create \
-  "${TARGET_DIR}/$TARGET/${REL_TYPE_DIR}/libmatrix_sdk_ffi.a" \
-  -output "${GENERATED_DIR}/libmatrix_sdk_ffi_iossimulator.a"
-
-# Generate uniffi files
-uniffi-bindgen generate \
-  --language swift \
-  --lib-file "${TARGET_DIR}/$TARGET/${REL_TYPE_DIR}/libmatrix_sdk_ffi.a" \
-  --out-dir ${GENERATED_DIR} \
-  "${SRC_ROOT}/bindings/matrix-sdk-ffi/src/api.udl"
-
-# Move them to the right place
-HEADERS_DIR=${GENERATED_DIR}/headers
-mkdir -p ${HEADERS_DIR}
-
-mv ${GENERATED_DIR}/*.h ${HEADERS_DIR}
-
-# Rename and move modulemap to the right place
-mv ${GENERATED_DIR}/*.modulemap ${HEADERS_DIR}/module.modulemap
-
-SWIFT_DIR="${GENERATED_DIR}/swift"
-mkdir -p ${SWIFT_DIR}
-
-mv ${GENERATED_DIR}/*.swift ${SWIFT_DIR}
-
-# Build the xcframework
-
-if [ -d "${GENERATED_DIR}/MatrixSDKFFI.xcframework" ]; then rm -rf "${GENERATED_DIR}/MatrixSDKFFI.xcframework"; fi
-
-xcodebuild -create-xcframework \
-  -library "${GENERATED_DIR}/libmatrix_sdk_ffi_iossimulator.a" \
-  -headers ${HEADERS_DIR} \
-  -output "${GENERATED_DIR}/MatrixSDKFFI.xcframework"
-
-# Cleanup
-
-if [ -f "${GENERATED_DIR}/libmatrix_sdk_ffi_iossimulator.a" ]; then rm -rf "${GENERATED_DIR}/libmatrix_sdk_ffi_iossimulator.a"; fi
-if [ -d ${HEADERS_DIR} ]; then rm -rf ${HEADERS_DIR}; fi
-
-if [ "$IS_CI" = false ] ; then
-  echo "Preparing matrix-rust-components-swift"
-
-  # Debug -> Copy generated files over to ../../../matrix-rust-components-swift
-  rsync -a --delete "${GENERATED_DIR}/MatrixSDKFFI.xcframework" "${SRC_ROOT}/../matrix-rust-components-swift/"
-  rsync -a --delete "${GENERATED_DIR}/swift/" "${SRC_ROOT}/../matrix-rust-components-swift/Sources/MatrixRustSDK"
-fi
+cargo xtask swift build-framework --sim-only-target=${TARGET} $*

bindings/matrix-sdk-ffi/src/platform.rs

@@ -26,6 +26,9 @@ mod android {
 
 #[cfg(target_os = "ios")]
 mod ios {
+    use std::io;
+
+    use tracing_subscriber::{fmt, prelude::*, EnvFilter};
     pub fn setup_tracing(configuration: String) {
         tracing_subscriber::registry()
             .with(EnvFilter::new(configuration))

xtask/Cargo.toml

@@ -13,5 +13,6 @@ camino = "1.0.8"
 clap = { version = "4.0.18", features = ["derive"] }
 serde = { version = "1.0.136", features = ["derive"] }
 serde_json = "1.0.79"
+fs_extra = "1"
 uniffi_bindgen = { workspace = true }
 xshell = "0.1.17"