Full spm (#5359)

* Update codable conformances for SPM

* Fix SentryId for SentryEvent in SPM

* Update build and add to CI

* PR comments

Author: noahsmartin

.github/workflows/build.yml

@@ -87,6 +87,14 @@ jobs:
           name: raw-build-output-scheme-${{matrix.scheme}}
           path: |
             raw-build-output.log
+  build-spm:
+    name: Build with SPM
+    runs-on: macos-15
+    steps:
+      - uses: actions/checkout@v4
+      # Only watchOS is compiling with SPM so far, the rest of the targets need profiling support which is still a work in progress due to the ObjC++ usage
+      - run: rm -r Sentry.xcodeproj && rm -r Sentry.xcworkspace && EXPERIMENTAL_SPM_BUILDS=1 xcodebuild build -scheme SentrySPM -sdk watchos -destination 'generic/platform=watchOS'
+        shell: sh
 
   check-debug-without-UIKit:
     name: Check no UIKit linkage (DebugWithoutUIKit)

Package.swift

@@ -1,41 +1,90 @@
 // swift-tools-version:5.3
+import Darwin.C
 import PackageDescription
 
+var products: [Product] = [
+    .library(name: "Sentry", targets: ["Sentry"]),
+    .library(name: "Sentry-Dynamic", targets: ["Sentry-Dynamic"]),
+    .library(name: "SentrySwiftUI", targets: ["Sentry", "SentrySwiftUI"])
+]
+
+var targets: [Target] = [
+    .binaryTarget(
+        name: "Sentry",
+        url: "https://github.com/getsentry/sentry-cocoa/releases/download/8.52.1/Sentry.xcframework.zip",
+        checksum: "48a6c6693148a3f9096108164eb938a931b964395fcf38e169383b9e4cffcfc5" //Sentry-Static
+    ),
+    .binaryTarget(
+        name: "Sentry-Dynamic",
+        url: "https://github.com/getsentry/sentry-cocoa/releases/download/8.52.1/Sentry-Dynamic.xcframework.zip",
+        checksum: "b9d9054c65ee5ac0591c27826edddc54490a96c2a83dee25519cae0c1a593231" //Sentry-Dynamic
+    ),
+    .target (
+        name: "SentrySwiftUI",
+        dependencies: ["Sentry", "SentryInternal"],
+        path: "Sources/SentrySwiftUI",
+        exclude: ["SentryInternal/", "module.modulemap"],
+        linkerSettings: [
+            .linkedFramework("Sentry")
+        ]),
+    .target(
+        name: "SentryInternal",
+        path: "Sources/SentrySwiftUI",
+        sources: [
+            "SentryInternal/"
+        ],
+        publicHeadersPath: "SentryInternal/")
+]
+
+let env = getenv("EXPERIMENTAL_SPM_BUILDS")
+if let env, String(cString: env, encoding: .utf8) == "1" {
+    products.append(.library(name: "SentrySPM", type: .dynamic, targets: ["SentryObjc"]))
+    targets.append(contentsOf: [
+        // At least one source file is required
+        .target(name: "SentryHeaders", path: "Sources/Sentry", sources: ["SentryDsn.m"], publicHeadersPath: "Public"),
+        .target(
+            name: "_SentryPrivate",
+            dependencies: ["SentryHeaders"],
+            path: "Sources/Sentry",
+            sources: ["NSLocale+Sentry.m"],
+            publicHeadersPath: "include",
+            cSettings: [.headerSearchPath("include/HybridPublic")]),
+        .target(
+            name: "SentrySwift",
+            dependencies: ["_SentryPrivate", "SentryHeaders"],
+            path: "Sources/Swift",
+            swiftSettings: [
+                // The application extension flag is required due to https://github.com/getsentry/sentry-cocoa/issues/5371
+                .unsafeFlags(["-enable-library-evolution", "-Xfrontend", "-application-extension"]),
+                // This flag is used to make some API breaking changes necessary for the framework to compile with SPM.
+                // We can either make more extensive changes to allow it to be backwards compatible, or release them as part of a V9 release.
+                // For now we use this flag so that CI can compile the SPM version.
+                    .define("SENTRY_SWIFT_PACKAGE")
+            ],
+            linkerSettings: [
+                .unsafeFlags(["-Xlinker", "-application_extension"])
+            ]),
+        .target(
+            name: "SentryObjc",
+            dependencies: ["SentrySwift"],
+            path: "Sources",
+            exclude: ["Sentry/SentryDsn.m", "Sentry/NSLocale+Sentry.m", "Swift", "SentrySwiftUI", "Resources", "Configuration"],
+            cSettings: [
+                .headerSearchPath("Sentry/include/HybridPublic"),
+                .headerSearchPath("Sentry"),
+                .headerSearchPath("SentryCrash/Recording"),
+                .headerSearchPath("SentryCrash/Recording/Monitors"),
+                .headerSearchPath("SentryCrash/Recording/Tools"),
+                .headerSearchPath("SentryCrash/Installations"),
+                .headerSearchPath("SentryCrash/Reporting/Filters"),
+                .headerSearchPath("SentryCrash/Reporting/Filters/Tools")])
+    ])
+}
+
 let package = Package(
     name: "Sentry",
     platforms: [.iOS(.v11), .macOS(.v10_13), .tvOS(.v11), .watchOS(.v4)],
-    products: [
-        .library(name: "Sentry", targets: ["Sentry"]),
-        .library(name: "Sentry-Dynamic", targets: ["Sentry-Dynamic"]),
-        .library(name: "SentrySwiftUI", targets: ["Sentry", "SentrySwiftUI"])
-    ],
-    targets: [
-        .binaryTarget(
-                    name: "Sentry",
-                    url: "https://github.com/getsentry/sentry-cocoa/releases/download/8.52.1/Sentry.xcframework.zip",
-                    checksum: "48a6c6693148a3f9096108164eb938a931b964395fcf38e169383b9e4cffcfc5" //Sentry-Static
-                ),
-        .binaryTarget(
-                    name: "Sentry-Dynamic",
-                    url: "https://github.com/getsentry/sentry-cocoa/releases/download/8.52.1/Sentry-Dynamic.xcframework.zip",
-                    checksum: "b9d9054c65ee5ac0591c27826edddc54490a96c2a83dee25519cae0c1a593231" //Sentry-Dynamic
-                ),
-        .target ( name: "SentrySwiftUI",
-                  dependencies: ["Sentry", "SentryInternal"],
-                  path: "Sources/SentrySwiftUI",
-                  exclude: ["SentryInternal/", "module.modulemap"],
-                  linkerSettings: [
-                     .linkedFramework("Sentry")
-                  ]
-                ),
-        .target( name: "SentryInternal",
-                 path: "Sources/SentrySwiftUI",
-                 sources: [
-                    "SentryInternal/"
-                 ],
-                 publicHeadersPath: "SentryInternal/"
-               ),
-        .target(name: "SentryCoreSwift", path: "Sources/Swift/Core")
-    ],
+    products: products,
+    targets: targets,
     cxxLanguageStandard: .cxx14
 )

Sentry.xcodeproj/project.pbxproj

@@ -1071,6 +1071,8 @@
 		FA67DD192DDBD4EA00896B02 /* SwizzleClassNameExclude.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA67DCD52DDBD4EA00896B02 /* SwizzleClassNameExclude.swift */; };
 		FA8A36182DEAA1EB0058D883 /* SentryThread+Private.h in Headers */ = {isa = PBXBuildFile; fileRef = FA8A36172DEAA1EB0058D883 /* SentryThread+Private.h */; };
 		FA90FAFD2E070A3B008CAAE8 /* SentryURLRequestFactory.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA90FAFC2E070A3B008CAAE8 /* SentryURLRequestFactory.swift */; };
