AppUserDefaultsTests.swift

//
//  AppUserDefaultsTests.swift
//  DuckDuckGo
//
//  Copyright © 2017 DuckDuckGo. All rights reserved.
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//  http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
//

import XCTest
import BrowserServicesKit

@testable import DuckDuckGo
@testable import Core

class AppUserDefaultsTests: XCTestCase {

    let testGroupName = "test"
    var internalUserDeciderStore: MockInternalUserStoring!
    var customSuite: UserDefaults!

    override func setUp() {
        super.setUp()
        customSuite = UserDefaults(suiteName: testGroupName)
        customSuite.removePersistentDomain(forName: testGroupName)
        internalUserDeciderStore = MockInternalUserStoring()

        // Isolate defaults for UserDefaultsWrapper
        UserDefaults.app = customSuite
    }

    override func tearDown() {
        UserDefaults.app = .standard

        internalUserDeciderStore = nil
        super.tearDown()
    }

    func testWhenLinkPreviewsIsSetThenItIsPersisted() {

        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.longPressPreviews = false
        XCTAssertFalse(appUserDefaults.longPressPreviews)

    }

    func testWhenSettingsIsNewThenDefaultForHideLinkPreviewsIsTrue() {

        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        XCTAssertTrue(appUserDefaults.longPressPreviews)

    }

    func testWhenAllowUniversalLinksIsSetThenItIsPersisted() {

        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.allowUniversalLinks = false
        XCTAssertFalse(appUserDefaults.allowUniversalLinks)

    }

    func testWhenSettingsIsNewThenDefaultForAllowUniversalLinksIsTrue() {
        
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        XCTAssertTrue(appUserDefaults.allowUniversalLinks)

    }

    func testWhenAutocompleteIsSetThenItIsPersisted() {

        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.autocomplete = false
        XCTAssertTrue(!appUserDefaults.autocomplete)

    }

    func testWhenReadingAutocompleteDefaultThenTrueIsReturned() {

        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        XCTAssertTrue(appUserDefaults.autocomplete)

    }
    
    func testWhenCurrentThemeIsSetThenItIsPersisted() {
        
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.currentThemeName = .light
        XCTAssertEqual(appUserDefaults.currentThemeName, .light)
        
    }
    
    func testWhenReadingCurrentThemeDefaultThenSystemDefaultIsReturned() {
        
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        
        XCTAssertEqual(appUserDefaults.currentThemeName, .systemDefault)
    }

    func testDefaultAutofillStateIsFalse() {
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.featureFlagger = createFeatureFlagger(withSubfeatureEnabled: false)
        XCTAssertFalse(appUserDefaults.autofillCredentialsEnabled)
    }

    func testWhenAutofillCredentialsIsDisabledAndHasNotBeenTurnedOnAutomaticallyBeforeWhenSavePromptShownThenDefaultAutofillStateIsFalse() {
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.featureFlagger = createFeatureFlagger(withSubfeatureEnabled: false)
        appUserDefaults.autofillCredentialsHasBeenEnabledAutomaticallyIfNecessary = false
        appUserDefaults.autofillCredentialsSavePromptShowAtLeastOnce = true

        XCTAssertFalse(appUserDefaults.autofillCredentialsEnabled)
    }

    func testWhenAutofillCredentialsIsDisabledAndHasNotBeenTurnedOnAutomaticallyBeforeAndPromptHasNotBeenSeenAndIsNotNewInstallThenDefaultAutofillStateIsFalse() {
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.featureFlagger = createFeatureFlagger(withSubfeatureEnabled: false)
        appUserDefaults.autofillCredentialsHasBeenEnabledAutomaticallyIfNecessary = false
        appUserDefaults.autofillCredentialsSavePromptShowAtLeastOnce = false
        appUserDefaults.autofillIsNewInstallForOnByDefault = false

        XCTAssertFalse(appUserDefaults.autofillCredentialsEnabled)
    }

    func testWhenAutofillCredentialsIsDisabledAndHasNotBeenTurnedOnAutomaticallyBeforeAndPromptHasNotBeenSeenAndIsNewInstallAndFeatureFlagDisabledThenDefaultAutofillStateIsFalse() {
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.autofillCredentialsHasBeenEnabledAutomaticallyIfNecessary = false
        appUserDefaults.autofillCredentialsSavePromptShowAtLeastOnce = false
        appUserDefaults.autofillIsNewInstallForOnByDefault = true
        let featureFlagger = createFeatureFlagger(withSubfeatureEnabled: false)
        appUserDefaults.featureFlagger = featureFlagger

        XCTAssertFalse(appUserDefaults.autofillCredentialsEnabled)
    }

    func testWhenAutofillCredentialsIsDisabledAndHasNotBeenTurnedOnAutomaticallyBeforeAndPromptHasNotBeenSeenAndIsNewInstallAndFeatureFlagEnabledThenDefaultAutofillStateIsTrue() {
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.autofillCredentialsHasBeenEnabledAutomaticallyIfNecessary = false
        appUserDefaults.autofillCredentialsSavePromptShowAtLeastOnce = false
        appUserDefaults.autofillIsNewInstallForOnByDefault = true
        let featureFlagger = createFeatureFlagger(withFeatureFlagEnabled: .autofillOnByDefault)
        appUserDefaults.featureFlagger = featureFlagger

        XCTAssertTrue(appUserDefaults.autofillCredentialsEnabled)
    }

