Skip to content
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

Add Events Firing for Phishing Detection Settings: Point to BSK #3423

Merged
merged 3 commits into from
Oct 15, 2024

Conversation

not-a-rootkit
Copy link
Contributor

Task/Issue URL: https://app.asana.com/0/72649045549333/1208270234071171/f
Tech Design URL: N/A

Description:
In ✓ Phishing Detection Pixels we defined several pixels to include, and one of them did not make it into the initial release:

  • macos.phishing-detection.feature-toggled:
    • Parameters:
      • newState - on/off, indicating whether the user turned it on or off
  • Condition
    • triggers when a user disables the feature from the settings page
  • Reasoning
    • the aim is to use this as a "do-no-harm" KPI, to determine how many users are actively choosing to disable/enable phishing protection

Steps to test this PR:

  1. No testing required on iOS, this is just a library change introduction in BSK, used by macOS.
  2. Ensure CI goes green

Definition of Done (Internal Only):

Copy Testing:

  • Use of correct apostrophes in new copy, ie rather than '

Orientation Testing:

  • Portrait
  • Landscape

Device Testing:

  • iPhone SE (1st Gen)
  • iPhone 8
  • iPhone X
  • iPhone 14 Pro
  • iPad

OS Testing:

  • iOS 15
  • iOS 16
  • iOS 17

Theme Testing:

  • Light theme
  • Dark theme

Internal references:

Software Engineering Expectations
Technical Design Template

@not-a-rootkit not-a-rootkit marked this pull request as ready for review October 9, 2024 16:19
not-a-rootkit added a commit to duckduckgo/BrowserServicesKit that referenced this pull request Oct 15, 2024
<!--
Note: This checklist is a reminder of our shared engineering
expectations.
-->

Please review the release process for BrowserServicesKit
[here](https://app.asana.com/0/1200194497630846/1200837094583426).

**Required**:

Task/Issue URL:
https://app.asana.com/0/72649045549333/1208270234071171/f
iOS PR: duckduckgo/iOS#3423
macOS PR: duckduckgo/macos-browser#3379
What kind of version bump will this require?:Minor

**Optional**:

Tech Design URL: N/A
CC:

**Description**:
In [✓ Phishing Detection
Pixels](https://app.asana.com/0/0/1207699541075655/f) we defined several
pixels to include, and one of them did not make it into the initial
release:
- macos.phishing-detection.feature-toggled:
  - Parameters:
    - newState - on/off, indicating whether the user turned it on or off
- Condition
  - triggers when a user disables the feature from the settings page
- Reasoning
- the aim is to use this as a "do-no-harm" KPI, to determine how many
users are actively choosing to disable/enable phishing protection

<!--
Tagging instructions
If this PR isn't ready to be merged for whatever reason it should be
marked with the `DO NOT MERGE` label (particularly if it's a draft)
If it's pending Product Review/PFR, please add the `Pending Product
Review` label.

If at any point it isn't actively being worked on/ready for
review/otherwise moving forward (besides the above PR/PFR exception)
strongly consider closing it (or not opening it in the first place). If
you decide not to close it, make sure it's labelled to make it clear the
PRs state and comment with more information.
-->

**Steps to test this PR**:
1. Point to tespach/phish-det-settings-event
2. Build the macOS browser
3. Filter by `m_mac_phishing_detection_setting-toggled` in the debug
output of the app
4. Ensure you're authenticated via use-login.duckduckgo.com - this
feature is internal only
5. Go to Settings>General
6. Toggle "Malicious Site Protection"
7. Return to debug output and ensure you see:
8. `👾[Standard-Fired] m_mac_phishing_detection_setting-toggled
["appVersion": "1.109.0", "pixelSource": "browser-dmg",
"setting_toggled_to": "false"]`

<!--
Before submitting a PR, please ensure you have tested the combinations
you expect the reviewer to test, then delete configurations you *know*
do not need explicit testing.

Using a simulator where a physical device is unavailable is acceptable.
-->

**OS Testing**:

* [ ] iOS 14
* [ ] iOS 15
* [ ] iOS 16
* [ ] macOS 10.15
* [ ] macOS 11
* [ ] macOS 12

---
###### Internal references:
[Software Engineering
Expectations](https://app.asana.com/0/59792373528535/199064865822552)
[Technical Design
Template](https://app.asana.com/0/59792373528535/184709971311943)
@not-a-rootkit not-a-rootkit merged commit 39a9251 into main Oct 15, 2024
13 checks passed
@not-a-rootkit not-a-rootkit deleted the tespach/phish-det-settings-event branch October 15, 2024 17:10
samsymons added a commit that referenced this pull request Oct 16, 2024
* main:
  Add Events Firing for Phishing Detection Settings: Point to BSK (#3423)
  DuckPlayer: Temporary Fix for Watch In Youtube (#3437)
  Add 'Open in New Tab' support for DuckPlayer (#3431)
  update BSK dependency (#3434)
dus7 added a commit that referenced this pull request Oct 16, 2024
#3423 updated the BSK version in project file but missed the Package.resolve update
samsymons added a commit that referenced this pull request Oct 21, 2024
# By Daniel Bernal (4) and others
# Via Daniel Bernal (1) and others
* main:
  Pixel retrying (#3358)
  Remove `voiceSearchHelper` from `AppDependencyProvider` (#3452)
  Update AutoClearSettingsViewController to use DI for app settings (#3448)
  Bump BSK (#3441)
  Remove `SubscriptionFeatureAvailability` from `AppDependencyProvider` (#3447)
  Release 7.141.0-2 (#3451)
  Do not notify the FE on experiment activation (#3450)
  point to bsk branch (#3444)
  bump bsk for content blocker rules fix (#3445)
  speculative fix for set bars visibility crashes (#3442)
  Release 7.141.0-1 (#3443)
  Fix browsing menu bottom offset when bar location set to bottom (#3440)
  Properly handle responses that should trigger download action (#3407)
  Add Events Firing for Phishing Detection Settings: Point to BSK (#3423)
  DuckPlayer: Temporary Fix for Watch In Youtube (#3437)
  Add 'Open in New Tab' support for DuckPlayer (#3431)
  update BSK dependency (#3434)
  Release 7.141.0-0 (#3435)
  Add error handling to contrainer removal (#3424)
  Prevent autofill prompt crash for edge case where a context menu is also visible on screen (#3417)

# Conflicts:
#	DuckDuckGo.xcodeproj/project.pbxproj
#	DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants