From ad62bcd44f18ac558abbe9aff13f9cce23abf09d Mon Sep 17 00:00:00 2001 From: Matt Wagner Date: Wed, 24 Jan 2024 10:57:45 -0500 Subject: [PATCH 1/5] Bolds non-ruby linter output The output is otherwise very easy to miss. changelog: Internal, Makefile, events ordering linter outputs errors in bold text --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 7ab336cbb12..7b2cf9f134f 100644 --- a/Makefile +++ b/Makefile @@ -283,7 +283,7 @@ lint_analytics_events: .yardoc ## Checks that all methods on AnalyticsEvents are lint_analytics_events_sorted: @test "$(shell grep '^ def ' app/services/analytics_events.rb)" = "$(shell grep '^ def ' app/services/analytics_events.rb | sort)" \ - || (echo 'Error: methods in analytics_events.rb are not sorted alphabetically' && exit 1) + || (echo -e '\033[1;31mError: methods in analytics_events.rb are not sorted alphabetically\033[0m' && exit 1) lint_tracker_events: .yardoc ## Checks that all methods on AnalyticsEvents are documented bundle exec ruby lib/analytics_events_documenter.rb --class-name="IrsAttemptsApi::TrackerEvents" --check --skip-extra-params $< From d1a4febe2b3afc195c8e5b0b65521c40126af996 Mon Sep 17 00:00:00 2001 From: Matt Wagner Date: Wed, 24 Jan 2024 10:59:38 -0500 Subject: [PATCH 2/5] Adds out-of-order method for demo --- app/services/analytics_events.rb | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/app/services/analytics_events.rb b/app/services/analytics_events.rb index e775a18ab07..dbeef891090 100644 --- a/app/services/analytics_events.rb +++ b/app/services/analytics_events.rb @@ -17,6 +17,10 @@ def account_delete_submitted(success:, **extra) track_event('Account Delete submitted', success: success, **extra) end + def z_out_of_order + # remove before commit + end + # When a user visits the page to delete their account def account_delete_visited track_event('Account Delete visited') From 70e927d95895247a0e74055c4401de560217e79b Mon Sep 17 00:00:00 2001 From: Matt Wagner Date: Wed, 24 Jan 2024 11:53:01 -0500 Subject: [PATCH 3/5] De-alphabetize methods to trigger error --- app/services/analytics_events.rb | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/app/services/analytics_events.rb b/app/services/analytics_events.rb index dbeef891090..8cfcc81c3e5 100644 --- a/app/services/analytics_events.rb +++ b/app/services/analytics_events.rb @@ -17,8 +17,10 @@ def account_delete_submitted(success:, **extra) track_event('Account Delete submitted', success: success, **extra) end - def z_out_of_order - # remove before commit + # @param [String] request_came_from the controller/action the request came from + # When a user deletes their account + def account_deletion(request_came_from:, **extra) + track_event('Account Deletion Requested', request_came_from: request_came_from, **extra) end # When a user visits the page to delete their account @@ -26,12 +28,6 @@ def account_delete_visited track_event('Account Delete visited') end - # @param [String] request_came_from the controller/action the request came from - # When a user deletes their account - def account_deletion(request_came_from:, **extra) - track_event('Account Deletion Requested', request_came_from: request_came_from, **extra) - end - # @identity.idp.previous_event_name Account Reset # @param [String] user_id # @param [String, nil] message_id from AWS Pinpoint API From da3e603b60895cd8bec1b5ca3b30a247e9be6b9f Mon Sep 17 00:00:00 2001 From: Matt Wagner Date: Wed, 24 Jan 2024 15:35:57 -0500 Subject: [PATCH 4/5] Remove -e flag --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 7b2cf9f134f..3f37ac5aaea 100644 --- a/Makefile +++ b/Makefile @@ -283,7 +283,7 @@ lint_analytics_events: .yardoc ## Checks that all methods on AnalyticsEvents are lint_analytics_events_sorted: @test "$(shell grep '^ def ' app/services/analytics_events.rb)" = "$(shell grep '^ def ' app/services/analytics_events.rb | sort)" \ - || (echo -e '\033[1;31mError: methods in analytics_events.rb are not sorted alphabetically\033[0m' && exit 1) + || (echo '\033[1;31mError: methods in analytics_events.rb are not sorted alphabetically\033[0m' && exit 1) lint_tracker_events: .yardoc ## Checks that all methods on AnalyticsEvents are documented bundle exec ruby lib/analytics_events_documenter.rb --class-name="IrsAttemptsApi::TrackerEvents" --check --skip-extra-params $< From d326165e1b3de4d732dc611e98d061490cddd3f4 Mon Sep 17 00:00:00 2001 From: Matt Wagner Date: Wed, 24 Jan 2024 21:10:13 -0500 Subject: [PATCH 5/5] Removes intentional error to trigger linter for demo --- app/services/analytics_events.rb | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/app/services/analytics_events.rb b/app/services/analytics_events.rb index 8cfcc81c3e5..e775a18ab07 100644 --- a/app/services/analytics_events.rb +++ b/app/services/analytics_events.rb @@ -17,17 +17,17 @@ def account_delete_submitted(success:, **extra) track_event('Account Delete submitted', success: success, **extra) end + # When a user visits the page to delete their account + def account_delete_visited + track_event('Account Delete visited') + end + # @param [String] request_came_from the controller/action the request came from # When a user deletes their account def account_deletion(request_came_from:, **extra) track_event('Account Deletion Requested', request_came_from: request_came_from, **extra) end - # When a user visits the page to delete their account - def account_delete_visited - track_event('Account Delete visited') - end - # @identity.idp.previous_event_name Account Reset # @param [String] user_id # @param [String, nil] message_id from AWS Pinpoint API