chore(auth): Add logging to non throwing tasks (#3791)

* fix(Auth): Add logging to non throwing tasks * update logs * update * added documentation * Update API dumps for new version --------- Co-authored-by: aws-amplify-ops <[email protected]>
aws-amplify · Aug 21, 2024 · bdfa37a · bdfa37a
1 parent 79d062d
commit bdfa37a
Show file tree

Hide file tree

Showing 21 changed files with 102 additions and 88 deletions.
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthChangePasswordTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthChangePasswordTask.swift
@@ -33,7 +33,6 @@ class AWSAuthChangePasswordTask: AuthChangePasswordTask, DefaultLogger {
     }
 
     func execute() async throws {
-        log.verbose("Starting execution")
         do {
             await taskHelper.didStateMachineConfigured()
             let accessToken = try await taskHelper.getAccessToken()

diff --git a/...ins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthClearFederationToIdentityPoolTask.swift b/...ins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthClearFederationToIdentityPoolTask.swift
@@ -35,7 +35,6 @@ public class AWSAuthClearFederationToIdentityPoolTask: AuthClearFederationToIden
     }
 
     public func execute() async throws {
-        log.verbose("Starting execution")
         await taskHelper.didStateMachineConfigured()
         try await clearFederationHelper.clearFederation(authStateMachine)
         log.verbose("Cleared federation")

diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthConfirmResetPasswordTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthConfirmResetPasswordTask.swift
@@ -27,7 +27,6 @@ class AWSAuthConfirmResetPasswordTask: AuthConfirmResetPasswordTask, DefaultLogg
     }
 
     func execute() async throws {
-        log.verbose("Starting execution")
         if let validationError = request.hasError() {
             throw validationError
         }

diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthConfirmSignInTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthConfirmSignInTask.swift
@@ -29,7 +29,6 @@ class AWSAuthConfirmSignInTask: AuthConfirmSignInTask, DefaultLogger {
     }
 
     func execute() async throws -> AuthSignInResult {
-        log.verbose("Starting execution")
         await taskHelper.didStateMachineConfigured()
 
         // Check if we have a user pool configuration

diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthConfirmSignUpTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthConfirmSignUpTask.swift
@@ -24,7 +24,6 @@ class AWSAuthConfirmSignUpTask: AuthConfirmSignUpTask, DefaultLogger {
     }
 
     func execute() async throws -> AuthSignUpResult {
-        log.verbose("Starting execution")
         try request.hasError()
         let userPoolEnvironment = authEnvironment.userPoolEnvironment
         do {

diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthDeleteUserTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthDeleteUserTask.swift
@@ -26,7 +26,6 @@ class AWSAuthDeleteUserTask: AuthDeleteUserTask, DefaultLogger {
     }
 
     func execute() async throws {
-        log.verbose("Starting execution")
         await taskHelper.didStateMachineConfigured()
         let accessToken = try await taskHelper.getAccessToken()
 

diff --git a/...ifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthFederateToIdentityPoolTask.swift b/...ifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthFederateToIdentityPoolTask.swift
@@ -34,7 +34,6 @@ public class AWSAuthFederateToIdentityPoolTask: AuthFederateToIdentityPoolTask,
     }
 
     public func execute() async throws -> FederateToIdentityPoolResult {
-        log.verbose("Starting execution")
         await taskHelper.didStateMachineConfigured()
         let state = await authStateMachine.currentState
         guard case .configured(let authNState, let authZState) = state  else {

diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthFetchSessionTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthFetchSessionTask.swift
@@ -26,7 +26,6 @@ class AWSAuthFetchSessionTask: AuthFetchSessionTask, DefaultLogger {
     }
 
     func execute() async throws -> AuthSession {
-        log.verbose("Starting execution")
         await taskHelper.didStateMachineConfigured()
         let doesNeedForceRefresh = request.options.forceRefresh
         return try await fetchAuthSessionHelper.fetch(authStateMachine,

diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthResendSignUpCodeTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthResendSignUpCodeTask.swift
@@ -27,7 +27,6 @@ class AWSAuthResendSignUpCodeTask: AuthResendSignUpCodeTask, DefaultLogger {
     }
 
     func execute() async throws -> AuthCodeDeliveryDetails {
-        log.verbose("Starting execution")
         if let validationError = request.hasError() {
             throw validationError
         }

diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthResetPasswordTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthResetPasswordTask.swift
@@ -28,7 +28,6 @@ class AWSAuthResetPasswordTask: AuthResetPasswordTask, DefaultLogger {
     }
 
     func execute() async throws -> AuthResetPasswordResult {
-        log.verbose("Starting execution")
         if let validationError = request.hasError() {
             throw validationError
         }

diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthSignInTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthSignInTask.swift
@@ -29,7 +29,6 @@ class AWSAuthSignInTask: AuthSignInTask, DefaultLogger {
     }
 
     func execute() async throws -> AuthSignInResult {
-        log.verbose("Starting execution")
         await taskHelper.didStateMachineConfigured()
         // Check if we have a user pool configuration
         guard let userPoolConfiguration = authConfiguration.getUserPoolConfiguration() else {

diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthSignOutTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthSignOutTask.swift
@@ -25,7 +25,6 @@ class AWSAuthSignOutTask: AuthSignOutTask, DefaultLogger {
     }
 
     func execute() async -> AuthSignOutResult {
-        log.verbose("Starting execution")
         await taskHelper.didStateMachineConfigured()
 
         guard case .configured(let authNState, _) = await authStateMachine.currentState else {

diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthSignUpTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthSignUpTask.swift
@@ -25,7 +25,6 @@ class AWSAuthSignUpTask: AuthSignUpTask, DefaultLogger {
     }
 
     func execute() async throws -> AuthSignUpResult {
-        log.verbose("Starting execution")
         let userPoolEnvironment = authEnvironment.userPoolEnvironment
         try request.hasError()
 

diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthWebUISignInTask.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthWebUISignInTask.swift
@@ -33,7 +33,6 @@ class AWSAuthWebUISignInTask: AuthWebUISignInTask, DefaultLogger {
     }
 
     func execute() async throws -> AuthSignInResult {
-        log.verbose("Starting execution")
         do {
             await taskHelper.didStateMachineConfigured()
             let result = try await helper.initiateSignIn()

diff --git a/...Plugins/Auth/Sources/AWSCognitoAuthPlugin/Task/Protocols/AmplifyAuthTaskNonThrowing.swift b/...Plugins/Auth/Sources/AWSCognitoAuthPlugin/Task/Protocols/AmplifyAuthTaskNonThrowing.swift
@@ -23,10 +23,12 @@ protocol AmplifyAuthTaskNonThrowing {
 
 }
 
-extension AmplifyAuthTaskNonThrowing {
+extension AmplifyAuthTaskNonThrowing where Self: DefaultLogger {
     var value: Success {
         get async {
+            log.info("Starting execution for \(eventName)")
             let valueReturned = await execute()
+            log.info("Successfully completed execution for \(eventName) with result:\n\(valueReturned)")
             dispatch(result: valueReturned)
             return valueReturned
         }

diff --git a/AmplifyPlugins/Core/AWSPluginsCore/Auth/AuthAWSCredentialsProvider.swift b/AmplifyPlugins/Core/AWSPluginsCore/Auth/AuthAWSCredentialsProvider.swift
@@ -35,16 +35,42 @@ public protocol AWSCredentialsProvider {
     func fetchAWSCredentials() async throws -> AWSCredentials
 }
 
-public protocol AWSTemporaryCredentials: AWSCredentials {
-
-    var sessionToken: String { get }
+/**
+ Represents AWS credentials.
 
-    var expiration: Date { get }
-}
+ Typically refers to long-term credentials that do not expire unless manually rotated or deactivated.
+ These credentials are generally associated with an IAM (Identity and Access Management) user and are used to authenticate API requests to AWS services.
 
+ - Properties:
+ - accessKeyId: A unique identifier.
+ - secretAccessKey: A secret key used to sign requests cryptographically.
+ */
 public protocol AWSCredentials {
 
+    /// A unique identifier.
     var accessKeyId: String { get }
 
+    /// A secret key used to sign requests cryptographically.
     var secretAccessKey: String { get }
 }
+
+/**
+ Represents temporary AWS credentials.
+
+ Refers to short-term credentials generated by AWS STS (Security Token Service).
+ These credentials are used for temporary access, often for applications, temporary roles, federated users, or scenarios requiring limited-time access.
+
+ - Inherits: AWSCredentials
+
+ - Properties:
+ - sessionToken: A token that is required when using temporary security credentials to sign requests.
+ - expiration: The expiration date and time of the temporary credentials.
+ */
+public protocol AWSTemporaryCredentials: AWSCredentials {
+
+    /// A token that is required when using temporary security credentials to sign requests.
+    var sessionToken: String { get }
+
+    /// The expiration date and time of the temporary credentials.
+    var expiration: Date { get }
+}
diff --git a/AmplifyPlugins/Core/AWSPluginsCore/Keychain/KeychainStore.swift b/AmplifyPlugins/Core/AWSPluginsCore/Keychain/KeychainStore.swift
@@ -92,7 +92,7 @@ public struct KeychainStore: KeychainStoreBehavior {
             log.error("[KeychainStore] Unable to create String from Data retrieved")
             throw KeychainStoreError.conversionError("Unable to create String from Data retrieved")
         }
-        log.verbose("[KeychainStore] Successfully retrieved string from the store")
+        log.verbose("[KeychainStore] Successfully retrieved `String` from the store")
         return string
 
     }
@@ -175,7 +175,7 @@ public struct KeychainStore: KeychainStoreBehavior {
                 log.error("[KeychainStore] Error updating item to keychain with status=\(updateStatus)")
                 throw KeychainStoreError.securityError(updateStatus)
             }
-            log.verbose("[KeychainStore] Successfully updated `String` in keychain for key=\(key)")
+            log.verbose("[KeychainStore] Successfully updated `Data` in keychain for key=\(key)")
             #endif
         case errSecItemNotFound:
             log.verbose("[KeychainStore] Unable to find an existing item, creating new item")
@@ -188,7 +188,7 @@ public struct KeychainStore: KeychainStoreBehavior {
                 log.error("[KeychainStore] Error adding item to keychain with status=\(addStatus)")
                 throw KeychainStoreError.securityError(addStatus)
             }
-            log.verbose("[KeychainStore] Successfully added `String` in keychain for key=\(key)")
+            log.verbose("[KeychainStore] Successfully added `Data` in keychain for key=\(key)")
         default:
             log.error("[KeychainStore] Error occurred while retrieving data from keychain when deciding to update or add with status=\(fetchStatus)")
             throw KeychainStoreError.securityError(fetchStatus)
@@ -206,7 +206,7 @@ public struct KeychainStore: KeychainStoreBehavior {
 
         let status = SecItemDelete(query as CFDictionary)
         if status != errSecSuccess && status != errSecItemNotFound {
-            log.error("[KeychainStore] Error removing itms from keychain with status=\(status)")
+            log.error("[KeychainStore] Error removing items from keychain with status=\(status)")
             throw KeychainStoreError.securityError(status)
         }
         log.verbose("[KeychainStore] Successfully removed item from keychain")

diff --git a/api-dump/AWSDataStorePlugin.json b/api-dump/AWSDataStorePlugin.json
@@ -8205,7 +8205,7 @@
       "-module",
       "AWSDataStorePlugin",
       "-o",
-      "\/var\/folders\/hn\/5bx1f4_d4ds5vhwhkxc7vdcr0000gn\/T\/tmp.nAGRifhwH6\/AWSDataStorePlugin.json",
+      "\/var\/folders\/hw\/1f0gcr8d6kn9ms0_wn0_57qc0000gn\/T\/tmp.rjSPtedPzR\/AWSDataStorePlugin.json",
       "-I",
       ".build\/debug",
       "-sdk-version",