Add vpn-enable wide event #7092

lmac012 · 2025-11-10T12:50:54Z

Task/Issue URL: https://app.asana.com/1/137249556945/project/1205648422731273/task/1211892474020113?focus=true

Description

This PR adds a new wide event to monitor the success rate of enabling vpn.

Steps to test this PR

Prerequisites for each test scenario

Apply patch from https://app.asana.com/1/137249556945/project/1209991789468715/task/1210448620621729?focus=true
Clean install
Purchase/Activate a test subscription

Happy path

Go to VPN settings and enable VPN
Grant VPN permission
Verify that wide_vpn-enable.* pixels were sent, with status=Success and parameters defined in https://app.asana.com/1/137249556945/project/1205648422731273/task/1211799839160665?focus=true

User rejects VPN permission

Go to VPN settings and enable VPN
Reject VPN permission
Verify that wide_vpn-enable.* pixels were sent with status=Cancelled

Another VPN is already running

Install and enable any other VPN on device
Go to VPN settings and enable DDG VPN
Tap "Cancel"
Verify that wide_vpn-enable.* pixels were sent, with status=Cancelled

Device is offline

Enable airplane mode in Android
Go to VPN settings and enable VPN
Grant VPN permission
Verify that there was an attempt to send wide_vpn-enable.* pixels, with status=Failure
- we should enqueue such pixels to be sent when the device come online, but this is out of scope of this PR

Enable VPN using the tile in system tray

Go to system tray and enable VPN
Verify that if the app didn't have VPN permission, you were just taken to the VPN settings, VPN stays off and no wide event has been sent
Verify that if the app already had VPN permission, VPN was enabled and wide_vpn-enable.* pixel hase been sent

Re-enable VPN using system notification

Go to VPN settings and enable VPN
Grant VPN permission
Verify that wide_vpn-enable.* pixels were sent, with status=Success
Disable VPN
Go to system notifications and find the one saying "VPN is disconnected. Tap to continue securing your device traffic." and click "Connect"
Verify that wide_vpn-enable.* pixels were sent, with status=Success

App tracking protection is enabled

Enable AppTP
Go to VPN settings and enable VPN
Verify that there was an attempt to send wide_vpn-enable.* pixels, with status=Success
- we should enqueue such pixels to be sent when the device come online, but this is out of scope of this PR

No UI changes

lmac012 · 2025-11-10T12:51:11Z

Add vpn-enable wide event #7092 👈 (View in Graphite)
develop

This stack of pull requests is managed by Graphite. Learn more about stacking.

github-actions · 2025-11-11T03:49:37Z

Privacy Review task: https://app.asana.com/0/69071770703008/1211907027107113

karlenDimla · 2025-11-11T08:30:32Z

PixelDefinitions/params_dictionary.json

