-
Notifications
You must be signed in to change notification settings - Fork 423
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Malicious site protection feature flags #3719
Open
alessandroboron
wants to merge
2
commits into
alessandro/malicious-site-protection-address-bar-and-privacy-dashboard
Choose a base branch
from
alessandro/malicious-site-protection-feature-flags
base: alessandro/malicious-site-protection-address-bar-and-privacy-dashboard
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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
60 changes: 60 additions & 0 deletions
60
DuckDuckGo/MaliciousSiteProtection/FeatureFlags/MaliciousSiteProtectionFeatureFlags.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,60 @@ | ||
| // | ||
| // MaliciousSiteProtectionFeatureFlags.swift | ||
| // DuckDuckGo | ||
| // | ||
| // 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 Foundation | ||
| import BrowserServicesKit | ||
| import Core | ||
|
|
||
| protocol MaliciousSiteProtectionFeatureFlagger { | ||
| /// A Boolean value indicating whether malicious site protection is enabled. | ||
| /// - Returns: `true` if malicious site protection is enabled; otherwise, `false`. | ||
| var isMaliciousSiteProtectionEnabled: Bool { get } | ||
|
|
||
| /// Checks if should detect malicious threats for a specific domain. | ||
| /// - Parameter domain: The domain to check for malicious threat. | ||
| /// - Returns: `true` if should check for malicious threats for the specified domain; otherwise, `false`. | ||
| func shouldDetectMaliciousThreat(forDomain domain: String?) -> Bool | ||
| } | ||
|
|
||
| final class MaliciousSiteProtectionFeatureFlags { | ||
| private let featureFlagger: FeatureFlagger | ||
| private let privacyConfigManager: PrivacyConfigurationManaging | ||
|
|
||
| init( | ||
| featureFlagger: FeatureFlagger = AppDependencyProvider.shared.featureFlagger, | ||
| privacyConfigManager: PrivacyConfigurationManaging = ContentBlocking.shared.privacyConfigurationManager | ||
| ) { | ||
| self.featureFlagger = featureFlagger | ||
| self.privacyConfigManager = privacyConfigManager | ||
| } | ||
| } | ||
|
|
||
| // MARK: - MaliciousSiteProtectionFeatureFlagger | ||
|
|
||
| extension MaliciousSiteProtectionFeatureFlags: MaliciousSiteProtectionFeatureFlagger { | ||
|
|
||
| var isMaliciousSiteProtectionEnabled: Bool { | ||
| featureFlagger.isFeatureOn(.maliciousSiteProtection) | ||
| } | ||
|
|
||
| func shouldDetectMaliciousThreat(forDomain domain: String?) -> Bool { | ||
| privacyConfigManager.privacyConfig.isFeature(.maliciousSiteProtection, enabledForDomain: domain) | ||
| } | ||
|
|
||
| } |
112 changes: 112 additions & 0 deletions
112
DuckDuckGoTests/MaliciousSiteProtection/MaliciousSiteProtectionFeatureFlagsTests.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,112 @@ | ||
| // | ||
| // MaliciousSiteProtectionFeatureFlagsTests.swift | ||
| // DuckDuckGo | ||
| // | ||
| // 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 Testing | ||
| import BrowserServicesKit | ||
| @testable import DuckDuckGo | ||
|
|
||
| @Suite("Malicious Site Protection - Feature Flags", .serialized) | ||
| final class MaliciousSiteProtectionFeatureFlagsTests { | ||
| private var sut: MaliciousSiteProtectionFeatureFlags! | ||
| private var featureFlaggerMock: MockFeatureFlagger! | ||
| private var configurationManagerMock: PrivacyConfigurationManagerMock! | ||
|
|
||
| init() async throws { | ||
| featureFlaggerMock = MockFeatureFlagger() | ||
| configurationManagerMock = PrivacyConfigurationManagerMock() | ||
| sut = MaliciousSiteProtectionFeatureFlags(featureFlagger: featureFlaggerMock, privacyConfigManager: configurationManagerMock) | ||
| } | ||
|
|
||
| deinit { | ||
| featureFlaggerMock = nil | ||
| configurationManagerMock = nil | ||
| sut = nil | ||
| } | ||
|
|
||
| // MARK: - Web Error Page | ||
|
|
||
| @Test("Check Threat Detection Enabled") | ||
| func whenThreatDetectionEnabled_AndFeatureFlagIsOn_ThenReturnTrue() throws { | ||
| // GIVEN | ||
| featureFlaggerMock.enabledFeatureFlags = [.maliciousSiteProtection] | ||
|
|
||
| // WHEN | ||
| let result = sut.isMaliciousSiteProtectionEnabled | ||
|
|
||
| // THEN | ||
| #expect(result) | ||
| } | ||
|
|
||
| @Test("Check Threat Detection Disabled") | ||
| func whenThreatDetectionEnabled_AndFeatureFlagIsOff_ThenReturnFalse() throws { | ||
| // GIVEN | ||
| featureFlaggerMock.enabledFeatureFlags = [] | ||
|
|
||
| // WHEN | ||
| let result = sut.isMaliciousSiteProtectionEnabled | ||
|
|
||
| // THEN | ||
| #expect(!result) | ||
| } | ||
|
|
||
| @Test("Check Threat Detection Enabled For Domain") | ||
| func whenThreatDetectionEnabledForDomain_AndFeatureIsAvailableForDomain_ThenReturnTrue() throws { | ||
| // GIVEN | ||
| featureFlaggerMock.enabledFeatureFlags = [.maliciousSiteProtection] | ||
| let privacyConfigMock = try #require(configurationManagerMock.privacyConfig as? PrivacyConfigurationMock) | ||
| privacyConfigMock.enabledFeatures = [.maliciousSiteProtection: ["example.com"]] | ||
| let domain = "example.com" | ||
|
|
||
| // WHEN | ||
| let result = sut.shouldDetectMaliciousThreat(forDomain: domain) | ||
|
|
||
| // THEN | ||
| #expect(result) | ||
| } | ||
|
|
||
| @Test("Check Threat Detection Disabled For Domain When Protection For Domain Is Not Enabled") | ||
| func whenThreatDetectionCalledEnabledForDomain_AndFeatureIsNotAvailableForDomain_ThenReturnFalse() throws { | ||
| // GIVEN | ||
| featureFlaggerMock.enabledFeatureFlags = [.maliciousSiteProtection] | ||
| let privacyConfigMock = try #require(configurationManagerMock.privacyConfig as? PrivacyConfigurationMock) | ||
| privacyConfigMock.enabledFeatures = [.maliciousSiteProtection: []] | ||
| let domain = "example.com" | ||
|
|
||
| // WHEN | ||
| let result = sut.shouldDetectMaliciousThreat(forDomain: domain) | ||
|
|
||
| // THEN | ||
| #expect(!result) | ||
| } | ||
|
|
||
| @Test("Check Threat Detection Disabled For Domain When Feature Flag Is Off") | ||
| func whenThreatDetectionEnabledForDomain_AndPrivacyConfigFeatureFlagIsOn_AndThreatDetectionSubFeatureIsOff_ThenReturnTrue() throws { | ||
| // GIVEN | ||
| let privacyConfigMock = try #require(configurationManagerMock.privacyConfig as? PrivacyConfigurationMock) | ||
| privacyConfigMock.enabledFeatures = [.adClickAttribution: ["example.com"]] | ||
| let domain = "example.com" | ||
|
|
||
| // WHEN | ||
| let result = sut.shouldDetectMaliciousThreat(forDomain: domain) | ||
|
|
||
| // THEN | ||
| #expect(!result) | ||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
now that I think of nilling properties in deinit is probably not needed as it will do it automatically. I will fix it.