[BWA-155] refactor: Bring ConfigService into BitwardenKit (#1572)

Author: KatherineInCode

AuthenticatorShared/Core/Platform/Models/Enum/FeatureFlag.swift

@@ -15,7 +15,7 @@ extension FeatureFlag: @retroactive CaseIterable {
 
     public static var allCases: [FeatureFlag] {
         [
-            .enablePasswordManagerSync
+            .enablePasswordManagerSync,
         ]
     }
 }

AuthenticatorShared/Core/Platform/Services/StateService.swift

@@ -48,23 +48,12 @@ protocol StateService: AnyObject {
     ///
     func getClearClipboardValue(userId: String?) async throws -> ClearClipboardValue
 
-    /// Gets the server config used by the app prior to the user authenticating.
-    /// - Returns: The server config used prior to user authentication.
-    func getPreAuthServerConfig() async -> ServerConfig?
-
     /// Gets the user's encryption secret key.
     ///
     /// - Returns: The user's encryption secret key.
     ///
     func getSecretKey(userId: String?) async throws -> String?
 
-    /// Gets the server config for a user ID, as set by the server.
-    ///
-    /// - Parameter userId: The user ID associated with the server config. Defaults to the active account if `nil`.
-    /// - Returns: The user's server config.
-    ///
-    func getServerConfig(userId: String?) async throws -> ServerConfig?
-
     /// Get whether to show website icons.
     ///
     /// - Returns: Whether to show the website icons.
@@ -105,25 +94,13 @@ protocol StateService: AnyObject {
     ///
     func setClearClipboardValue(_ clearClipboardValue: ClearClipboardValue?, userId: String?) async throws
 
-    /// Sets the server config used prior to user authentication
-    /// - Parameter config: The server config to use prior to user authentication.
-    func setPreAuthServerConfig(config: ServerConfig) async
-
     /// Sets the user's encryption secreet key.
     ///
     /// - Parameters:
     ///   - key: The key to set
     ///
     func setSecretKey(_ key: String, userId: String?) async throws
 
-    /// Sets the server configuration as provided by a server for a user ID.
-    ///
-    /// - Parameters:
-    ///   - configModel: The config values to set as provided by the server.
-    ///   - userId: The user ID associated with the server config.
-    ///
-    func setServerConfig(_ config: ServerConfig?, userId: String?) async throws
-
     /// Set whether to show the website icons.
     ///
     /// - Parameter showWebIcons: Whether to show the website icons.
@@ -167,7 +144,7 @@ enum StateServiceError: Error {
 
 /// A default implementation of `StateService`.
 ///
-actor DefaultStateService: StateService {
+actor DefaultStateService: StateService, ConfigStateService {
     // MARK: Properties
 
     /// The language option currently selected for the app.
@@ -304,16 +281,6 @@ actor DefaultStateService: StateService {
     }
 }
 
-extension StateService {
-    /// Gets the server config for the active account.
-    ///
-    /// - Returns: The server config sent by the server for the active account.
-    ///
-    func getServerConfig() async throws -> ServerConfig? {
-        try await getServerConfig(userId: getActiveAccountId())
-    }
-}
-
 // MARK: Biometrics
 
 extension DefaultStateService {

AuthenticatorShared/Core/Platform/Services/Stores/AppSettingsStore.swift

@@ -64,18 +64,6 @@ protocol AppSettingsStore: AnyObject {
     ///
     func clearClipboardValue(userId: String) -> ClearClipboardValue
 
-    /// Retrieves a feature flag value from the app's settings store.
-    ///
-    /// This method fetches the value for a specified feature flag from the app's settings store.
-    /// The value is returned as a `Bool`. If the flag does not exist or cannot be decoded,
-    /// the method returns `nil`.
-    ///
-    /// - Parameter name: The name of the feature flag to retrieve, represented as a `String`.
-    /// - Returns: The value of the feature flag as a `Bool`, or `nil` if the flag does not exist
-    ///     or cannot be decoded.
-    ///
-    func debugFeatureFlag(name: String) -> Bool?
-
     /// Flag to identify if the user has previously synced with the named account. `true` if they have previously
     /// synced with the named account, `false` if they have not synced previously.
     ///
@@ -104,19 +92,6 @@ protocol AppSettingsStore: AnyObject {
     ///
     func lastActiveTime(userId: String) -> Date?
 
-    /// Sets a feature flag value in the app's settings store.
-    ///
-    /// This method updates or removes the value for a specified feature flag in the app's settings store.
-    /// If the `value` parameter is `nil`, the feature flag is removed from the store. Otherwise, the flag
-    /// is set to the provided boolean value.
-    ///
-    /// - Parameters:
-    ///   - name: The name of the feature flag to set or remove, represented as a `String`.
-    ///   - value: The boolean value to assign to the feature flag. If `nil`, the feature flag will be removed
-    ///    from the settings store.
-    ///
-    func overrideDebugFeatureFlag(name: String, value: Bool?)
-
     /// Gets the user's secret encryption key.
     ///
     /// - Parameters:
@@ -321,7 +296,7 @@ class DefaultAppSettingsStore {
     }
 }
 
-extension DefaultAppSettingsStore: AppSettingsStore {
+extension DefaultAppSettingsStore: AppSettingsStore, ConfigSettingsStore {
     /// The keys used to store their associated values.
     ///
     enum Keys {

AuthenticatorShared/Core/Platform/Services/TestHelpers/MockConfigService.swift

@@ -1,3 +1,4 @@
+import BitwardenKitMocks
 import SwiftUI
 import XCTest
 

AuthenticatorShared/UI/DebugMenu/DebugMenuCoordinatorTests.swift

@@ -1,3 +1,5 @@
+import BitwardenKit
+import BitwardenKitMocks
 import XCTest
 
 @testable import AuthenticatorShared

AuthenticatorShared/UI/DebugMenu/DebugMenuFeatureFlag.swift

@@ -1,3 +1,4 @@
+import BitwardenKit
 import Foundation
 
 // MARK: - DebugMenuState

AuthenticatorShared/UI/DebugMenu/DebugMenuProcessorTests.swift

@@ -1,3 +1,4 @@
+import BitwardenKit
 import SwiftUI
 
 // MARK: - DebugMenuView

AuthenticatorShared/UI/DebugMenu/DebugMenuState.swift

@@ -1,3 +1,4 @@
+import BitwardenKitMocks
 import XCTest
 
 @testable import AuthenticatorShared

AuthenticatorShared/UI/DebugMenu/DebugMenuView.swift

@@ -1,3 +1,4 @@
+import BitwardenKitMocks
 import XCTest
 
 @testable import AuthenticatorShared

AuthenticatorShared/UI/Platform/Settings/Settings/SettingsProcessorTests.swift

@@ -1,20 +1,25 @@
-import BitwardenKit
 import Foundation
 
 // MARK: - DebugMenuFeatureFlag
 
 /// A structure representing a feature flag in the debug menu, including its enabled state.
 /// This is used to display and manage feature flags within the debug menu interface.
 ///
-struct DebugMenuFeatureFlag: Equatable, Identifiable {
+public struct DebugMenuFeatureFlag: Equatable, Identifiable, Sendable {
     /// A unique identifier for the feature flag, based on its raw value.
-    var id: String {
+    public var id: String {
         feature.rawValue
     }
 
     /// The feature flag enum that this instance represents.
-    let feature: FeatureFlag
+    public let feature: FeatureFlag
 
     /// A boolean value indicating whether the feature is enabled or not.
-    let isEnabled: Bool
+    public let isEnabled: Bool
+
+    /// Public version of synthesized initializer.
+    public init(feature: FeatureFlag, isEnabled: Bool) {
+        self.feature = feature
+        self.isEnabled = isEnabled
+    }
 }

AuthenticatorShared/UI/Vault/VaultItem/AuthenticatorKeyCapture/ManualEntryProcessorTests.swift

@@ -0,0 +1,18 @@
+/// Helper object to send updated server config object with extra metadata
+/// like whether it comes from pre-auth and the user ID it belongs to.
+/// This is useful for getting the config on background and establishing which was the original context.
+public struct MetaServerConfig {
+    /// If true, the call is coming before the user is authenticated or when adding a new account
+    public let isPreAuth: Bool
+    /// The user ID the requested the server config.
+    public let userId: String?
+    /// The server config.
+    public let serverConfig: ServerConfig?
+
+    /// Public version of synthesized initializer.
+    public init(isPreAuth: Bool, userId: String?, serverConfig: ServerConfig?) {
+        self.isPreAuth = isPreAuth
+        self.userId = userId
+        self.serverConfig = serverConfig
+    }
+}

BitwardenShared/UI/Platform/DebugMenu/DebugMenuFeatureFlag.swift renamed to BitwardenKit/Core/Platform/Models/Domain/DebugMenuFeatureFlag.swift

@@ -1,57 +1,72 @@
+// swiftlint:disable:this file_name
+
 import BitwardenKit
 
-public extension FeatureFlag {
+extension FeatureFlag: @retroactive CaseIterable {
     /// A test feature flag that isn't remotely configured and has no initial value.
-    static let testLocalFeatureFlag = FeatureFlag(
+    public static let testLocalFeatureFlag = FeatureFlag(
         rawValue: "test-local-feature-flag",
         isRemotelyConfigured: false
     )
 
     /// A test feature flag that has an initial boolean value and is not remotely configured.
-    static let testLocalInitialBoolFlag = FeatureFlag(
+    public static let testLocalInitialBoolFlag = FeatureFlag(
         rawValue: "test-local-initial-bool-flag",
         initialValue: .bool(true),
         isRemotelyConfigured: false
     )
 
     /// A test feature flag that has an initial integer value and is not remotely configured.
-    static let testLocalInitialIntFlag = FeatureFlag(
+    public static let testLocalInitialIntFlag = FeatureFlag(
         rawValue: "test-local-initial-int-flag",
         initialValue: .int(42),
         isRemotelyConfigured: false
     )
 
     /// A test feature flag that has an initial string value and is not remotely configured.
-    static let testLocalInitialStringFlag = FeatureFlag(
+    public static let testLocalInitialStringFlag = FeatureFlag(
         rawValue: "test-local-initial-string-flag",
         initialValue: .string("Test String"),
         isRemotelyConfigured: false
     )
 
     /// A test feature flag that can be remotely configured.
-    static let testRemoteFeatureFlag = FeatureFlag(
+    public static let testRemoteFeatureFlag = FeatureFlag(
         rawValue: "test-remote-feature-flag",
         isRemotelyConfigured: true
     )
 
     /// A test feature flag that has an initial boolean value and is not remotely configured.
-    static let testRemoteInitialBoolFlag = FeatureFlag(
+    public static let testRemoteInitialBoolFlag = FeatureFlag(
         rawValue: "test-remote-initial-bool-flag",
         initialValue: .bool(true),
         isRemotelyConfigured: true
     )
 
     /// A test feature flag that has an initial integer value and is not remotely configured.
-    static let testRemoteInitialIntFlag = FeatureFlag(
+    public static let testRemoteInitialIntFlag = FeatureFlag(
         rawValue: "test-remote-initial-int-flag",
         initialValue: .int(42),
         isRemotelyConfigured: true
     )
 
     /// A test feature flag that has an initial string value and is not remotely configured.
-    static let testRemoteInitialStringFlag = FeatureFlag(
+    public static let testRemoteInitialStringFlag = FeatureFlag(
         rawValue: "test-remote-initial-string-flag",
         initialValue: .string("Test String"),
         isRemotelyConfigured: true
     )
+
+    public static var allCases: [FeatureFlag] {
+        [
+            .testLocalFeatureFlag,
+            .testLocalInitialBoolFlag,
+            .testLocalInitialIntFlag,
+            .testLocalInitialStringFlag,
+            .testRemoteFeatureFlag,
+            .testRemoteInitialBoolFlag,
+            .testRemoteInitialIntFlag,
+            .testRemoteInitialStringFlag,
+        ]
+    }
 }