fix(Auth): Add logging to Amplify Auth tasks (#3365)

harsh62 · web-flow · commit d3af5f9222c3 · 2023-12-11T09:04:21.000-05:00
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthChangePasswordTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthChangePasswordTask.swift
@@ -58,10 +58,4 @@ class AWSAuthChangePasswordTask: AuthChangePasswordTask, DefaultLogger {
         _ = try await userPoolService.changePassword(input: input)
     }
     
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    public var log: Logger {
-        Self.log
-    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthClearFederationToIdentityPoolTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthClearFederationToIdentityPoolTask.swift
@@ -42,10 +42,4 @@ public class AWSAuthClearFederationToIdentityPoolTask: AuthClearFederationToIden
         return
     }
     
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    public var log: Logger {
-        Self.log
-    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthConfirmResetPasswordTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthConfirmResetPasswordTask.swift
@@ -89,10 +89,4 @@ class AWSAuthConfirmResetPasswordTask: AuthConfirmResetPasswordTask, DefaultLogg
         _ = try await userPoolService.confirmForgotPassword(input: input)
     }
     
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    public var log: Logger {
-        Self.log
-    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthConfirmSignInTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthConfirmSignInTask.swift
@@ -148,10 +148,4 @@ class AWSAuthConfirmSignInTask: AuthConfirmSignInTask, DefaultLogger {
             friendlyDeviceName: pluginOptions?.friendlyDeviceName)
     }
 
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    public var log: Logger {
-        Self.log
-    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthConfirmSignUpTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthConfirmSignUpTask.swift
@@ -53,10 +53,4 @@ class AWSAuthConfirmSignUpTask: AuthConfirmSignUpTask, DefaultLogger {
         }
     }
     
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    public var log: Logger {
-        Self.log
-    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthDeleteUserTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthDeleteUserTask.swift
@@ -86,10 +86,4 @@ class AWSAuthDeleteUserTask: AuthDeleteUserTask, DefaultLogger {
         await taskHelper.didStateMachineConfigured()
     }
     
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    public var log: Logger {
-        Self.log
-    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthFederateToIdentityPoolTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthFederateToIdentityPoolTask.swift
@@ -113,11 +113,4 @@ public class AWSAuthFederateToIdentityPoolTask: AuthFederateToIdentityPoolTask,
         }
     }
 
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    
-    public var log: Logger {
-        Self.log
-    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthFetchSessionTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthFetchSessionTask.swift
@@ -33,11 +33,4 @@ class AWSAuthFetchSessionTask: AuthFetchSessionTask, DefaultLogger {
                                                       forceRefresh: doesNeedForceRefresh)
     }
     
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    
-    public var log: Logger {
-        Self.log
-    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthResendSignUpCodeTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthResendSignUpCodeTask.swift
@@ -94,11 +94,4 @@ class AWSAuthResendSignUpCodeTask: AuthResendSignUpCodeTask, DefaultLogger {
         return deliveryDetails
     }
     
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    
-    public var log: Logger {
-        Self.log
-    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthResetPasswordTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthResetPasswordTask.swift
@@ -94,12 +94,4 @@ class AWSAuthResetPasswordTask: AuthResetPasswordTask, DefaultLogger {
         let authResetPasswordResult = AuthResetPasswordResult(isPasswordReset: false, nextStep: nextStep)
         return authResetPasswordResult
     }
-    
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    
-    public var log: Logger {
-        Self.log
-    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthSignInTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthSignInTask.swift
@@ -170,12 +170,4 @@ class AWSAuthSignInTask: AuthSignInTask, DefaultLogger {
 
         return clientMetadata
     }
-    
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    
-    public var log: Logger {
-        Self.log
-    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthSignOutTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthSignOutTask.swift
@@ -77,12 +77,4 @@ class AWSAuthSignOutTask: AuthSignOutTask, DefaultLogger {
         let event = AuthenticationEvent(eventType: .signOutRequested(signOutData))
         await authStateMachine.send(event)
     }
-    
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    
-    public var log: Logger {
-        Self.log
-    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthSignUpTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthSignUpTask.swift
@@ -62,12 +62,4 @@ class AWSAuthSignUpTask: AuthSignUpTask, DefaultLogger {
             )
         }
     }
-
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    
-    public var log: Logger {
-        Self.log
-    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthWebUISignInTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthWebUISignInTask.swift
@@ -47,12 +47,5 @@ class AWSAuthWebUISignInTask: AuthWebUISignInTask, DefaultLogger {
         }
     }
     
-    public static var log: Logger {
-        Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))
-    }
-    
-    public var log: Logger {
-        Self.log
-    }
 }
 #endif
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/DeviceTasks/AWSAuthFetchDevicesTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/DeviceTasks/AWSAuthFetchDevicesTask.swift
@@ -11,7 +11,7 @@ import AWSPluginsCore
 import ClientRuntime
 import AWSCognitoIdentityProvider
 
-class AWSAuthFetchDevicesTask: AuthFetchDevicesTask {
+class AWSAuthFetchDevicesTask: AuthFetchDevicesTask, DefaultLogger {
     typealias CognitoUserPoolFactory = () throws -> CognitoUserPoolBehavior
 
     private let request: AuthFetchDevicesRequest
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/DeviceTasks/AWSAuthForgetDeviceTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/DeviceTasks/AWSAuthForgetDeviceTask.swift
@@ -11,7 +11,7 @@ import AWSPluginsCore
 import ClientRuntime
 import AWSCognitoIdentityProvider
 
-class AWSAuthForgetDeviceTask: AuthForgetDeviceTask {
+class AWSAuthForgetDeviceTask: AuthForgetDeviceTask, DefaultLogger {
 
     private let request: AuthForgetDeviceRequest
     private let authStateMachine: AuthStateMachine
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/DeviceTasks/AWSAuthRememberDeviceTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/DeviceTasks/AWSAuthRememberDeviceTask.swift
@@ -11,7 +11,7 @@ import AWSPluginsCore
 import ClientRuntime
 import AWSCognitoIdentityProvider
 
-class AWSAuthRememberDeviceTask: AuthRememberDeviceTask {
+class AWSAuthRememberDeviceTask: AuthRememberDeviceTask, DefaultLogger {
 
     private let request: AuthRememberDeviceRequest
     private let authStateMachine: AuthStateMachine
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/Protocols/AmplifyAuthTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/Protocols/AmplifyAuthTask.swift
@@ -25,14 +25,17 @@ protocol AmplifyAuthTask {
 
 }
 
-extension AmplifyAuthTask {
+extension AmplifyAuthTask where Self: DefaultLogger {
     var value: Success {
         get async throws {
             do {
+                log.info("Starting execution for \(eventName)")
                 let valueReturned = try await execute()
+                log.info("Successfully completed execution for \(eventName) with result:\n\(prettify(valueReturned))")
                 dispatch(result: .success(valueReturned))
                 return valueReturned
             } catch let error as Failure {
+                log.error("Failed execution for \(eventName) with error:\n\(prettify(error))")
                 dispatch(result: .failure(error))
                 throw error
             }
@@ -44,4 +47,10 @@ extension AmplifyAuthTask {
         let payload = HubPayload(eventName: eventName, context: nil, data: result)
         Amplify.Hub.dispatch(to: channel, payload: payload)
     }
+
+    private func prettify<T>(_ value: T) -> String {
+        var result = ""
+        dump(value, to: &result)
+        return result
+    }
 }
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/UserTasks/AWSAuthAttributeResendConfirmationCodeTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/UserTasks/AWSAuthAttributeResendConfirmationCodeTask.swift
@@ -10,7 +10,7 @@ import Amplify
 import AWSPluginsCore
 import AWSCognitoIdentityProvider
 
-class AWSAuthAttributeResendConfirmationCodeTask: AuthAttributeResendConfirmationCodeTask {
+class AWSAuthAttributeResendConfirmationCodeTask: AuthAttributeResendConfirmationCodeTask, DefaultLogger {
     typealias CognitoUserPoolFactory = () throws -> CognitoUserPoolBehavior
 
     private let request: AuthAttributeResendConfirmationCodeRequest
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/UserTasks/AWSAuthConfirmUserAttributeTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/UserTasks/AWSAuthConfirmUserAttributeTask.swift
@@ -11,7 +11,7 @@ import AWSPluginsCore
 import ClientRuntime
 import AWSCognitoIdentityProvider
 
-class AWSAuthConfirmUserAttributeTask: AuthConfirmUserAttributeTask {
+class AWSAuthConfirmUserAttributeTask: AuthConfirmUserAttributeTask, DefaultLogger {
     typealias CognitoUserPoolFactory = () throws -> CognitoUserPoolBehavior
 
     private let request: AuthConfirmUserAttributeRequest
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/UserTasks/AWSAuthFetchUserAttributeTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/UserTasks/AWSAuthFetchUserAttributeTask.swift
@@ -11,7 +11,7 @@ import AWSPluginsCore
 import ClientRuntime
 import AWSCognitoIdentityProvider
 
-class AWSAuthFetchUserAttributeTask: AuthFetchUserAttributeTask {
+class AWSAuthFetchUserAttributeTask: AuthFetchUserAttributeTask, DefaultLogger {
     typealias CognitoUserPoolFactory = () throws -> CognitoUserPoolBehavior
 
     private let request: AuthFetchUserAttributesRequest
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/UserTasks/AWSAuthUpdateUserAttributeTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/UserTasks/AWSAuthUpdateUserAttributeTask.swift
@@ -10,7 +10,7 @@ import Amplify
 import AWSPluginsCore
 import AWSCognitoIdentityProvider
 
-class AWSAuthUpdateUserAttributeTask: AuthUpdateUserAttributeTask {
+class AWSAuthUpdateUserAttributeTask: AuthUpdateUserAttributeTask, DefaultLogger {
     typealias CognitoUserPoolFactory = () throws -> CognitoUserPoolBehavior
 
     private let request: AuthUpdateUserAttributeRequest
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/UserTasks/AWSAuthUpdateUserAttributesTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/UserTasks/AWSAuthUpdateUserAttributesTask.swift
@@ -10,7 +10,7 @@ import Amplify
 import AWSPluginsCore
 import AWSCognitoIdentityProvider
 
-class AWSAuthUpdateUserAttributesTask: AuthUpdateUserAttributesTask {
+class AWSAuthUpdateUserAttributesTask: AuthUpdateUserAttributesTask, DefaultLogger {
     typealias CognitoUserPoolFactory = () throws -> CognitoUserPoolBehavior
 
     private let request: AuthUpdateUserAttributesRequest

Original file line number	Diff line number	Diff line change
`@@ -58,10 +58,4 @@ class AWSAuthChangePasswordTask: AuthChangePasswordTask, DefaultLogger {`
`58`	`58`	`_ = try await userPoolService.changePassword(input: input)`
`59`	`59`	`}`
`60`	`60`
`61`		`- public static var log: Logger {`
`62`		`- Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))`
`63`		`- }`
`64`		`- public var log: Logger {`
`65`		`- Self.log`
`66`		`- }`
`67`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,10 +42,4 @@ public class AWSAuthClearFederationToIdentityPoolTask: AuthClearFederationToIden`
`42`	`42`	`return`
`43`	`43`	`}`
`44`	`44`
`45`		`- public static var log: Logger {`
`46`		`- Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))`
`47`		`- }`
`48`		`- public var log: Logger {`
`49`		`- Self.log`
`50`		`- }`
`51`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -89,10 +89,4 @@ class AWSAuthConfirmResetPasswordTask: AuthConfirmResetPasswordTask, DefaultLogg`
`89`	`89`	`_ = try await userPoolService.confirmForgotPassword(input: input)`
`90`	`90`	`}`
`91`	`91`
`92`		`- public static var log: Logger {`
`93`		`- Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))`
`94`		`- }`
`95`		`- public var log: Logger {`
`96`		`- Self.log`
`97`		`- }`
`98`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -148,10 +148,4 @@ class AWSAuthConfirmSignInTask: AuthConfirmSignInTask, DefaultLogger {`
`148`	`148`	`friendlyDeviceName: pluginOptions?.friendlyDeviceName)`
`149`	`149`	`}`
`150`	`150`
`151`		`- public static var log: Logger {`
`152`		`- Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))`
`153`		`- }`
`154`		`- public var log: Logger {`
`155`		`- Self.log`
`156`		`- }`
`157`	`151`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,10 +53,4 @@ class AWSAuthConfirmSignUpTask: AuthConfirmSignUpTask, DefaultLogger {`
`53`	`53`	`}`
`54`	`54`	`}`
`55`	`55`
`56`		`- public static var log: Logger {`
`57`		`- Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))`
`58`		`- }`
`59`		`- public var log: Logger {`
`60`		`- Self.log`
`61`		`- }`
`62`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -86,10 +86,4 @@ class AWSAuthDeleteUserTask: AuthDeleteUserTask, DefaultLogger {`
`86`	`86`	`await taskHelper.didStateMachineConfigured()`
`87`	`87`	`}`
`88`	`88`
`89`		`- public static var log: Logger {`
`90`		`- Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))`
`91`		`- }`
`92`		`- public var log: Logger {`
`93`		`- Self.log`
`94`		`- }`
`95`	`89`	`}`
Original file line number	Diff line number	Diff line change
`@@ -113,11 +113,4 @@ public class AWSAuthFederateToIdentityPoolTask: AuthFederateToIdentityPoolTask,`
`113`	`113`	`}`
`114`	`114`	`}`
`115`	`115`
`116`		`- public static var log: Logger {`
`117`		`- Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))`
`118`		`- }`
`119`		`-`
`120`		`- public var log: Logger {`
`121`		`- Self.log`
`122`		`- }`
`123`	`116`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,11 +33,4 @@ class AWSAuthFetchSessionTask: AuthFetchSessionTask, DefaultLogger {`
`33`	`33`	`forceRefresh: doesNeedForceRefresh)`
`34`	`34`	`}`
`35`	`35`
`36`		`- public static var log: Logger {`
`37`		`- Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))`
`38`		`- }`
`39`		`-`
`40`		`- public var log: Logger {`
`41`		`- Self.log`
`42`		`- }`
`43`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -94,11 +94,4 @@ class AWSAuthResendSignUpCodeTask: AuthResendSignUpCodeTask, DefaultLogger {`
`94`	`94`	`return deliveryDetails`
`95`	`95`	`}`
`96`	`96`
`97`		`- public static var log: Logger {`
`98`		`- Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))`
`99`		`- }`
`100`		`-`
`101`		`- public var log: Logger {`
`102`		`- Self.log`
`103`		`- }`
`104`	`97`	`}`
Original file line number	Diff line number	Diff line change
`@@ -94,12 +94,4 @@ class AWSAuthResetPasswordTask: AuthResetPasswordTask, DefaultLogger {`
`94`	`94`	`let authResetPasswordResult = AuthResetPasswordResult(isPasswordReset: false, nextStep: nextStep)`
`95`	`95`	`return authResetPasswordResult`
`96`	`96`	`}`
`97`		`-`
`98`		`- public static var log: Logger {`
`99`		`- Amplify.Logging.logger(forCategory: CategoryType.auth.displayName, forNamespace: String(describing: self))`
`100`		`- }`
`101`		`-`
`102`		`- public var log: Logger {`
`103`		`- Self.log`
`104`		`- }`
`105`	`97`	`}`