fix(api): add default user-agent header value for subscription requests (#2700)

5d · web-flow · commit 178e1067fb5e · 2023-01-26T11:30:49.000-08:00
* fix(api): upgrade to appsync client v3

* fix(api): add default user-agent header to subscription requests
diff --git a/AmplifyPlugins.podspec b/AmplifyPlugins.podspec
@@ -36,7 +36,7 @@ Pod::Spec.new do |s|
 
   s.subspec 'AWSAPIPlugin' do |ss|
     ss.source_files = 'AmplifyPlugins/API/AWSAPICategoryPlugin/**/*.swift'
-    ss.dependency 'AppSyncRealTimeClient', "~> 2.0"
+    ss.dependency 'AppSyncRealTimeClient', "~> 3.0"
   end
 
   s.subspec 'AWSCognitoAuthPlugin' do |ss|
diff --git a/AmplifyPlugins/API/AWSAPICategoryPlugin/Operation/AWSGraphQLSubscriptionOperation.swift b/AmplifyPlugins/API/AWSAPICategoryPlugin/Operation/AWSGraphQLSubscriptionOperation.swift
@@ -93,15 +93,17 @@ final public class AWSGraphQLSubscriptionOperation<R: Decodable>: GraphQLSubscri
         // Retrieve request plugin option and
         // auth type in case of a multi-auth setup
         let pluginOptions = request.options.pluginOptions as? AWSPluginOptions
+        let urlRequest = generateSubscriptionURLRequest(from: endpointConfig)
 
         // Retrieve the subscription connection
         subscriptionQueue.sync {
             do {
                 subscriptionConnection = try subscriptionConnectionFactory
                     .getOrCreateConnection(for: endpointConfig,
-                                              authService: authService,
-                                              authType: pluginOptions?.authType,
-                                              apiAuthProviderFactory: apiAuthProviderFactory)
+                                           urlRequest: urlRequest,
+                                           authService: authService,
+                                           authType: pluginOptions?.authType,
+                                           apiAuthProviderFactory: apiAuthProviderFactory)
             } catch {
                 let error = APIError.operationError("Unable to get connection for api \(endpointConfig.name)", "", error)
                 dispatch(result: .failure(error))
@@ -119,6 +121,17 @@ final public class AWSGraphQLSubscriptionOperation<R: Decodable>: GraphQLSubscri
         }
     }
 
