π End-to-end encrypted cloud for everything.
Dart 2faandroidauthye2eeencryptionend-to-end-encryptionfluttergolanggoogle-photosgoogle-photos-alternativeiosopensourcephotosprivacyprivacy-toolstypescriptzero-knowledge
[mob][ios] Use static-library ONNX Runtime package
laurenspriem741e35683a27
diff --git a/.github/workflows/ensu-ios-build.yml b/.github/workflows/ensu-ios-build.ymlindex 1eb0df5356..02ab5a2426 100644--- a/.github/workflows/ensu-ios-build.yml+++ b/.github/workflows/ensu-ios-build.yml@@ -4,6 +4,7 @@ on:pull_request:paths:- "mobile/native/apple/apps/ensu/**"+ - "mobile/native/apple/packages/EnteOnnxRuntime/**"- "rust/apps/codegen/**"- "rust/crates/core/**"- "rust/crates/ensu/**"diff --git a/mobile/apps/photos/ios/Podfile.lock b/mobile/apps/photos/ios/Podfile.lockindex ad538295af..91b7322df5 100644--- a/mobile/apps/photos/ios/Podfile.lock+++ b/mobile/apps/photos/ios/Podfile.lock@@ -26,7 +26,7 @@ PODS:- Flutter- ente_screen_cover (0.0.1):- Flutter- - EnteOnnxRuntime (1.27.0-r2)+ - EnteOnnxRuntime (1.27.0-r3)- ffmpeg_kit_custom (6.0.3)- ffmpeg_kit_flutter (6.0.3):- ffmpeg_kit_custom@@ -476,11 +476,11 @@ SPEC CHECKSUMS:cupertino_http: 94ac07f5ff090b8effa6c5e2c47871d48ab7c86cdevice_info_plus: 21fcca2080fbcd348be798aa36c3e5ed849eefbeente_cast: a25feb3127397e5fc6aff03a12120916707757d4- ente_photos_rust: 380a324fc22445a1281e206726ccddd86582ad28+ ente_photos_rust: 2db1f31cbe3f13ef0f52909a52b1f885b880a6ecente_qr: 86beaf5d2644705db9b565b32dd8b82c05fb36afente_rust: d0197ebd5460e8f67576579452b073d698404abeente_screen_cover: 6792566774f1c83939f9c1d03ed0a1f1ded45ae4- EnteOnnxRuntime: 2b0a46f3b247216f991233074d030ab53c257a3f+ EnteOnnxRuntime: 6621104c53b3bfced7e51f27e1ef5650678523aaffmpeg_kit_custom: 682b4f2f1ff1f8abae5a92f6c3540f2441d5be99ffmpeg_kit_flutter: 915b345acc97d4142e8a9a8549d177ff10f043f5file_saver: 6cdbcddd690cb02b0c1a0c225b37cd805c2bf8b6diff --git a/mobile/apps/photos/rust_builder/ios/ente_photos_rust.podspec b/mobile/apps/photos/rust_builder/ios/ente_photos_rust.podspecindex 14611c84cf..db12aa5b8b 100644--- a/mobile/apps/photos/rust_builder/ios/ente_photos_rust.podspec+++ b/mobile/apps/photos/rust_builder/ios/ente_photos_rust.podspec@@ -41,7 +41,7 @@ A new Flutter FFI plugin project.iphonesimulator) ort_slice=ios-arm64-simulator ;;*) echo "error: unsupported platform for ONNX Runtime: $PLATFORM_NAME" >&2; exit 1 ;;esac- export ORT_LIB_PATH="$PODS_ROOT/EnteOnnxRuntime/static-lib/$ort_slice"+ export ORT_LIB_PATH="$PODS_ROOT/EnteOnnxRuntime/onnxruntime.xcframework/$ort_slice"if [ ! -f "$ORT_LIB_PATH/libonnxruntime.a" ]; thenecho "error: $ORT_LIB_PATH/libonnxruntime.a is missing; run 'pod install'" >&2exit 1diff --git a/mobile/native/apple/packages/EnteOnnxRuntime/Package.swift b/mobile/native/apple/packages/EnteOnnxRuntime/Package.swiftindex 395a608a7c..63f9c42e3c 100644--- a/mobile/native/apple/packages/EnteOnnxRuntime/Package.swift+++ b/mobile/native/apple/packages/EnteOnnxRuntime/Package.swift@@ -1,13 +1,13 @@// swift-tools-version: 5.9-// Ente's pinned custom ONNX Runtime static XCFramework for iOS (CoreML and-// CPU; device and ARM64 Simulator). SPM downloads the release ZIP, verifies+// Ente's pinned custom ONNX Runtime static-library XCFramework for iOS+// (CoreML and CPU; device and ARM64 Simulator). SPM downloads the release ZIP, verifies// its checksum (a plain SHA-256 of the archive, published in the release's// SHA256SUMS asset), and links the correct slice into the app.//// The Rust side (ente-ensu's iOS `ort-sys` dependency) is built with// "disable-linking" so that it neither downloads nor bundles any other ONNX-// Runtime; the symbols resolve against this framework at app link time.+// Runtime; the symbols resolve against this static library at app link time.//// See mobile/native/onnxruntime/README.md for the release bump checklist.import PackageDescription@@ -20,8 +20,8 @@ let package = Package(targets: [.binaryTarget(name: "onnxruntime",- url: "https://github.com/laurens-pilot/ort-packaging/releases/download/ort-1.27.0-r2/onnxruntime-coreml-ios-1.27.0-r2.zip",- checksum: "87f27a8d899ff9dbea29a0eac99e08d58a854b0d58542cc131de16f029bb8d5f"+ url: "https://github.com/laurens-pilot/ort-packaging/releases/download/ort-1.27.0-r3/onnxruntime-coreml-ios-1.27.0-r3.zip",+ checksum: "b8c450fe29c6517789b6a31e909c0469fac2aa416b4830f2adc7c4f9b4f33f89")])diff --git a/mobile/native/onnxruntime/EnteOnnxRuntime.podspec b/mobile/native/onnxruntime/EnteOnnxRuntime.podspecindex ca5f8a7e78..a4904e47ed 100644--- a/mobile/native/onnxruntime/EnteOnnxRuntime.podspec+++ b/mobile/native/onnxruntime/EnteOnnxRuntime.podspec@@ -1,28 +1,29 @@-# Download vehicle for Ente's pinned custom ONNX Runtime iOS static-# libraries. CocoaPods downloads the release ZIP at `pod install` time,+# Download vehicle for Ente's pinned custom ONNX Runtime iOS static-library+# XCFramework. CocoaPods downloads the release ZIP at `pod install` time,# verifies its SHA-256, and caches it. Nothing is compiled or linked here:# the ente_photos_rust pod's build phase points the Rust `ort` crate at the-# pre-thinned static archive for the active platform via ORT_LIB_PATH.+# XCFramework's static archive for the active platform via ORT_LIB_PATH.## See README.md next to this file for the release bump checklist.Pod::Spec.new do |s|s.name = 'EnteOnnxRuntime'- s.version = '1.27.0-r2'- s.summary = "Ente's custom prebuilt ONNX Runtime static libraries for iOS."+ s.version = '1.27.0-r3'+ s.summary = "Ente's custom prebuilt ONNX Runtime static-library XCFramework for iOS."s.homepage = 'https://github.com/laurens-pilot/ort-packaging's.authors = { 'Ente' => '[email protected]' }s.license = { :type => 'MIT', :file => 'ONNXRUNTIME-LICENSE' }s.source = {- :http => 'https://github.com/laurens-pilot/ort-packaging/releases/download/ort-1.27.0-r2/onnxruntime-coreml-ios-1.27.0-r2.zip',- :sha256 => '87f27a8d899ff9dbea29a0eac99e08d58a854b0d58542cc131de16f029bb8d5f',+ :http => 'https://github.com/laurens-pilot/ort-packaging/releases/download/ort-1.27.0-r3/onnxruntime-coreml-ios-1.27.0-r3.zip',+ :sha256 => 'b8c450fe29c6517789b6a31e909c0469fac2aa416b4830f2adc7c4f9b4f33f89',}s.platform = :ios, '15.1'- # Keep only the pre-thinned per-slice static archives; the XCFramework in- # the ZIP is not used (the Rust build consumes the .a files directly).+ # Keep the XCFramework as downloaded, but do not declare it as a vendored+ # framework. CocoaPods is only the download/checksum vehicle; the Rust build+ # consumes the selected .a slice directly and links it into its staticlib.s.preserve_paths = \- 'static-lib/**/*',+ 'onnxruntime.xcframework/**/*','ONNXRUNTIME-LICENSE','ThirdPartyNotices.txt'enddiff --git a/mobile/native/onnxruntime/README.md b/mobile/native/onnxruntime/README.mdindex 67738a90d6..188538ddd8 100644--- a/mobile/native/onnxruntime/README.md+++ b/mobile/native/onnxruntime/README.md@@ -1,10 +1,10 @@# Custom ONNX Runtime binaries-The mobile apps use Ente's pinned custom ONNX Runtime 1.27.0 packaging build-(`ort-1.27.0-r2` from the ort-packaging repository):+The mobile apps use Ente's pinned custom ONNX Runtime 1.27.0 packaging builds+from the ort-packaging repository:-- Android: WebGPU, XNNPACK, and CPU; ARM64, ARMv7, and x86_64-- iOS: CoreML and CPU; iOS 15.1+ device and ARM64 Simulator+- Android (`ort-1.27.0-r2`): WebGPU, XNNPACK, and CPU; ARM64, ARMv7, and x86_64+- iOS (`ort-1.27.0-r3`): CoreML and CPU; iOS 15.1+ device and ARM64 SimulatorEach platform's own package manager downloads and checksum-verifies thebinaries; there are no custom download scripts.@@ -16,15 +16,17 @@ binaries; there are no custom download scripts.- **iOS (photos)**: the release ZIP is downloaded by CocoaPods as the local`EnteOnnxRuntime` pod (`EnteOnnxRuntime.podspec` in this directory), whichpins its SHA-256. The `ente_photos_rust` pod's build phase exports- `ORT_LIB_PATH` pointing at the pre-thinned static archive for the active- platform slice, which the Rust `ort` crate links statically.-- **iOS (ensu)**: the Ensu Xcode project links the static XCFramework from+ `ORT_LIB_PATH` pointing at the static archive inside the XCFramework's active+ platform slice, which the Rust `ort` crate links statically. The podspec uses+ `preserve_paths`, not `vendored_frameworks`, so CocoaPods does not also link+ or embed the XCFramework.+- **iOS (ensu)**: the Ensu Xcode project links the static-library XCFramework fromthe same ZIP through Swift Package Manager(`mobile/native/apple/packages/EnteOnnxRuntime/Package.swift`, a binarytarget with a pinned checksum). The Rust side builds `ort-sys` with`disable-linking` on iOS (see `rust/crates/ensu/Cargo.toml`), so cargoneither downloads nor bundles any other ONNX Runtime; symbols resolve- against the SPM framework at app link time. Note: because of this, build+ against the SPM static library at app link time. Note: because of this, build`ente-ensu-uniffi` for iOS with `--crate-type staticlib` (as the app's`build-rust.sh` does); the cdylib crate type cannot link on iOS sincenothing provides ONNX Runtime at cargo link time.@@ -34,21 +36,26 @@ Desktop ONNX Runtime packaging is intentionally unchanged.## Bumping the pinned releaseUpdate the release tag, version, and SHA-256 digests (published as the-`SHA256SUMS` release asset) in each of:+`SHA256SUMS` release asset) for the platform being bumped.++For iOS:1. `EnteOnnxRuntime.podspec` (this directory): `s.version`, `:http` URL, and`:sha256`; then run `pod install` in `mobile/apps/photos/ios`.-2. `mobile/apps/photos/android/app/build.gradle`: the+2. `mobile/native/apple/packages/EnteOnnxRuntime/Package.swift`: the binary+ target URL and checksum (the checksum is the plain SHA-256 of the iOS+ ZIP, identical to the one used in 1).++For Android:++1. `mobile/apps/photos/android/app/build.gradle`: the`io.ente.onnxruntime:onnxruntime-webgpu-android` dependency version.-3. `mobile/apps/photos/android/gradle/verification-metadata.xml`: the+2. `mobile/apps/photos/android/gradle/verification-metadata.xml`: thecomponent version, artifact file name, and SHA-256.-4. `mobile/native/android/apps/ensu/rust/build.gradle.kts`: the dependency+3. `mobile/native/android/apps/ensu/rust/build.gradle.kts`: the dependencyversion.-5. `mobile/native/android/apps/ensu/gradle/verification-metadata.xml`: same- as 3.-6. `mobile/native/apple/packages/EnteOnnxRuntime/Package.swift`: the binary- target URL and checksum (the checksum is the plain SHA-256 of the iOS- ZIP, identical to the one used in 1).+4. `mobile/native/android/apps/ensu/gradle/verification-metadata.xml`: the+ same component, artifact, and SHA-256 updates as 2.## WebGPU rollout status@@ -66,7 +73,7 @@ invocations against an iOS target (for example `cargo check`), run`pod install` in `mobile/apps/photos/ios` once, then export it manually:```sh-ORT_LIB_PATH="$PWD/mobile/apps/photos/ios/Pods/EnteOnnxRuntime/static-lib/ios-arm64" \+ORT_LIB_PATH="$PWD/mobile/apps/photos/ios/Pods/EnteOnnxRuntime/onnxruntime.xcframework/ios-arm64" \IPHONEOS_DEPLOYMENT_TARGET=15.1 \cargo check -p ente-photos --target aarch64-apple-ios```