LG-7304 Add Attempts API Logout Initiated tracking

app/controllers/concerns/saml_idp_logout_concern.rb

@@ -58,6 +58,9 @@ def track_logout_event
       oidc: false,
       saml_request_valid: sp_initiated ? valid_saml_request? : true,
     )
+    irs_attempts_api_tracker.logout_initiated(
+      success: true,
+    )
   end
 
   def track_remote_logout_event

app/controllers/openid_connect/logout_controller.rb

@@ -10,6 +10,9 @@ def index
       result = @logout_form.submit
 
       analytics.logout_initiated(**result.to_h.except(:redirect_uri))
+      irs_attempts_api_tracker.logout_initiated(
+        success: result.success?,
+      )
 
       if result.success? && (redirect_uri = result.extra[:redirect_uri])
         sign_out

app/controllers/sign_out_controller.rb

@@ -3,6 +3,9 @@ class SignOutController < ApplicationController
 
   def destroy
     analytics.logout_initiated(method: 'cancel link')
+    irs_attempts_api_tracker.logout_initiated(
+      success: true,
+    )
     url_after_cancellation = decorated_session.cancel_link_url
     sign_out
     flash[:success] = t('devise.sessions.signed_out')

app/controllers/users/sessions_controller.rb

@@ -41,8 +41,6 @@ def create
     def destroy
       analytics.logout_initiated(sp_initiated: false, oidc: false)
       irs_attempts_api_tracker.logout_initiated(
-        user_uuid: current_user.uuid,
-        unique_session_id: current_user.unique_session_id,
         success: true,
       )
       super

app/services/irs_attempts_api/tracker_events.rb

@@ -15,11 +15,9 @@ def email_and_password_auth(email:, success:)
     # @param [String] unique_session_id The unique session id
     # @param [Boolean] success True if the email and password matched
     # A user has initiated a logout event
-    def logout_initiated(user_uuid:, unique_session_id:, success:)
+    def logout_initiated(success:)
       track_event(
         :logout_initiated,
-        user_uuid: user_uuid,
-        unique_session_id: unique_session_id,
         success: success,
       )
     end

spec/controllers/openid_connect/logout_controller_spec.rb

@@ -51,7 +51,7 @@
           expect(response).to redirect_to(/^#{post_logout_redirect_uri}/)
         end
 
-        it 'tracks analytics' do
+        it 'tracks events' do
           stub_analytics
           expect(@analytics).to receive(:track_event).
             with(
@@ -65,6 +65,11 @@
               ),
             )
 
+          stub_attempts_tracker
+          expect(@irs_attempts_api_tracker).to receive(:logout_initiated).
+            with(
+              success: true,
+            )
           action
         end
       end
@@ -84,7 +89,7 @@
           action
         end
 
-        it 'tracks analytics' do
+        it 'tracks events' do
           stub_analytics
 
           errors = {
@@ -102,14 +107,19 @@
               method: nil,
               saml_request_valid: nil,
             )
+          stub_attempts_tracker
+          expect(@irs_attempts_api_tracker).to receive(:logout_initiated).
+            with(
+              success: false,
+            )
 
           action
         end
       end
 
       context 'with a bad id_token_hint' do
         let(:id_token_hint) { { id_token_hint: 'abc123' } }
-        it 'tracks analytics' do
+        it 'tracks events' do
           stub_analytics
           errors_keys = [:id_token_hint, :redirect_uri]
 
@@ -125,6 +135,11 @@
               method: nil,
               saml_request_valid: nil,
             )
+          stub_attempts_tracker
+          expect(@irs_attempts_api_tracker).to receive(:logout_initiated).
+            with(
+              success: false,
+            )
 
           action
         end

spec/controllers/saml_idp_controller_spec.rb

@@ -8,28 +8,40 @@
   describe '/api/saml/logout' do
     it 'tracks the event when idp initiated' do
       stub_analytics
