-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into sam/vpn-error-description-fix
* main: Upgrade to Xcode 16 and macOS 15 (#1075) add text zoom feature flag (#1057) Add support for local overrides for feature flags (#1074) Speculative password import prompt crash fix (#1072)
- Loading branch information
Showing
27 changed files
with
742 additions
and
106 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 15.4 | ||
| 16.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
200 changes: 200 additions & 0 deletions
200
Sources/BrowserServicesKit/FeatureFlagger/FeatureFlagLocalOverrides.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| // | ||
| // FeatureFlagLocalOverrides.swift | ||
| // | ||
| // Copyright © 2024 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 Combine | ||
| import Foundation | ||
| import Persistence | ||
|
|
||
| /// This protocol defines persistence layer for feature flag overrides. | ||
| public protocol FeatureFlagLocalOverridesPersisting { | ||
| /// Return value for the flag override. | ||
| /// | ||
| /// If there's no override, this function should return `nil`. | ||
| /// | ||
| func value<Flag: FeatureFlagDescribing>(for flag: Flag) -> Bool? | ||
|
|
||
| /// Set new override for the feature flag. | ||
| /// | ||
| /// Flag can be overridden to `true` or `false`. Setting `nil` clears the override. | ||
| /// | ||
| func set<Flag: FeatureFlagDescribing>(_ value: Bool?, for flag: Flag) | ||
| } | ||
|
|
||
| public struct FeatureFlagLocalOverridesUserDefaultsPersistor: FeatureFlagLocalOverridesPersisting { | ||
|
|
||
| public let keyValueStore: KeyValueStoring | ||
|
|
||
| public init(keyValueStore: KeyValueStoring) { | ||
| self.keyValueStore = keyValueStore | ||
| } | ||
|
|
||
| public func value<Flag: FeatureFlagDescribing>(for flag: Flag) -> Bool? { | ||
| let key = key(for: flag) | ||
| return keyValueStore.object(forKey: key) as? Bool | ||
| } | ||
|
|
||
| public func set<Flag: FeatureFlagDescribing>(_ value: Bool?, for flag: Flag) { | ||
| let key = key(for: flag) | ||
| keyValueStore.set(value, forKey: key) | ||
| } | ||
|
|
||
| /// This function returns the User Defaults key for a feature flag override. | ||
| /// | ||
| /// It uses camel case to simplify inter-process User Defaults KVO. | ||
| /// | ||
| private func key<Flag: FeatureFlagDescribing>(for flag: Flag) -> String { | ||
| return "localOverride\(flag.rawValue.capitalizedFirstLetter)" | ||
| } | ||
| } | ||
|
|
||
| private extension String { | ||
| var capitalizedFirstLetter: String { | ||
| return prefix(1).capitalized + dropFirst() | ||
| } | ||
| } | ||
|
|
||
| /// This protocol defines the callback that can be used to reacting to feature flag changes. | ||
| public protocol FeatureFlagLocalOverridesHandling { | ||
|
|
||
| /// This function is called whenever an effective value of a feature flag | ||
| /// changes as a result of adding or removing a local override. | ||
| /// | ||
| /// It can be implemented by client apps to react to changes to feature flag | ||
| /// value in runtime, caused by adjusting its local override. | ||
| func flagDidChange<Flag: FeatureFlagDescribing>(_ featureFlag: Flag, isEnabled: Bool) | ||
| } | ||
|
|
||
| /// `FeatureFlagLocalOverridesHandling` implementation providing Combine publisher for flag changes. | ||
| /// | ||
| /// It can be used by client apps if a more sophisticated handler isn't needed. | ||
| /// | ||
| public struct FeatureFlagOverridesPublishingHandler<F: FeatureFlagDescribing>: FeatureFlagLocalOverridesHandling { | ||
|
|
||
| public let flagDidChangePublisher: AnyPublisher<(F, Bool), Never> | ||
| private let flagDidChangeSubject = PassthroughSubject<(F, Bool), Never>() | ||
|
|
||
| public init() { | ||
| flagDidChangePublisher = flagDidChangeSubject.eraseToAnyPublisher() | ||
| } | ||
|
|
||
| public func flagDidChange<Flag: FeatureFlagDescribing>(_ featureFlag: Flag, isEnabled: Bool) { | ||
| guard let flag = featureFlag as? F else { return } | ||
| flagDidChangeSubject.send((flag, isEnabled)) | ||
| } | ||
| } | ||
|
|
||
| /// This protocol defines the interface for feature flag overriding mechanism. | ||
| /// | ||
| /// All flag overrides APIs only have effect if flag has `supportsLocalOverriding` set to `true`. | ||
| /// | ||
| public protocol FeatureFlagLocalOverriding: AnyObject { | ||
|
|
||
| /// Handle to the feature flagger. | ||
| /// | ||
| /// It's used to query current, non-overriden state of a feature flag to | ||
| /// decide about calling `FeatureFlagLocalOverridesHandling.flagDidChange` | ||
| /// upon clearing an override. | ||
| var featureFlagger: FeatureFlagger? { get set } | ||
|
|
||
| /// The action handler responding to feature flag changes. | ||
| var actionHandler: FeatureFlagLocalOverridesHandling { get } | ||
|
|
||
| /// Returns the current override for a feature flag, or `nil` if override is not set. | ||
| func override<Flag: FeatureFlagDescribing>(for featureFlag: Flag) -> Bool? | ||
|
|
||
| /// Toggles override for a feature flag. | ||
| /// | ||
| /// If override is not currently present, it sets the override to the opposite of the current flag value. | ||
| /// | ||
| func toggleOverride<Flag: FeatureFlagDescribing>(for featureFlag: Flag) | ||
|
|
||
| /// Clears override for a feature flag. | ||
| /// | ||
| /// Calls `FeatureFlagLocalOverridesHandling.flagDidChange` if the effective flag value | ||
| /// changes as a result of clearing the override. | ||
| /// | ||
| func clearOverride<Flag: FeatureFlagDescribing>(for featureFlag: Flag) | ||
|
|
||
| /// Clears overrides for all feature flags. | ||
| /// | ||
| /// This function calls `clearOverride(for:)` for each flag. | ||
| /// | ||
| func clearAllOverrides<Flag: FeatureFlagDescribing>(for flagType: Flag.Type) | ||
| } | ||
|
|
||
| public final class FeatureFlagLocalOverrides: FeatureFlagLocalOverriding { | ||
|
|
||
| public let actionHandler: FeatureFlagLocalOverridesHandling | ||
| public weak var featureFlagger: FeatureFlagger? | ||
| private let persistor: FeatureFlagLocalOverridesPersisting | ||
|
|
||
| public convenience init( | ||
| keyValueStore: KeyValueStoring, | ||
| actionHandler: FeatureFlagLocalOverridesHandling | ||
| ) { | ||
| self.init( | ||
| persistor: FeatureFlagLocalOverridesUserDefaultsPersistor(keyValueStore: keyValueStore), | ||
| actionHandler: actionHandler | ||
| ) | ||
| } | ||
|
|
||
| public init( | ||
| persistor: FeatureFlagLocalOverridesPersisting, | ||
| actionHandler: FeatureFlagLocalOverridesHandling | ||
| ) { | ||
| self.persistor = persistor | ||
| self.actionHandler = actionHandler | ||
| } | ||
|
|
||
| public func override<Flag: FeatureFlagDescribing>(for featureFlag: Flag) -> Bool? { | ||
| guard featureFlag.supportsLocalOverriding else { | ||
| return nil | ||
| } | ||
| return persistor.value(for: featureFlag) | ||
| } | ||
|
|
||
| public func toggleOverride<Flag: FeatureFlagDescribing>(for featureFlag: Flag) { | ||
| guard featureFlag.supportsLocalOverriding else { | ||
| return | ||
| } | ||
| let currentValue = persistor.value(for: featureFlag) ?? currentValue(for: featureFlag) ?? false | ||
| let newValue = !currentValue | ||
| persistor.set(newValue, for: featureFlag) | ||
| actionHandler.flagDidChange(featureFlag, isEnabled: newValue) | ||
| } | ||
|
|
||
| public func clearOverride<Flag: FeatureFlagDescribing>(for featureFlag: Flag) { | ||
| guard let override = override(for: featureFlag) else { | ||
| return | ||
| } | ||
| persistor.set(nil, for: featureFlag) | ||
| if let defaultValue = currentValue(for: featureFlag), defaultValue != override { | ||
| actionHandler.flagDidChange(featureFlag, isEnabled: defaultValue) | ||
| } | ||
| } | ||
|
|
||
| public func clearAllOverrides<Flag: FeatureFlagDescribing>(for flagType: Flag.Type) { | ||
| flagType.allCases.forEach { flag in | ||
| clearOverride(for: flag) | ||
| } | ||
| } | ||
|
|
||
| private func currentValue<Flag: FeatureFlagDescribing>(for featureFlag: Flag) -> Bool? { | ||
| featureFlagger?.isFeatureOn(for: featureFlag, allowOverride: true) | ||
| } | ||
| } |
Oops, something went wrong.