feat: Add SentryDistribution

noahsmartin · noahsmartin · commit ea23f05f227e · 2025-09-15T17:09:29.000-04:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -98,6 +98,8 @@ jobs:
             config: DebugV9
           - scheme: iOS-ObjectiveC
             config: DebugV9
+          - scheme: DistributionSample
+            config: Debug
 
     steps:
       - uses: actions/checkout@v5
@@ -129,6 +131,26 @@ jobs:
         if: ${{ failure() || cancelled() }}
         run: ./scripts/ci-diagnostics.sh
 
+  build-distribution:
+    name: Build the distribution framework
+    runs-on: macos-15
+    needs: files-changed
+    steps:
+      - uses: actions/checkout@v5
+
+      - run: ./scripts/ci-select-xcode.sh 16.4
+        shell: sh
+      - run: rm -r Sentry.xcodeproj && rm -r Sentry.xcworkspace
+      - run: set -o pipefail && NSUnbufferedIO=YES xcodebuild build -scheme SentryDistribution -sdk iphoneos -destination 'generic/platform=iphoneos' | tee raw-build-output-spm.log | xcbeautify
+        shell: sh
+      - name: Upload SPM Build Logs
+        uses: actions/upload-artifact@v4
+        if: ${{ failure() || cancelled() }}
+        with:
+          name: raw-build-output-spm
+          path: |
+            raw-build-output-spm.log
+
   build-spm:
     name: Build with SPM
     runs-on: macos-15
@@ -340,6 +362,8 @@ jobs:
         files-changed,
         ios-swift-release,
         build-sample,
+        build-distribution,
+        build-distribution-sample,
         build-spm,
         build-v9,
         check-debug-without-UIKit,
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -92,6 +92,23 @@ jobs:
         if: failure()
         run: ./scripts/ci-diagnostics.sh
 
+  distribution-tests:
+    name: Distribution Tests
+    runs-on: macos-15
+    needs: files-changed
+    steps:
+      - uses: actions/checkout@v5
+      - run: rm -r Sentry.xcodeproj && rm -r Sentry.xcworkspace
+      - run: set -o pipefail && NSUnbufferedIO=YES xcodebuild test -scheme SentryDistributionTests -sdk iphoneos -destination 'generic/platform=iphoneos' | tee raw-test-output-spm.log | xcbeautify
+        shell: sh
+      - name: Upload SPM Test Logs
+        uses: actions/upload-artifact@v4
+        if: ${{ failure() || cancelled() }}
+        with:
+          name: raw-test-output-spm
+          path: |
+            raw-test-output-spm.log
+
   unit-tests:
     name: Unit ${{matrix.name}}
     runs-on: ${{matrix.runs-on}}
@@ -351,6 +368,7 @@ jobs:
       [
         files-changed,
         build-test-server,
+        distribution-tests,
         unit-tests,
       ]
     name: Unit Tests
diff --git a/Makefile b/Makefile
@@ -189,3 +189,4 @@ xcode-ci:
 	xcodegen --spec Samples/watchOS-Swift/watchOS-Swift.yml
 	xcodegen --spec TestSamples/SwiftUITestSample/SwiftUITestSample.yml
 	xcodegen --spec TestSamples/SwiftUICrashTest/SwiftUICrashTest.yml