+		FAB359982E05D7E90083D5E3 /* SentryEventSwiftHelper.h in Headers */ = {isa = PBXBuildFile; fileRef = FAB359972E05D7E90083D5E3 /* SentryEventSwiftHelper.h */; };
+		FAB3599A2E05D8080083D5E3 /* SentryEventSwiftHelper.m in Sources */ = {isa = PBXBuildFile; fileRef = FAB359992E05D8080083D5E3 /* SentryEventSwiftHelper.m */; };
 		FAEC270E2DF3526000878871 /* SentryUserFeedback.swift in Sources */ = {isa = PBXBuildFile; fileRef = FAEC270D2DF3526000878871 /* SentryUserFeedback.swift */; };
 		FAEC273D2DF3933A00878871 /* NSData+Unzip.m in Sources */ = {isa = PBXBuildFile; fileRef = FAEC273C2DF3933200878871 /* NSData+Unzip.m */; };
 /* End PBXBuildFile section */
@@ -2322,6 +2324,8 @@
 		FA67DCF22DDBD4EA00896B02 /* SwiftDescriptor.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SwiftDescriptor.swift; sourceTree = "<group>"; };
 		FA8A36172DEAA1EB0058D883 /* SentryThread+Private.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = "SentryThread+Private.h"; path = "include/SentryThread+Private.h"; sourceTree = "<group>"; };
 		FA90FAFC2E070A3B008CAAE8 /* SentryURLRequestFactory.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryURLRequestFactory.swift; sourceTree = "<group>"; };
+		FAB359972E05D7E90083D5E3 /* SentryEventSwiftHelper.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryEventSwiftHelper.h; path = include/SentryEventSwiftHelper.h; sourceTree = "<group>"; };
+		FAB359992E05D8080083D5E3 /* SentryEventSwiftHelper.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryEventSwiftHelper.m; sourceTree = "<group>"; };
 		FAEC270D2DF3526000878871 /* SentryUserFeedback.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryUserFeedback.swift; sourceTree = "<group>"; };
 		FAEC273C2DF3933200878871 /* NSData+Unzip.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "NSData+Unzip.m"; sourceTree = "<group>"; };
 		FAEC273E2DF393E000878871 /* NSData+Unzip.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "NSData+Unzip.h"; sourceTree = "<group>"; };
@@ -2796,6 +2800,8 @@
 				844EDC75294144DB00C86F34 /* SentrySystemWrapper.mm */,
 				844EDCE32947DC3100C86F34 /* SentryNSTimerFactory.h */,
 				844EDCE42947DC3100C86F34 /* SentryNSTimerFactory.m */,
