fix: Making APIKeyBasedConnectionPool thread safe

awslabs · May 10, 2024 · f94828f · f94828f
1 parent c37e6f0
commit f94828f
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 30 deletions.
diff --git a/AWSAppSyncClient/Internal/SubscriptionFactory/APIKeyBasedConnectionPool.swift b/AWSAppSyncClient/Internal/SubscriptionFactory/APIKeyBasedConnectionPool.swift
@@ -12,19 +12,28 @@ class APIKeyBasedConnectionPool: SubscriptionConnectionPool {
     private let apiKeyProvider: AWSAPIKeyAuthProvider
     var endPointToProvider: [String: ConnectionProvider]
 
+    private let queue = DispatchQueue(
+        label: "com.amazonaws.connectionPool.APIKeyBased.concurrentQueue",
+        attributes: .concurrent,
+        target: .global(
+            qos: .userInitiated
+        )
+    )
+
     init(_ apiKeyProvider: AWSAPIKeyAuthProvider) {
         self.apiKeyProvider = apiKeyProvider
         self.endPointToProvider = [:]
     }
 
     func connection(for url: URL, connectionType: SubscriptionConnectionType) -> SubscriptionConnection {
-
-        let connectionProvider = endPointToProvider[url.absoluteString] ??
+        queue.sync(flags: .barrier) {
+            let connectionProvider = endPointToProvider[url.absoluteString] ??
             ConnectionProviderFactory.createConnectionProvider(for: URLRequest(url: url),
                                                                authInterceptor: APIKeyAuthInterceptor(apiKeyProvider.getAPIKey()),
                                                                connectionType: connectionType)
-        endPointToProvider[url.absoluteString] = connectionProvider
-        let connection = AppSyncSubscriptionConnection(provider: connectionProvider)
-        return connection
+            endPointToProvider[url.absoluteString] = connectionProvider
+            let connection = AppSyncSubscriptionConnection(provider: connectionProvider)
+            return connection
+        }
     }
 }