+        "description": "The name of the app sending the pixel",
+        "enum": ["DuckDuckGo Android"]
+    },
+    "widePixelAppVersion": {


What is the difference between widePixelAppVersion and appVersion? Why do we need a different param? Is it mainly to align with other platforms?

Ah good question @karlenDimla . @ladamski and/or @nshuba is there more to widePixelppVersion than aligning across platforms?

I think the wide event schema was designed without taking existing pixel params into account, because the goal is to send wide events using dedicated POST endpoint and not as a pixel. I don't think we need widePixelAppVersion now, but it will make the transition from pixel to the dedicated endpoint smoother. widePixelAppVersion is also used in existing wide events that predate pixel registry integration, and changing that here would complicate things.

...ection/vpn-impl/src/main/java/com/duckduckgo/mobile/android/vpn/pixels/VpnEnableWideEvent.kt

karlenDimla

Aligns with definition and works as expected. It is worth noting (already mentioned in description) that sometimes the wide event pixel fails to send when the pixel is attempted to be sent when the VPN is not yet fully up and running - there might be some delays after startVPN has been executed. It is best to enqueue this pixel to be 100% sure that they are sent.

jeannamatthews · 2025-11-11T10:35:05Z

PixelDefinitions/pixels/wide_vpn_enable.json5

+            },
+            {
+                "key": "feature.data.ext.service_start_duration_ms_bucketed",
+                "description": "The duration of TrackerBlockingVpnService (re)start in milliseconds, bucketed",


I believe our default is to specify the lower end of each range. Is this lower or upper? Worth clarifying in the comment. https://app.asana.com/1/137249556945/project/1207561877052131/task/1210817094107521?focus=true

This is the upper end of each range. This bucketing logic is shared with existing wide events and AFAIK is the same on other platforms. I'm happy to change this to use lower end (TIL this should be the default), but I believe this change should be handled in a separate task.

jeannamatthews · 2025-11-11T10:35:47Z

PixelDefinitions/pixels/wide_vpn_enable.json5

+            {
+                "key": "feature.data.ext.step.show_vpn_conflict_dialog",
+                "description": "true if the user was asked if they want to disable existing 3rd party VPN",
+                "enum": ["true"]


Can it be set to false as well or only sent if true?

Same question for the next 5.

It is only sent when true, I'll clarify that in the description.

jeannamatthews · 2025-11-11T10:37:28Z

PixelDefinitions/suffixes_dictionary.json

    },
+    "first_daily_count_short": {
+        "type": "string",
+        "description": "Pixel schedule type",


To be super clear could say in description u= first, d=daily, c=count

This ensures that when wide event is added in vpn process, the sending logic that lives in main process will be triggered.

lmac012 marked this pull request as ready for review November 10, 2025 12:56

lmac012 requested a review from karlenDimla November 10, 2025 12:56

lmac012 assigned karlenDimla Nov 10, 2025

lmac012 force-pushed the feature/lukasz/vpn-enable-wide-event branch 3 times, most recently from 322aa8d to 54d5f0a Compare November 11, 2025 03:47

lmac012 added the privacy review required label Nov 11, 2025

karlenDimla reviewed Nov 11, 2025

View reviewed changes

...ection/vpn-impl/src/main/java/com/duckduckgo/mobile/android/vpn/pixels/VpnEnableWideEvent.kt Show resolved Hide resolved

karlenDimla reviewed Nov 11, 2025

View reviewed changes

karlenDimla approved these changes Nov 11, 2025

View reviewed changes

jeannamatthews reviewed Nov 11, 2025

View reviewed changes

lmac012 added 6 commits November 11, 2025 20:01

Add vpn-enable wide event

cfe5262

add unit tests for both VpnEnableWideEvent implementations

b66d3ed

enable multi-instance invalidation for wide events db

0576d88

This ensures that when wide event is added in vpn process, the sending logic that lives in main process will be triggered.

add vpn-enable wide pixel definition

e8ff992

make lint happy

ff7f3f9

make VpnEnableWideEvent a singleton

b01c0e9

lmac012 force-pushed the feature/lukasz/vpn-enable-wide-event branch 2 times, most recently from 6b70739 to 82130c6 Compare November 12, 2025 01:18

lmac012 added 2 commits November 11, 2025 21:00

add missing error message

5cf771a

fix pixel definition

93d0f6e

lmac012 force-pushed the feature/lukasz/vpn-enable-wide-event branch from 82130c6 to 93d0f6e Compare November 12, 2025 02:01

lmac012 merged commit 185939d into develop Nov 12, 2025
11 of 12 checks passed

lmac012 deleted the feature/lukasz/vpn-enable-wide-event branch November 12, 2025 18:31

Add vpn-enable wide event #7092

Add vpn-enable wide event #7092

Conversation

lmac012 commented Nov 10, 2025 • edited by karlenDimla Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Steps to test this PR

Happy path

User rejects VPN permission

Another VPN is already running

Device is offline

Enable VPN using the tile in system tray

Re-enable VPN using system notification

App tracking protection is enabled

No UI changes

Uh oh!

lmac012 commented Nov 10, 2025

Uh oh!

github-actions bot commented Nov 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

karlenDimla left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lmac012 commented Nov 10, 2025 •

edited by karlenDimla

Loading