+				FAB359972E05D7E90083D5E3 /* SentryEventSwiftHelper.h */,
+				FAB359992E05D8080083D5E3 /* SentryEventSwiftHelper.m */,
 				33042A0B29DAF5F400C60085 /* SentryExtraContextProvider.h */,
 				33042A0C29DAF79A00C60085 /* SentryExtraContextProvider.m */,
 				D858FA642A29EAB3002A3503 /* SentryBinaryImageCache.h */,
@@ -4781,6 +4787,7 @@
 				8E564AEF267AF24400FE117D /* SentryNetworkTracker.h in Headers */,
 				63FE715120DA4C1100CDBAE8 /* SentryCrashDebug.h in Headers */,
 				63FE70F520DA4C1000CDBAE8 /* SentryCrashMonitor_System.h in Headers */,
+				FAB359982E05D7E90083D5E3 /* SentryEventSwiftHelper.h in Headers */,
 				7B31C291277B04A000337126 /* SentryCrashPlatformSpecificDefines.h in Headers */,
 				D452FC732DDB553100AFF56F /* SentryWatchdogTerminationBreadcrumbProcessor.h in Headers */,
 				D456B4382D706BFE007068CB /* SentrySpanDataKey.h in Headers */,
@@ -5591,6 +5598,7 @@
 				63FE711520DA4C1000CDBAE8 /* SentryCrashJSONCodec.c in Sources */,
 				03F84D3327DD4191008FE43F /* SentryMachLogging.cpp in Sources */,
 				D85852BA27EDDC5900C6D8AE /* SentryUIApplication.m in Sources */,
+				FAB3599A2E05D8080083D5E3 /* SentryEventSwiftHelper.m in Sources */,
 				7B4E375F258231FC00059C93 /* SentryAttachment.m in Sources */,
 				636085141ED47BE600E8599E /* SentryFileManager.m in Sources */,
 				63FE710B20DA4C1000CDBAE8 /* SentryCrashMach.c in Sources */,

Sources/Sentry/SentryEventSwiftHelper.m

@@ -0,0 +1,24 @@
+#import "SentryEventSwiftHelper.h"
+#import "SentryEvent.h"
+#import "SentrySwift.h"
+
+// This helper is to bridge Swift and ObjC when building with SPM.
+// SPM cannot use Swift types in public ObjC APIs. Since SentryId
+// is Swift and SentryEvent is ObjC, Swift code built with SPM
+// cannot modify the eventId. This helper makes that possible.
+// Other solutions involve a force cast, forward declaring in ObjC
+// or re-writing in Swift. We will explore those in the future, but for
+// now this enables CI to build with SPM.
+@implementation SentryEventSwiftHelper
+
++ (void)setEventIdString:(NSString *)idString event:(SentryEvent *)event
+{
+    event.eventId = [[SentryId alloc] initWithUUIDString:idString];
+}
+
++ (NSString *)getEventIdString:(SentryEvent *)event
+{
+    return event.eventId.sentryIdString;
+}
+
+@end

