Merge branch 'devise-controller-context' into 'master'

Add user information to context metadata for Devise controllers

See merge request gitlab-org/gitlab!63303

app/controllers/application_controller.rb

@@ -457,9 +457,7 @@ class ApplicationController < ActionController::Base
 
   def set_current_context(&block)
     Gitlab::ApplicationContext.with_context(
-      # Avoid loading the auth_user again after the request. Otherwise calling
-      # `auth_user` again would also trigger the Warden callbacks again
-      user: -> { auth_user if strong_memoized?(:auth_user) },
+      user: -> { context_user },
       project: -> { @project if @project&.persisted? },
       namespace: -> { @group if @group&.persisted? },
       caller_id: caller_id,
@@ -542,6 +540,12 @@ class ApplicationController < ActionController::Base
     end
   end
 
+  # Avoid loading the auth_user again after the request. Otherwise calling
+  # `auth_user` again would also trigger the Warden callbacks again
+  def context_user
+    auth_user if strong_memoized?(:auth_user)
+  end
+
   def caller_id
     "#{self.class.name}##{action_name}"
   end

app/controllers/confirmations_controller.rb

@@ -34,6 +34,10 @@ class ConfirmationsController < Devise::ConfirmationsController
   def after_sign_in(resource)
     after_sign_in_path_for(resource)
   end
+
+  def context_user
+    resource
+  end
 end
 
 ConfirmationsController.prepend_mod_with('ConfirmationsController')

app/controllers/omniauth_callbacks_controller.rb

@@ -287,6 +287,10 @@ class OmniauthCallbacksController < Devise::OmniauthCallbacksController
   def fail_admin_mode_invalid_credentials
     redirect_to new_admin_session_path, alert: _('Invalid login or password')
   end
+
+  def context_user
+    current_user
+  end
 end
 
 OmniauthCallbacksController.prepend_mod_with('OmniauthCallbacksController')

app/controllers/passwords_controller.rb

@@ -67,6 +67,10 @@ class PasswordsController < Devise::PasswordsController
     redirect_to new_user_session_path,
       notice: I18n.t('devise.passwords.send_paranoid_instructions')
   end
+
+  def context_user
+    resource
+  end
 end
 
 PasswordsController.prepend_mod_with('PasswordsController')

app/controllers/registrations_controller.rb

@@ -202,6 +202,10 @@ class RegistrationsController < Devise::RegistrationsController
     experiment(:invite_signup_page_interaction, actor: member).track(:form_submission)
     experiment('members/invite_email', actor: member).track(:accepted)
   end
+
+  def context_user
+    current_user
+  end
 end
 
 RegistrationsController.prepend_mod_with('RegistrationsController')

spec/controllers/confirmations_controller_spec.rb

@@ -12,7 +12,9 @@ RSpec.describe ConfirmationsController do
   describe '#show' do
     render_views
 
-    subject { get :show, params: { confirmation_token: confirmation_token } }
+    def perform_request
+      get :show, params: { confirmation_token: confirmation_token }
+    end
 
     context 'user is already confirmed' do
       let_it_be_with_reload(:user) { create(:user, :unconfirmed) }
@@ -20,20 +22,37 @@ RSpec.describe ConfirmationsController do
 
       before do
         user.confirm
-        subject
       end
 
       it 'renders `new`' do
+        perform_request
+
         expect(response).to render_template(:new)
       end
 
       it 'displays an error message' do
+        perform_request
+
         expect(response.body).to include('Email was already confirmed, please try signing in')
       end
 
       it 'does not display the email of the user' do
+        perform_request
+
         expect(response.body).not_to include(user.email)
       end
+
+      it 'sets the username and caller_id in the context' do
+        expect(controller).to receive(:show).and_wrap_original do |m, *args|
+          m.call(*args)
+
+          expect(Gitlab::ApplicationContext.current)
+            .to include('meta.user' => user.username,
+                        'meta.caller_id' => 'ConfirmationsController#show')
+        end
+
+        perform_request
+      end
     end
 
     context 'user accesses the link after the expiry of confirmation token has passed' do
@@ -42,39 +61,64 @@ RSpec.describe ConfirmationsController do
 
       before do
         allow(Devise).to receive(:confirm_within).and_return(1.day)
-
-        travel_to(3.days.from_now) do
-          subject
-        end
       end
 
       it 'renders `new`' do
+        travel_to(3.days.from_now) { perform_request }
+
         expect(response).to render_template(:new)
       end
 
       it 'displays an error message' do
+        travel_to(3.days.from_now) { perform_request }
+
         expect(response.body).to include('Email needs to be confirmed within 1 day, please request a new one below')
       end
 
       it 'does not display the email of the user' do
+        travel_to(3.days.from_now) { perform_request }
+
         expect(response.body).not_to include(user.email)
       end
+
+      it 'sets the username and caller_id in the context' do
+        expect(controller).to receive(:show).and_wrap_original do |m, *args|
+          m.call(*args)
+
+          expect(Gitlab::ApplicationContext.current)
+            .to include('meta.user' => user.username,
+                        'meta.caller_id' => 'ConfirmationsController#show')
+        end
+
+        travel_to(3.days.from_now) { perform_request }
+      end
     end
 
     context 'with an invalid confirmation token' do
       let(:confirmation_token) { 'invalid_confirmation_token' }
 
-      before do
-        subject
-      end
-
       it 'renders `new`' do
+        perform_request
+
         expect(response).to render_template(:new)
       end
 
       it 'displays an error message' do
+        perform_request
+
         expect(response.body).to include('Confirmation token is invalid')
       end
+
+      it 'sets the the caller_id in the context' do
+        expect(controller).to receive(:show).and_wrap_original do |m, *args|
+          expect(Gitlab::ApplicationContext.current)
+            .to include('meta.caller_id' => 'ConfirmationsController#show')
+
+          m.call(*args)
+        end
+
+        perform_request
+      end
     end
   end
 end

spec/controllers/omniauth_callbacks_controller_spec.rb

@@ -293,6 +293,18 @@ RSpec.describe OmniauthCallbacksController, type: :controller do
 
             expect(request.env['warden']).to be_authenticated
           end
+
+          it 'sets the username and caller_id in the context' do
+            expect(controller).to receive(:atlassian_oauth2).and_wrap_original do |m, *args|
+              m.call(*args)
+
+              expect(Gitlab::ApplicationContext.current)
+                .to include('meta.user' => user.username,
+                            'meta.caller_id' => 'OmniauthCallbacksController#atlassian_oauth2')
+            end
+
+            post :atlassian_oauth2
+          end
         end
 
         context 'for a new user' do
@@ -454,6 +466,18 @@ RSpec.describe OmniauthCallbacksController, type: :controller do
       it 'doesn\'t link a new identity to the user' do
         expect { post :saml, params: { SAMLResponse: mock_saml_response } }.not_to change { user.identities.count }
       end
+
+      it 'sets the username and caller_id in the context' do
+        expect(controller).to receive(:saml).and_wrap_original do |m, *args|
+          m.call(*args)
+
+          expect(Gitlab::ApplicationContext.current)
+            .to include('meta.user' => user.username,
+                        'meta.caller_id' => 'OmniauthCallbacksController#saml')
+        end
+
+        post :saml, params: { SAMLResponse: mock_saml_response }
+      end
     end
   end
 

spec/controllers/passwords_controller_spec.rb

@@ -77,6 +77,18 @@ RSpec.describe PasswordsController do
           expect(user.password_expires_at).not_to be_nil
         end
       end
+
+      it 'sets the username and caller_id in the context' do
+        expect(controller).to receive(:update).and_wrap_original do |m, *args|
+          m.call(*args)
+
+          expect(Gitlab::ApplicationContext.current)
+            .to include('meta.user' => user.username,
+                        'meta.caller_id' => 'PasswordsController#update')
+        end
+
+        subject
+      end
     end
   end
 end

spec/controllers/registrations_controller_spec.rb

@@ -434,6 +434,18 @@ RSpec.describe RegistrationsController do
       expect(User.last.last_name).to eq(base_user_params[:last_name])
       expect(User.last.name).to eq("#{base_user_params[:first_name]} #{base_user_params[:last_name]}")
     end
+
+    it 'sets the username and caller_id in the context' do
+      expect(controller).to receive(:create).and_wrap_original do |m, *args|
+        m.call(*args)
+
+        expect(Gitlab::ApplicationContext.current)
+          .to include('meta.user' => base_user_params[:username],
+                      'meta.caller_id' => 'RegistrationsController#create')
+      end
+
+      subject
+    end
   end
 
   describe '#destroy' do
@@ -525,5 +537,17 @@ RSpec.describe RegistrationsController do
         end
       end
     end
+
+    it 'sets the username and caller_id in the context' do
+      expect(controller).to receive(:destroy).and_wrap_original do |m, *args|
+        m.call(*args)
+
+        expect(Gitlab::ApplicationContext.current)
+          .to include('meta.user' => user.username,
+                      'meta.caller_id' => 'RegistrationsController#destroy')
+      end
+
+      post :destroy
+    end
   end
 end