Skip to content

Alphabetize tracker_events #6852

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
ThatSpaceGuy merged 1 commit into from
Aug 26, 2022
Merged

Alphabetize tracker_events #6852

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
66 changes: 33 additions & 33 deletions app/services/irs_attempts_api/tracker_events.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@
# rubocop:disable Metrics/ModuleLength
module IrsAttemptsApi
module TrackerEvents
# param [Boolean] success True if Account Successfully Deleted
# param [Hash<Key, Array<String>>] failure_reason displays why account deletion failed
# A User confirms and deletes their Login.gov account after 24 hour period
def account_reset_account_deleted(success:, failure_reason:)
track_event(
:account_reset_account_deleted,
success: success,
failure_reason: failure_reason,
)
end

# param [Boolean] success True if account reset request is cancelled
# A user cancels the request to delete their account before 24 hour period
def account_reset_cancel_request(success:)
Expand All @@ -21,17 +32,6 @@ def account_reset_request_submitted(success:)
)
end

# param [Boolean] success True if Account Successfully Deleted
# param [Hash<Key, Array<String>>] failure_reason displays why account deletion failed
# A User confirms and deletes their Login.gov account after 24 hour period
def account_reset_account_deleted(success:, failure_reason:)
track_event(
:account_reset_account_deleted,
success: success,
failure_reason: failure_reason,
)
end

# @param ["mobile", "desktop"] upload_method method chosen for uploading id verification
# A user has selected id document upload method
def document_upload_method_selected(upload_method:)
Expand All @@ -52,6 +52,16 @@ def email_and_password_auth(email:, success:)
)
end

# @param [Boolean] success
# @param [Hash<Symbol,Array<Symbol>>] failure_reason
def forgot_password_email_confirmed(success:, failure_reason: nil)
track_event(
:forgot_password_email_confirmed,
success: success,
failure_reason: failure_reason,
)
end

# The user has exceeded the rate limit for password reset emails
# @param [String] email The user's email address
def forgot_password_email_rate_limited(email:)
Expand All @@ -74,9 +84,9 @@ def forgot_password_email_sent(email:, success:)

# @param [Boolean] success
# @param [Hash<Symbol,Array<Symbol>>] failure_reason
def forgot_password_email_confirmed(success:, failure_reason: nil)
def forgot_password_new_password_submitted(success:, failure_reason: nil)
track_event(
:forgot_password_email_confirmed,
:forgot_password_new_password_submitted,
success: success,
failure_reason: failure_reason,
)
Expand Down Expand Up @@ -146,16 +156,6 @@ def logout_initiated(success:)
)
end

# @param [Boolean] success
# @param [Hash<Symbol,Array<Symbol>>] failure_reason
def forgot_password_new_password_submitted(success:, failure_reason: nil)
track_event(
:forgot_password_new_password_submitted,
success: success,
failure_reason: failure_reason,
)
end

# Tracks when the user has attempted to enroll the Backup Codes MFA method to their account
# @param [Boolean] success
def mfa_enroll_backup_code(success:)
Expand Down Expand Up @@ -188,16 +188,6 @@ def mfa_enroll_phone_otp_sent(phone_number:, success:)
)
end

# @param [Boolean] success - True if the sms otp submitted matched what was sent
# The user, after having previously been sent an OTP code during phone enrollment
# has been asked to submit that code.
def mfa_enroll_phone_otp_submitted(success:)
track_event(
:mfa_enroll_phone_otp_submitted,
success: success,
)
end

# @param [String] phone_number - The user's phone number used for multi-factor authentication
# @param [Boolean] success - True if the user was locked out
# The user has exceeded the rate limit for SMS OTP sends.
Expand All @@ -209,6 +199,16 @@ def mfa_enroll_phone_otp_sent_rate_limited(phone_number:, success:)
)
end

# @param [Boolean] success - True if the sms otp submitted matched what was sent
# The user, after having previously been sent an OTP code during phone enrollment
# has been asked to submit that code.
def mfa_enroll_phone_otp_submitted(success:)
track_event(
:mfa_enroll_phone_otp_submitted,
success: success,
)
end

# Tracks when the user has attempted to enroll the piv cac MFA method to their account
# @param [String] subject_dn
# @param [Boolean] success
Expand Down