+    private func generateSubscriptionURLRequest(
+        from endpointConfig: AWSAPICategoryPluginConfiguration.EndpointConfig
+    ) -> URLRequest {
+        var urlRequest = URLRequest(url: endpointConfig.baseURL)
+        urlRequest.setValue(
+            AmplifyAWSServiceConfiguration.baseUserAgent(),
+            forHTTPHeaderField: URLRequestConstants.Header.userAgent
+        )
+        return urlRequest
+    }
+
     private func onAsyncSubscriptionEvent(event: SubscriptionItemEvent) {
         switch event {
         case .connection(let subscriptionConnectionEvent):
diff --git a/AmplifyPlugins/API/AWSAPICategoryPlugin/SubscriptionFactory/AWSSubscriptionConnectionFactory.swift b/AmplifyPlugins/API/AWSAPICategoryPlugin/SubscriptionFactory/AWSSubscriptionConnectionFactory.swift
@@ -23,23 +23,24 @@ class AWSSubscriptionConnectionFactory: SubscriptionConnectionFactory {
 
     private var apiToConnectionProvider: [MapperCacheKey: ConnectionProvider] = [:]
 
-    func getOrCreateConnection(for endpointConfig: AWSAPICategoryPluginConfiguration.EndpointConfig,
-                               authService: AWSAuthServiceBehavior,
-                               authType: AWSAuthorizationType? = nil,
-                               apiAuthProviderFactory: APIAuthProviderFactory) throws -> SubscriptionConnection {
+    func getOrCreateConnection(
+        for endpointConfig: AWSAPICategoryPluginConfiguration.EndpointConfig,
+        urlRequest: URLRequest,
+        authService: AWSAuthServiceBehavior,
+        authType: AWSAuthorizationType? = nil,
+        apiAuthProviderFactory: APIAuthProviderFactory
+    ) throws -> SubscriptionConnection {
         return try concurrencyQueue.sync {
             let apiName = endpointConfig.name
 
-            let url = endpointConfig.baseURL
-
             let authInterceptor = try getInterceptor(for: getOrCreateAuthConfiguration(from: endpointConfig,
                                                                                        authType: authType),
                                                      authService: authService,
                                                      apiAuthProviderFactory: apiAuthProviderFactory)
 
             // create or retrieve the connection provider. If creating, add interceptors onto the provider.
             let connectionProvider = apiToConnectionProvider[MapperCacheKey(apiName: apiName, authType: authType)] ??
-                ConnectionProviderFactory.createConnectionProvider(for: url,
+                ConnectionProviderFactory.createConnectionProvider(for: urlRequest,
                                                                    authInterceptor: authInterceptor,
                                                                    connectionType: .appSyncRealtime)
 
diff --git a/AmplifyPlugins/API/AWSAPICategoryPlugin/SubscriptionFactory/SubscriptionConnectionFactory.swift b/AmplifyPlugins/API/AWSAPICategoryPlugin/SubscriptionFactory/SubscriptionConnectionFactory.swift
@@ -5,6 +5,8 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+import Foundation
+
 import Amplify
 import AWSPluginsCore
 import AppSyncRealTimeClient
@@ -14,6 +16,7 @@ protocol SubscriptionConnectionFactory {
 
     /// Get connection based on the connection type
     func getOrCreateConnection(for endpointConfig: AWSAPICategoryPluginConfiguration.EndpointConfig,
+                               urlRequest: URLRequest,
                                authService: AWSAuthServiceBehavior,
                                authType: AWSAuthorizationType?,
                                apiAuthProviderFactory: APIAuthProviderFactory) throws -> SubscriptionConnection
diff --git a/AmplifyPlugins/API/AWSAPICategoryPluginTests/Mocks/MockSubscription.swift b/AmplifyPlugins/API/AWSAPICategoryPluginTests/Mocks/MockSubscription.swift
@@ -14,6 +14,7 @@ import AppSyncRealTimeClient
 struct MockSubscriptionConnectionFactory: SubscriptionConnectionFactory {
     typealias OnGetOrCreateConnection = (
         AWSAPICategoryPluginConfiguration.EndpointConfig,
+        URLRequest,
         AWSAuthServiceBehavior,
         AWSAuthorizationType?,
         APIAuthProviderFactory
@@ -27,11 +28,12 @@ struct MockSubscriptionConnectionFactory: SubscriptionConnectionFactory {
 
     func getOrCreateConnection(
         for endpointConfig: AWSAPICategoryPluginConfiguration.EndpointConfig,
+        urlRequest: URLRequest,
         authService: AWSAuthServiceBehavior,
         authType: AWSAuthorizationType?,
         apiAuthProviderFactory: APIAuthProviderFactory
     ) throws -> SubscriptionConnection {
-        try onGetOrCreateConnection(endpointConfig, authService, authType, apiAuthProviderFactory)
+        try onGetOrCreateConnection(endpointConfig, urlRequest, authService, authType, apiAuthProviderFactory)
     }
 
 }
diff --git a/AmplifyPlugins/API/AWSAPICategoryPluginTests/Operation/AWSGraphQLSubscriptionOperationCancelTests.swift b/AmplifyPlugins/API/AWSAPICategoryPluginTests/Operation/AWSGraphQLSubscriptionOperationCancelTests.swift
@@ -67,7 +67,7 @@ class AWSGraphQLSubscriptionOperationCancelTests: XCTestCase {
     }
 
     func testCancelSendsCompletion() {
-        let mockSubscriptionConnectionFactory = MockSubscriptionConnectionFactory(onGetOrCreateConnection: { _, _, _, _ in
+        let mockSubscriptionConnectionFactory = MockSubscriptionConnectionFactory(onGetOrCreateConnection: { _, _, _, _, _ in
             return MockSubscriptionConnection(onSubscribe: { (_, _, eventHandler) -> SubscriptionItem in
                 let item = SubscriptionItem(requestString: "", variables: nil, eventHandler: { _, _ in
                 })
@@ -126,7 +126,7 @@ class AWSGraphQLSubscriptionOperationCancelTests: XCTestCase {
     }
 
     func testFailureOnConnection() {
-        let mockSubscriptionConnectionFactory = MockSubscriptionConnectionFactory(onGetOrCreateConnection: { _, _, _, _ in
+        let mockSubscriptionConnectionFactory = MockSubscriptionConnectionFactory(onGetOrCreateConnection: { _, _, _, _, _ in
             throw APIError.invalidConfiguration("something went wrong", "", nil)
         })
 
@@ -168,16 +168,17 @@ class AWSGraphQLSubscriptionOperationCancelTests: XCTestCase {
 
     func testCallingCancelWhileCreatingConnectionShouldCallCompletionListener() {
         let connectionCreation = expectation(description: "connection factory called")
-        let mockSubscriptionConnectionFactory = MockSubscriptionConnectionFactory(onGetOrCreateConnection: { _, _, _, _ in
-            connectionCreation.fulfill()
-            return MockSubscriptionConnection(onSubscribe: { (_, _, eventHandler) -> SubscriptionItem in
-                let item = SubscriptionItem(requestString: "", variables: nil, eventHandler: { _, _ in
+        let mockSubscriptionConnectionFactory =
+            MockSubscriptionConnectionFactory(onGetOrCreateConnection: { _, _, _, _, _ in
+                connectionCreation.fulfill()
+                return MockSubscriptionConnection(onSubscribe: { (_, _, eventHandler) -> SubscriptionItem in
+                    let item = SubscriptionItem(requestString: "", variables: nil, eventHandler: { _, _ in
+                    })
+                    eventHandler(.connection(.connecting), item)
+                    return item
+                }, onUnsubscribe: {_ in
                 })
-                eventHandler(.connection(.connecting), item)
-                return item
-            }, onUnsubscribe: {_ in
             })
-        })
 
         setUp(subscriptionConnectionFactory: mockSubscriptionConnectionFactory)
 
diff --git a/AmplifyPlugins/API/AWSAPICategoryPluginTests/Operation/GraphQLSubscribeCombineTests.swift b/AmplifyPlugins/API/AWSAPICategoryPluginTests/Operation/GraphQLSubscribeCombineTests.swift
@@ -228,7 +228,7 @@ class GraphQLSubscribeCombineTests: OperationTestBase {
             return item
         }
 
-        let onGetOrCreateConnection: MockSubscriptionConnectionFactory.OnGetOrCreateConnection = { _, _, _, _  in
+        let onGetOrCreateConnection: MockSubscriptionConnectionFactory.OnGetOrCreateConnection = { _, _, _, _, _  in
             MockSubscriptionConnection(onSubscribe: onSubscribe, onUnsubscribe: { _ in })
         }
 
diff --git a/AmplifyPlugins/API/AWSAPICategoryPluginTests/Operation/GraphQLSubscribeTests.swift b/AmplifyPlugins/API/AWSAPICategoryPluginTests/Operation/GraphQLSubscribeTests.swift
@@ -290,7 +290,7 @@ class GraphQLSubscribeTests: OperationTestBase {
             return item
         }
 
-        let onGetOrCreateConnection: MockSubscriptionConnectionFactory.OnGetOrCreateConnection = { _, _, _, _  in
+        let onGetOrCreateConnection: MockSubscriptionConnectionFactory.OnGetOrCreateConnection = { _, _, _, _, _  in
             MockSubscriptionConnection(onSubscribe: onSubscribe, onUnsubscribe: { _ in })
         }
 
diff --git a/AmplifyPlugins/API/Podfile b/AmplifyPlugins/API/Podfile
@@ -8,7 +8,7 @@ include_build_tools!
 target 'AWSAPICategoryPlugin' do
 	pod 'Amplify', :path => '../../'
   pod 'AWSPluginsCore', :path => '../../'
-  pod "AppSyncRealTimeClient", "~> 2.0"
+  pod "AppSyncRealTimeClient", "~> 3.0"
 
   target "AWSAPICategoryPluginTests" do
     inherit! :complete
diff --git a/AmplifyPlugins/API/Podfile.lock b/AmplifyPlugins/API/Podfile.lock
@@ -19,7 +19,7 @@ PODS:
     - AWSMobileClient (~> 2.30.1)
     - AWSPluginsCore (= 1.28.4)
     - CwlPreconditionTesting (~> 2.0)
-  - AppSyncRealTimeClient (2.1.1):
+  - AppSyncRealTimeClient (3.0.0):
     - Starscream (~> 4.0.4)
   - AWSAuthCore (2.30.1):
     - AWSCore (= 2.30.1)
@@ -54,7 +54,7 @@ DEPENDENCIES:
   - Amplify (from `../../`)
   - AmplifyPlugins/AWSCognitoAuthPlugin (from `../../`)
   - AmplifyTestCommon (from `../../`)
-  - AppSyncRealTimeClient (~> 2.0)
+  - AppSyncRealTimeClient (~> 3.0)
   - AWSPluginsCore (from `../../`)
   - CwlPreconditionTesting (from `https://github.com/mattgallagher/CwlPreconditionTesting.git`, tag `2.1.0`)
   - SwiftFormat/CLI (= 0.44.17)
@@ -96,9 +96,9 @@ CHECKOUT OPTIONS:
 
 SPEC CHECKSUMS:
   Amplify: be704bdc5c808a61b1a9a0ee79ba4892de9c5dcc
-  AmplifyPlugins: 667480a37ee4239024148daf67e0b4346b7c46d1
+  AmplifyPlugins: 12ae75a354d38ad623f1f78dc7f672f7baf4c0de
   AmplifyTestCommon: ee2908d5c7e372bb9caf5733644fe06f2cd7fcaf
-  AppSyncRealTimeClient: 937360221f2b664c4c33ae142a60643e64f480cd
+  AppSyncRealTimeClient: ec19a24f635611b193eb98a2da573abcf98b793b
   AWSAuthCore: 88e77e867b210e5d09e35a484de19753d587aee3
   AWSCognitoIdentityProvider: 37ff510e8f64dc6a1240088ba92ad4d6f0cd841e
   AWSCognitoIdentityProviderASF: f2cd19990c4ae642ad73d09a4945018a994c9ff8
@@ -114,6 +114,6 @@ SPEC CHECKSUMS:
   SwiftFormat: 3b5caa6389b2b9adbc00e133b3ccc8c6e687a6a4
   SwiftLint: 32ee33ded0636d0905ef6911b2b67bbaeeedafa5
 
-PODFILE CHECKSUM: 2a9177ccb9833844ad436a0c7c9e5768a7ab8868
+PODFILE CHECKSUM: 5170578806036f2ba018abb8868d56e448fb0ada
 
 COCOAPODS: 1.11.3
diff --git a/AmplifyPlugins/DataStore/Podfile.lock b/AmplifyPlugins/DataStore/Podfile.lock
@@ -3,7 +3,7 @@ PODS:
     - Amplify/Default (= 1.28.4)
   - Amplify/Default (1.28.4)
   - AmplifyPlugins/AWSAPIPlugin (1.28.4):
-    - AppSyncRealTimeClient (~> 2.0)
+    - AppSyncRealTimeClient (~> 3.0)
     - AWSCore (~> 2.30.1)
     - AWSPluginsCore (= 1.28.4)
   - AmplifyPlugins/AWSCognitoAuthPlugin (1.28.4):
@@ -23,7 +23,7 @@ PODS:
     - AWSMobileClient (~> 2.30.1)
     - AWSPluginsCore (= 1.28.4)
     - CwlPreconditionTesting (~> 2.0)
-  - AppSyncRealTimeClient (2.1.1):
+  - AppSyncRealTimeClient (3.0.0):
     - Starscream (~> 4.0.4)
   - AWSAuthCore (2.30.1):
     - AWSCore (= 2.30.1)
@@ -106,9 +106,9 @@ CHECKOUT OPTIONS:
 
 SPEC CHECKSUMS:
   Amplify: be704bdc5c808a61b1a9a0ee79ba4892de9c5dcc
-  AmplifyPlugins: 667480a37ee4239024148daf67e0b4346b7c46d1
+  AmplifyPlugins: 12ae75a354d38ad623f1f78dc7f672f7baf4c0de
   AmplifyTestCommon: ee2908d5c7e372bb9caf5733644fe06f2cd7fcaf
-  AppSyncRealTimeClient: 937360221f2b664c4c33ae142a60643e64f480cd
+  AppSyncRealTimeClient: ec19a24f635611b193eb98a2da573abcf98b793b
   AWSAuthCore: 88e77e867b210e5d09e35a484de19753d587aee3
   AWSCognitoIdentityProvider: 37ff510e8f64dc6a1240088ba92ad4d6f0cd841e
   AWSCognitoIdentityProviderASF: f2cd19990c4ae642ad73d09a4945018a994c9ff8
diff --git a/Package.resolved b/Package.resolved
diff --git a/Package.swift b/Package.swift
@@ -10,32 +10,32 @@ let package = Package(
         .library(
             name: "Amplify",
             targets: ["Amplify"]),
-        
+
         .library(name: "AWSPluginsCore",
                  targets: ["AWSPluginsCore"]),
-        
+
         .library(name: "AWSAPIPlugin",
                  targets: ["AWSAPIPlugin"]),
-        
+
         .library(name: "AWSCognitoAuthPlugin",
                  targets: ["AWSCognitoAuthPlugin"]),
-        
+
         .library(name: "AWSDataStorePlugin",
                  targets: ["AWSDataStorePlugin"]),
-        
+
         .library(name: "AWSLocationGeoPlugin",
                  targets: ["AWSLocationGeoPlugin"]),
-        
+
         .library(name: "AWSPinpointAnalyticsPlugin",
                  targets: ["AWSPinpointAnalyticsPlugin"]),
-        
+
         .library(name: "AWSS3StoragePlugin",
                  targets: ["AWSS3StoragePlugin"]),
-        
+
     ],
     dependencies: [
         .package(name: "AWSiOSSDKV2", url: "https://github.com/aws-amplify/aws-sdk-ios-spm.git", .upToNextMinor(from: "2.30.1")),
-        .package(name: "AppSyncRealTimeClient", url: "https://github.com/aws-amplify/aws-appsync-realtime-client-ios.git", from: "2.0.0"),
+        .package(name: "AppSyncRealTimeClient", url: "https://github.com/aws-amplify/aws-appsync-realtime-client-ios.git", from: "3.0.0"),
         .package(url: "https://github.com/stephencelis/SQLite.swift.git", .exact("0.13.2"))
     ],
     targets: [

Original file line number	Diff line number	Diff line change
`@@ -228,7 +228,7 @@ class GraphQLSubscribeCombineTests: OperationTestBase {`
`228`	`228`	`return item`
`229`	`229`	`}`
`230`	`230`
`231`		`- let onGetOrCreateConnection: MockSubscriptionConnectionFactory.OnGetOrCreateConnection = { _, _, _, _ in`
	`231`	`+ let onGetOrCreateConnection: MockSubscriptionConnectionFactory.OnGetOrCreateConnection = { _, _, _, _, _ in`
`232`	`232`	`MockSubscriptionConnection(onSubscribe: onSubscribe, onUnsubscribe: { _ in })`
`233`	`233`	`}`
`234`	`234`
Original file line number	Diff line number	Diff line change
`@@ -290,7 +290,7 @@ class GraphQLSubscribeTests: OperationTestBase {`
`290`	`290`	`return item`
`291`	`291`	`}`
`292`	`292`
`293`		`- let onGetOrCreateConnection: MockSubscriptionConnectionFactory.OnGetOrCreateConnection = { _, _, _, _ in`
	`293`	`+ let onGetOrCreateConnection: MockSubscriptionConnectionFactory.OnGetOrCreateConnection = { _, _, _, _, _ in`
`294`	`294`	`MockSubscriptionConnection(onSubscribe: onSubscribe, onUnsubscribe: { _ in })`
`295`	`295`	`}`
`296`	`296`