zashi-ios-wallet-private/secant/Dependencies/UserPreferencesStorage.swift

//
//  UserPreferencesStorage.swift
//  secant-testnet
//
//  Created by Lukáš Korba on 03/18/2022.
//

import Foundation
import ComposableArchitecture

/// Live implementation of the `UserPreferences` using User Defaults
/// according to https://developer.apple.com/documentation/foundation/userdefaults
/// the UserDefaults class is thread-safe.
struct UserPreferencesStorage {
    enum Constants: String, CaseIterable {
        case zcashActiveAppSessionFrom
        case zcashCurrency
        case zcashFiatConverted
        case zcashRecoveryPhraseTestCompleted
        case zcashSessionAutoshielded
    }
    
    /// Default values for all preferences in case there is no value stored (counterparts to `Constants`)
    private let appSessionFrom: TimeInterval
    private let convertedCurrency: String
    private let fiatConvertion: Bool
    private let recoveryPhraseTestCompleted: Bool
    private let sessionAutoshielded: Bool
    
    private let userDefaults: WrappedUserDefaults
    
    init(
        appSessionFrom: TimeInterval,
        convertedCurrency: String,
        fiatConvertion: Bool,
        recoveryPhraseTestCompleted: Bool,
        sessionAutoshielded: Bool,
        userDefaults: WrappedUserDefaults
    ) {
        self.appSessionFrom = appSessionFrom
        self.convertedCurrency = convertedCurrency
        self.fiatConvertion = fiatConvertion
        self.recoveryPhraseTestCompleted = recoveryPhraseTestCompleted
        self.sessionAutoshielded = sessionAutoshielded
        self.userDefaults = userDefaults
    }
    
    /// From when the app is on and uninterrupted
    var activeAppSessionFrom: TimeInterval {
        getValue(forKey: Constants.zcashActiveAppSessionFrom.rawValue, default: appSessionFrom)
    }
    
    func setActiveAppSessionFrom(_ timeInterval: TimeInterval) -> Effect<Never, Never> {
        setValue(timeInterval, forKey: Constants.zcashActiveAppSessionFrom.rawValue)
    }

    /// What is the set up currency
    var currency: String {
        getValue(forKey: Constants.zcashCurrency.rawValue, default: convertedCurrency)
    }
    
    func setCurrency(_ string: String) -> Effect<Never, Never> {
        setValue(string, forKey: Constants.zcashCurrency.rawValue)
    }

    /// Whether the fiat conversion is on/off
    var isFiatConverted: Bool {
        getValue(forKey: Constants.zcashFiatConverted.rawValue, default: fiatConvertion)
    }

    func setIsFiatConverted(_ bool: Bool) -> Effect<Never, Never> {
        setValue(bool, forKey: Constants.zcashFiatConverted.rawValue)
    }

    /// Whether user finished recovery phrase backup test
    var isRecoveryPhraseTestCompleted: Bool {
        getValue(forKey: Constants.zcashRecoveryPhraseTestCompleted.rawValue, default: recoveryPhraseTestCompleted)
    }

    func setIsRecoveryPhraseTestCompleted(_ bool: Bool) -> Effect<Never, Never> {
        setValue(bool, forKey: Constants.zcashRecoveryPhraseTestCompleted.rawValue)
    }

    /// Whether the user has been autoshielded in the running session
    var isSessionAutoshielded: Bool {
        getValue(forKey: Constants.zcashSessionAutoshielded.rawValue, default: sessionAutoshielded)
    }

    func setIsSessionAutoshielded(_ bool: Bool) -> Effect<Never, Never> {
        setValue(bool, forKey: Constants.zcashSessionAutoshielded.rawValue)
    }

    /// Use carefully: Deletes all user preferences from the User Defaults
    func removeAll() -> Effect<Never, Never> {
        var removals: [Effect<Never, Never>] = []

        Constants.allCases.forEach { removals.append(userDefaults.remove($0.rawValue)) }
        
        return Effect.concatenate(removals)
    }
}

private extension UserPreferencesStorage {
    func getValue<Value>(forKey: String, default defaultIfNil: Value) -> Value {
        userDefaults.objectForKey(forKey) as? Value ?? defaultIfNil
    }

    func setValue<Value>(_ value: Value, forKey: String) -> Effect<Never, Never> {
        let effect = userDefaults.setValue(value, forKey)
        _ = userDefaults.synchronize()
        
        return effect
    }
}

extension UserPreferencesStorage {
    static let live = UserPreferencesStorage(
        appSessionFrom: Date().timeIntervalSince1970,
        convertedCurrency: "USD",
        fiatConvertion: true,
        recoveryPhraseTestCompleted: false,
        sessionAutoshielded: true,
        userDefaults: .live()
    )
    
    static let mock = UserPreferencesStorage(
        appSessionFrom: 1651039606.0,
        convertedCurrency: "USD",
        fiatConvertion: true,
        recoveryPhraseTestCompleted: false,
        sessionAutoshielded: true,
        userDefaults: .mock
    )
}