Adds pixels to VPN tips #3629

diegoreymendez · 2024-11-27T11:12:23Z

Task/Issue URL: https://app.asana.com/0/1206580121312550/1208856370909429/f

Description

Add pixels for VPN tips in iOS.

Testing

Open Console.app and filter by "Pixel fired".
To start clean go into Settings > All Debug Options > Reset TipKit, and relaunch the app.
Enable the VPN.
First tip shown will be geoswitching. This tip can be dismissed by clicking X or actioning it (open locations). Ignoring a tip means you close the status view without doing anything with it.

Based on the previous description you should get different pixels depending on how you interact with the tip:

11:40:50.374186+0100    2746: 0x10c044  debug   General DuckDuckGo      Pixel fired m.vpn.tip.geoswitching.shown
11:41:25.337882+0100    2746: 0x10c044  debug   General DuckDuckGo      Pixel fired m.vpn.tip.geoswitching.actioned
11:44:35.587539+0100    2761: 0x10d604  debug   General DuckDuckGo      Pixel fired m.vpn.tip.geoswitching.ignored
11:44:44.401814+0100    2761: 0x10d604  debug   General DuckDuckGo      Pixel fired m.vpn.tip.geoswitching.dismissed

Second tip is "Add Widget" when the VPN is off. Can be dismissed by clicking x or actioning it (tap "learn More").

The pixels you can get with this tip are:

11:41:44.250283+0100    2746: 0x10c044  debug   General DuckDuckGo      Pixel fired m.vpn.tip.widget.shown
11:41:55.950480+0100    2746: 0x10c044  debug   General DuckDuckGo      Pixel fired m.vpn.tip.widget.actioned
11:45:22.136784+0100    2761: 0x10d604  debug   General DuckDuckGo      Pixel fired m.vpn.tip.widget.ignored
11:45:51.363188+0100    2761: 0x10d604  debug   General DuckDuckGo      Pixel fired m.vpn.tip.widget.dismissed

Last tip is snooze, when the VPN is back on. This can be dismissed by clicking x or snoozing the VPN.

The pixels you can get with this tip are:

11:46:08.038970+0100    2761: 0x10d604  debug   General DuckDuckGo      Pixel fired m.vpn.tip.snooze.shown
11:46:45.431303+0100    2761: 0x10d604  debug   General DuckDuckGo      Pixel fired m.vpn.tip.snooze.actioned
11:46:30.707391+0100    2761: 0x10d604  debug   General DuckDuckGo      Pixel fired m.vpn.tip.snooze.ignored
11:43:05.883666+0100    2746: 0x10c044  debug   General DuckDuckGo      Pixel fired m.vpn.tip.snooze.dismissed

Definition of Done (Internal Only):

Does this PR satisfy our Definition of Done?

Internal references:

Software Engineering Expectations
Technical Design Template

diegoreymendez · 2024-11-27T11:15:01Z

Core/PixelEvent.swift

+        case networkProtectionWidgetTipShown
+        case networkProtectionWidgetTipActioned
+        case networkProtectionWidgetTipDismissed
+        case networkProtectionWidgetTipIgnored


diegoreymendez · 2024-11-27T11:15:37Z

DuckDuckGo/NetworkProtectionStatusView.swift

+    var tipsModel: VPNTipsModel {
+        statusModel.tipsModel
+    }


Placing the tips in a model to separate view and other logic.

diegoreymendez · 2024-11-27T11:17:48Z

DuckDuckGo/NetworkProtectionStatusView.swift

