fix: Propagate @discardableResult to implementations (#719)

palpatim · web-flow · commit 83bd335a7aa2 · 2020-08-17T15:00:11.000-07:00
* chore: Fix bugs in README-combine-support sample code * chore: Upgrade SwiftLint, fix linting errors refs:#713
diff --git a/Amplify/Categories/API/ClientBehavior/AmplifyAPICategory+GraphQLBehavior.swift b/Amplify/Categories/API/ClientBehavior/AmplifyAPICategory+GraphQLBehavior.swift
@@ -9,11 +9,13 @@ extension AmplifyAPICategory: APICategoryGraphQLBehavior {
 
     // MARK: - Request-based GraphQL operations
 
+    @discardableResult
     public func query<R: Decodable>(request: GraphQLRequest<R>,
                                     listener: GraphQLOperation<R>.ResultListener?) -> GraphQLOperation<R> {
         plugin.query(request: request, listener: listener)
     }
 
+    @discardableResult
     public func mutate<R: Decodable>(request: GraphQLRequest<R>,
                                      listener: GraphQLOperation<R>.ResultListener?) -> GraphQLOperation<R> {
         plugin.mutate(request: request, listener: listener)
diff --git a/Amplify/Categories/API/ClientBehavior/AmplifyAPICategory+RESTBehavior.swift b/Amplify/Categories/API/ClientBehavior/AmplifyAPICategory+RESTBehavior.swift
@@ -8,26 +8,32 @@
 import Foundation
 
 extension AmplifyAPICategory: APICategoryRESTBehavior {
+    @discardableResult
     public func get(request: RESTRequest, listener: RESTOperation.ResultListener?) -> RESTOperation {
         plugin.get(request: request, listener: listener)
     }
 
+    @discardableResult
     public func put(request: RESTRequest, listener: RESTOperation.ResultListener?) -> RESTOperation {
         plugin.put(request: request, listener: listener)
     }
 
+    @discardableResult
     public func post(request: RESTRequest, listener: RESTOperation.ResultListener?) -> RESTOperation {
         plugin.post(request: request, listener: listener)
     }
 
+    @discardableResult
     public func delete(request: RESTRequest, listener: RESTOperation.ResultListener?) -> RESTOperation {
         plugin.delete(request: request, listener: listener)
     }
 
+    @discardableResult
     public func head(request: RESTRequest, listener: RESTOperation.ResultListener?) -> RESTOperation {
         plugin.head(request: request, listener: listener)
     }
 
+    @discardableResult
     public func patch(request: RESTRequest, listener: RESTOperation.ResultListener?) -> RESTOperation {
         plugin.patch(request: request, listener: listener)
     }
diff --git a/Amplify/Categories/Auth/AuthCategory+ClientBehavior.swift b/Amplify/Categories/Auth/AuthCategory+ClientBehavior.swift
@@ -9,6 +9,7 @@ import Foundation
 
 extension AuthCategory: AuthCategoryBehavior {
 
+    @discardableResult
     public func signUp(username: String,
                        password: String? = nil,
                        options: AuthSignUpOperation.Request.Options? = nil,
@@ -19,6 +20,7 @@ extension AuthCategory: AuthCategoryBehavior {
                              listener: listener)
     }
 
+    @discardableResult
     public func confirmSignUp(for username: String,
                               confirmationCode: String,
                               options: AuthConfirmSignUpOperation.Request.Options? = nil,
@@ -29,6 +31,7 @@ extension AuthCategory: AuthCategoryBehavior {
                                     listener: listener)
     }
 
+    @discardableResult
     public func resendSignUpCode(for username: String,
                                  options: AuthResendSignUpCodeOperation.Request.Options? = nil,
                                  listener: AuthResendSignUpCodeOperation.ResultListener?)
@@ -38,6 +41,7 @@ extension AuthCategory: AuthCategoryBehavior {
                                            listener: listener)
     }
 
+    @discardableResult
     public func signIn(username: String? = nil,
                        password: String? = nil,
                        options: AuthSignInOperation.Request.Options? = nil,
@@ -48,6 +52,7 @@ extension AuthCategory: AuthCategoryBehavior {
                              listener: listener)
     }
 
+    @discardableResult
     public func signInWithWebUI(presentationAnchor: AuthUIPresentationAnchor,
                                 options: AuthWebUISignInOperation.Request.Options? = nil,
                                 listener: AuthWebUISignInOperation.ResultListener?) -> AuthWebUISignInOperation {
@@ -56,6 +61,7 @@ extension AuthCategory: AuthCategoryBehavior {
                                       listener: listener)
     }
 
+    @discardableResult
     public func signInWithWebUI(for authProvider: AuthProvider,
                                 presentationAnchor: AuthUIPresentationAnchor,
                                 options: AuthSocialWebUISignInOperation.Request.Options? = nil,
@@ -67,6 +73,7 @@ extension AuthCategory: AuthCategoryBehavior {
                                           listener: listener)
     }
 
+    @discardableResult
     public func confirmSignIn(challengeResponse: String,
                               options: AuthConfirmSignInOperation.Request.Options? = nil,
                               listener: AuthConfirmSignInOperation.ResultListener?) -> AuthConfirmSignInOperation {
@@ -75,17 +82,20 @@ extension AuthCategory: AuthCategoryBehavior {
                                     listener: listener)
     }
 
+    @discardableResult
     public func signOut(options: AuthSignOutOperation.Request.Options? = nil,
                         listener: AuthSignOutOperation.ResultListener?) -> AuthSignOutOperation {
         plugin.signOut(options: options, listener: listener)
     }
 
+    @discardableResult
     public func fetchAuthSession(options: AuthFetchSessionOperation.Request.Options? = nil,
                                  listener: AuthFetchSessionOperation.ResultListener?) -> AuthFetchSessionOperation {
         return plugin.fetchAuthSession(options: options,
                                        listener: listener)
     }
 
+    @discardableResult
     public func resetPassword(for username: String,
                               options: AuthResetPasswordOperation.Request.Options? = nil,
                               listener: AuthResetPasswordOperation.ResultListener?) -> AuthResetPasswordOperation {
@@ -94,6 +104,7 @@ extension AuthCategory: AuthCategoryBehavior {
                                     listener: listener)
     }
 
+    @discardableResult
     public func confirmResetPassword(for username: String,
                                      with newPassword: String,
                                      confirmationCode: String,
diff --git a/Amplify/Categories/Auth/AuthCategory+DeviceBehavior.swift b/Amplify/Categories/Auth/AuthCategory+DeviceBehavior.swift
@@ -9,13 +9,15 @@ import Foundation
 
 extension AuthCategory: AuthCategoryDeviceBehavior {
 
+    @discardableResult
     public func fetchDevices(
         options: AuthFetchDevicesOperation.Request.Options? = nil,
         listener: AuthFetchDevicesOperation.ResultListener?) -> AuthFetchDevicesOperation {
         return plugin.fetchDevices(options: options,
                                    listener: listener)
     }
 
+    @discardableResult
     public func forgetDevice(
         _ device: AuthDevice? = nil,
         options: AuthForgetDeviceOperation.Request.Options? = nil,
@@ -25,6 +27,7 @@ extension AuthCategory: AuthCategoryDeviceBehavior {
                                    listener: listener)
     }
 
+    @discardableResult
     public func rememberDevice(
         options: AuthRememberDeviceOperation.Request.Options? = nil,
         listener: AuthRememberDeviceOperation.ResultListener?) -> AuthRememberDeviceOperation {
diff --git a/Amplify/Categories/Auth/AuthCategory+UserBehavior.swift b/Amplify/Categories/Auth/AuthCategory+UserBehavior.swift
@@ -13,13 +13,15 @@ extension AuthCategory: AuthCategoryUserBehavior {
         return plugin.getCurrentUser()
     }
 
+    @discardableResult
     public func fetchUserAttributes(options: AuthFetchUserAttributeOperation.Request.Options? = nil,
                                     listener: AuthFetchUserAttributeOperation.ResultListener?)
         -> AuthFetchUserAttributeOperation {
             return plugin.fetchUserAttributes(options: options,
                                               listener: listener)
     }
 
+    @discardableResult
     public func update(userAttribute: AuthUserAttribute,
                        options: AuthUpdateUserAttributeOperation.Request.Options? = nil,
                        listener: AuthUpdateUserAttributeOperation.ResultListener?) -> AuthUpdateUserAttributeOperation {
@@ -28,6 +30,7 @@ extension AuthCategory: AuthCategoryUserBehavior {
                              listener: listener)
     }
 
+    @discardableResult
     public func update(userAttributes: [AuthUserAttribute],
                        options: AuthUpdateUserAttributesOperation.Request.Options? = nil,
                        listener: AuthUpdateUserAttributesOperation.ResultListener?)
@@ -37,6 +40,7 @@ extension AuthCategory: AuthCategoryUserBehavior {
                                  listener: listener)
     }
 
+    @discardableResult
     public func resendConfirmationCode(for attributeKey: AuthUserAttributeKey,
                                        options: AuthAttributeResendConfirmationCodeOperation.Request.Options? = nil,
                                        listener: AuthAttributeResendConfirmationCodeOperation.ResultListener?)
@@ -47,6 +51,7 @@ extension AuthCategory: AuthCategoryUserBehavior {
 
     }
 
+    @discardableResult
     public func confirm(userAttribute: AuthUserAttributeKey,
                         confirmationCode: String,
                         options: AuthConfirmUserAttributeOperation.Request.Options? = nil,
@@ -58,6 +63,7 @@ extension AuthCategory: AuthCategoryUserBehavior {
                                   listener: listener)
     }
 
+    @discardableResult
     public func update(oldPassword: String,
                        to newPassword: String,
                        options: AuthChangePasswordOperation.Request.Options? = nil,
diff --git a/Amplify/Categories/Predictions/PredictionsCategory+ClientBehavior.swift b/Amplify/Categories/Predictions/PredictionsCategory+ClientBehavior.swift
@@ -9,6 +9,7 @@ import Foundation
 
 extension PredictionsCategory: PredictionsCategoryBehavior {
 
+    @discardableResult
     public func convert(textToSpeech: String,
                         options: PredictionsTextToSpeechRequest.Options? = nil,
                         listener: PredictionsTextToSpeechOperation.ResultListener?
@@ -18,6 +19,7 @@ extension PredictionsCategory: PredictionsCategoryBehavior {
                        listener: listener)
     }
 
+    @discardableResult
     public func convert(textToTranslate: String,
                         language: LanguageType?,
                         targetLanguage: LanguageType?,
@@ -31,13 +33,15 @@ extension PredictionsCategory: PredictionsCategoryBehavior {
                            listener: listener)
     }
 
+    @discardableResult
     public func convert(speechToText: URL,
                         options: PredictionsSpeechToTextRequest.Options?,
                         listener: PredictionsSpeechToTextOperation.ResultListener?
     ) -> PredictionsSpeechToTextOperation {
         plugin.convert(speechToText: speechToText, options: options, listener: listener)
     }
 
+    @discardableResult
     public func identify(type: IdentifyAction,
                          image: URL,
                          options: PredictionsIdentifyRequest.Options? = nil,
@@ -49,6 +53,7 @@ extension PredictionsCategory: PredictionsCategoryBehavior {
                         listener: listener)
     }
 
+    @discardableResult
     public func interpret(text: String,
                           options: PredictionsInterpretRequest.Options? = nil,
                           listener: PredictionsInterpretOperation.ResultListener?
diff --git a/Amplify/Categories/Storage/StorageCategory+ClientBehavior.swift b/Amplify/Categories/Storage/StorageCategory+ClientBehavior.swift
@@ -8,12 +8,14 @@
 import Foundation
 
 extension StorageCategory: StorageCategoryBehavior {
+    @discardableResult
     public func getURL(key: String,
                        options: StorageGetURLRequest.Options? = nil,
                        resultListener: StorageGetURLOperation.ResultListener?) -> StorageGetURLOperation {
         return plugin.getURL(key: key, options: options, resultListener: resultListener)
     }
 
+    @discardableResult
     public func downloadData(key: String,
                              options: StorageDownloadDataRequest.Options? = nil,
                              progressListener: ProgressListener? = nil,
@@ -25,6 +27,7 @@ extension StorageCategory: StorageCategoryBehavior {
                                    resultListener: resultListener)
     }
 
+    @discardableResult
     public func downloadFile(key: String,
                              local: URL,
                              options: StorageDownloadFileRequest.Options? = nil,
@@ -38,6 +41,7 @@ extension StorageCategory: StorageCategoryBehavior {
                                    resultListener: resultListener)
     }
 
+    @discardableResult
     public func uploadData(key: String,
                            data: Data,
                            options: StorageUploadDataRequest.Options? = nil,
@@ -51,6 +55,7 @@ extension StorageCategory: StorageCategoryBehavior {
                                  resultListener: resultListener)
     }
 
+    @discardableResult
     public func uploadFile(key: String,
                            local: URL,
                            options: StorageUploadFileRequest.Options? = nil,
@@ -64,12 +69,14 @@ extension StorageCategory: StorageCategoryBehavior {
                                  resultListener: resultListener)
     }
 
+    @discardableResult
     public func remove(key: String,
                        options: StorageRemoveRequest.Options? = nil,
                        resultListener: StorageRemoveOperation.ResultListener?) -> StorageRemoveOperation {
         return plugin.remove(key: key, options: options, resultListener: resultListener)
     }
 
+    @discardableResult
     public func list(options: StorageListRequest.Options? = nil,
                      resultListener: StorageListOperation.ResultListener?) -> StorageListOperation {
         return plugin.list(options: options, resultListener: resultListener)
diff --git a/AmplifyPlugins/API/AWSAPICategoryPluginTests/AWSAPICategoryPlugin+ConfigureTests.swift b/AmplifyPlugins/API/AWSAPICategoryPluginTests/AWSAPICategoryPlugin+ConfigureTests.swift
@@ -46,7 +46,7 @@ class AWSAPICategoryPluginConfigureTests: AWSAPICategoryPluginTestBase {
             XCTFail("Api configuration should not succeed")
         } catch {
             guard let apiError = error as? PluginError,
-                case .pluginConfigurationError(_, _, _) = apiError else {
+                case .pluginConfigurationError = apiError else {
                     XCTFail("Should throw invalidConfiguration exception. But received \(error) ")
                     return
             }
diff --git a/AmplifyPlugins/Analytics/AWSPinpointAnalyticsPluginTests/AWSPinpointAnalyticsPluginConfigureTests.swift b/AmplifyPlugins/Analytics/AWSPinpointAnalyticsPluginTests/AWSPinpointAnalyticsPluginConfigureTests.swift
@@ -66,7 +66,7 @@ class AWSPinpointAnalyticsPluginConfigureTests: AWSPinpointAnalyticsPluginTestBa
             XCTFail("Analytics configuration should not succeed")
         } catch {
             guard let pluginError = error as? PluginError,
-                case .pluginConfigurationError(_, _, _) = pluginError else {
+                case .pluginConfigurationError = pluginError else {
                     XCTFail("Should throw invalidConfiguration exception. But received \(error) ")
                     return
             }
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPlugin/Dependency/AuthenticationProviderAdapter+SignOut.swift b/AmplifyPlugins/Auth/AWSCognitoAuthPlugin/Dependency/AuthenticationProviderAdapter+SignOut.swift
@@ -33,7 +33,7 @@ extension AuthenticationProviderAdapter {
         awsMobileClient.signOut(options: signOutOptions) { [weak self] error in
             guard error == nil else {
                 let authError = AuthErrorHelper.toAuthError(error!)
-                if case .notAuthorized(_, _, _) = authError {
+                if case .notAuthorized = authError {
                     // signOut globally might return notAuthorized when the current token is expired or invalidated
                     // In this case, we just signOut the user locally and return a success result back.
                     self?.awsMobileClient.signOutLocally()
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPlugin/HubEvents/AuthHubEventHandler.swift b/AmplifyPlugins/Auth/AWSCognitoAuthPlugin/HubEvents/AuthHubEventHandler.swift
@@ -64,7 +64,7 @@ class AuthHubEventHandler: AuthHubEventBehavior {
 
             case HubPayload.EventName.Auth.signOutAPI:
                 guard let event = payload.data as? AWSAuthSignOutOperation.OperationResult,
-                    case .success(_) = event else {
+                    case .success = event else {
                         return
                 }
                 self?.sendUserSignedOutEvent()
@@ -94,7 +94,7 @@ class AuthHubEventHandler: AuthHubEventBehavior {
             case let .failure(authError) = tokensProvider.getCognitoTokens() else {
                 return
         }
-        guard case .sessionExpired(_, _, _) = authError else {
+        guard case .sessionExpired = authError else {
             return
         }
         sendSessionExpiredEvent()
diff --git a/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AWSCognitoAuthPluginConfigTests.swift b/AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/AWSCognitoAuthPluginConfigTests.swift
@@ -181,7 +181,7 @@ class AWSCognitoAuthPluginConfigTests: XCTestCase {
             XCTFail("Auth configuration should not succeed")
         } catch {
             guard let pluginError = error as? PluginError,
-                case .pluginConfigurationError(_, _, _) = pluginError else {
+                case .pluginConfigurationError = pluginError else {
                     XCTFail("Should throw invalidConfiguration exception. But received \(error) ")
                     return
             }
diff --git a/AmplifyPlugins/Storage/AWSS3StoragePluginTests/AWSS3StoragePluginConfigureTests.swift b/AmplifyPlugins/Storage/AWSS3StoragePluginTests/AWSS3StoragePluginConfigureTests.swift
@@ -78,7 +78,7 @@ class AWSS3StoragePluginConfigureTests: AWSS3StoragePluginTests {
             XCTFail("Storage configuration should not succeed")
         } catch {
             guard let pluginError = error as? PluginError,
-                case .pluginConfigurationError(_, _, _) = pluginError else {
+                case .pluginConfigurationError = pluginError else {
                     XCTFail("Should throw invalidConfiguration exception. But received \(error) ")
                     return
             }
diff --git a/AmplifyPlugins/Storage/AWSS3StoragePluginTests/Mocks/MockAWSS3StorageService.swift b/AmplifyPlugins/Storage/AWSS3StoragePluginTests/Mocks/MockAWSS3StorageService.swift
@@ -174,10 +174,10 @@ public class MockAWSS3StorageService: AWSS3StorageServiceBehaviour {
         XCTAssertEqual(uploadServiceKey, serviceKey)
         if let uploadUploadSource = uploadUploadSource {
             var uploadSourceEqual = false
-            if case .data(_) = uploadSource, case .data(_) = uploadUploadSource {
+            if case .data = uploadSource, case .data = uploadUploadSource {
                 uploadSourceEqual = true
             }
-            if case .local(_) = uploadSource, case .local(_) = uploadUploadSource {
+            if case .local = uploadSource, case .local = uploadUploadSource {
                 uploadSourceEqual = true
             }
             XCTAssertTrue(uploadSourceEqual)
@@ -199,10 +199,10 @@ public class MockAWSS3StorageService: AWSS3StorageServiceBehaviour {
         XCTAssertEqual(multiPartUploadServiceKey, serviceKey)
         if let multiPartUploadUploadSource = multiPartUploadUploadSource {
             var uploadSourceEqual = false
-            if case .data(_) = uploadSource, case .data(_) = multiPartUploadUploadSource {
+            if case .data = uploadSource, case .data = multiPartUploadUploadSource {
                 uploadSourceEqual = true
             }
-            if case .local(_) = uploadSource, case .local(_) = multiPartUploadUploadSource {
+            if case .local = uploadSource, case .local = multiPartUploadUploadSource {
                 uploadSourceEqual = true
             }
             XCTAssertTrue(uploadSourceEqual)
diff --git a/Podfile.lock b/Podfile.lock
diff --git a/README-combine-support.md b/README-combine-support.md

Original file line number	Diff line number	Diff line change
`@@ -8,26 +8,32 @@`
`8`	`8`	`import Foundation`
`9`	`9`
`10`	`10`	`extension AmplifyAPICategory: APICategoryRESTBehavior {`
	`11`	`+ @discardableResult`
`11`	`12`	`public func get(request: RESTRequest, listener: RESTOperation.ResultListener?) -> RESTOperation {`
`12`	`13`	`plugin.get(request: request, listener: listener)`
`13`	`14`	`}`
`14`	`15`
	`16`	`+ @discardableResult`
`15`	`17`	`public func put(request: RESTRequest, listener: RESTOperation.ResultListener?) -> RESTOperation {`
`16`	`18`	`plugin.put(request: request, listener: listener)`
`17`	`19`	`}`
`18`	`20`
	`21`	`+ @discardableResult`
`19`	`22`	`public func post(request: RESTRequest, listener: RESTOperation.ResultListener?) -> RESTOperation {`
`20`	`23`	`plugin.post(request: request, listener: listener)`
`21`	`24`	`}`
`22`	`25`
	`26`	`+ @discardableResult`
`23`	`27`	`public func delete(request: RESTRequest, listener: RESTOperation.ResultListener?) -> RESTOperation {`
`24`	`28`	`plugin.delete(request: request, listener: listener)`
`25`	`29`	`}`
`26`	`30`
	`31`	`+ @discardableResult`
`27`	`32`	`public func head(request: RESTRequest, listener: RESTOperation.ResultListener?) -> RESTOperation {`
`28`	`33`	`plugin.head(request: request, listener: listener)`
`29`	`34`	`}`
`30`	`35`
	`36`	`+ @discardableResult`
`31`	`37`	`public func patch(request: RESTRequest, listener: RESTOperation.ResultListener?) -> RESTOperation {`
`32`	`38`	`plugin.patch(request: request, listener: listener)`
`33`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ class AWSAPICategoryPluginConfigureTests: AWSAPICategoryPluginTestBase {`
`46`	`46`	`XCTFail("Api configuration should not succeed")`
`47`	`47`	`} catch {`
`48`	`48`	`guard let apiError = error as? PluginError,`
`49`		`- case .pluginConfigurationError(_, _, _) = apiError else {`
	`49`	`+ case .pluginConfigurationError = apiError else {`
`50`	`50`	`XCTFail("Should throw invalidConfiguration exception. But received \(error) ")`
`51`	`51`	`return`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ class AWSPinpointAnalyticsPluginConfigureTests: AWSPinpointAnalyticsPluginTestBa`
`66`	`66`	`XCTFail("Analytics configuration should not succeed")`
`67`	`67`	`} catch {`
`68`	`68`	`guard let pluginError = error as? PluginError,`
`69`		`- case .pluginConfigurationError(_, _, _) = pluginError else {`
	`69`	`+ case .pluginConfigurationError = pluginError else {`
`70`	`70`	`XCTFail("Should throw invalidConfiguration exception. But received \(error) ")`
`71`	`71`	`return`
`72`	`72`	`}`