configure url session on ios

denrase · denrase · commit 67c474f125d1 · 2024-07-29T16:49:00.000+02:00
diff --git a/dart/lib/src/http_client/io_client_provider.dart b/dart/lib/src/http_client/io_client_provider.dart
@@ -35,7 +35,7 @@ class IoClientProvider implements ClientProvider {
       return Client();
     }
     final pac = proxy.toPacString();
-    if (proxy.type == ProxyType.socks) {
+    if (proxy.type == SentryProxyType.socks) {
       options.logger(
         SentryLevel.warning,
         "Setting proxy '$pac' is not supported.",
diff --git a/dart/lib/src/protocol/sentry_proxy.dart b/dart/lib/src/protocol/sentry_proxy.dart
@@ -1,5 +1,5 @@
 class SentryProxy {
-  final ProxyType type;
+  final SentryProxyType type;
   final String? host;
   final int? port;
   final String? user;
@@ -10,12 +10,12 @@ class SentryProxy {
   String toPacString() {
     String type = 'DIRECT';
     switch (this.type) {
-      case ProxyType.direct:
+      case SentryProxyType.direct:
         return 'DIRECT';
-      case ProxyType.http:
+      case SentryProxyType.http:
         type = 'PROXY';
         break;
-      case ProxyType.socks:
+      case SentryProxyType.socks:
         type = 'SOCKS';
         break;
     }
@@ -42,7 +42,7 @@ class SentryProxy {
   SentryProxy copyWith({
     String? host,
     int? port,
-    ProxyType? type,
+    SentryProxyType? type,
     String? user,
     String? pass,
   }) =>
@@ -55,7 +55,7 @@ class SentryProxy {
       );
 }
 
-enum ProxyType {
+enum SentryProxyType {
   direct,
   http,
   socks;
diff --git a/dart/test/http_client/io_client_provider_test.dart b/dart/test/http_client/io_client_provider_test.dart
@@ -19,7 +19,7 @@ void main() {
 
     test('http proxy should call findProxyResult', () async {
       fixture.options.proxy = SentryProxy(
-        type: ProxyType.http,
+        type: SentryProxyType.http,
         host: 'localhost',
         port: 8080,
       );
@@ -32,7 +32,7 @@ void main() {
     });
 
     test('direct proxy should call findProxyResult', () async {
-      fixture.options.proxy = SentryProxy(type: ProxyType.direct);
+      fixture.options.proxy = SentryProxy(type: SentryProxyType.direct);
 
       final sut = fixture.getSut();
       sut.getClient(fixture.options);
@@ -43,7 +43,7 @@ void main() {
 
     test('socks proxy should not call findProxyResult', () async {
       fixture.options.proxy =
-          SentryProxy(type: ProxyType.socks, host: 'localhost', port: 8080);
+          SentryProxy(type: SentryProxyType.socks, host: 'localhost', port: 8080);
 
       final sut = fixture.getSut();
       sut.getClient(fixture.options);
@@ -53,7 +53,7 @@ void main() {
 
     test('authenticated proxy http should call addProxyCredentials', () async {
       fixture.options.proxy = SentryProxy(
-        type: ProxyType.http,
+        type: SentryProxyType.http,
         host: 'localhost',
         port: 8080,
         user: 'admin',
diff --git a/dart/test/protocol/sentry_proxy_test.dart b/dart/test/protocol/sentry_proxy_test.dart
@@ -6,7 +6,7 @@ void main() {
   final proxy = SentryProxy(
     host: 'localhost',
     port: 8080,
-    type: ProxyType.http,
+    type: SentryProxyType.http,
     user: 'admin',
     pass: '0000',
   );
@@ -21,40 +21,40 @@ void main() {
 
   group('toPacString', () {
     test('returns "DIRECT" for ProxyType.direct', () {
-      SentryProxy proxy = SentryProxy(type: ProxyType.direct);
+      SentryProxy proxy = SentryProxy(type: SentryProxyType.direct);
       expect(proxy.toPacString(), equals('DIRECT'));
     });
 
     test('returns "PROXY host:port" for ProxyType.http with host and port', () {
       SentryProxy proxy =
-          SentryProxy(type: ProxyType.http, host: 'localhost', port: 8080);
+          SentryProxy(type: SentryProxyType.http, host: 'localhost', port: 8080);
       expect(proxy.toPacString(), equals('PROXY localhost:8080'));
     });
 
     test('returns "PROXY host" for ProxyType.http with host only', () {
-      SentryProxy proxy = SentryProxy(type: ProxyType.http, host: 'localhost');
+      SentryProxy proxy = SentryProxy(type: SentryProxyType.http, host: 'localhost');
       expect(proxy.toPacString(), equals('PROXY localhost'));
     });
 
     test('returns "SOCKS host:port" for ProxyType.socks with host and port',
         () {
       SentryProxy proxy =
-          SentryProxy(type: ProxyType.socks, host: 'localhost', port: 8080);
+          SentryProxy(type: SentryProxyType.socks, host: 'localhost', port: 8080);
       expect(proxy.toPacString(), equals('SOCKS localhost:8080'));
     });
 
     test('returns "SOCKS host" for ProxyType.socks with host only', () {
-      SentryProxy proxy = SentryProxy(type: ProxyType.socks, host: 'localhost');
+      SentryProxy proxy = SentryProxy(type: SentryProxyType.socks, host: 'localhost');
       expect(proxy.toPacString(), equals('SOCKS localhost'));
     });
 
     test('falls back to "DIRECT" if http is missing host', () {
-      SentryProxy proxy = SentryProxy(type: ProxyType.http);
+      SentryProxy proxy = SentryProxy(type: SentryProxyType.http);
       expect(proxy.toPacString(), equals('DIRECT'));
     });
 
     test('falls back to "DIRECT" if socks is missing host', () {
-      SentryProxy proxy = SentryProxy(type: ProxyType.socks);
+      SentryProxy proxy = SentryProxy(type: SentryProxyType.socks);
       expect(proxy.toPacString(), equals('DIRECT'));
     });
   });
@@ -85,14 +85,14 @@ void main() {
       final copy = data.copyWith(
         host: 'localhost-2',
         port: 9001,
-        type: ProxyType.socks,
+        type: SentryProxyType.socks,
         user: 'user',
         pass: '1234',
       );
 
       expect('localhost-2', copy.host);
       expect(9001, copy.port);
-      expect(ProxyType.socks, copy.type);
+      expect(SentryProxyType.socks, copy.type);
       expect('user', copy.user);
       expect('1234', copy.pass);
     });
diff --git a/flutter/example/ios/RunnerTests/SentryFlutterTests.swift b/flutter/example/ios/RunnerTests/SentryFlutterTests.swift
@@ -43,7 +43,14 @@ final class SentryFlutterTests: XCTestCase {
                 "maxAttachmentSize": NSNumber(value: 9004),
                 "captureFailedRequests": false,
                 "enableAppHangTracking": false,
-                "appHangTimeoutIntervalMillis": NSNumber(value: 10000)
+                "appHangTimeoutIntervalMillis": NSNumber(value: 10000),
+                "proxy": [
+                    "host": "localhost",
+                    "port": NSNumber(value: 8080),
+                    "type": "hTtP", // mixed case to check enum mapping
+                    "user": "admin",
+                    "pass": "0000",
+                ]
             ]
         )
 
@@ -68,6 +75,41 @@ final class SentryFlutterTests: XCTestCase {
         XCTAssertEqual(false, fixture.options.enableCaptureFailedRequests)
         XCTAssertEqual(false, fixture.options.enableAppHangTracking)
         XCTAssertEqual(10, fixture.options.appHangTimeoutInterval)
+        
+        XCTAssertNotNil(fixture.options.urlSession)
+        XCTAssertEqual(true, fixture.options.urlSession?.configuration.connectionProxyDictionary?[kCFNetworkProxiesHTTPEnable as String] as? Bool)
+        XCTAssertEqual("localhost", fixture.options.urlSession?.configuration.connectionProxyDictionary?[kCFNetworkProxiesHTTPProxy as String] as? String)
+        XCTAssertEqual(8080, fixture.options.urlSession?.configuration.connectionProxyDictionary?[kCFNetworkProxiesHTTPPort as String] as? Int)
+        XCTAssertEqual("admin", fixture.options.urlSession?.configuration.connectionProxyDictionary?[kCFProxyUsernameKey as String] as? String)
+        XCTAssertEqual("0000", fixture.options.urlSession?.configuration.connectionProxyDictionary?[kCFProxyPasswordKey as String] as? String)
+    }
+    
+    func testUpdateSocksProxy() {
+        let sut = fixture.getSut()
+
+        sut.update(
+            options: fixture.options,
+            with: [
+                "proxy": [
+                    "host": "localhost",
+                    "port": 8080,
+                    "type": "sOcKs", // mixed case to check enum mapping
+                    "user": "admin",
+                    "pass": "0000",
+                ]
+            ]
+        )
+        
+        #if os(macOS)
+        XCTAssertNotNil(fixture.options.urlSession)
+        XCTAssertEqual(true, fixture.options.urlSession?.configuration.connectionProxyDictionary?[kCFNetworkProxiesSOCKSEnable as String] as? Bool)
+        XCTAssertEqual("localhost", fixture.options.urlSession?.configuration.connectionProxyDictionary?[kCFNetworkProxiesSOCKSProxy as String] as? String)
+        XCTAssertEqual(8080, fixture.options.urlSession?.configuration.connectionProxyDictionary?[kCFNetworkProxiesSOCKSPort as String] as? Int)
+        XCTAssertEqual("admin", fixture.options.urlSession?.configuration.connectionProxyDictionary?[kCFProxyUsernameKey as String] as? String)
+        XCTAssertEqual("0000", fixture.options.urlSession?.configuration.connectionProxyDictionary?[kCFProxyPasswordKey as String] as? String)
+        #else
+        XCTAssertNil(fixture.options.urlSession)
+        #endif
     }
 }
 
diff --git a/flutter/ios/Classes/SentryFlutter.swift b/flutter/ios/Classes/SentryFlutter.swift
@@ -70,6 +70,40 @@ public final class SentryFlutter {
         if let appHangTimeoutIntervalMillis = data["appHangTimeoutIntervalMillis"] as? NSNumber {
             options.appHangTimeoutInterval = appHangTimeoutIntervalMillis.doubleValue / 1000
         }
+        if let proxy = data["proxy"] as? [String: Any] {
+            guard let host = proxy["host"] as? String,
+                  let port = proxy["port"] as? Int,
+                  let type = proxy["type"] as? String else {
+                return
+            }
+            
+            var connectionProxyDictionary: [String: Any] = [:]
+            if type.lowercased() == "http" {
+                connectionProxyDictionary[kCFNetworkProxiesHTTPEnable as String] = true
+                connectionProxyDictionary[kCFNetworkProxiesHTTPProxy as String] = host
+                connectionProxyDictionary[kCFNetworkProxiesHTTPPort as String] = port
+            } else if type.lowercased() == "socks" {
+                #if os(macOS)
+                connectionProxyDictionary[kCFNetworkProxiesSOCKSEnable as String] = true
+                connectionProxyDictionary[kCFNetworkProxiesSOCKSProxy as String] = host
+                connectionProxyDictionary[kCFNetworkProxiesSOCKSPort as String] = port
+                #else
+                return
+                #endif
+            } else {
+                return
+            }
+            
+            if let user = proxy["user"] as? String, let pass = proxy["pass"] {
+                connectionProxyDictionary[kCFProxyUsernameKey as String] = user
+                connectionProxyDictionary[kCFProxyPasswordKey as String] = pass
+            }
+            
+            let configuration = URLSessionConfiguration.default
+            configuration.connectionProxyDictionary = connectionProxyDictionary
+            
+            options.urlSession = URLSession(configuration: configuration)
+        }
     }
 
     private func logLevelFrom(diagnosticLevel: String) -> SentryLevel {
diff --git a/flutter/test/integrations/init_native_sdk_test.dart b/flutter/test/integrations/init_native_sdk_test.dart
@@ -108,7 +108,7 @@ void main() {
       ..proxy = SentryProxy(
         host: "localhost",
         port: 8080,
-        type: ProxyType.http,
+        type: SentryProxyType.http,
         user: 'admin',
         pass: '0000',
       );

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ class IoClientProvider implements ClientProvider {`
`35`	`35`	`return Client();`
`36`	`36`	`}`
`37`	`37`	`final pac = proxy.toPacString();`
`38`		`- if (proxy.type == ProxyType.socks) {`
	`38`	`+ if (proxy.type == SentryProxyType.socks) {`
`39`	`39`	`options.logger(`
`40`	`40`	`SentryLevel.warning,`
`41`	`41`	`"Setting proxy '$pac' is not supported.",`