+	xcodegen --spec Samples/DistributionSample/DistributionSample.yml
diff --git a/Package.swift b/Package.swift
@@ -15,7 +15,8 @@ var products: [Product] = [
     .library(name: "Sentry-Dynamic-WithARM64e", targets: ["Sentry-Dynamic-WithARM64e"]),
     .library(name: "Sentry-WithoutUIKitOrAppKit", targets: ["Sentry-WithoutUIKitOrAppKit", "SentryCppHelper"]),
     .library(name: "Sentry-WithoutUIKitOrAppKit-WithARM64e", targets: ["Sentry-WithoutUIKitOrAppKit-WithARM64e", "SentryCppHelper"]),
-    .library(name: "SentrySwiftUI", targets: ["Sentry", "SentrySwiftUI", "SentryCppHelper"])
+    .library(name: "SentrySwiftUI", targets: ["Sentry", "SentrySwiftUI", "SentryCppHelper"]),
+    .library(name: "SentryDistribution", targets: ["SentryDistribution"])
 ]
 
 var targets: [Target] = [
@@ -66,7 +67,9 @@ var targets: [Target] = [
         linkerSettings: [
          .linkedLibrary("c++")
         ]
-    )
+    ),
+    .target(name: "SentryDistribution", path: "Sources/SentryDistribution"),
+    .testTarget(name: "SentryDistributionTests", path: "Sources/SentryDistributionTests")
 ]
 
 let env = getenv("EXPERIMENTAL_SPM_BUILDS")
