LeadKit/TINetworking/Sources/RequestPreprocessors/DefaultSecuritySchemesRequestPreprocessor.swift

//
//  Copyright (c) 2022 Touch Instinct
//
//  Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the Software), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
//

import TIFoundationUtils

open class DefaultEndpointSecurityPreprocessor: EndpointRequestPreprocessor {
    enum PreprocessError: Error {
        case missingSecurityScheme(String, [String: SecurityScheme])
        case unableToSatisfyRequirements(anyOfRequired: [[String]],
                                         registeredPreprocessors: [String: SecuritySchemePreprocessor])
    }

    private let openApi: OpenAPI

    private var schemePreprocessors: [String: SecuritySchemePreprocessor]

    public init(openApi: OpenAPI, schemePreprocessors: [String: SecuritySchemePreprocessor] = [:]) {
        self.openApi = openApi
        self.schemePreprocessors = schemePreprocessors
    }

    public func preprocess<B,S>(request: EndpointRequest<B,S>,
                                completion: @escaping (Result<EndpointRequest<B,S>, Error>) -> Void) -> Cancellable {

        guard !request.security.compactMap({ $0 }).isEmpty else {
            completion(.success(request))
            return Cancellables.nonCancellable()
        }

        do {
            let endpointSchemes: [[KeyValueTuple<String, SecurityScheme>]] = try request.security.map {
                try $0.map {
                    guard let securityScheme = openApi.security[$0] else {
                        throw PreprocessError.missingSecurityScheme($0, openApi.security)
                    }

                    return ($0, securityScheme)
                }
            }

            return Self.preprocess(request: request,
                                   using: endpointSchemes,
                                   schemePreprocessors: schemePreprocessors) { [schemePreprocessors] in
                switch $0 {
                case let .success(modifiedRequest):
                    completion(.success(modifiedRequest))
                case .failure:
                    completion(.failure(PreprocessError.unableToSatisfyRequirements(anyOfRequired: request.security,
                                                                                    registeredPreprocessors: schemePreprocessors)))
                }
            }
        } catch {
            completion(.failure(error))
            return Cancellables.nonCancellable()
        }
    }

    public func register(preprocessor: SecuritySchemePreprocessor, for scheme: String) {
        schemePreprocessors[scheme] = preprocessor
    }

    private static func preprocess<B,S,SC: Collection>(request: EndpointRequest<B,S>,
                                                       using schemes: SC,
                                                       schemePreprocessors: [String: SecuritySchemePreprocessor],
                                                       completion: @escaping (Result<EndpointRequest<B,S>, Error>) -> Void) -> Cancellable
    where SC.Element == [KeyValueTuple<String, SecurityScheme>] {

        guard let schemeGroup = schemes.first else {
            completion(.success(request))
            return Cancellables.nonCancellable()
        }

        let preprocessorsGroup: [KeyValueTuple<SecurityScheme, SecuritySchemePreprocessor>] = schemeGroup.compactMap {
            guard let preprocessor = schemePreprocessors[$0.key] else {
                return nil
            }

            return ($0.value, preprocessor)
        }

        guard preprocessorsGroup.count == schemeGroup.count else {
            // unable to satisfy group requirement
            // try next scheme group
            return preprocess(request: request,
                              using: schemes.dropFirst(),
                              schemePreprocessors: schemePreprocessors,
                              completion: completion)
        }

        return ScopeCancellable { scope in
            preprocess(request: request,
                       with: preprocessorsGroup) {

                switch $0 {
                case let .success(modifiedRequest):
                    completion(.success(modifiedRequest))
                case let .failure(error):
                    guard !schemes.isEmpty else {
                        completion(.failure(error))
                        return
                    }

                    preprocess(request: request,
                               using: schemes.dropFirst(),
                               schemePreprocessors: schemePreprocessors,
                               completion: completion)
                        .add(to: scope)
                }
            }
        }
    }

    private static func preprocess<B,S,G: Collection>(request: EndpointRequest<B,S>,
                                                      with groups: G,
                                                      completion: @escaping (Result<EndpointRequest<B,S>, Error>) -> Void) -> Cancellable
    where G.Element == KeyValueTuple<SecurityScheme, SecuritySchemePreprocessor> {

        guard let group = groups.first else {
            completion(.success(request))
            return Cancellables.nonCancellable()
        }

        return ScopeCancellable { scope in
            group.value.preprocess(request: request,
                                   using: group.key) {
                switch $0 {
                case let .success(modifiedRequest):
                    preprocess(request: modifiedRequest,
                               with: groups.dropFirst(),
                               completion: completion)
                        .add(to: scope)
                case let .failure(error):
                    completion(.failure(error))
                }
            }
        }
    }
}