SPM Support

.github/workflows/flutter.yml

@@ -143,6 +143,33 @@ jobs:
           ;;
           esac
 
+  spm:
+    name: "SPM"
+    runs-on: macos-15
+    timeout-minutes: 30
+    defaults:
+      run:
+        shell: bash
+        working-directory: flutter/example
+    strategy:
+      fail-fast: false
+      matrix:
+        target: [ios, macos]
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: subosito/flutter-action@44ac965b96f18d999802d4b807e3256d5a3f9fa1 # pin@v2.16.0
+        with:
+          channel: main
+      - run: flutter upgrade
+      - run: flutter config --enable-swift-package-manager
+      - name: Run on iOS
+        if: matrix.target == 'ios'
+        run: flutter run -d "iPhone 16 Pro"
+      - name: Run on macOS
+        if: matrix.target == 'macos'
+        run: flutter run -d "macOS"
+
   analyze:
     uses: ./.github/workflows/analyze.yml
     with:

CHANGELOG.md

@@ -93,6 +93,8 @@
   );
   ```
 
+- SPM Support ([#2280](https://github.com/getsentry/sentry-dart/pull/2280))
+
 ### Enhancements
 
 - Avoid sending too many empty client reports when Http Transport is used ([#2380](https://github.com/getsentry/sentry-dart/pull/2380))

flutter/.gitignore

@@ -10,4 +10,8 @@ build/
 .cxx/
 
 .vscode/launch.json
+cocoa_bindings_temp
+
+ios/sentry_flutter/Package.resolved
+
 temp

flutter/ios/.gitignore

@@ -34,4 +34,8 @@ Icon?
 .tags*
 
 /Flutter/Generated.xcconfig
-/Flutter/flutter_export_environment.sh
+/Flutter/flutter_export_environment.sh
+
+.build
+.swiftpm
+Package.resolved

flutter/ios/sentry_flutter/Package.swift

@@ -0,0 +1,35 @@
+// swift-tools-version: 5.9
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "sentry_flutter",
+    platforms: [
+        .iOS("12.0"),
+        .macOS("10.13")
+    ],
+    products: [
+        .library(name: "sentry-flutter", targets: ["sentry_flutter", "sentry_flutter_objc"])
+    ],
+    dependencies: [
+      .package(url: "https://github.com/getsentry/sentry-cocoa", from: "8.37.0")
+    ],
+    targets: [
+        .target(
+            name: "sentry_flutter",
+            dependencies: [
+                "sentry_flutter_objc",
+                .product(name: "Sentry", package: "sentry-cocoa")
+            ]
+        ),
+        // SPM does not support mixed-language targets, so we need to move the ObjC files into a separate one
+        .target(
+            name: "sentry_flutter_objc",
+            dependencies: [
+                .target(name: "Sentry")
+                .product(name: "Sentry", package: "sentry-cocoa")
+            ]
+        )
+    ]
+)

flutter/ios/Classes/SentryFlutterPluginApple.swift → flutter/ios/sentry_flutter/Sources/sentry_flutter/SentryFlutterPlugin.swift

@@ -1,4 +1,10 @@
 import Sentry
+
+#if SWIFT_PACKAGE
+import Sentry._Hybrid
+import sentry_flutter_objc
+#endif
+
 #if os(iOS)
 import Flutter
 import UIKit
@@ -11,7 +17,7 @@ import CoreVideo
 // swiftlint:disable file_length function_body_length
 
 // swiftlint:disable:next type_body_length
-public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
+public class SentryFlutterPlugin: NSObject, FlutterPlugin {
     private let channel: FlutterMethodChannel
 
     private static let nativeClientName = "sentry.cocoa.flutter"
@@ -39,7 +45,7 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
         let channel = FlutterMethodChannel(name: "sentry_flutter", binaryMessenger: registrar.messenger)
 #endif
 
-        let instance = SentryFlutterPluginApple(channel: channel)
+        let instance = SentryFlutterPlugin(channel: channel)
         instance.registerObserver()
         registrar.addMethodCallDelegate(instance, channel: channel)
     }
@@ -300,7 +306,7 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
             }
 
             let version = PrivateSentrySDKOnly.getSdkVersionString()
-            PrivateSentrySDKOnly.setSdkName(SentryFlutterPluginApple.nativeClientName, andVersionString: version)
+            PrivateSentrySDKOnly.setSdkName(SentryFlutterPlugin.nativeClientName, andVersionString: version)
 
             // note : for now, in sentry-cocoa, beforeSend is not called before captureEnvelope
             options.beforeSend = { event in
@@ -341,9 +347,9 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
 
 #if canImport(UIKit) && !SENTRY_NO_UIKIT
 #if os(iOS) || os(tvOS)
-        let breadcrumbConverter = SentryFlutterReplayBreadcrumbConverter()
-        let screenshotProvider = SentryFlutterReplayScreenshotProvider(channel: self.channel)
-        PrivateSentrySDKOnly.configureSessionReplay(with: breadcrumbConverter, screenshotProvider: screenshotProvider)
+       let breadcrumbConverter = SentryFlutterReplayBreadcrumbConverter()
+       let screenshotProvider = SentryFlutterReplayScreenshotProvider(channel: self.channel)
+       PrivateSentrySDKOnly.configureSessionReplay(with: breadcrumbConverter, screenshotProvider: screenshotProvider)
 #endif
 #endif
 
@@ -362,7 +368,7 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
         if isValidSdk(sdk: sdk) {
 
             switch sdk["name"] as? String {
-            case SentryFlutterPluginApple.nativeClientName:
+            case SentryFlutterPlugin.nativeClientName:
                 #if os(OSX)
                     let origin = "mac"
                 #elseif os(watchOS)
@@ -477,7 +483,7 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
         let isColdStart = appStartMeasurement.type == .cold
 
         let item: [String: Any] = [
-            "pluginRegistrationTime": SentryFlutterPluginApple.pluginRegistrationTime,
+            "pluginRegistrationTime": SentryFlutterPlugin.pluginRegistrationTime,
             "appStartTime": appStartTime,
             "isColdStart": isColdStart,
             "nativeSpanTimes": nativeSpanTimes

flutter/ios/Classes/SentryFlutterReplayBreadcrumbConverter.m → flutter/ios/sentry_flutter/Sources/sentry_flutter_objc/SentryFlutterReplayBreadcrumbConverter.m

@@ -1,7 +1,11 @@
-#import "SentryFlutterReplayBreadcrumbConverter.h"
+#import "include/SentryFlutterReplayBreadcrumbConverter.h"
 
 @import Sentry;
 
+#if SWIFT_PACKAGE
+@import Sentry._Hybrid;
+#endif
+
 #if SENTRY_TARGET_REPLAY_SUPPORTED
 
 @implementation SentryFlutterReplayBreadcrumbConverter {

flutter/ios/Classes/SentryFlutterReplayScreenshotProvider.m → flutter/ios/sentry_flutter/Sources/sentry_flutter_objc/SentryFlutterReplayScreenshotProvider.m

@@ -1,5 +1,9 @@
 @import Sentry;
 
+#if SWIFT_PACKAGE
+@import Sentry._Hybrid;
+#endif
+
 #if SENTRY_TARGET_REPLAY_SUPPORTED
 #import "SentryFlutterReplayScreenshotProvider.h"
 #import <Flutter/Flutter.h>

flutter/macos/sentry_flutter/Package.swift

@@ -0,0 +1 @@
+../../ios/sentry_flutter/Package.swift

flutter/macos/sentry_flutter/Sources/sentry_flutter/SentryFlutter.swift

@@ -0,0 +1 @@
+../../../../ios/sentry_flutter/Sources/sentry_flutter/SentryFlutter.swift

flutter/macos/sentry_flutter/Sources/sentry_flutter/SentryFlutterPlugin.swift

@@ -0,0 +1 @@
+../../../../ios/sentry_flutter/Sources/sentry_flutter/SentryFlutterPlugin.swift

flutter/macos/sentry_flutter/Sources/sentry_flutter_objc/SentryFlutterReplayBreadcrumbConverter.m

@@ -0,0 +1 @@
+../../../../ios/sentry_flutter/Sources/sentry_flutter_objc/SentryFlutterReplayBreadcrumbConverter.m

flutter/macos/sentry_flutter/Sources/sentry_flutter_objc/SentryFlutterReplayScreenshotProvider.m

@@ -0,0 +1 @@
+../../../../ios/sentry_flutter/Sources/sentry_flutter_objc/SentryFlutterReplayScreenshotProvider.m

flutter/macos/sentry_flutter/Sources/sentry_flutter_objc/include/SentryFlutterReplayBreadcrumbConverter.h

@@ -0,0 +1 @@
+../../../../../ios/sentry_flutter/Sources/sentry_flutter_objc/include/SentryFlutterReplayBreadcrumbConverter.h

flutter/macos/sentry_flutter/Sources/sentry_flutter_objc/include/SentryFlutterReplayScreenshotProvider.h

@@ -0,0 +1 @@
+../../../../../ios/sentry_flutter/Sources/sentry_flutter_objc/include/SentryFlutterReplayScreenshotProvider.h