SPM Support (#2280)

Author: denrase

.github/workflows/flutter.yml

@@ -97,6 +97,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 # [email protected]
+        with:
+          channel: main
+      - run: flutter upgrade
+      - run: flutter config --enable-swift-package-manager
+      - name: Run on iOS
+        if: matrix.target == 'ios'
+        run: flutter build ios --no-codesign
+      - name: Run on macOS
+        if: matrix.target == 'macos'
+        run: flutter build macos
+
   analyze:
     uses: ./.github/workflows/analyze.yml
     with:

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Features
 
 - Add SentryReplayQuality setting (`options.experimental.replay.quality`) ([#2582](https://github.com/getsentry/sentry-dart/pull/2582))
+- SPM Support ([#2280](https://github.com/getsentry/sentry-dart/pull/2280))
 
 ### Dependencies
 

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/Assets/.gitkeep

@@ -14,8 +14,8 @@ Sentry SDK for Flutter with support to native through sentry-cocoa.
   s.authors          = "Sentry"
   s.source           = { :git => "https://github.com/getsentry/sentry-dart.git",
                          :tag => s.version.to_s }
-  s.source_files     = 'Classes/**/*'
-  s.public_header_files = 'Classes/**/*.h'
+  s.source_files     = 'sentry_flutter/Sources/**/*'
+  s.public_header_files = 'sentry_flutter/Sources/**/*.h'
   s.dependency 'Sentry/HybridSDK', '8.43.0'
   s.ios.dependency 'Flutter'
   s.osx.dependency 'FlutterMacOS'

flutter/ios/Classes/SentryFlutterPlugin.h

@@ -0,0 +1,34 @@
+// 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.43.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: [
+                .product(name: "Sentry", package: "sentry-cocoa")
+            ]
+        )
+    ]
+)

flutter/ios/Classes/SentryFlutterPlugin.m

@@ -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"
@@ -27,7 +33,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)
         registrar.addMethodCallDelegate(instance, channel: channel)
     }
 
@@ -294,7 +300,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
@@ -337,9 +343,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
 
@@ -358,7 +364,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)
@@ -473,7 +479,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/sentry_flutter.podspec

@@ -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/sentry_flutter/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata

@@ -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/ios/sentry_flutter/Package.swift

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

flutter/ios/Classes/SentryFlutter.swift renamed to flutter/ios/sentry_flutter/Sources/sentry_flutter/SentryFlutter.swift

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

flutter/ios/Classes/SentryFlutterPluginApple.swift renamed to flutter/ios/sentry_flutter/Sources/sentry_flutter/SentryFlutterPlugin.swift

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

flutter/ios/Classes/SentryFlutterReplayBreadcrumbConverter.m renamed to flutter/ios/sentry_flutter/Sources/sentry_flutter_objc/SentryFlutterReplayBreadcrumbConverter.m

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

flutter/ios/Classes/SentryFlutterReplayScreenshotProvider.m renamed to flutter/ios/sentry_flutter/Sources/sentry_flutter_objc/SentryFlutterReplayScreenshotProvider.m

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

flutter/ios/Classes/SentryFlutterReplayBreadcrumbConverter.h renamed to flutter/ios/sentry_flutter/Sources/sentry_flutter_objc/include/SentryFlutterReplayBreadcrumbConverter.h

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

flutter/ios/Classes/SentryFlutterReplayScreenshotProvider.h renamed to flutter/ios/sentry_flutter/Sources/sentry_flutter_objc/include/SentryFlutterReplayScreenshotProvider.h

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

flutter/macos/Classes/SentryFlutter.swift

@@ -2,25 +2,55 @@
 set -euo pipefail
 
 cd $(dirname "$0")/../ios
-file='sentry_flutter.podspec'
-content=$(cat $file)
-regex="('Sentry/HybridSDK', *)'([0-9\.]+(\-[a-z0-9\.]+)?)'"
-if ! [[ $content =~ $regex ]]; then
+
+get_podspec_version() {
+  local file='sentry_flutter.podspec'
+  local content=$(cat $file)
+  regex="('Sentry/HybridSDK', *)'([0-9\.]+(\-[a-z0-9\.]+)?)'"
+  if ! [[ $content =~ $regex ]]; then
+    echo "Failed to find the plugin version in $file"
+    exit 1
+  else
+    echo "${BASH_REMATCH[2]}"
+  fi
+}
+
+set_podspec_version() {
+  local file='sentry_flutter.podspec'
+  local content=$(cat $file)
+  regex="('Sentry/HybridSDK', *)'([0-9\.]+(\-[a-z0-9\.]+)?)'"
+  if ! [[ $content =~ $regex ]]; then
+    echo "Failed to find the plugin version in $file"
+    exit 1
+  else
+    newValue="${BASH_REMATCH[1]}'$1'"
+    echo "${content/${BASH_REMATCH[0]}/$newValue}" >$file
+  fi
+}
+
+set_spm_version() {
+  local file='sentry_flutter/Package.swift'
+  local content=$(cat $file)
+  regex="(url: *['\"]https://github.com/getsentry/sentry-cocoa['\"], *from: *)['\"]([0-9\.]+(-[a-z0-9\.]+)?)['\"]"
+  if ! [[ $content =~ $regex ]]; then
     echo "Failed to find the plugin version in $file"
     exit 1
-fi
+  else
+    newValue="${BASH_REMATCH[1]}\"$1\""
+    echo "${content/${BASH_REMATCH[0]}/$newValue}" >$file
+  fi
+}
 
 case $1 in
 get-version)
-    echo ${BASH_REMATCH[2]}
+    echo $(get_podspec_version)
     ;;
 get-repo)
     echo "https://github.com/getsentry/sentry-cocoa.git"
     ;;
 set-version)
-    newValue="${BASH_REMATCH[1]}'$2'"
-    echo "${content/${BASH_REMATCH[0]}/$newValue}" >$file
-    ../scripts/generate-cocoa-bindings.sh "$2"
+    set_podspec_version "$2"
+    set_spm_version "$2"
     ;;
 *)
     echo "Unknown argument $1"