+                    for await status in tipsModel.geoswitchingTip.statusUpdates {
+                        if case .invalidated(let reason) = status {
+                            if case .available = previousStatus {


This is a bit nasty. I copied this logic from macOS.

Tips don't have a simple action hook for when they're dismissed through the "X" button, unless we reimplement them from scratch.

Since I didn't want to recreate the standard tip UI, I am observing the tip status and when I detect a change from available (should be shown to the user) to invalidated (either closed or actioned) I'm firing a call to handle the event. This is mostly used for pixel-firing within tipsModel.

diegoreymendez · 2024-11-27T11:18:29Z

DuckDuckGo/NetworkProtectionStatusViewModel.swift

@@ -138,7 +140,7 @@ final class NetworkProtectionStatusViewModel: ObservableObject {
        didSet {
            if #available(iOS 17.0, *) {
                if isNetPEnabled {
-                    VPNGeoswitchingTip.donateVPNConnectedEvent()
+                    VPNGeoswitchingTip.vpnEnabledOnce = true


Just a change to keep this as a flag, rather than an ever growing counter. We just need to know this happened once.

diegoreymendez · 2024-11-27T11:18:42Z

DuckDuckGo/NetworkProtectionStatusViewModel.swift

+        self.tipsModel = VPNTipsModel(
+            isTipFeatureEnabled: featureFlagger.isFeatureOn(.networkProtectionUserTips),
+            statusObserver: statusObserver,
+            vpnSettings: settings)


Spawning the tips model.

diegoreymendez · 2024-11-27T11:19:33Z

DuckDuckGo/NetworkProtectionStatusViewModel.swift

@@ -577,30 +585,30 @@ final class NetworkProtectionStatusViewModel: ObservableObject {

    // MARK: - UI Events handling

-    @available(iOS 17.0, *)
+    @available(iOS 18.0, *)


This may seem confusing, but the VPN tips feature was initially meant for iOS 17, but due to some unexpected crashes that seem to be on Apple, we've decided to move them to iOS 18.

This just needed to be updated.

diegoreymendez · 2024-11-27T11:20:42Z

DuckDuckGo/VPNAddWidgetTip.swift

+    ///     - The VPN is enabled when previous tip's status is invalidated.
+    ///
+    @Parameter
+    static var isDistancedFromPreviousTip: Bool = false


"Distance" is a bit of a vague / abstract concept. This flag signals two things:

The previous tip has been dismissed.

The previous tip hasn't just been hidden.

Bunn

LGTM, one question:
Shouldn't we only call configure if the feature flag is enabled here?

iOS/DuckDuckGo/TipKit/TipKitAppEventHandling.swift

Line 51 in 7b35da4

controller.configureTipKit([

Here's the output of some of my tests:


Testing dismissed
Pixel fired m.vpn.tip.geoswitching.shown
Pixel fired m.vpn.tip.geoswitching.dismissed


Pixel fired m.vpn.tip.widget.shown
Pixel fired m.vpn.tip.widget.dismissed

Pixel fired m.vpn.tip.snooze.shown
Pixel fired m.vpn.tip.snooze.dismissed


-----
Testing actioned

Pixel fired m.vpn.tip.geoswitching.shown
Pixel fired m.vpn.tip.geoswitching.actioned

Pixel fired m.vpn.tip.widget.shown
Pixel fired m.vpn.tip.widget.actioned

Pixel fired m.vpn.tip.snooze.shown
Pixel fired m.vpn.tip.snooze.actioned

----
Testing ignore
Pixel fired m.vpn.tip.geoswitching.shown
Pixel fired m.vpn.tip.geoswitching.ignored
Pixel fired m.vpn.tip.geoswitching.shown
Pixel fired m.vpn.tip.geoswitching.ignored
Pixel fired m.vpn.tip.geoswitching.shown
Pixel fired m.vpn.tip.geoswitching.dismissed
Pixel fired m.vpn.tip.widget.shown
Pixel fired m.vpn.tip.widget.ignored
Pixel fired m.vpn.tip.widget.shown
Pixel fired m.vpn.tip.widget.ignored
Pixel fired m.vpn.tip.widget.shown
Pixel fired m.vpn.tip.widget.dismissed
Pixel fired m.vpn.tip.snooze.shown
Pixel fired m.vpn.tip.snooze.ignored

diegoreymendez · 2024-11-28T08:52:58Z

Shouldn't we only call configure if the feature flag is enabled here?

This was actually fine, although I understand where the question is coming from - I flagged it during our call 😅

The feature flag guard is a few lines above that point.

Adds pixels to VPN tips

58e19c8

diegoreymendez requested review from a team and amddg44 and removed request for a team November 27, 2024 11:14

diegoreymendez marked this pull request as ready for review November 27, 2024 11:14

diegoreymendez commented Nov 27, 2024

View reviewed changes

diegoreymendez requested review from Bunn and removed request for amddg44 November 27, 2024 14:40

Bunn approved these changes Nov 27, 2024

View reviewed changes

Fixes a swiftlint warning

4f1bfa1

diegoreymendez merged commit 038dd7a into main Nov 28, 2024
13 checks passed

diegoreymendez deleted the diego/vpn-tip-pixels branch November 28, 2024 09:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds pixels to VPN tips #3629

Adds pixels to VPN tips #3629

diegoreymendez commented Nov 27, 2024 •

edited

Loading

diegoreymendez Nov 27, 2024

diegoreymendez Nov 27, 2024

diegoreymendez Nov 27, 2024

diegoreymendez Nov 27, 2024

diegoreymendez Nov 27, 2024

diegoreymendez Nov 27, 2024

diegoreymendez Nov 27, 2024

Bunn left a comment

diegoreymendez commented Nov 28, 2024

Adds pixels to VPN tips #3629

Adds pixels to VPN tips #3629

Conversation

diegoreymendez commented Nov 27, 2024 • edited Loading

Description

Testing

Internal references:

diegoreymendez Nov 27, 2024

Choose a reason for hiding this comment

diegoreymendez Nov 27, 2024

Choose a reason for hiding this comment

diegoreymendez Nov 27, 2024

Choose a reason for hiding this comment

diegoreymendez Nov 27, 2024

Choose a reason for hiding this comment

diegoreymendez Nov 27, 2024

Choose a reason for hiding this comment

diegoreymendez Nov 27, 2024

Choose a reason for hiding this comment

diegoreymendez Nov 27, 2024

Choose a reason for hiding this comment

Bunn left a comment

Choose a reason for hiding this comment

diegoreymendez commented Nov 28, 2024

diegoreymendez commented Nov 27, 2024 •

edited

Loading