Refactor Gemstone iOS library build

Author: 0xh3rman

.github/workflows/ci-stone-ios.yml

@@ -34,6 +34,9 @@ jobs:
       - name: Install iOS targets
         run: just install-ios-targets
 
+      - name: Install XcodeGen
+        run: brew install xcodegen
+
       - name: Build iOS
         run: just build-ios
 

gemstone/.gitignore

@@ -5,3 +5,10 @@ xcuserdata/
 jniLibs/
 .kotlin/
 gradle-daemon-jvm.properties
+tests/ios/GemTest/GemTest.xcodeproj/
+tests/ios/GemTest/GemTest/Info.plist
+tests/ios/GemTest/GemTestTests/Info.plist
+tests/ios/Packages/Gemstone/.build/
+tests/ios/Packages/Gemstone/.swiftpm/
+tests/ios/Packages/Gemstone/Sources/Gemstone/Gemstone.swift
+tests/ios/Packages/Gemstone/Sources/GemstoneFFI/include/GemstoneFFI.h

gemstone/README.md

@@ -4,12 +4,16 @@ Gemstone is the essential cross platform library used by Gem Wallet clients (mai
 
 ## Build
 
-iOS
+iOS example
 
 ```bash
+just generate-ios-project
 just build-ios
+just test-ios
 ```
 
+`just generate-ios-project` creates the local Swift package sources and regenerates `GemTest.xcodeproj` with XcodeGen. The generated Xcode project builds and links the native Gemstone static library during the Xcode build.
+
 Android
 
 ```bash

gemstone/justfile

@@ -12,7 +12,6 @@ test:
     cargo test --lib
 
 export ANDROID_HOME := env("ANDROID_HOME", "~/Library/Android/sdk")
-export HOST_ARCH := arch()
 
 install-ndk:
     #!/usr/bin/env bash
@@ -24,16 +23,23 @@ install-ndk:
 
 install-ios-targets:
     #!/usr/bin/env bash
-    rustup target add aarch64-apple-ios-sim aarch64-apple-ios aarch64-apple-ios-macabi aarch64-apple-darwin
-    if [ ${HOST_ARCH} == "x86_64" ]; then \
-        rustup target add x86_64-apple-ios; \
-    fi
+    rustup target add aarch64-apple-ios-sim aarch64-apple-ios
 
 install-android-targets:
     rustup target add x86_64-linux-android aarch64-linux-android armv7-linux-androideabi
     cargo install cargo-ndk@4.1.2
 
-test-ios:
+build-ios: generate-ios-project
+    #!/usr/bin/env bash
+    set -o pipefail
+    DEVICE_ID=$(xcrun simctl list devices available | grep iPhone | head -1 | sed 's/.*(\([A-F0-9-]*\)).*/\1/')
+    echo "Using Simulator: $DEVICE_ID"
+    xcodebuild -project tests/ios/GemTest/GemTest.xcodeproj \
+    -scheme GemTest \
+    -destination "platform=iOS Simulator,id=$DEVICE_ID,arch=arm64" \
+    build | xcbeautify
+
+test-ios: generate-ios-project
     #!/usr/bin/env bash
     set -o pipefail
     DEVICE_ID=$(xcrun simctl list devices available | grep iPhone | head -1 | sed 's/.*(\([A-F0-9-]*\)).*/\1/')
@@ -44,7 +50,6 @@ test-ios:
     test | xcbeautify
 
 export LIB_NAME := "gemstone"
-export FW_NAME := "Gemstone"
 export STATIC_LIB_NAME := "lib" + LIB_NAME + ".a"
 export DY_LIB_NAME := if os() == "macos" { "libgemstone.dylib" } else { "libgemstone.so" }
 
@@ -56,24 +61,10 @@ export TARGET_DIR := "../target"
 export GEN_SWIFT_FOLDER := "generated/swift"
 export GEN_KOTLIN_FOLDER := "generated/kotlin"
 export ANDROID_MODULE_FOLDER := "android/gemstone/src/main/java"
+export IOS_PROJECT_FOLDER := "tests/ios/GemTest"
+export IOS_PACKAGE_FOLDER := "tests/ios/Packages/Gemstone"
 
-export TARGET_XC_FW_FOLDER := "target/spm"
-export FW_FFI_NAME := FW_NAME + "FFI"
-export FW_FFI_FILE := FW_FFI_NAME + ".framework"
-export XC_FW_FFI_NAME := FW_FFI_NAME + ".xcframework"
-export DEPLOYMENT_TARGET := env("IPHONEOS_DEPLOYMENT_TARGET", "17.0")
 export LIB_OUTPUT_PATH := TARGET_DIR + "/" + BUILD_MODE_TARGET + "/" + DY_LIB_NAME
-build-ios: build-targets bindgen-swift assemble-frameworks xcframework cp-xcframework-source
-
-build-targets:
-    #!/usr/bin/env bash
-    echo "Host: ${HOST_ARCH}, iOS deployment target ${DEPLOYMENT_TARGET}, BUILD_MODE_TARGET: ${BUILD_MODE_TARGET}"
-    if [ ${HOST_ARCH} == "x86_64" ]; then \
-        IPHONEOS_DEPLOYMENT_TARGET=${DEPLOYMENT_TARGET} cargo build --target x86_64-apple-ios ${BUILD_FLAG}; \
-    else \
-        IPHONEOS_DEPLOYMENT_TARGET=${DEPLOYMENT_TARGET} cargo build --target aarch64-apple-ios-sim --target aarch64-apple-ios ${BUILD_FLAG}; \
-        env -u IPHONEOS_DEPLOYMENT_TARGET cargo build --target aarch64-apple-ios-macabi --target aarch64-apple-darwin ${BUILD_FLAG}; \
-    fi
 
 bindgen-swift:
     #!/usr/bin/env bash
@@ -89,56 +80,14 @@ bindgen-swift:
     fi; \
     cargo run ${BUILD_FLAG} -p uniffi-bindgen -- generate --library --language swift --crate ${LIB_NAME} -o ${GEN_SWIFT_FOLDER} "${LIB_OUTPUT_PATH}"
 
-assemble-frameworks:
+prepare-ios-package: bindgen-swift
     #!/usr/bin/env bash
-    MODULE_MAP=$(
-    cat << EOF
-    // This file was autogenerated by some hot garbage in the uniffi crate.
-    framework module ${FW_FFI_NAME} {
-        header "${FW_FFI_NAME}.h"
-        export *
-    }
-    EOF
-    )
-    cd ${TARGET_DIR} && find . -type d -name ${FW_FFI_FILE} | xargs rm -rf
-    targets=(aarch64-apple-ios-sim aarch64-apple-ios aarch64-apple-ios-macabi aarch64-apple-darwin)
-    if [ ${HOST_ARCH} == "x86_64" ]; then
-        targets=(x86_64-apple-ios)
-    fi
-    for target in ${targets[@]}; do \
-        pushd ${TARGET_DIR}/${target}/${BUILD_MODE_TARGET} > /dev/null && \
-        mkdir -p ${FW_FFI_FILE} && \
-        cd ${FW_FFI_FILE} && \
-        mkdir Headers Modules && \
-        echo "$MODULE_MAP" > ./Modules/module.modulemap && \
-        cp ../../../../${LIB_NAME}/${GEN_SWIFT_FOLDER}/${FW_FFI_NAME}.h ./Headers && \
-        cp ../${STATIC_LIB_NAME} ./${FW_FFI_NAME} && \
-        cp ../../../../${LIB_NAME}/src/Info.plist ./; \
-        popd > /dev/null; \
-    done
-
-xcframework:
-    #!/usr/bin/env bash
-    rm -rf ${TARGET_XC_FW_FOLDER}/Sources/${XC_FW_FFI_NAME}
-    mkdir -p ${TARGET_XC_FW_FOLDER}/Sources
-    if [ ${HOST_ARCH} == "x86_64" ]; then \
-        xcodebuild -create-xcframework \
-            -framework ${TARGET_DIR}/x86_64-apple-ios/${BUILD_MODE_TARGET}/${FW_FFI_FILE} \
-            -output ${TARGET_XC_FW_FOLDER}/Sources/${XC_FW_FFI_NAME}; \
-    else \
-        xcodebuild -create-xcframework \
-            -framework ${TARGET_DIR}/aarch64-apple-ios/${BUILD_MODE_TARGET}/${FW_FFI_FILE} \
-            -framework ${TARGET_DIR}/aarch64-apple-ios-sim/${BUILD_MODE_TARGET}/${FW_FFI_FILE} \
-            -framework ${TARGET_DIR}/aarch64-apple-ios-macabi/${BUILD_MODE_TARGET}/${FW_FFI_FILE} \
-            -framework ${TARGET_DIR}/aarch64-apple-darwin/${BUILD_MODE_TARGET}/${FW_FFI_FILE} \
-            -output ${TARGET_XC_FW_FOLDER}/Sources/${XC_FW_FFI_NAME}; \
-    fi
+    mkdir -p ${IOS_PACKAGE_FOLDER}/Sources/Gemstone ${IOS_PACKAGE_FOLDER}/Sources/GemstoneFFI/include
+    cp ${GEN_SWIFT_FOLDER}/gemstone.swift ${IOS_PACKAGE_FOLDER}/Sources/Gemstone/Gemstone.swift
+    cp ${GEN_SWIFT_FOLDER}/GemstoneFFI.h ${IOS_PACKAGE_FOLDER}/Sources/GemstoneFFI/include/GemstoneFFI.h
 
-cp-xcframework-source:
-    #!/usr/bin/env bash
-    mkdir -p ${TARGET_XC_FW_FOLDER}/Sources/${FW_NAME}
-    cp src/Package.swift ${TARGET_XC_FW_FOLDER}
-    cp ${GEN_SWIFT_FOLDER}/${FW_NAME}.swift ${TARGET_XC_FW_FOLDER}/Sources/${FW_NAME}
+generate-ios-project: prepare-ios-package
+    xcodegen generate --spec ${IOS_PROJECT_FOLDER}/project.yml --project ${IOS_PROJECT_FOLDER}
 
 bindgen-kotlin:
     #!/usr/bin/env bash

gemstone/scripts/build-ios-lib.sh

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+#
+# Build the Gemstone Rust static library for the active Xcode destination.
+
+set -euo pipefail
+
+export PATH="$HOME/.cargo/bin:/opt/homebrew/bin:/usr/local/bin:$PATH"
+
+SCRIPT_DIR=$(dirname "$(realpath "$0")")
+GEMSTONE_DIR="$SCRIPT_DIR/.."
+TARGET_DIR="$GEMSTONE_DIR/../target"
+
+if [ -z "${BUILT_PRODUCTS_DIR:-}" ] || [ -z "${PLATFORM_NAME:-}" ] || [ -z "${CONFIGURATION:-}" ]; then
+    echo "error: build-ios-lib.sh must run from an Xcode build environment" >&2
+    exit 1
+fi
+
+profile="debug"
+build_flag=""
+requested_arch="${ARCHS:-${CURRENT_ARCH:-$(uname -m)}}"
+
+if [ "$CONFIGURATION" = "Release" ]; then
+    profile="release"
+    build_flag="--release"
+fi
+
+if [ -z "$requested_arch" ] || [ "$requested_arch" = "undefined_arch" ]; then
+    requested_arch="$(uname -m)"
+fi
+
+if [ "$requested_arch" != "arm64" ]; then
+    echo "error: Intel Macs are not supported for iOS Gemstone builds." >&2
+    exit 1
+fi
+
+case "$PLATFORM_NAME" in
+    iphoneos) rust_target="aarch64-apple-ios" ;;
+    iphonesimulator) rust_target="aarch64-apple-ios-sim" ;;
+    *)
+        echo "error: unsupported Gemstone platform: $PLATFORM_NAME" >&2
+        exit 1
+        ;;
+esac
+
+mkdir -p "$BUILT_PRODUCTS_DIR"
+
+echo "note: Building Gemstone Rust library for $rust_target ($profile)"
+env -u MACOSX_DEPLOYMENT_TARGET -u TVOS_DEPLOYMENT_TARGET -u WATCHOS_DEPLOYMENT_TARGET -u XROS_DEPLOYMENT_TARGET \
+    IPHONEOS_DEPLOYMENT_TARGET="${IPHONEOS_DEPLOYMENT_TARGET:-17.0}" \
+    cargo build --manifest-path "$GEMSTONE_DIR/Cargo.toml" --target "$rust_target" --lib ${build_flag}
+
+cp "$TARGET_DIR/$rust_target/$profile/libgemstone.a" "$BUILT_PRODUCTS_DIR/libgemstone.a"
+echo "note: Gemstone Rust library ready at $BUILT_PRODUCTS_DIR/libgemstone.a"