From 513c475e3d9a0661b72364121c67d22a44c9d7d6 Mon Sep 17 00:00:00 2001
From: Pascal Hartig <realpassy@fb.com>
Date: Fri, 5 Nov 2021 05:01:32 -0700
Subject: [PATCH] Add comments for interaction events

Summary: Per title

Reviewed By: mweststrate

Differential Revision: D32171224

fbshipit-source-id: b7610e8c10674d56e75468f46a3fd0664d70b4aa
---
 desktop/app/src/deeplinkTracking.tsx | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/desktop/app/src/deeplinkTracking.tsx b/desktop/app/src/deeplinkTracking.tsx
index 8699a83bd..8085bd9f3 100644
--- a/desktop/app/src/deeplinkTracking.tsx
+++ b/desktop/app/src/deeplinkTracking.tsx
@@ -19,15 +19,15 @@ export type OpenPluginParams = {
 export type DeeplinkInteractionState =
   | 'INIT'
   | 'ERROR'
-  | 'PLUGIN_LIGHTHOUSE_BAIL'
-  | 'PLUGIN_STATUS_BAIL'
-  | 'PLUGIN_DEVICE_BAIL'
-  | 'PLUGIN_CLIENT_BAIL'
-  | 'PLUGIN_DEVICE_SELECTION_BAIL'
-  | 'PLUGIN_CLIENT_SELECTION_BAIL'
-  | 'PLUGIN_DEVICE_UNSUPPORTED'
-  | 'PLUGIN_CLIENT_UNSUPPORTED'
-  | 'PLUGIN_OPEN_SUCCESS';
+  | 'PLUGIN_LIGHTHOUSE_BAIL' // User did not connect to VPN/Lighthouse when asked
+  | 'PLUGIN_STATUS_BAIL' // User did not install the plugin (has `extra` attribute with more information)
+  | 'PLUGIN_DEVICE_BAIL' // User did not launch a new device
+  | 'PLUGIN_CLIENT_BAIL' // User did not launch a supported app
+  | 'PLUGIN_DEVICE_SELECTION_BAIL' // User closed dialogue asking to select one of many devices
+  | 'PLUGIN_CLIENT_SELECTION_BAIL' // User closed dialogue asking to select one of many apps
+  | 'PLUGIN_DEVICE_UNSUPPORTED' // The device did not match the requirements specified in the deeplink URL
+  | 'PLUGIN_CLIENT_UNSUPPORTED' // The already opened app did not match the requirements specified in the deeplink URL
+  | 'PLUGIN_OPEN_SUCCESS'; // Everything is awesome
 
 export type DeeplinkInteraction = {
   state: DeeplinkInteractionState;