diff --git a/Makefile b/Makefile index a3b6d3fa26c..602b2ab5898 100644 --- a/Makefile +++ b/Makefile @@ -64,6 +64,7 @@ lint: ## Runs all lint tests bundle exec rubocop --parallel @echo "--- analytics_events ---" make lint_analytics_events + make lint_tracker_events @echo "--- brakeman ---" bundle exec brakeman @echo "--- bundler-audit ---" diff --git a/app/services/irs_attempts_api/tracker_events.rb b/app/services/irs_attempts_api/tracker_events.rb index 53482d33e10..a7cedd5b361 100644 --- a/app/services/irs_attempts_api/tracker_events.rb +++ b/app/services/irs_attempts_api/tracker_events.rb @@ -3,7 +3,7 @@ # rubocop:disable Metrics/ModuleLength module IrsAttemptsApi module TrackerEvents - # param [Boolean] success True if Account Successfully Deleted + # @param [Boolean] success True if Account Successfully Deleted # A User deletes their Login.gov account def account_purged(success:) track_event( @@ -12,8 +12,8 @@ def account_purged(success:) ) end - # param [Boolean] success True if Account Successfully Deleted - # param [Hash>] failure_reason displays why account deletion failed + # @param [Boolean] success True if Account Successfully Deleted + # @param [Hash>] 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( @@ -23,7 +23,7 @@ def account_reset_account_deleted(success:, failure_reason:) ) end - # param [Boolean] success True if account reset request is cancelled + # @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:) track_event( @@ -146,8 +146,8 @@ def idv_document_upload_submitted( ) end - # param [Boolean] Success - # param [Hash>] failure_reason displays GPO submission failed + # @param [Boolean] success + # @param [Hash>] failure_reason displays GPO submission failed # GPO verification submitted from Letter sent to verify address def idv_gpo_verification_submitted(success:, failure_reason:) track_event( @@ -225,7 +225,7 @@ def idv_phone_otp_sent_rate_limited # Tracks when a user submits OTP code sent to their phone # @param [String] phone_number - # param [Boolean] success + # @param [Boolean] success # @param [Hash>] failure_reason def idv_phone_otp_submitted(phone_number:, success:, failure_reason: nil) track_event( @@ -256,7 +256,7 @@ def idv_phone_send_link_rate_limited(phone_number:) # Tracks when the user submits their idv phone number # @param [String] phone_number - # param [Boolean] success + # @param [Boolean] success # @param [Hash>] failure_reason def idv_phone_submitted(phone_number:, success:, failure_reason: nil) track_event( @@ -327,6 +327,7 @@ def idv_verification_rate_limited # @param [String] last_name # @param [String] date_of_birth # @param [String] address + # @param [String] ssn # @param [Hash>] failure_reason # The verification was submitted during the IDV process def idv_verification_submitted( @@ -541,7 +542,8 @@ def mfa_login_phone_otp_sent_rate_limited(phone_number:) ) end - # @param [Boolean] success - True if the sms otp submitted matched what was sent + # @param [Boolean] reauthentication if the user was already logged in + # @param [Boolean] success True if the sms otp submitted matched what was sent # During a login attempt, the user, having previously been sent an OTP code via SMS # has entered an OTP code. def mfa_login_phone_otp_submitted(reauthentication:, success:)