+      stub_attempts_tracker
 
       result = { sp_initiated: false, oidc: false, saml_request_valid: true }
       expect(@analytics).to receive(:track_event).with('Logout Initiated', hash_including(result))
+      expect(@irs_attempts_api_tracker).to receive(:logout_initiated).with(
+        success: true,
+      )
 
       delete :logout
     end
 
     it 'tracks the event when sp initiated' do
       allow(controller).to receive(:saml_request).and_return(FakeSamlLogoutRequest.new)
       stub_analytics
+      stub_attempts_tracker
 
       result = { sp_initiated: true, oidc: false, saml_request_valid: true }
       expect(@analytics).to receive(:track_event).with('Logout Initiated', hash_including(result))
+      expect(@irs_attempts_api_tracker).to receive(:logout_initiated).with(
+        success: true,
+      )
 
       delete :logout, params: { SAMLRequest: 'foo' }
     end
 
     it 'tracks the event when the saml request is invalid' do
       stub_analytics
+      stub_attempts_tracker
 
       result = { sp_initiated: true, oidc: false, saml_request_valid: false }
       expect(@analytics).to receive(:track_event).with('Logout Initiated', hash_including(result))
+      expect(@irs_attempts_api_tracker).to receive(:logout_initiated).with(
+        success: true,
+      )
 
       delete :logout, params: { SAMLRequest: 'foo' }
     end

spec/controllers/sign_out_controller_spec.rb

@@ -22,11 +22,16 @@
     it 'tracks the event' do
       stub_sign_in_before_2fa
       stub_analytics
+      stub_attempts_tracker
       allow(controller.decorated_session).to receive(:cancel_link_url).and_return('foo')
 
       expect(@analytics).
         to receive(:track_event).with('Logout Initiated', hash_including(method: 'cancel link'))
 
+      expect(@irs_attempts_api_tracker).to receive(:logout_initiated).with(
+        success: true,
+      )
+
       get :destroy
     end
   end

spec/controllers/users/sessions_controller_spec.rb

@@ -118,6 +118,7 @@
   describe 'GET /logout' do
     it 'tracks a logout event' do
       stub_analytics
+      stub_attempts_tracker
       expect(@analytics).to receive(:track_event).with(
         'Logout Initiated',
         hash_including(
@@ -128,9 +129,7 @@
 
       sign_in_as_user
 
-      expect_any_instance_of(IrsAttemptsApi::Tracker).to receive(:logout_initiated).with(
-        user_uuid: controller.current_user.uuid,
-        unique_session_id: controller.current_user.unique_session_id,
+      expect(@irs_attempts_api_tracker).to receive(:logout_initiated).with(
         success: true,
       )
 
@@ -142,6 +141,7 @@
   describe 'DELETE /logout' do
     it 'tracks a logout event' do
       stub_analytics
+      stub_attempts_tracker
       expect(@analytics).to receive(:track_event).with(
         'Logout Initiated',
         hash_including(
@@ -152,9 +152,7 @@
 
       sign_in_as_user
 
-      expect_any_instance_of(IrsAttemptsApi::Tracker).to receive(:logout_initiated).with(
-        user_uuid: controller.current_user.uuid,
-        unique_session_id: controller.current_user.unique_session_id,
+      expect(@irs_attempts_api_tracker).to receive(:logout_initiated).with(
         success: true,
       )
 
@@ -205,6 +203,7 @@
       subject.session['user_return_to'] = 'http://example.com'
 
       stub_analytics
+      stub_attempts_tracker
       analytics_hash = {
         success: true,
         user_id: user.uuid,
@@ -217,7 +216,7 @@
       expect(@analytics).to receive(:track_event).
         with('Email and Password Authentication', analytics_hash)
 
-      expect_any_instance_of(IrsAttemptsApi::Tracker).to receive(:email_and_password_auth).
+      expect(@irs_attempts_api_tracker).to receive(:email_and_password_auth).
         with(email: user.email, success: true)
 
       post :create, params: { user: { email: user.email, password: user.password } }