ref: Rename SentryClient and SentryUser (#2403)

brustolin · web-flow · commit 1ce879f30ae3 · 2022-11-22T18:15:54.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,8 @@ This version adds a dependency on Swift.
 - Make `SpanProtocol.data` non nullable (#2409)
 - Mark `- [SpanProtocol setExtraValue:forKey:]` as deprecated (#2413)
 - Bump minimum supported OS versions to macOS 10.13, iOS 11, tvOS 11, and watchOS 4 (#2414)
+- Renaming Client to SentryClient for Swift (#2403)
+- Renaming User to SentryUser for Swift (#2403)
 
 ## 7.31.2
 
diff --git a/Samples/iOS-Swift/iOS-Swift/ViewController.swift b/Samples/iOS-Swift/iOS-Swift/ViewController.swift
@@ -20,7 +20,7 @@ class ViewController: UIViewController {
             scope.setTag(value: "swift", key: "language")
             scope.setExtra(value: String(describing: self), key: "currentViewController")
 
-            let user = Sentry.User(userId: "1")
+            let user = SentryUser(userId: "1")
             user.email = "tony@example.com"
             scope.setUser(user)
             
@@ -33,7 +33,7 @@ class ViewController: UIViewController {
         }
 
         // Also works
-        let user = Sentry.User(userId: "1")
+        let user = SentryUser(userId: "1")
         user.email = "tony1@example.com"
         SentrySDK.setUser(user)
         
diff --git a/Sources/Sentry/Public/SentryClient.h b/Sources/Sentry/Public/SentryClient.h
@@ -5,7 +5,6 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-NS_SWIFT_NAME(Client)
 @interface SentryClient : NSObject
 SENTRY_NO_INIT
 
diff --git a/Sources/Sentry/Public/SentryUser.h b/Sources/Sentry/Public/SentryUser.h
@@ -3,7 +3,6 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-NS_SWIFT_NAME(User)
 @interface SentryUser : NSObject <SentrySerializable, NSCopying>
 
 /**
diff --git a/Tests/SentryTests/Integrations/Breadcrumbs/SentrySystemEventBreadcrumbsTest.swift b/Tests/SentryTests/Integrations/Breadcrumbs/SentrySystemEventBreadcrumbsTest.swift
@@ -22,7 +22,7 @@ class SentrySystemEventBreadcrumbsTest: XCTestCase {
         }
 
         func getSut(scope: Scope, currentDevice: UIDevice? = UIDevice.current) -> SentrySystemEventBreadcrumbs {
-            let client = Client(options: self.options)
+            let client = SentryClient(options: self.options)
             let hub = SentryHub(client: client, andScope: scope)
             SentrySDK.setCurrentHub(hub)
 
diff --git a/Tests/SentryTests/Integrations/SentryCrash/SentryCrashIntegrationTests.swift b/Tests/SentryTests/Integrations/SentryCrash/SentryCrashIntegrationTests.swift
@@ -22,7 +22,7 @@ class SentryCrashIntegrationTests: NotificationCenterTestCase {
             options.dsn = SentryCrashIntegrationTests.dsnAsString
             options.releaseName = TestData.appState.releaseName
             
-            let client = Client(options: options, permissionsObserver: TestSentryPermissionsObserver())
+            let client = SentryClient(options: options, permissionsObserver: TestSentryPermissionsObserver())
             hub = TestHub(client: client, andScope: nil)
         }
         
@@ -278,7 +278,7 @@ class SentryCrashIntegrationTests: NotificationCenterTestCase {
         api?.pointee.setEnabled(true)
         
         let transport = TestTransport()
-        let client = Client(options: fixture.options)
+        let client = SentryClient(options: fixture.options)
         Dynamic(client).transportAdapter = TestTransportAdapter(transport: transport, options: fixture.options)
         hub.bindClient(client)
         
diff --git a/Tests/SentryTests/Protocol/SentryUserTests.swift b/Tests/SentryTests/Protocol/SentryUserTests.swift
@@ -3,7 +3,7 @@ import XCTest
 class SentryUserTests: XCTestCase {
 
     func testSerializationWithAllProperties() {
-        let user = TestData.user.copy() as! User
+        let user = TestData.user.copy() as! SentryUser
         let actual = user.serialize()
 
         // Changing the original doesn't modify the serialized
@@ -23,15 +23,15 @@ class SentryUserTests: XCTestCase {
     }
     
     func testSerializationWithOnlyId() {
-        let user = User(userId: "someid")
+        let user = SentryUser(userId: "someid")
         let actual = user.serialize()
         
         XCTAssertEqual(user.userId, actual["id"] as? String)
         XCTAssertEqual(1, actual.count)
     }
 
     func testSerializationWithoutId() {
-        let user = User()
+        let user = SentryUser()
         let actual = user.serialize()
 
         XCTAssertNil(actual["id"] as? String)
@@ -55,7 +55,7 @@ class SentryUserTests: XCTestCase {
     }
     
     func testIsEqualToCopy() {
-        XCTAssertEqual(TestData.user, TestData.user.copy() as! User)
+        XCTAssertEqual(TestData.user, TestData.user.copy() as! SentryUser)
     }
     
     func testNotIsEqual() {
@@ -67,15 +67,15 @@ class SentryUserTests: XCTestCase {
         testIsNotEqual { user in user.data?.removeAll() }
     }
     
-    func testIsNotEqual(block: (User) -> Void ) {
-        let user = TestData.user.copy() as! User
+    func testIsNotEqual(block: (SentryUser) -> Void ) {
+        let user = TestData.user.copy() as! SentryUser
         block(user)
         XCTAssertNotEqual(TestData.user, user)
     }
     
     func testCopyWithZone_CopiesDeepCopy() {
         let user = TestData.user
-        let copiedUser = user.copy() as! User
+        let copiedUser = user.copy() as! SentryUser
         
         // Modifying the original does not change the copy
         user.userId = ""
@@ -95,7 +95,7 @@ class SentryUserTests: XCTestCase {
         let queue = DispatchQueue(label: "SentryScopeTests", qos: .userInteractive, attributes: [.concurrent, .initiallyInactive])
         let group = DispatchGroup()
         
-        let user = TestData.user.copy() as! User
+        let user = TestData.user.copy() as! SentryUser
         
         for i in 0...20 {
             group.enter()
diff --git a/Tests/SentryTests/Protocol/TestData.swift b/Tests/SentryTests/Protocol/TestData.swift
@@ -55,8 +55,8 @@ class TestData {
         return event
     }
     
-    static var user: User {
-        let user = User(userId: "id")
+    static var user: SentryUser {
+        let user = SentryUser(userId: "id")
         user.email = "user@sentry.io"
         user.username = "user123"
         user.ipAddress = "127.0.0.1"
diff --git a/Tests/SentryTests/SentryClientTests.swift b/Tests/SentryTests/SentryClientTests.swift
@@ -21,7 +21,7 @@ class SentryClientTest: XCTestCase {
         let messageAsString = "message"
         let message: SentryMessage
         
-        let user: User
+        let user: SentryUser
         let fileManager: SentryFileManager
         let random = TestRandom(value: 1.0)
         
@@ -43,7 +43,7 @@ class SentryClientTest: XCTestCase {
             event = Event()
             event.message = message
             
-            user = User()
+            user = SentryUser()
             user.email = "someone@sentry.io"
             user.ipAddress = "127.0.0.1"
             
@@ -57,13 +57,13 @@ class SentryClientTest: XCTestCase {
             transportAdapter = TestTransportAdapter(transport: transport, options: options)
         }
 
-        func getSut(configureOptions: (Options) -> Void = { _ in }) -> Client {
-            var client: Client!
+        func getSut(configureOptions: (Options) -> Void = { _ in }) -> SentryClient {
+            var client: SentryClient!
             do {
                 let options = try Options(dsn: SentryClientTest.dsn)
                 configureOptions(options)
 
-                client = Client(
+                client = SentryClient(
                     options: options,
                     transportAdapter: transportAdapter,
                     fileManager: fileManager,
@@ -82,13 +82,13 @@ class SentryClientTest: XCTestCase {
             return client
         }
 
-        func getSutWithNoDsn() -> Client {
+        func getSutWithNoDsn() -> SentryClient {
             getSut(configureOptions: { options in
                 options.parsedDsn = nil
             })
         }
         
-        func getSutDisabledSdk() -> Client {
+        func getSutDisabledSdk() -> SentryClient {
             getSut(configureOptions: { options in
                 options.enabled = false
             })
@@ -1106,7 +1106,7 @@ class SentryClientTest: XCTestCase {
         
         let options = Options()
         options.dsn = SentryClientTest.dsn
-        let client = Client(options: options, permissionsObserver: TestSentryPermissionsObserver())
+        let client = SentryClient(options: options, permissionsObserver: TestSentryPermissionsObserver())
         
         XCTAssertNil(client)
         
@@ -1342,7 +1342,7 @@ class SentryClientTest: XCTestCase {
         return event
     }
     
-    private func beforeSendReturnsNil(capture: (Client) -> Void) {
+    private func beforeSendReturnsNil(capture: (SentryClient) -> Void) {
         capture(fixture.getSut(configureOptions: { options in
             options.beforeSend = { _ in
                 nil
diff --git a/Tests/SentryTests/SentryHubTests.swift b/Tests/SentryTests/SentryHubTests.swift
@@ -178,10 +178,10 @@ class SentryHubTests: XCTestCase {
     }
     
     func testAddUserToTheScope() {
-        let client = Client(options: fixture.options)
+        let client = SentryClient(options: fixture.options)
         let hub = SentryHub(client: client, andScope: Scope())
 
-        let user = User()
+        let user = SentryUser()
         user.userId = "123"
         hub.setUser(user)
 
diff --git a/Tests/SentryTests/SentrySDKTests.swift b/Tests/SentryTests/SentrySDKTests.swift
@@ -499,7 +499,7 @@ class SentrySDKTests: XCTestCase {
         }
         
         let transport = TestTransport()
-        let client = Client(options: fixture.options)
+        let client = SentryClient(options: fixture.options)
         Dynamic(client).transportAdapter = TestTransportAdapter(transport: transport, options: fixture.options)
         SentrySDK.currentHub().bindClient(client)
         
diff --git a/Tests/SentryTests/SentryScopeSwiftTests.swift b/Tests/SentryTests/SentryScopeSwiftTests.swift
@@ -3,7 +3,7 @@ import XCTest
 class SentryScopeSwiftTests: XCTestCase {
 
     private class Fixture {
-        let user: User
+        let user: SentryUser
         let breadcrumb: Breadcrumb
         let scope: Scope
         let date: Date
@@ -25,7 +25,7 @@ class SentryScopeSwiftTests: XCTestCase {
         init() {
             date = Date(timeIntervalSince1970: 10)
             
-            user = User(userId: "id")
+            user = SentryUser(userId: "id")
             user.email = "user@sentry.io"
             user.username = "user123"
             user.ipAddress = ipAddress
@@ -85,7 +85,7 @@ class SentryScopeSwiftTests: XCTestCase {
         scope.setTag(value: "another", key: "another")
         scope.setExtra(value: "another", key: "another")
         scope.setContext(value: ["": 1], key: "another")
-        scope.setUser(User())
+        scope.setUser(SentryUser())
         scope.setDist("")
         scope.setEnvironment("")
         scope.setFingerprint([])
@@ -558,8 +558,8 @@ class SentryScopeSwiftTests: XCTestCase {
             clearInvocations += 1
         }
         
-        var user: User?
-        func setUser(_ user: User?) {
+        var user: SentryUser?
+        func setUser(_ user: SentryUser?) {
             self.user = user
         }
     }
diff --git a/Tests/SentryTests/SentrySessionTests.swift b/Tests/SentryTests/SentrySessionTests.swift
@@ -38,7 +38,7 @@ class SentrySessionTestsSwift: XCTestCase {
     }
 
     func testCopySession() {
-        let user = User()
+        let user = SentryUser()
         user.email = "someone@sentry.io"
 
         let session = SentrySession(releaseName: "1.0.0")
diff --git a/Tests/SentryTests/TestClient.swift b/Tests/SentryTests/TestClient.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-class TestClient: Client {
+class TestClient: SentryClient {
     let sentryFileManager: SentryFileManager
 
     override init?(options: Options) {
diff --git a/Tests/SentryTests/Transaction/SentrySpanTests.swift b/Tests/SentryTests/Transaction/SentrySpanTests.swift
@@ -27,7 +27,7 @@ class SentrySpanTests: XCTestCase {
             return getSut(client: TestClient(options: options)!)
         }
         
-        func getSut(client: Client) -> Span {
+        func getSut(client: SentryClient) -> Span {
             let hub = SentryHub(client: client, andScope: nil, andCrashWrapper: TestSentryCrashWrapper.sharedInstance(), andCurrentDateProvider: currentDateProvider)
             return hub.startTransaction(name: someTransaction, operation: someOperation)
         }
diff --git a/Tests/SentryTests/Transaction/SentryTraceStateTests.swift b/Tests/SentryTests/Transaction/SentryTraceStateTests.swift
@@ -28,7 +28,7 @@ class SentryTraceContextTests: XCTestCase {
             tracer = SentryTracer(transactionContext: TransactionContext(name: transactionName, operation: transactionOperation), hub: nil)
             
             scope = Scope()
-            scope.setUser(User(userId: userId))
+            scope.setUser(SentryUser(userId: userId))
             scope.userObject?.segment = userSegment
             scope.span = tracer
             

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class SentrySystemEventBreadcrumbsTest: XCTestCase {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`func getSut(scope: Scope, currentDevice: UIDevice? = UIDevice.current) -> SentrySystemEventBreadcrumbs {`
`25`		`- let client = Client(options: self.options)`
	`25`	`+ let client = SentryClient(options: self.options)`
`26`	`26`	`let hub = SentryHub(client: client, andScope: scope)`
`27`	`27`	`SentrySDK.setCurrentHub(hub)`
`28`	`28`