Sources/Sentry/include/SentryEventSwiftHelper.h

@@ -0,0 +1,15 @@
+#import <Foundation/Foundation.h>
+
+@class SentryEvent;
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface SentryEventSwiftHelper : NSObject
+
++ (void)setEventIdString:(NSString *)idString event:(SentryEvent *)event;
+
++ (NSString *)getEventIdString:(SentryEvent *)event;
+
+@end
+
+NS_ASSUME_NONNULL_END

Sources/Sentry/include/SentryPrivate.h

@@ -3,6 +3,7 @@
 #import "NSLocale+Sentry.h"
 #import "SentryCrashExceptionApplicationHelper.h"
 #import "SentryDispatchQueueWrapper.h"
+#import "SentryEventSwiftHelper.h"
 #import "SentryNSDataUtils.h"
 #import "SentryRandom.h"
 #import "SentryTime.h"

Sources/Swift/Exports.swift

@@ -0,0 +1,8 @@
+// This file is only for SPM, it allows all Swift
+// files to use code in SentryHeaders without needing
+// to add an import. This allows the same source to
+// compile in SPM and xcodebuild (which doesn't separate
+// ObjC into the SentryHeaders target)
+#if SENTRY_SWIFT_PACKAGE
+@_exported import SentryHeaders
+#endif

Sources/Swift/Integrations/SessionReplay/SentryReplayEvent.swift

@@ -28,7 +28,7 @@ import Foundation
         self.segmentId = segmentId
 
         super.init()
-        self.eventId = eventId
+        SentryEventSwiftHelper.setEventIdString(eventId.sentryIdString, event: self)
         self.type = "replay_video"
     }
 
@@ -40,7 +40,7 @@ import Foundation
         var result = super.serialize()
         result["urls"] = urls
         result["replay_start_timestamp"] = replayStartTimestamp.timeIntervalSince1970
-        result["replay_id"] = eventId.sentryIdString
+        result["replay_id"] = SentryEventSwiftHelper.getEventIdString(self)
         result["segment_id"] = segmentId
         result["replay_type"] = replayType.toString()
         return result

Sources/Swift/Protocol/Codable/SentryBreadcrumbCodable.swift

@@ -1,7 +1,17 @@
 @_implementationOnly import _SentryPrivate
 import Foundation
 
-extension Breadcrumb: Decodable {
+// See `develop-docs/README.md` for an explanation of this pattern.
+#if SENTRY_SWIFT_PACKAGE
+final class BreadcrumbDecodable: Breadcrumb {
+    convenience public init(from decoder: any Decoder) throws {
+        try self.init(decodedFrom: decoder)
+    }
+}
+#else
+typealias BreadcrumbDecodable = Breadcrumb
+#endif
+extension BreadcrumbDecodable: Decodable {
 
     private enum CodingKeys: String, CodingKey {
         case level
@@ -13,7 +23,13 @@ extension Breadcrumb: Decodable {
         case origin
     }
 
+    #if !SENTRY_SWIFT_PACKAGE
     required convenience public init(from decoder: any Decoder) throws {
+        try self.init(decodedFrom: decoder)
+    }
+    #endif
+
+    private convenience init(decodedFrom decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
 
         self.init()

Sources/Swift/Protocol/Codable/SentryDebugMetaCodable.swift

@@ -1,7 +1,17 @@
 @_implementationOnly import _SentryPrivate
 import Foundation
 
-extension DebugMeta: Decodable {
+// See `develop-docs/README.md` for an explanation of this pattern.
+#if SENTRY_SWIFT_PACKAGE
+final class DebugMetaDecodable: DebugMeta {
+    convenience public init(from decoder: any Decoder) throws {
+        try self.init(decodedFrom: decoder)
+    }
+}
+#else
+typealias DebugMetaDecodable = DebugMeta
+#endif
+extension DebugMetaDecodable: Decodable {
 
     private enum CodingKeys: String, CodingKey {
         case uuid
@@ -14,7 +24,13 @@ extension DebugMeta: Decodable {
         case codeFile = "code_file"
     }
 
+    #if !SENTRY_SWIFT_PACKAGE
     required convenience public init(from decoder: any Decoder) throws {
+        try self.init(decodedFrom: decoder)
+    }
+    #endif
+
+    private convenience init(decodedFrom decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
 
         self.init()