Skip to content

Patch: analytics events 11 #6303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zachmargolis merged 3 commits into from
May 4, 2022
+5 −14
Merged

Patch: analytics events 11 #6303

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1961a1
Remove @identity.idp.event_name
zachmargolis May 4, 2022
8878636
Remove blank lines
zachmargolis May 4, 2022
069e17e
Add clearer comments for each event
zachmargolis May 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 5 additions & 14 deletions app/services/analytics_events.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,10 +465,9 @@ def idv_doc_auth_exception_visited(step_name:, remaining_attempts:, **extra)
)
end

# @identity.idp.event_name Document authentication: Upload image from form
# @param [Boolean] success
# @param [Hash] errors
# Authentication document image uploaded by form
# The document capture image uploaded was locally validated during the IDV process
def idv_doc_auth_submitted_image_upload_form(
success:,
errors:,
Expand All @@ -482,7 +481,6 @@ def idv_doc_auth_submitted_image_upload_form(
)
end

# @identity.idp.event_name Document authentication: Upload image from vendor
# @param [Boolean] success
# @param [Hash] errors
# @param [String] exception
Expand All @@ -495,7 +493,7 @@ def idv_doc_auth_submitted_image_upload_form(
# @param [Integer] remaining_attempts
# @param [Hash] client_image_metrics
# @param [String] flow_path
# Authentication document image uploaded by vendor
# The document capture image was uploaded to vendor during the IDV process
def idv_doc_auth_submitted_image_upload_vendor(
success:,
errors:,
Expand Down Expand Up @@ -528,15 +526,13 @@ def idv_doc_auth_submitted_image_upload_vendor(
)
end

# @identity.idp.event_name Document authentication: PII validation
# @param [Boolean] success
# @param [Hash] errors
# @param [String] user_id
# @param [Integer] remaining_attempts
# @param [Hash] pii_like_keypaths
# @param [String] flow_path
# Authentication document image uploaded by vendor - PII validation

# The PII that came back from the document capture vendor was validated
def idv_doc_auth_submitted_pii_validation(
success:,
errors:,
Expand All @@ -558,11 +554,9 @@ def idv_doc_auth_submitted_pii_validation(
)
end

# @identity.idp.event_name Document authentication: warning visited
# @param [String] step_name
# @param [Integer] remaining_attempts
# Authentication document warning visited

# The user was sent to a warning page during the IDV flow
def idv_doc_auth_warning_visited(
step_name:,
remaining_attempts:,
Expand All @@ -576,10 +570,8 @@ def idv_doc_auth_warning_visited(
)
end

# @identity.idp.event_name Final IdV: final resolution
# @param [Boolean] success
# Final IdV: final resolution

# Tracks the last step of IDV, indicates the user successfully prooved
def idv_final(
success:,
**extra
Expand All @@ -591,7 +583,6 @@ def idv_final(
)
end

# @identity.idp.event_name IdV: personal key visited
# User visited IDV personal key page
def idv_personal_key_visited
track_event('IdV: personal key visited')
Expand Down