feat(analytics): add optional error_code event property

cal-itp · May 29, 2024 · 3420fbb · 3420fbb
1 parent 25da735
commit 3420fbb
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/benefits/oauth/analytics.py b/benefits/oauth/analytics.py
@@ -32,8 +32,10 @@ def __init__(self, request):
 class FinishedSignInEvent(OAuthEvent):
     """Analytics event representing the end of the OAuth sign in flow."""
 
-    def __init__(self, request):
+    def __init__(self, request, error=None):
         super().__init__(request, "finished sign in")
+        if error is not None:
+            self.update_event_properties(error_code=error)
 
 
 class StartedSignOutEvent(OAuthEvent):
@@ -61,9 +63,12 @@ def canceled_sign_in(request):
     core.send_event(CanceledSignInEvent(request))
 
 
-def finished_sign_in(request):
+def finished_sign_in(request, error=None):
     """Send the "finished sign in" analytics event."""
-    core.send_event(FinishedSignInEvent(request))
+    if error is not None:
+        core.send_event(FinishedSignInEvent(request, error))
+    else:
+        core.send_event(FinishedSignInEvent(request))
 
 
 def started_sign_out(request):