    func testWhenAutofillCredentialsIsDisabledAndHasNotBeenTurnedOnAutomaticallyBeforeAndPromptHasBeenSeenThenAutofillCredentialsStaysDisabled() {
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.autofillCredentialsEnabled = false
        appUserDefaults.autofillCredentialsSavePromptShowAtLeastOnce = true
        appUserDefaults.autofillCredentialsHasBeenEnabledAutomaticallyIfNecessary = false
        XCTAssertEqual(appUserDefaults.autofillCredentialsEnabled, false)
    }
    
    func testWhenAutofillCredentialsIsDisabledAndButHasBeenTurnedOnAutomaticallyBeforeThenAutofillCredentialsStaysDisabled() {
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.autofillCredentialsEnabled = false
        appUserDefaults.autofillCredentialsSavePromptShowAtLeastOnce = false
        appUserDefaults.autofillCredentialsHasBeenEnabledAutomaticallyIfNecessary = true
        XCTAssertEqual(appUserDefaults.autofillCredentialsEnabled, false)
    }

    func testWhenAutofillCredentialsIsDisabledAndHasNotBeenTurnedOnAutomaticallyBeforeAndPromptHasNotBeenSeenAndAllUsersFeatureFlagEnabledThenDefaultAutofillStateIsTrue() {
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.autofillCredentialsHasBeenEnabledAutomaticallyIfNecessary = false
        appUserDefaults.autofillCredentialsSavePromptShowAtLeastOnce = false
        appUserDefaults.autofillIsNewInstallForOnByDefault = false
        let featureFlagger = createFeatureFlagger(withFeatureFlagEnabled: .autofillOnForExistingUsers)
        appUserDefaults.featureFlagger = featureFlagger

        XCTAssertTrue(appUserDefaults.autofillCredentialsEnabled)
    }

    func testWhenAutofillCredentialsIsDisabledAndHasNotBeenTurnedOnAutomaticallyBeforeAndPromptHasBeenSeenAndAllUsersFeatureFlagEnabledThenDefaultAutofillStateIsFalse() {
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.autofillCredentialsHasBeenEnabledAutomaticallyIfNecessary = false
        appUserDefaults.autofillCredentialsSavePromptShowAtLeastOnce = true
        appUserDefaults.autofillIsNewInstallForOnByDefault = false
        let featureFlagger = createFeatureFlagger(withFeatureFlagEnabled: .autofillOnForExistingUsers)
        appUserDefaults.featureFlagger = featureFlagger

        XCTAssertFalse(appUserDefaults.autofillCredentialsEnabled)
    }

    func testDefaultAutoconsentStateIsFalse_WhenNotInRollout() {
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.featureFlagger = createFeatureFlagger(withSubfeatureEnabled: false)
        XCTAssertFalse(appUserDefaults.autoconsentEnabled)
    }

    func testDefaultAutoconsentStateIsTrue_WhenInRollout() {
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
        appUserDefaults.featureFlagger = createFeatureFlagger(withFeatureFlagEnabled: .autoconsentOnByDefault)
        XCTAssertTrue(appUserDefaults.autoconsentEnabled)
    }

    func testAutoconsentReadsUserStoredValue_RegardlessOfRolloutState() {
        let appUserDefaults = AppUserDefaults(groupName: testGroupName)
     
        // When setting disabled by user and rollout enabled
        appUserDefaults.autoconsentEnabled = false
        appUserDefaults.featureFlagger = createFeatureFlagger(withFeatureFlagEnabled: .autoconsentOnByDefault)

        XCTAssertFalse(appUserDefaults.autoconsentEnabled)

        // When setting enabled by user and rollout disabled
        appUserDefaults.autoconsentEnabled = true
        appUserDefaults.featureFlagger = createFeatureFlagger(withSubfeatureEnabled: false)

        XCTAssertTrue(appUserDefaults.autoconsentEnabled)
    }

    // MARK: - Mock Creation

    private func createFeatureFlagger(withSubfeatureEnabled enabled: Bool) -> DefaultFeatureFlagger {
        let mockManager = MockPrivacyConfigurationManager()
        mockManager.privacyConfig = mockConfiguration(subfeatureEnabled: enabled)

        let internalUserDecider = DefaultInternalUserDecider(store: internalUserDeciderStore)
        return DefaultFeatureFlagger(internalUserDecider: internalUserDecider, privacyConfigManager: mockManager, experimentManager: nil)
    }

    private func mockConfiguration(subfeatureEnabled: Bool) -> PrivacyConfiguration {
        let mockPrivacyConfiguration = MockPrivacyConfiguration()
        mockPrivacyConfiguration.isSubfeatureKeyEnabled = { _, _ in
            return subfeatureEnabled
        }

        return mockPrivacyConfiguration
    }

    private func createFeatureFlagger(withFeatureFlagEnabled featureFlag: FeatureFlag) -> FeatureFlagger {
        let mockFeatureFlagger = MockFeatureFlagger()
        mockFeatureFlagger.enabledFeatureFlags.append(featureFlag)
        return mockFeatureFlagger
    }
}