session-ios/SessionSnodeKit/Types/ValidatableResponse.swift

// Copyright © 2023 Rangeproof Pty Ltd. All rights reserved.

import Foundation
import SessionUtilitiesKit

internal protocol ValidatableResponse {
    associatedtype ValidationData
    associatedtype ValidationResponse
    
    /// This valid controls the number of successful responses for a response to be considered "valid", a
    /// positive number indicates an exact number of responses required whereas a negative number indicates
    /// a dividing factor, eg.
    /// 2 = Two nodes need to have returned success responses
    /// -2 = 50% of the nodes need to have returned success responses
    /// -4 = 25% of the nodes need to have returned success responses
    static var requiredSuccessfulResponses: Int { get }
    
    @discardableResult static func validated(
        map validResultMap: [String: ValidationResponse],
        totalResponseCount: Int
    ) throws -> [String: ValidationResponse]
    
    @discardableResult func validResultMap(
        swarmPublicKey: String,
        validationData: ValidationData,
        using dependencies: Dependencies
    ) throws -> [String: ValidationResponse]
}

// MARK: - Convenience

internal extension ValidatableResponse {
    @discardableResult static func validated(
        map validResultMap: [String: ValidationResponse],
        totalResponseCount: Int
    ) throws -> [String: ValidationResponse] {
        guard totalResponseCount > 0 else { return [:] }
        
        let numSuccessResponses: Int = validResultMap.count
        let successPercentage: CGFloat = (CGFloat(numSuccessResponses) / CGFloat(totalResponseCount))
        
        guard
            (   // Positive value is an exact number comparison
                Self.requiredSuccessfulResponses >= 0 &&
                numSuccessResponses >= Self.requiredSuccessfulResponses
            ) || (
                // Negative value is a "divisor" for a percentage comparison
                Self.requiredSuccessfulResponses < 0 &&
                successPercentage >= abs(1 / CGFloat(Self.requiredSuccessfulResponses))
            )
        else { throw SnodeAPIError.responseFailedValidation }
        
        return validResultMap
    }
    
    func validateResultMap(swarmPublicKey: String, validationData: ValidationData, using dependencies: Dependencies) throws {
        _ = try validResultMap(
            swarmPublicKey: swarmPublicKey,
            validationData: validationData,
            using: dependencies
        )
    }
}

internal extension ValidatableResponse where ValidationData == Void {
    @discardableResult func validResultMap(
        swarmPublicKey: String,
        using dependencies: Dependencies
    ) throws -> [String: ValidationResponse] {
        return try validResultMap(swarmPublicKey: swarmPublicKey, validationData: (), using: dependencies)
    }
    
    func validateResultMap(swarmPublicKey: String, using dependencies: Dependencies) throws {
        _ = try validResultMap(
            swarmPublicKey: swarmPublicKey,
            validationData: (),
            using: dependencies
        )
    }
}

internal extension ValidatableResponse where ValidationResponse == Bool {
    @discardableResult static func validated(map validResultMap: [String: Bool]) throws -> [String: Bool] {
        return try validated(
            map: validResultMap.filter { $0.value },
            totalResponseCount: validResultMap.count
        )
    }
}