AmplifyAuthTask.swift

//
// Copyright Amazon.com Inc. or its affiliates.
// All Rights Reserved.
//
// SPDX-License-Identifier: Apache-2.0
//
import Foundation
import Amplify

#if canImport(UIKit)
import UIKit
#endif

protocol AmplifyAuthTask {

    associatedtype Success
    associatedtype Request
    associatedtype Failure: AmplifyError

    typealias AmplifyAuthTaskResult = Result<Success, Failure>

    var value: Success { get async throws }

    var eventName: HubPayloadEventName { get }

    func execute() async throws -> Success

    func dispatch(result: AmplifyAuthTaskResult)

}

extension AmplifyAuthTask where Self: DefaultLogger {
    var value: Success {
        get async throws {
            do {
                log.info("Starting execution for \(eventName)")
#if canImport(UIKit)
                guard await UIApplication.shared.isProtectedDataAvailable else {
                    throw AuthError.configuration(
                        AuthPluginErrorConstants.protectedDataUnavailableError.errorDescription,
                        AuthPluginErrorConstants.protectedDataUnavailableError.recoverySuggestion,
                        AWSCognitoAuthError.protectedDataUnavailable)
                }
#endif
                let valueReturned = try await execute()
                log.info("Successfully completed execution for \(eventName) with result:\n\(valueReturned)")
                dispatch(result: .success(valueReturned))
                return valueReturned
            } catch let error as Failure {
                log.error("Failed execution for \(eventName) with error:\n\(error)")
                dispatch(result: .failure(error))
                throw error
            }
        }
    }

    func dispatch(result: AmplifyAuthTaskResult) {
        let channel = HubChannel(from: .auth)
        let payload = HubPayload(eventName: eventName, context: nil, data: result)
        Amplify.Hub.dispatch(to: channel, payload: payload)
    }
}