@@ -101,7 +104,7 @@ if let env = env, String(cString: env, encoding: .utf8) == "1" {
             name: "SentryObjc",
             dependencies: ["SentrySwift"],
             path: "Sources",
-            exclude: ["Sentry/SentryDummyPublicEmptyClass.m", "Sentry/SentryDummyPrivateEmptyClass.m", "Swift", "SentrySwiftUI", "Resources", "Configuration", "SentryCppHelper"],
+            exclude: ["Sentry/SentryDummyPublicEmptyClass.m", "Sentry/SentryDummyPrivateEmptyClass.m", "Swift", "SentrySwiftUI", "Resources", "Configuration", "SentryCppHelper", "Distribution"],
             cSettings: [
                 .headerSearchPath("Sentry/include/HybridPublic"),
                 .headerSearchPath("Sentry"),
diff --git a/Samples/DistributionSample/DistributionSample.xcconfig b/Samples/DistributionSample/DistributionSample.xcconfig
@@ -0,0 +1,4 @@
+PRODUCT_BUNDLE_IDENTIFIER = io.sentry.DistributionSample
+INFOPLIST_FILE = DistributionSample/Info.plist
+SUPPORTED_PLATFORMS = iphoneos iphonesimulator
+IPHONEOS_DEPLOYMENT_TARGET = 15.0
diff --git a/Samples/DistributionSample/DistributionSample.yml b/Samples/DistributionSample/DistributionSample.yml
@@ -0,0 +1,31 @@
+name: DistributionSample
+createIntermediateGroups: true
+generateEmptyDirectories: true
+configs:
+  Debug: debug
+  Release: release
+options:
+  bundleIdPrefix: io.sentry
+packages:
+  Sentry:
+    path: ../../
+targets:
+  DistributionSample:
+    type: application
+    platform: auto
+    sources:
+      - DistributionSample
+    dependencies:
+      - package: Sentry
+        products:
+          - SentryDistribution
+    configFiles:
+      Debug: DistributionSample.xcconfig
+      Release: DistributionSample.xcconfig
+schemes:
+  DistributionSample:
+    templates:
+      - SampleAppScheme
+    build:
+      targets:
+        DistributionSample: all
diff --git a/Samples/DistributionSample/DistributionSample/App.swift b/Samples/DistributionSample/DistributionSample/App.swift
@@ -0,0 +1,10 @@
+import SwiftUI
+
+@main
+struct DemoAppApp: App {
+    var body: some Scene {
+        WindowGroup {
+            ContentView()
+        }
+    }
+}
diff --git a/Samples/DistributionSample/DistributionSample/Constants.swift b/Samples/DistributionSample/DistributionSample/Constants.swift
@@ -0,0 +1,7 @@
+import Foundation
+
+enum Constants {
+  static let accessToken = ""
+  static let organization = ""
+  static let project = ""
+}
diff --git a/Samples/DistributionSample/DistributionSample/ContentView.swift b/Samples/DistributionSample/DistributionSample/ContentView.swift
@@ -0,0 +1,20 @@
+import SwiftUI
+
+struct ContentView: View {
+  var body: some View {
+    VStack(spacing: 20.0) {
+      Button("Check For Update Swift") {
+        UpdateUtil.checkForUpdates()
+      }
+      .padding()
+      .background(.blue)
+      .foregroundColor(.white)
+      .cornerRadius(10)
+    }
+    .padding()
+  }
+}
+
+#Preview {
+  ContentView()
+}
diff --git a/Samples/DistributionSample/DistributionSample/Info.plist b/Samples/DistributionSample/DistributionSample/Info.plist
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+	<key>GIT_BRANCH</key>
+	<string>&lt;branch&gt;</string>
+	<key>GIT_COMMIT_HASH</key>
+	<string>&lt;sha&gt;</string>
+	<key>GIT_STATUS_CLEAN</key>
+	<string>&lt;status&gt;</string>
+	<key>LSRequiresIPhoneOS</key>
+	<true/>
+	<key>UIApplicationSceneManifest</key>
+	<dict>
+		<key>UIApplicationSupportsMultipleScenes</key>
+		<true/>
+	</dict>
+	<key>UIApplicationSupportsIndirectInputEvents</key>
+	<true/>
+	<key>UILaunchScreen</key>
+	<dict/>
+	<key>UIRequiredDeviceCapabilities</key>
+	<array>
+		<string>armv7</string>
+	</array>
+	<key>UISupportedInterfaceOrientations</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+	<key>UISupportedInterfaceOrientations~ipad</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationPortraitUpsideDown</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+</dict>
+</plist>
diff --git a/Samples/DistributionSample/DistributionSample/UpdateUtil.swift b/Samples/DistributionSample/DistributionSample/UpdateUtil.swift
@@ -0,0 +1,49 @@
+import Foundation
+import SentryDistribution
+import UIKit
+
+enum UpdateUtil {
+  @MainActor
+  static func checkForUpdates() {
+    let params = CheckForUpdateParams(accessToken: Constants.accessToken, organization: Constants.organization, project: Constants.project)
+    Updater.shared.checkForUpdate(params: params) { result in
+      handleUpdateResult(result: result)
+    }
+  }
+  
+  @MainActor
+  static func handleUpdateResult(result: Result<UpdateCheckResponse, Error>) {
+    guard case let .success(releaseInfo) = result else {
+      if case let .failure(error) = result {
+        print("Error checking for update: \(error)")
+      }
+      return
+    }
+    
+    guard let releaseInfo = releaseInfo.update else {
+      print("Already up to date")
+      return
+    }
+    
+    UpdateUtil.installRelease(releaseInfo: releaseInfo)
+  }
+  
+  @MainActor
+  private static func installRelease(releaseInfo: ReleaseInfo) {
+    guard let url = Updater.buildUrlForInstall(releaseInfo.downloadUrl) else {
+      return
+    }
+    DispatchQueue.main.async {
+      UIApplication.shared.open(url) { _ in
+        // Post notification event before closing the app
+        NotificationCenter.default.post(name: UIApplication.willTerminateNotification, object: nil)
+
+        // Close the app after a slight delay so it has time to execute code for the notification
+        DispatchQueue.main.asyncAfter(deadline: .now() + 0.3) {
+          // We need to exit since iOS doesn't start the install until the app exits
+          exit(0)
+        }
+      }
+    }
+  }
+}
diff --git a/Sentry.xcworkspace/contents.xcworkspacedata b/Sentry.xcworkspace/contents.xcworkspacedata
diff --git a/Sources/SentryDistribution/Mach-O/BinaryParser.swift b/Sources/SentryDistribution/Mach-O/BinaryParser.swift
@@ -0,0 +1,42 @@
+import Darwin
+import Foundation
+import MachO
+
+fileprivate let _dyld_get_image_uuid = unsafeBitCast(dlsym(dlopen(nil, RTLD_LAZY), "_dyld_get_image_uuid"), to: (@convention(c) (UnsafePointer<mach_header>, UnsafeRawPointer) -> Bool).self)
+
+struct BinaryParser {
+  //swiftlint:disable large_tuple
+  private static func formatUUID(_ uuid: (UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8)) -> String {
+    "\(uuid.0.asHex)\(uuid.1.asHex)\(uuid.2.asHex)\(uuid.3.asHex)-\(uuid.4.asHex)\(uuid.5.asHex)-\(uuid.6.asHex)\(uuid.7.asHex)-\(uuid.8.asHex)\(uuid.9.asHex)-\(uuid.10.asHex)\(uuid.11.asHex)\(uuid.12.asHex)\(uuid.13.asHex)\(uuid.14.asHex)\(uuid.15.asHex)"
+  }
+  //swiftlint:enable large_tuple
+  
+  static func getMainBinaryUUID() -> String {
+    guard let executableName = Bundle.main.infoDictionary?["CFBundleExecutable"] as? String else {
+      fatalError("Executable name not found.")
+    }
+    let executablePath = "\(Bundle.main.bundlePath)/\(executableName)"
+    
+    for i in 0..<_dyld_image_count() {
+      guard let header = _dyld_get_image_header(i) else { continue }
+      let imagePath = String(cString: _dyld_get_image_name(i))
+      
+      guard imagePath == executablePath else {
+        continue
+      }
+
+      var _uuid = UUID().uuid
+      let _ = withUnsafeMutablePointer(to: &_uuid) {
+        _dyld_get_image_uuid(header, $0)
+      }
+      return formatUUID(_uuid)
+    }
+    return ""
+  }
+}
+
+private extension UInt8 {
+  var asHex: String {
+    String(format: "%02X", self)
+  }
+}
diff --git a/Sources/SentryDistribution/Models/CheckForUpdateParams.swift b/Sources/SentryDistribution/Models/CheckForUpdateParams.swift
@@ -0,0 +1,20 @@
+import Foundation
+
+/// A model for configuring parameters needed to check for app updates.
+public struct CheckForUpdateParams {
+  public init(accessToken: String, organization: String, project: String, hostname: String = "us.sentry.io", binaryIdentifierOverride: String? = nil, appIdOverride: String? = nil) {
+    self.accessToken = accessToken
+    self.organization = organization
+    self.project = project
+    self.hostname = hostname
+    self.binaryIdentifierOverride = binaryIdentifierOverride
+    self.appIdOverride = appIdOverride
+  }
+
+  let accessToken: String
+  let organization: String
+  let project: String
+  let hostname: String
+  let binaryIdentifierOverride: String?
+  let appIdOverride: String?
+}
diff --git a/Sources/SentryDistribution/Models/ReleaseInfo.swift b/Sources/SentryDistribution/Models/ReleaseInfo.swift
@@ -0,0 +1,16 @@
+import Foundation
+
+public struct ReleaseInfo: Decodable {
+  public let id: String
+  public let buildVersion: String
+  public let buildNumber: Int
+  public let releaseNotes: String?
+  public let downloadUrl: String
+  public let iconUrl: String?
+  public let appName: String
+  private let createdDate: String
+
+  public var created: Date? {
+    Date.fromString(createdDate)
+  }
+}
diff --git a/Sources/SentryDistribution/Models/UpdateCheckResponse.swift b/Sources/SentryDistribution/Models/UpdateCheckResponse.swift
@@ -0,0 +1,6 @@
+import Foundation
+
+public struct UpdateCheckResponse: Decodable {
+  public let current: ReleaseInfo?
+  public let update: ReleaseInfo?
+}
diff --git a/Sources/SentryDistribution/Network/URLSession+Distribute.swift b/Sources/SentryDistribution/Network/URLSession+Distribute.swift
diff --git a/Sources/SentryDistribution/Updater.swift b/Sources/SentryDistribution/Updater.swift
diff --git a/Sources/SentryDistribution/Utils/Date+Parse.swift b/Sources/SentryDistribution/Utils/Date+Parse.swift
diff --git a/Sources/SentryDistributionTests/DistributionReleaseInfoTests.swift b/Sources/SentryDistributionTests/DistributionReleaseInfoTests.swift
