VPN-6324: Telemetry for web based authentication (#10171)

* VPN-6324 web based auth telemetry * PR feedback * add data review
mozilla-mobile · Jan 8, 2025 · 31eb72f · 31eb72f
1 parent f95b87b
commit 31eb72f
Show file tree

Hide file tree

Showing 3 changed files with 97 additions and 4 deletions.
diff --git a/src/tasks/authenticate/taskauthenticate.cpp b/src/tasks/authenticate/taskauthenticate.cpp
@@ -13,6 +13,7 @@
 #include "authenticationlistener.h"
 #include "constants.h"
 #include "errorhandler.h"
+#include "glean/generated/metrics.h"
 #include "leakdetector.h"
 #include "logger.h"
 #include "networkrequest.h"
@@ -52,6 +53,14 @@ void TaskAuthenticate::run() {
             logger.debug() << "Authentication completed with code:"
                            << logger.sensitive(pkceCodeSuccess);
 
+            if (m_authenticationType ==
+                AuthenticationListener::AuthenticationInBrowser) {
+              mozilla::glean::web_authentication::successful.record(
+                  mozilla::glean::web_authentication::SuccessfulExtra{
+                      ._uuid = m_metricUuid.toString(QUuid::WithoutBraces),
+                  });
+            }
+
             NetworkRequest* request = new NetworkRequest(this, 200);
             request->post(
                 AuthenticationListener::createLoginVerifyUrl(),
@@ -76,6 +85,13 @@ void TaskAuthenticate::run() {
 
   connect(m_authenticationListener, &AuthenticationListener::failed, this,
           [this](ErrorHandler::ErrorType error) {
+            if (m_authenticationType ==
+                AuthenticationListener::AuthenticationInBrowser) {
+              mozilla::glean::web_authentication::failed.record(
+                  mozilla::glean::web_authentication::FailedExtra{
+                      ._uuid = m_metricUuid.toString(QUuid::WithoutBraces),
+                  });
+            }
             REPORTERROR(error, name());
             m_authenticationListener->aboutToFinish();
           });
@@ -86,6 +102,13 @@ void TaskAuthenticate::run() {
             m_authenticationListener->aboutToFinish();
           });
 
+  m_metricUuid = QUuid::createUuid();
+  if (m_authenticationType == AuthenticationListener::AuthenticationInBrowser) {
+    mozilla::glean::web_authentication::started.record(
+        mozilla::glean::web_authentication::StartedExtra{
+            ._uuid = m_metricUuid.toString(QUuid::WithoutBraces),
+        });
+  }
   m_authenticationListener->start(this, pkceCodeChallenge,
                                   CODE_CHALLENGE_METHOD,
                                   SettingsHolder::instance()->userEmail());

diff --git a/src/tasks/authenticate/taskauthenticate.h b/src/tasks/authenticate/taskauthenticate.h
@@ -5,6 +5,8 @@
 #ifndef TASKAUTHENTICATE_H
 #define TASKAUTHENTICATE_H
 
+#include <QUuid>
+
 #include "authenticationlistener.h"
 #include "task.h"
 
@@ -32,6 +34,7 @@ class TaskAuthenticate final : public Task {
   AuthenticationListener* m_authenticationListener = nullptr;
   AuthenticationListener::AuthenticationType m_authenticationType =
       AuthenticationListener::AuthenticationInBrowser;
+  QUuid m_metricUuid = QUuid::createUuid();
 };
 
 #endif  // TASKAUTHENTICATE_H
diff --git a/src/telemetry/metrics.yaml b/src/telemetry/metrics.yaml
@@ -663,7 +663,7 @@ session:
     bugs:
       - https://mozilla-hub.atlassian.net/browse/VPN-6406
     data_reviews:
-      - TBA
+      - https://github.com/mozilla-mobile/mozilla-vpn-client/pull/9593#issuecomment-2159109154
     data_sensitivity:
       - technical
     notification_emails:
@@ -839,7 +839,7 @@ connection_health:
     bugs:
       - https://mozilla-hub.atlassian.net/browse/VPN-6406
     data_reviews:
-      - TBA
+      - https://github.com/mozilla-mobile/mozilla-vpn-client/pull/9593#issuecomment-2159109154
     data_sensitivity:
       - technical
     notification_emails:
@@ -945,7 +945,7 @@ connection_health:
     bugs:
       - https://mozilla-hub.atlassian.net/browse/VPN-6406
     data_reviews:
-      - TBA
+      - https://github.com/mozilla-mobile/mozilla-vpn-client/pull/9593#issuecomment-2159109154
     data_sensitivity:
       - technical
     notification_emails:
@@ -1032,7 +1032,7 @@ connection_health:
     bugs:
       - https://mozilla-hub.atlassian.net/browse/VPN-6406
     data_reviews:
-      - TBA
+      - https://github.com/mozilla-mobile/mozilla-vpn-client/pull/9593#issuecomment-2159109154
     data_sensitivity:
       - technical
     notification_emails:
@@ -1062,3 +1062,70 @@ connection_health:
         description: |
           Error type
         type: string
+
+web_authentication:
+  started:
+    type: event
+    lifetime: ping
+    send_in_pings:
+      - main
+    description: |
+      Web authentication was started.
+    bugs:
+      - https://mozilla-hub.atlassian.net/browse/VPN-6323
+    data_reviews:
+      - https://github.com/mozilla-mobile/mozilla-vpn-client/pull/10171#pullrequestreview-2537047062
+    data_sensitivity:
+      - interaction
+    notification_emails:
+      - [email protected]
+      - [email protected]
+    expires: 2026-06-30
+    extra_keys:
+      uuid:
+        description: UUID to match starting events to ending ones
+        type: string
+
+  successful:
+    type: event
+    lifetime: ping
+    send_in_pings:
+      - main
+    description: |
+      Web authentication was successfully completed.
+    bugs:
+      - https://mozilla-hub.atlassian.net/browse/VPN-6323
+    data_reviews:
+      - https://github.com/mozilla-mobile/mozilla-vpn-client/pull/10171#pullrequestreview-2537047062
+    data_sensitivity:
+      - interaction
+    notification_emails:
+      - [email protected]
+      - [email protected]
+    expires: 2026-06-30
+    extra_keys:
+      uuid:
+        description: UUID to match ending event to starting one
+        type: string
+
+  failed:
+    type: event
+    lifetime: ping
+    send_in_pings:
+      - main
+    description: |
+      Web authentication was unsuccessfully completed.
+    bugs:
+      - https://mozilla-hub.atlassian.net/browse/VPN-6323
+    data_reviews:
+      - https://github.com/mozilla-mobile/mozilla-vpn-client/pull/10171#pullrequestreview-2537047062
+    data_sensitivity:
+      - interaction
+    notification_emails:
+      - [email protected]
+      - [email protected]
+    expires: 2026-06-30
+    extra_keys:
+      uuid:
+        description: UUID to match ending event to starting one
+        type: string