diff --git a/AWSAppSyncIntegrationTests/SubscriptionTests.swift b/AWSAppSyncIntegrationTests/SubscriptionTests.swift
@@ -29,7 +29,7 @@ class SubscriptionTests: XCTestCase {
         super.setUp()
 
         AWSDDLog.sharedInstance.logLevel = .warning
-        AWSDDTTYLogger.sharedInstance.logFormatter = AWSAppSyncClientLogFormatter()
+        AWSDDTTYLogger.sharedInstance?.logFormatter = AWSAppSyncClientLogFormatter()
         AWSDDLog.sharedInstance.add(AWSDDTTYLogger.sharedInstance)
 
         do {
@@ -130,7 +130,7 @@ class SubscriptionTests: XCTestCase {
 
     func testSubscriptionReceivesConnectedMessage() throws {
         AWSDDLog.sharedInstance.logLevel = .verbose
-        AWSDDTTYLogger.sharedInstance.logFormatter = AWSAppSyncClientLogFormatter()
+        AWSDDTTYLogger.sharedInstance?.logFormatter = AWSAppSyncClientLogFormatter()
         AWSDDLog.sharedInstance.add(AWSDDTTYLogger.sharedInstance)
 
         let statusChangedToConnected = expectation(description: "Subscription received status change notification to 'connected'")

diff --git a/AWSAppSyncUnitTests/Logging/AppSyncLogHelperTests.swift b/AWSAppSyncUnitTests/Logging/AppSyncLogHelperTests.swift
@@ -48,7 +48,7 @@ class AppSyncLogHelperTests: XCTestCase {
 class MockLogger: NSObject, AWSDDLogger {
     var loggedMessage = ""
 
-    var logFormatter: AWSDDLogFormatter = AWSAppSyncClientLogFormatter()
+    var logFormatter: AWSDDLogFormatter? = AWSAppSyncClientLogFormatter()
 
     func log(message logMessage: AWSDDLogMessage) {
         loggedMessage = logMessage.message

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,7 +3,12 @@
 The AWS AppSync SDK for iOS enables you to access your AWS AppSync backend and perform operations like `Queries`, `Mutations` and `Subscriptions`. The SDK
 also includes support for offline operations.
 
-### 3.7.0
+## 3.7.1
+
+### Bug Fixes
+- Making APIKeyBasedConnectionPool thread-safe to prevent crashes (#596)
+
+## 3.7.0
 
 ### Features
 - update minimum ios deployment target to v12([PR #586](https://github.com/awslabs/aws-mobile-appsync-sdk-ios/pull/586))

diff --git a/Podfile.lock b/Podfile.lock
@@ -1,21 +1,21 @@
 PODS:
   - AppSyncRealTimeClient (3.2.0):
     - Starscream (= 4.0.8)
-  - AWSAuthCore (2.36.0):
-    - AWSCore (= 2.36.0)
-  - AWSCognitoIdentityProvider (2.36.0):
-    - AWSCognitoIdentityProviderASF (= 2.36.0)
-    - AWSCore (= 2.36.0)
-  - AWSCognitoIdentityProviderASF (2.36.0):
-    - AWSCore (= 2.36.0)
-  - AWSCore (2.36.0)
-  - AWSMobileClient (2.36.0):
-    - AWSAuthCore (= 2.36.0)
-    - AWSCognitoIdentityProvider (= 2.36.0)
-    - AWSCognitoIdentityProviderASF (= 2.36.0)
-    - AWSCore (= 2.36.0)
-  - AWSS3 (2.36.0):
-    - AWSCore (= 2.36.0)
+  - AWSAuthCore (2.36.1):
+    - AWSCore (= 2.36.1)
+  - AWSCognitoIdentityProvider (2.36.1):
+    - AWSCognitoIdentityProviderASF (= 2.36.1)
+    - AWSCore (= 2.36.1)
+  - AWSCognitoIdentityProviderASF (2.36.1):
+    - AWSCore (= 2.36.1)
+  - AWSCore (2.36.1)
+  - AWSMobileClient (2.36.1):
+    - AWSAuthCore (= 2.36.1)
+    - AWSCognitoIdentityProvider (= 2.36.1)
+    - AWSCognitoIdentityProviderASF (= 2.36.1)
+    - AWSCore (= 2.36.1)
+  - AWSS3 (2.36.1):
+    - AWSCore (= 2.36.1)
   - SQLite.swift (0.12.2):
     - SQLite.swift/standard (= 0.12.2)
   - SQLite.swift/standard (0.12.2)
@@ -45,12 +45,12 @@ SPEC REPOS:
 
 SPEC CHECKSUMS:
   AppSyncRealTimeClient: 35c0d2ae28234a9f5daba5dc31402acf45ad802f
-  AWSAuthCore: 16ad51c6cf9a5a556049401851498f6c0a3aebb7
-  AWSCognitoIdentityProvider: 454b162e1bf1a10d9fec5cacd9291c021ecbdd22
-  AWSCognitoIdentityProviderASF: 556ffdfa7ccd0626bc59f784e938b49bccfe3180
-  AWSCore: 6a3038e6c0b13be3d1fbb4746f98aab44f750e4d
-  AWSMobileClient: 161fe6a17f872e2e94d88d275c47dd87907beb23
-  AWSS3: f073fbcd77d59baf4bdaf7a9732747dca477fb3b
+  AWSAuthCore: 517263c65847c7ca44b04a15880e3bd2eeb1e26f
+  AWSCognitoIdentityProvider: 5cc7bd177d75192c52131aa24dbd4a4d86044d5a
+  AWSCognitoIdentityProviderASF: 2d023e2ec5c9d2664effcd0689944f9de874b8db
+  AWSCore: afcf0018ca1bf8d8e42d1010252bbfd45a2d43e4
+  AWSMobileClient: 4ad6d9c6c6a9babee53eae23e1938f3a0c94ba67
+  AWSS3: 85770c01ec07d1c6297da0049b585003e78c1fcb
   SQLite.swift: d2b4642190917051ce6bd1d49aab565fe794eea3
   Starscream: 19b5533ddb925208db698f0ac508a100b884a1b9
   SwiftLint: c1de071d9d08c8aba837545f6254315bc900e211