fix: add local/remote build modes for iOS builds

sanchitmonga22 · sanchitmonga22 · commit 80a8a5680d44 · 2026-01-01T17:27:38.000-08:00
- BUILD_MODE=local uses monorepo paths (../../../runanywhere-core)
- BUILD_MODE=remote uses downloaded paths (third_party/runanywhere-core)
- Auto-detects mode if not specified
- Fixed sherpa-onnx.xcframework path for remote mode
- Added verification step to download script
- Better logging for debugging
diff --git a/.github/workflows/commons-release.yml b/.github/workflows/commons-release.yml
@@ -114,7 +114,7 @@ jobs:
         working-directory: ${{ env.COMMONS_DIR }}
         run: |
           chmod +x scripts/build-ios.sh
-          ./scripts/build-ios.sh
+          BUILD_MODE=remote ./scripts/build-ios.sh
 
       - name: Package Release
         working-directory: ${{ env.COMMONS_DIR }}
diff --git a/Tests/Test Files b/Tests/Test Files
@@ -0,0 +1 @@
+Subproject commit 83a2bcadb7efb27c1835a2b1324b1a0617bcf901
diff --git a/sdk/runanywhere-commons/scripts/build-ios.sh b/sdk/runanywhere-commons/scripts/build-ios.sh
@@ -6,6 +6,14 @@
 # - RABackendLlamaCPP.xcframework (LlamaCpp backend)
 # - RABackendONNX.xcframework (ONNX backend)
 # - RABackendWhisperCPP.xcframework (WhisperCpp backend)
+#
+# MODES:
+#   BUILD_MODE=local   - Use local monorepo (../../../runanywhere-core)
+#   BUILD_MODE=remote  - Use downloaded core (third_party/runanywhere-core)
+#
+# Usage:
+#   BUILD_MODE=local ./scripts/build-ios.sh   # Local development
+#   BUILD_MODE=remote ./scripts/build-ios.sh  # CI/standalone builds
 
 set -e
 
@@ -17,6 +25,52 @@ DIST_DIR="${PROJECT_ROOT}/dist"
 # Load versions from VERSIONS file (single source of truth)
 source "${SCRIPT_DIR}/load-versions.sh"
 
+# Colors
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m'
+
+# =============================================================================
+# BUILD MODE DETECTION
+# =============================================================================
+# Auto-detect mode if not specified
+if [ -z "${BUILD_MODE}" ]; then
+    if [ -d "${PROJECT_ROOT}/third_party/runanywhere-core" ]; then
+        BUILD_MODE="remote"
+    elif [ -d "${PROJECT_ROOT}/../../../runanywhere-core" ]; then
+        BUILD_MODE="local"
+    else
+        echo -e "${RED}ERROR: Cannot detect build mode${NC}"
+        echo "Please set BUILD_MODE=local or BUILD_MODE=remote"
+        echo "Or run ./scripts/download-core.sh first for remote mode"
+        exit 1
+    fi
+fi
+
+# Set paths based on mode
+if [ "${BUILD_MODE}" = "local" ]; then
+    RUNANYWHERE_CORE_DIR="${PROJECT_ROOT}/../../../runanywhere-core"
+    SHERPA_ONNX_XCFW="${RUNANYWHERE_CORE_DIR}/third_party/sherpa-onnx-ios/sherpa-onnx.xcframework"
+elif [ "${BUILD_MODE}" = "remote" ]; then
+    RUNANYWHERE_CORE_DIR="${PROJECT_ROOT}/third_party/runanywhere-core"
+    # In remote mode, sherpa-onnx is extracted directly (no subdirectory)
+    SHERPA_ONNX_XCFW="${RUNANYWHERE_CORE_DIR}/third_party/sherpa-onnx.xcframework"
+else
+    echo -e "${RED}ERROR: Invalid BUILD_MODE '${BUILD_MODE}'${NC}"
+    echo "Use BUILD_MODE=local or BUILD_MODE=remote"
+    exit 1
+fi
+
+# Validate paths
+if [ ! -d "${RUNANYWHERE_CORE_DIR}" ]; then
+    echo -e "${RED}ERROR: runanywhere-core not found at ${RUNANYWHERE_CORE_DIR}${NC}"
+    if [ "${BUILD_MODE}" = "remote" ]; then
+        echo "Run: ./scripts/download-core.sh"
+    fi
+    exit 1
+fi
+
 # Configuration
 IOS_DEPLOYMENT_TARGET="${IOS_DEPLOYMENT_TARGET:-13.0}"
 BUILD_TYPE="${BUILD_TYPE:-Release}"
