ref: Convert more data serialization to Swift (#6196)

* ref: Convert more data serialization to Swift

* Add comment

Author: noahsmartin

Sources/Sentry/Processors/SentryWatchdogTerminationBreadcrumbProcessor.m

@@ -3,6 +3,7 @@
 #import "SentryInternalDefines.h"
 #import "SentryLogC.h"
 #import "SentrySerialization.h"
+#import "SentrySwift.h"
 
 @interface SentryWatchdogTerminationBreadcrumbProcessor ()
 
@@ -40,7 +41,7 @@ - (void)dealloc
 - (void)addSerializedBreadcrumb:(NSDictionary *)crumb
 {
     SENTRY_LOG_DEBUG(@"Adding breadcrumb: %@", crumb);
-    NSData *_Nullable jsonData = [SentrySerialization dataWithJSONObject:crumb];
+    NSData *_Nullable jsonData = [SentrySerializationSwift dataWithJSONObject:crumb];
     if (jsonData == nil) {
         SENTRY_LOG_ERROR(@"Error serializing breadcrumb to JSON");
         return;

Sources/Sentry/Profiling/SentryProfilerSerialization.m

@@ -331,7 +331,7 @@
         return nil;
     }
 
-    NSData *JSONData = [SentrySerialization dataWithJSONObject:payload];
+    NSData *JSONData = [SentrySerializationSwift dataWithJSONObject:payload];
     if (JSONData == nil) {
         SENTRY_LOG_DEBUG(@"Failed to encode profile to JSON.");
         return nil;
@@ -396,7 +396,7 @@
     payload[@"transaction"] = transactionDict;
     payload[@"timestamp"] = sentry_toIso8601String(startTimestamp);
 
-    NSData *JSONData = [SentrySerialization dataWithJSONObject:payload];
+    NSData *JSONData = [SentrySerializationSwift dataWithJSONObject:payload];
     if (JSONData == nil) {
         SENTRY_LOG_DEBUG(@"Failed to encode profile to JSON.");
         return nil;

Sources/Sentry/SentryBaseIntegration.m

@@ -187,6 +187,8 @@ - (BOOL)shouldBeEnabledWithOptions:(SentryOptions *)options
             = !options.enableAutoPerformanceTracing || !options.isTracingEnabled;
         BOOL appHangsV2Disabled = options.isAppHangTrackingV2Disabled;
 #    if SDK_V9
+        // The V9 watchdog tracker uses the frames tracker, so frame tracking
+        // must be enabled if watchdog tracking is enabled.
         BOOL watchdogDisabled = !options.enableWatchdogTerminationTracking;
 #    else
         // Before V9 this should have no effect so set it to YES

Sources/Sentry/SentryFileManager.m

@@ -218,7 +218,7 @@ - (NSURL *)getSentryPathAsURL
 
 - (nullable NSString *)storeEnvelope:(SentryEnvelope *)envelope
 {
-    NSData *envelopeData = [SentrySerialization dataWithEnvelope:envelope];
+    NSData *envelopeData = [SentrySerializationSwift dataWithEnvelope:envelope];
 
     if (envelopeData == nil) {
         SENTRY_LOG_ERROR(@"Serialization of envelope failed. Can't store envelope.");
@@ -414,7 +414,7 @@ - (NSDate *_Nullable)readTimestampLastInForeground
 
 - (void)storeAppState:(SentryAppState *)appState
 {
-    NSData *data = [SentrySerialization dataWithJSONObject:[appState serialize]];
+    NSData *data = [SentrySerializationSwift dataWithJSONObject:[appState serialize]];
 
     if (data == nil) {
         SENTRY_LOG_ERROR(@"Failed to store app state, because of an error in serialization");
@@ -582,7 +582,7 @@ - (void)deleteTimezoneOffset
 
 - (void)storeAppHangEvent:(SentryEvent *)appHangEvent
 {
-    NSData *jsonData = [SentrySerialization dataWithJSONObject:[appHangEvent serialize]];
+    NSData *jsonData = [SentrySerializationSwift dataWithJSONObject:[appHangEvent serialize]];
     if (jsonData == nil) {
         SENTRY_LOG_ERROR(@"Failed to store app hang event, because of an error in serialization.");
         return;
@@ -943,7 +943,7 @@ - (BOOL)isDirectory:(NSString *)path
 
 - (void)storeSession:(SentrySession *)session sessionFilePath:(NSString *)sessionFilePath
 {
-    NSData *sessionData = [SentrySerialization dataWithSession:session];
+    NSData *sessionData = [SentrySerializationSwift dataWithSession:session];
     SENTRY_LOG_DEBUG(@"Writing session: %@", sessionFilePath);
     @synchronized(self.currentSessionFilePath) {
         if (![self writeData:sessionData toPath:sessionFilePath]) {

Sources/Sentry/SentryMigrateSessionInit.m

@@ -109,7 +109,8 @@ + (void)storeSessionInit:(SentryEnvelope *)originalEnvelope
                                          items:envelopeItemsWithUpdatedSession];
 
     NSError *error;
-    NSData *envelopeWithInitFlagData = [SentrySerialization dataWithEnvelope:envelopeWithInitFlag];
+    NSData *envelopeWithInitFlagData =
+        [SentrySerializationSwift dataWithEnvelope:envelopeWithInitFlag];
     [envelopeWithInitFlagData writeToFile:envelopeFilePath
                                   options:NSDataWritingAtomic
                                     error:&error];

Sources/Sentry/SentryNSURLRequestBuilder.m

@@ -12,7 +12,7 @@ - (nullable NSURLRequest *)createEnvelopeRequest:(SentryEnvelope *)envelope
                                              dsn:(SentryDsn *)dsn
                                 didFailWithError:(NSError *_Nullable *_Nullable)error
 {
-    NSData *data = [SentrySerialization dataWithEnvelope:envelope];
+    NSData *data = [SentrySerializationSwift dataWithEnvelope:envelope];
     if (nil == data) {
         SENTRY_LOG_ERROR(@"Envelope cannot be converted to data");
         return nil;
@@ -24,7 +24,7 @@ - (nullable NSURLRequest *)createEnvelopeRequest:(SentryEnvelope *)envelope
                                              url:(NSURL *)url
                                 didFailWithError:(NSError *_Nullable *_Nullable)error
 {
-    NSData *data = [SentrySerialization dataWithEnvelope:envelope];
+    NSData *data = [SentrySerializationSwift dataWithEnvelope:envelope];
     if (nil == data) {
         SENTRY_LOG_ERROR(@"Envelope cannot be converted to data");
         return nil;

Sources/Sentry/SentrySerialization.m

@@ -13,74 +13,6 @@
 
 @implementation SentrySerialization
 
-+ (NSData *_Nullable)dataWithJSONObject:(id)jsonObject
-{
-    if (![NSJSONSerialization isValidJSONObject:jsonObject]) {
-        SENTRY_LOG_ERROR(@"Dictionary is not a valid JSON object.");
-        return nil;
-    }
-
-    NSError *error = nil;
-    NSData *data = [NSJSONSerialization dataWithJSONObject:jsonObject options:0 error:&error];
-    if (error) {
-        SENTRY_LOG_ERROR(@"Internal error while serializing JSON: %@", error);
-    }
-
-    return data;
-}
-
-+ (NSData *_Nullable)dataWithEnvelope:(SentryEnvelope *)envelope
-{
-    NSMutableData *envelopeData = [[NSMutableData alloc] init];
-    NSMutableDictionary *serializedData = [NSMutableDictionary new];
-    if (nil != envelope.header.eventId) {
-        [serializedData setValue:[envelope.header.eventId sentryIdString] forKey:@"event_id"];
-    }
-
-    SentrySdkInfo *sdkInfo = envelope.header.sdkInfo;
-    if (nil != sdkInfo) {
-        [serializedData setValue:[sdkInfo serialize] forKey:@"sdk"];
-    }
-
-    SentryTraceContext *traceContext = envelope.header.traceContext;
-    if (traceContext != nil) {
-        [serializedData setValue:[traceContext serialize] forKey:@"trace"];
-    }
-
-    NSDate *sentAt = envelope.header.sentAt;
-    if (sentAt != nil) {
-        [serializedData setValue:sentry_toIso8601String(sentAt) forKey:@"sent_at"];
-    }
-    NSData *header = [SentrySerialization dataWithJSONObject:serializedData];
-    if (nil == header) {
-        SENTRY_LOG_ERROR(@"Envelope header cannot be converted to JSON.");
-        return nil;
-    }
-    [envelopeData appendData:header];
-
-    NSData *_Nonnull const newLineData = [NSData dataWithBytes:"\n" length:1];
-    for (int i = 0; i < envelope.items.count; ++i) {
-        [envelopeData appendData:newLineData];
-        NSDictionary *serializedItemHeaderData = [envelope.items[i].header serialize];
-
-        NSData *itemHeader = [SentrySerialization dataWithJSONObject:serializedItemHeaderData];
-        if (nil == itemHeader) {
-            SENTRY_LOG_ERROR(@"Envelope item header cannot be converted to JSON.");
-            return nil;
-        }
-        [envelopeData appendData:itemHeader];
-        [envelopeData appendData:newLineData];
-        [envelopeData appendData:envelope.items[i].data];
-    }
-
-    return envelopeData;
-}
-
-+ (NSData *_Nullable)dataWithSession:(SentrySession *)session
-{
-    return [self dataWithJSONObject:[session serialize]];
-}
-
 + (NSDictionary *_Nullable)deserializeDictionaryFromJsonData:(NSData *)data
 {
     NSError *error = nil;

Sources/Sentry/SentrySessionReplayIntegration.m

@@ -451,7 +451,7 @@ - (void)saveCurrentSessionInfo:(SentryId *)sessionId
         [[NSDictionary alloc] initWithObjectsAndKeys:sessionId.sentryIdString, @"replayId",
             path.lastPathComponent, @"path", @(options.onErrorSampleRate), @"errorSampleRate", nil];
 
-    NSData *data = [SentrySerialization dataWithJSONObject:info];
+    NSData *data = [SentrySerializationSwift dataWithJSONObject:info];
 
     NSString *infoPath = [[path stringByDeletingLastPathComponent]
         stringByAppendingPathComponent:SENTRY_CURRENT_REPLAY];

Sources/Sentry/include/SentryModels+Serializable.h

@@ -18,6 +18,8 @@
 #    import "SentryTraceContext.h"
 #    import "SentryUser.h"
 
+NS_ASSUME_NONNULL_BEGIN
+
 @interface SentryScope () <SentryInternalSerializable>
 
 @end
@@ -56,6 +58,8 @@
 
 @interface SentryEnvelopeItemHeader () <SentryInternalSerializable>
 
+- (NSDictionary<NSString *, id> *)serialize;
+
 @end
 
 @interface SentryFrame () <SentryInternalSerializable>
@@ -72,6 +76,8 @@
 
 @interface SentryTraceContext () <SentryInternalSerializable>
 
+- (NSDictionary<NSString *, id> *)serialize;
+
 @end
 
 @interface SentryMessage () <SentryInternalSerializable>
@@ -90,4 +96,6 @@
 
 @end
 
+NS_ASSUME_NONNULL_END
+
 #endif // SDK_V9

Sources/Sentry/include/SentryPrivate.h

@@ -35,6 +35,7 @@
 #import "SentryFileManager.h"
 #import "SentryLevelHelper.h"
 #import "SentryMeta.h"
+#import "SentryModels+Serializable.h"
 #import "SentryMsgPackSerializer.h"
 #import "SentryNSDictionarySanitize.h"
 #import "SentryOptions+Private.h"