[WIP] Convert url request to Swift

CHANGELOG.md

@@ -18,6 +18,7 @@
 - Crashes for uncaught NSExceptions will now report the stracktrace recorded within the exception (#5306)
 - Move SentryExperimentalOptions to a property defined in Swift (#5329)
 - Add redaction in session replay for `SFSafariView` used by `SFSafariViewController` and `ASWebAuthenticationSession` (#5408)
+- Convert SentryNSURLRequest to Swift (#5451)
 
 ### Fixes
 

Sources/Sentry/SentryHttpTransport.m

@@ -15,8 +15,6 @@
 #import "SentryEvent.h"
 #import "SentryFileManager.h"
 #import "SentryLog.h"
-#import "SentryNSURLRequest.h"
-#import "SentryNSURLRequestBuilder.h"
 #import "SentryOptions.h"
 #import "SentrySerialization.h"
 #import "SentrySwift.h"
@@ -339,14 +337,13 @@ - (void)sendAllCachedEnvelopes
     rateLimitedEnvelope.header.sentAt = SentryDependencyContainer.sharedInstance.dateProvider.date;
 
     NSError *requestError = nil;
-    NSURLRequest *request = [self.requestBuilder createEnvelopeRequest:rateLimitedEnvelope
-                                                                   dsn:self.options.parsedDsn
-                                                      didFailWithError:&requestError];
+    NSURLRequest *request =
+        [self.requestBuilder createEnvelopeRequestWithEnvelope:rateLimitedEnvelope
+                                                           dsn:self.options.parsedDsn
+                                                         error:&requestError];
 
-    if (nil == request || nil != requestError) {
-        if (nil != requestError) {
-            SENTRY_LOG_DEBUG(@"Failed to build request: %@.", requestError);
-        }
+    if (nil != requestError) {
+        SENTRY_LOG_DEBUG(@"Failed to build request: %@.", requestError);
         [self recordLostEventFor:rateLimitedEnvelope.items];
         [self deleteEnvelopeAndSendNext:envelopeFilePath];
         return;

Sources/Sentry/SentrySpotlightTransport.m

@@ -4,10 +4,9 @@
 #import "SentryEnvelopeItemHeader.h"
 #import "SentryEnvelopeItemType.h"
 #import "SentryLog.h"
-#import "SentryNSURLRequest.h"
-#import "SentryNSURLRequestBuilder.h"
 #import "SentryOptions.h"
 #import "SentrySerialization.h"
+#import "SentrySwift.h"
 #import "SentryTransport.h"
 
 NS_ASSUME_NONNULL_BEGIN
@@ -66,14 +65,12 @@ - (void)sendEnvelope:(SentryEnvelope *)envelope
                                                                       items:allowedEnvelopeItems];
 
     NSError *requestError = nil;
-    NSURLRequest *request = [self.requestBuilder createEnvelopeRequest:envelopeToSend
-                                                                   url:self.apiURL
-                                                      didFailWithError:&requestError];
+    NSURLRequest *request = [self.requestBuilder createEnvelopeRequestWithEnvelope:envelopeToSend
+                                                                               url:self.apiURL
+                                                                             error:&requestError];
 
-    if (nil == request || nil != requestError) {
-        if (nil != requestError) {
-            SENTRY_LOG_ERROR(@"Unable to build envelope request with error %@", requestError);
-        }
+    if (nil != requestError) {
+        SENTRY_LOG_ERROR(@"Unable to build envelope request with error %@", requestError);
         return;
     }
 

Sources/Sentry/SentryTransportFactory.m

@@ -4,14 +4,14 @@
 #import "SentryEnvelopeRateLimit.h"
 #import "SentryHttpDateParser.h"
 #import "SentryHttpTransport.h"
-#import "SentryNSURLRequestBuilder.h"
 #import "SentryOptions.h"
 #import "SentryQueueableRequestManager.h"
 #import "SentryRateLimitParser.h"
 #import "SentryRateLimits.h"
 
 #import "SentryRetryAfterHeaderParser.h"
 #import "SentrySpotlightTransport.h"
+#import "SentrySwift.h"
 #import "SentryTransport.h"
 
 NS_ASSUME_NONNULL_BEGIN

Sources/Sentry/include/SentryPrivate.h

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

Sources/Swift/Tools/SentryURLRequestBuilder.swift

@@ -0,0 +1,27 @@
+@_implementationOnly import _SentryPrivate
+
+private enum Error: Swift.Error {
+    case serializationError
+}
+
+@objc(SentryNSURLRequestBuilder)
+@_spi(Private) public class SentryURLRequestBuilder: NSObject {
+
+    @objc
+    public func createEnvelopeRequest(envelope: SentryEnvelope, dsn: SentryDsn) throws -> URLRequest {
+        guard let data = SentrySerialization.data(with: envelope) else {
+            SentryLog.error("Envelope cannot be converted to data")
+            throw Error.serializationError
+        }
+        return try SentryURLRequestFactory.envelopeRequest(with: dsn, data: data)
+    }
+
+    @objc
+    public func createEnvelopeRequest(envelope: SentryEnvelope, url: URL) throws -> URLRequest {
+        guard let data = SentrySerialization.data(with: envelope) else {
+            SentryLog.error("Envelope cannot be converted to data")
+            throw Error.serializationError
+        }
+        return try SentryURLRequestFactory.envelopeRequest(with: url, data: data, authHeader: nil)
+    }
+}

Sources/Swift/Tools/SentryURLRequestFactory.swift

@@ -0,0 +1,60 @@
+@_implementationOnly import _SentryPrivate
+import Foundation
+
+private enum Error: Swift.Error {
+    case jsonConversionError
+}
+
+enum SentryURLRequestFactory {
+
+    private static let serverVersionString = "7"
+    private static let requestTimeout: TimeInterval = 15
+
+    static func envelopeRequest(with dsn: SentryDsn, data: Data) throws -> URLRequest {
+        let apiURL = dsn.getEnvelopeEndpoint()
+        let authHeader = Self.newAuthHeader(url: dsn.url)
+
+        return try Self.envelopeRequest(with: apiURL, data: data, authHeader: authHeader)
+    }
+
+    static func envelopeRequest(with url: URL, data: Data, authHeader: String?) throws -> URLRequest {
+        var request = URLRequest(url: url, cachePolicy: .reloadIgnoringLocalCacheData, timeoutInterval: Self.requestTimeout)
+
+        request.httpMethod = "POST"
+
+        if let authHeader = authHeader {
+            request.setValue(authHeader, forHTTPHeaderField: "X-Sentry-Auth")
+        }
+        request.setValue("application/x-sentry-envelope", forHTTPHeaderField: "Content-Type")
+        request.setValue("\(SentryMeta.sdkName)/\(SentryMeta.versionString)", forHTTPHeaderField: "User-Agent")
+        request.setValue("gzip", forHTTPHeaderField: "Content-Encoding")
+
+        var error: NSError?
+        let data = sentry_gzippedWithCompressionLevel(data, -1, &error)
+        if let error {
+            SentryLog.log(message: "Failed to compress envelope request body: \(error)", andLevel: .error)
+            throw error
+        }
+        request.httpBody = data
+
+        SentryLog.log(message: "Constructed request: \(self)", andLevel: .debug)
+        return request
+    }
+
+    private static func newHeaderPart(key: String, value: Any) -> String {
+        return "\(key)=\(value)"
+    }
+
+    private static func newAuthHeader(url: URL) -> String {
+        var string = "Sentry "
+        string += newHeaderPart(key: "sentry_version", value: serverVersionString) + ","
+        string += newHeaderPart(key: "sentry_client", value: "\(SentryMeta.sdkName)/\(SentryMeta.versionString)") + ","
+        string += newHeaderPart(key: "sentry_key", value: url.user ?? "")
+
+        if let password = url.password {
+            string += "," + newHeaderPart(key: "sentry_secret", value: password)
+        }
+
+        return string
+    }
+}

Tests/SentryTests/Networking/SentryDsnTests.m

@@ -1,8 +1,8 @@
 #import "SentryDsn.h"
 #import "SentryError.h"
 #import "SentryMeta.h"
-#import "SentryNSURLRequest.h"
 #import "SentryOptions+HybridSDKs.h"
+#import "SentrySwift.h"
 #import <XCTest/XCTest.h>
 
 @interface SentryDsnTests : XCTestCase