@@ -26,15 +80,13 @@ BUILD_LLAMACPP="${BUILD_LLAMACPP:-ON}"
 BUILD_ONNX="${BUILD_ONNX:-ON}"
 BUILD_WHISPERCPP="${BUILD_WHISPERCPP:-OFF}"
 
-# Colors
-RED='\033[0;31m'
-GREEN='\033[0;32m'
-YELLOW='\033[1;33m'
-NC='\033[0m'
-
 echo -e "${GREEN}========================================${NC}"
 echo -e "${GREEN}RunAnywhere Commons - iOS Build${NC}"
 echo -e "${GREEN}========================================${NC}"
+echo "Build mode: ${BUILD_MODE}"
+echo "Core directory: ${RUNANYWHERE_CORE_DIR}"
+echo "Sherpa-ONNX: ${SHERPA_ONNX_XCFW}"
+echo ""
 echo "Deployment target: iOS ${IOS_DEPLOYMENT_TARGET}"
 echo "Build type: ${BUILD_TYPE}"
 echo "LlamaCpp: ${BUILD_LLAMACPP}"
@@ -324,9 +376,6 @@ combine_onnx_libs() {
 
     echo "Combining ONNX libraries for ${PLATFORM}..."
 
-    # Sherpa-ONNX xcframework path
-    local SHERPA_ONNX_XCFW="${PROJECT_ROOT}/../../../runanywhere-core/third_party/sherpa-onnx-ios/sherpa-onnx.xcframework"
-
     # Collect all needed libraries (excluding ONNX Runtime itself)
     local LIBS=""
 
@@ -337,34 +386,39 @@ combine_onnx_libs() {
     [ -f "${PLATFORM_DIR}/runanywhere-core/src/backends/onnx/librunanywhere_onnx.a" ] && LIBS="$LIBS ${PLATFORM_DIR}/runanywhere-core/src/backends/onnx/librunanywhere_onnx.a"
 
     # Sherpa-ONNX static library (provides STT/TTS/VAD implementations)
+    # Uses global SHERPA_ONNX_XCFW set at script start based on BUILD_MODE
     local SHERPA_LIB=""
-    if [ "${PLATFORM}" = "OS" ]; then
-        SHERPA_LIB="${SHERPA_ONNX_XCFW}/ios-arm64/libsherpa-onnx.a"
-    elif [ "${PLATFORM}" = "SIMULATORARM64" ]; then
-        # Extract arm64 slice from fat simulator binary
-        local SHERPA_SIM_LIB="${SHERPA_ONNX_XCFW}/ios-arm64_x86_64-simulator/libsherpa-onnx.a"
-        if [ -f "${SHERPA_SIM_LIB}" ]; then
-            SHERPA_LIB="${PLATFORM_DIR}/libsherpa-onnx-arm64.a"
-            lipo -extract arm64 "${SHERPA_SIM_LIB}" -output "${SHERPA_LIB}" 2>/dev/null || \
-            lipo -thin arm64 "${SHERPA_SIM_LIB}" -output "${SHERPA_LIB}" 2>/dev/null || \
-            cp "${SHERPA_SIM_LIB}" "${SHERPA_LIB}"
-        fi
-    elif [ "${PLATFORM}" = "SIMULATOR" ]; then
-        # Extract x86_64 slice from fat simulator binary
-        local SHERPA_SIM_LIB="${SHERPA_ONNX_XCFW}/ios-arm64_x86_64-simulator/libsherpa-onnx.a"
-        if [ -f "${SHERPA_SIM_LIB}" ]; then
-            SHERPA_LIB="${PLATFORM_DIR}/libsherpa-onnx-x86_64.a"
-            lipo -extract x86_64 "${SHERPA_SIM_LIB}" -output "${SHERPA_LIB}" 2>/dev/null || \
-            lipo -thin x86_64 "${SHERPA_SIM_LIB}" -output "${SHERPA_LIB}" 2>/dev/null || \
-            cp "${SHERPA_SIM_LIB}" "${SHERPA_LIB}"
+    if [ -d "${SHERPA_ONNX_XCFW}" ]; then
+        if [ "${PLATFORM}" = "OS" ]; then
+            SHERPA_LIB="${SHERPA_ONNX_XCFW}/ios-arm64/libsherpa-onnx.a"
+        elif [ "${PLATFORM}" = "SIMULATORARM64" ]; then
+            # Extract arm64 slice from fat simulator binary
+            local SHERPA_SIM_LIB="${SHERPA_ONNX_XCFW}/ios-arm64_x86_64-simulator/libsherpa-onnx.a"
+            if [ -f "${SHERPA_SIM_LIB}" ]; then
+                SHERPA_LIB="${PLATFORM_DIR}/libsherpa-onnx-arm64.a"
+                lipo -extract arm64 "${SHERPA_SIM_LIB}" -output "${SHERPA_LIB}" 2>/dev/null || \
+                lipo -thin arm64 "${SHERPA_SIM_LIB}" -output "${SHERPA_LIB}" 2>/dev/null || \
+                cp "${SHERPA_SIM_LIB}" "${SHERPA_LIB}"
+            fi
+        elif [ "${PLATFORM}" = "SIMULATOR" ]; then
+            # Extract x86_64 slice from fat simulator binary
+            local SHERPA_SIM_LIB="${SHERPA_ONNX_XCFW}/ios-arm64_x86_64-simulator/libsherpa-onnx.a"
+            if [ -f "${SHERPA_SIM_LIB}" ]; then
+                SHERPA_LIB="${PLATFORM_DIR}/libsherpa-onnx-x86_64.a"
+                lipo -extract x86_64 "${SHERPA_SIM_LIB}" -output "${SHERPA_LIB}" 2>/dev/null || \
+                lipo -thin x86_64 "${SHERPA_SIM_LIB}" -output "${SHERPA_LIB}" 2>/dev/null || \
+                cp "${SHERPA_SIM_LIB}" "${SHERPA_LIB}"
+            fi
         fi
-    fi
 
-    if [ -f "${SHERPA_LIB}" ]; then
-        LIBS="$LIBS ${SHERPA_LIB}"
-        echo "  Including Sherpa-ONNX: ${SHERPA_LIB}"
+        if [ -f "${SHERPA_LIB}" ]; then
+            LIBS="$LIBS ${SHERPA_LIB}"
+            echo "  Including Sherpa-ONNX: ${SHERPA_LIB}"
+        else
+            echo -e "${YELLOW}Warning: Sherpa-ONNX library not found at ${SHERPA_LIB}${NC}"
+        fi
     else
-        echo -e "${YELLOW}Warning: Sherpa-ONNX library not found for ${PLATFORM}${NC}"
+        echo -e "${YELLOW}Warning: Sherpa-ONNX xcframework not found at ${SHERPA_ONNX_XCFW}${NC}"
     fi
 
     # NOTE: ONNX Runtime xcframework is NOT bundled here.
diff --git a/sdk/runanywhere-commons/scripts/download-core.sh b/sdk/runanywhere-commons/scripts/download-core.sh
@@ -3,16 +3,18 @@
 # download-core.sh - Download runanywhere-core source from runanywhere-binaries
 #
 # This script downloads the runanywhere-core source tarball and iOS/macOS dependencies
-# from the public runanywhere-binaries repository.
+# from the public runanywhere-binaries repository for REMOTE build mode.
 #
 # Usage:
 #   ./scripts/download-core.sh [version]
-#   ./scripts/download-core.sh          # Uses LATEST_CORE_VERSION
-#   ./scripts/download-core.sh 1.0.0    # Specific version
+#   ./scripts/download-core.sh              # Uses LATEST_CORE_VERSION
+#   ./scripts/download-core.sh 0.1.0        # Specific version
 #
 # Environment variables:
-#   RUNANYWHERE_CORE_VERSION - Override version to download
-#   SKIP_DEPS - Set to "true" to skip downloading dependencies (onnxruntime, sherpa-onnx)
+#   RUNANYWHERE_CORE_VERSION - Override core version to download
+#   SKIP_DEPS                - Set to "true" to skip downloading dependencies
+#
+# After running this script, use BUILD_MODE=remote ./scripts/build-ios.sh
 #
 
 set -e
@@ -21,6 +23,7 @@ SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 PROJECT_ROOT="$(cd "${SCRIPT_DIR}/.." && pwd)"
 THIRD_PARTY_DIR="${PROJECT_ROOT}/third_party"
 CORE_DIR="${THIRD_PARTY_DIR}/runanywhere-core"
+DEPS_DIR="${CORE_DIR}/third_party"
 
 # GitHub repository for published binaries
 BINARIES_REPO="RunanywhereAI/runanywhere-binaries"
@@ -36,6 +39,8 @@ NC='\033[0m'
 echo -e "${GREEN}========================================${NC}"
 echo -e "${GREEN}RunAnywhere Core Download Script${NC}"
 echo -e "${GREEN}========================================${NC}"
+echo "This script prepares REMOTE build mode."
+echo ""
 
 # Determine version to download
 get_version() {
@@ -45,19 +50,19 @@ get_version() {
         echo "$1"
     else
         # Fetch latest version from runanywhere-binaries
-        echo -e "${YELLOW}Fetching latest core version...${NC}"
+        echo -e "${YELLOW}Fetching latest core version...${NC}" >&2
         LATEST=$(curl -sL "${RAW_URL}/LATEST_CORE_VERSION" 2>/dev/null || echo "")
         if [[ -z "${LATEST}" ]]; then
-            echo -e "${RED}Failed to fetch LATEST_CORE_VERSION${NC}"
-            echo -e "${YELLOW}Please specify a version: ./scripts/download-core.sh 1.0.0${NC}"
+            echo -e "${RED}Failed to fetch LATEST_CORE_VERSION${NC}" >&2
+            echo -e "${YELLOW}Please specify a version: ./scripts/download-core.sh 0.1.0${NC}" >&2
             exit 1
         fi
         echo "${LATEST}"
     fi
 }
 
 VERSION=$(get_version "$1")
-echo "Version: ${VERSION}"
+echo "Core Version: ${VERSION}"
 echo ""
 
 # Create directories
@@ -106,35 +111,40 @@ download_ios_deps() {
         return
     fi
 
-    local IOS_DEPS_DIR="${CORE_DIR}/third_party"
-    mkdir -p "${IOS_DEPS_DIR}"
+    mkdir -p "${DEPS_DIR}"
 
     # ONNX Runtime for iOS
     echo -e "${GREEN}Downloading ONNX Runtime for iOS...${NC}"
     local ONNX_ZIP="onnxruntime-ios-v${VERSION}.zip"
     local ONNX_URL="${BINARIES_URL}/releases/download/core-v${VERSION}/${ONNX_ZIP}"
+    echo "  URL: ${ONNX_URL}"
 
-    if curl -L --fail -o "${IOS_DEPS_DIR}/${ONNX_ZIP}" "${ONNX_URL}" 2>/dev/null; then
-        cd "${IOS_DEPS_DIR}"
+    if curl -L --fail -o "${DEPS_DIR}/${ONNX_ZIP}" "${ONNX_URL}" 2>/dev/null; then
+        cd "${DEPS_DIR}"
         unzip -q -o "${ONNX_ZIP}"
         rm "${ONNX_ZIP}"
         echo -e "${GREEN}✓ ONNX Runtime for iOS downloaded${NC}"
+        # List what was extracted
+        ls -la *.xcframework 2>/dev/null || true
     else
-        echo -e "${YELLOW}⚠ ONNX Runtime for iOS not found in release (may need separate download)${NC}"
+        echo -e "${YELLOW}⚠ ONNX Runtime for iOS not found in release${NC}"
     fi
 
     # Sherpa-ONNX for iOS
     echo -e "${GREEN}Downloading Sherpa-ONNX for iOS...${NC}"
     local SHERPA_ZIP="sherpa-onnx-ios-v${VERSION}.zip"
     local SHERPA_URL="${BINARIES_URL}/releases/download/core-v${VERSION}/${SHERPA_ZIP}"
+    echo "  URL: ${SHERPA_URL}"
 
-    if curl -L --fail -o "${IOS_DEPS_DIR}/${SHERPA_ZIP}" "${SHERPA_URL}" 2>/dev/null; then
-        cd "${IOS_DEPS_DIR}"
+    if curl -L --fail -o "${DEPS_DIR}/${SHERPA_ZIP}" "${SHERPA_URL}" 2>/dev/null; then
+        cd "${DEPS_DIR}"
         unzip -q -o "${SHERPA_ZIP}"
         rm "${SHERPA_ZIP}"
         echo -e "${GREEN}✓ Sherpa-ONNX for iOS downloaded${NC}"
+        # List what was extracted
+        ls -la *.xcframework 2>/dev/null || true
     else
-        echo -e "${YELLOW}⚠ Sherpa-ONNX for iOS not found in release (may need separate download)${NC}"
+        echo -e "${YELLOW}⚠ Sherpa-ONNX for iOS not found in release${NC}"
     fi
 
     cd "${PROJECT_ROOT}"
@@ -149,21 +159,21 @@ download_macos_deps() {
         return
     fi
 
-    local MACOS_DEPS_DIR="${CORE_DIR}/third_party"
-    mkdir -p "${MACOS_DEPS_DIR}"
+    mkdir -p "${DEPS_DIR}"
 
     # ONNX Runtime for macOS
     echo -e "${GREEN}Downloading ONNX Runtime for macOS...${NC}"
     local ONNX_ZIP="onnxruntime-macos-v${VERSION}.zip"
     local ONNX_URL="${BINARIES_URL}/releases/download/core-v${VERSION}/${ONNX_ZIP}"
+    echo "  URL: ${ONNX_URL}"
 
-    if curl -L --fail -o "${MACOS_DEPS_DIR}/${ONNX_ZIP}" "${ONNX_URL}" 2>/dev/null; then
-        cd "${MACOS_DEPS_DIR}"
+    if curl -L --fail -o "${DEPS_DIR}/${ONNX_ZIP}" "${ONNX_URL}" 2>/dev/null; then
+        cd "${DEPS_DIR}"
         unzip -q -o "${ONNX_ZIP}"
         rm "${ONNX_ZIP}"
         echo -e "${GREEN}✓ ONNX Runtime for macOS downloaded${NC}"
     else
-        echo -e "${YELLOW}⚠ ONNX Runtime for macOS not found in release (may need separate download)${NC}"
+        echo -e "${YELLOW}⚠ ONNX Runtime for macOS not found in release${NC}"
     fi
 
     cd "${PROJECT_ROOT}"
@@ -177,6 +187,35 @@ save_version_info() {
     echo -e "${GREEN}Version ${VERSION} saved to DOWNLOADED_VERSION${NC}"
 }
 
+# =============================================================================
+# Verify downloads
+# =============================================================================
+verify_downloads() {
+    echo ""
+    echo -e "${GREEN}Verifying downloads...${NC}"
+
+    # Check core source
+    if [ -f "${CORE_DIR}/CMakeLists.txt" ]; then
+        echo -e "${GREEN}✓ Core source${NC}"
+    else
+        echo -e "${RED}✗ Core source NOT found${NC}"
+    fi
+
+    # Check sherpa-onnx
+    if [ -d "${DEPS_DIR}/sherpa-onnx.xcframework" ]; then
+        echo -e "${GREEN}✓ sherpa-onnx.xcframework${NC}"
+    else
+        echo -e "${YELLOW}⚠ sherpa-onnx.xcframework not found${NC}"
+    fi
+
+    # Check onnxruntime
+    if [ -d "${DEPS_DIR}/onnxruntime.xcframework" ]; then
+        echo -e "${GREEN}✓ onnxruntime.xcframework${NC}"
+    else
+        echo -e "${YELLOW}⚠ onnxruntime.xcframework not found${NC}"
+    fi
+}
+
 # =============================================================================
 # Main
 # =============================================================================
@@ -185,14 +224,23 @@ download_core_source
 download_ios_deps
 download_macos_deps
 save_version_info
+verify_downloads
 
 echo ""
 echo -e "${GREEN}========================================${NC}"
 echo -e "${GREEN}Download Complete!${NC}"
 echo -e "${GREEN}========================================${NC}"
-echo "Core source: ${CORE_DIR}"
+echo ""
+echo "Downloaded to: ${CORE_DIR}"
 echo "Version: ${VERSION}"
 echo ""
-echo "To use in CMake, set:"
-echo "  -DRUNANYWHERE_CORE_DIR=${CORE_DIR}"
+echo "Directory structure:"
+echo "  third_party/"
+echo "    runanywhere-core/           # Core source"
+echo "      third_party/"
+echo "        sherpa-onnx.xcframework # STT/TTS/VAD"
+echo "        onnxruntime.xcframework # ONNX Runtime"
+echo ""
+echo "To build iOS XCFrameworks:"
+echo "  BUILD_MODE=remote ./scripts/build-ios.sh"
 echo ""

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Subproject commit 83a2bcadb7efb27c1835a2b1324b1a0617bcf901`