Merge branch 'sh-consolidate-puma-error-handler' into 'master'

Consolidate Puma low-level handler

See merge request https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/7212

Merged-by: Balasankar 'Balu' C <[email protected]>
Approved-by: Clemens Beck <[email protected]>
Approved-by: Balasankar 'Balu' C <[email protected]>
Co-authored-by: Stan Hu <[email protected]>

Author: balasankarc

files/gitlab-cookbooks/gitlab/templates/default/puma.rb.erb

@@ -71,7 +71,7 @@ directory '<%= @working_directory %>'
 
 workers <%= @worker_processes %>
 
-require_relative "<%= @install_dir %>/embedded/service/gitlab-rails/lib/gitlab/cluster/lifecycle_events"
+require "<%= @install_dir %>/embedded/service/gitlab-rails/lib/gitlab/cluster/lifecycle_events"
 
 on_restart do
   # Signal application hooks that we're about to restart
@@ -113,22 +113,16 @@ worker_timeout <%= @worker_timeout %>
 wait_for_less_busy_worker ENV.fetch('PUMA_WAIT_FOR_LESS_BUSY_WORKER', 0.001).to_f
 
 # Use customised JSON formatter for Puma log
-require_relative "<%= @install_dir %>/embedded/service/gitlab-rails/lib/gitlab/puma_logging/json_formatter"
+require "<%= @install_dir %>/embedded/service/gitlab-rails/lib/gitlab/puma_logging/json_formatter"
 
 json_formatter = Gitlab::PumaLogging::JSONFormatter.new
 log_formatter do |str|
     json_formatter.call(str)
 end
 
-lowlevel_error_handler do |ex, env, status_code|
-  # Puma v6.4.0 added the status_code argument in
-  # https://github.com/puma/puma/pull/3094
-  status_code ||= 500
-
-  if Raven.configuration.capture_allowed?
-    Raven.capture_exception(ex, tags: { 'handler': 'puma_low_level' }, extra: { puma_env: env, status_code: status_code })
-  end
+require "<%= @install_dir %>/embedded/service/gitlab-rails/lib/gitlab/puma/error_handler"
+error_handler = Gitlab::Puma::ErrorHandler.new(ENV['RAILS_ENV'] == 'production')
 
-  # note the below is just a Rack response
-  [status_code, {}, ["An error has occurred and reported in the system's low-level error handler."]]
+lowlevel_error_handler do |ex, env, status_code|
+  error_handler.execute(ex, env, status_code)
 end

spec/chef/cookbooks/gitlab/recipes/puma_spec.rb

@@ -82,7 +82,7 @@
       )
       expect(chef_run).to render_file('/var/opt/gitlab/gitlab-rails/etc/puma.rb').with_content { |content|
         expect(content).to match(/lowlevel_error_handler/)
-        expect(content).to include('Raven.capture_exception')
+        expect(content).to include('require "/opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/puma/error_handler"')
       }
     end
 

spec/chef/cookbooks/gitlab/resources/puma_config_spec.rb

@@ -21,10 +21,10 @@
         expect(content).to match(%r(^bind 'unix:///var/opt/gitlab/gitlab-rails/sockets/gitlab.socket'))
         expect(content).to match(%r(^bind 'tcp://127.0.0.1:8080'))
         expect(content).to match(%r(^directory '/var/opt/gitlab/gitlab-rails/working'))
-        expect(content).to match(%r(^require_relative "/opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/cluster/lifecycle_events"$))
+        expect(content).to match(%r(^require "/opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/cluster/lifecycle_events"$))
         expect(content).to match(/^options = { workers: 2 }$/)
         expect(content).to match(/^preload_app!$/)
-        expect(content).to match(%r(^require_relative "/opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/puma_logging/json_formatter"$))
+        expect(content).to match(%r(^require "/opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/puma_logging/json_formatter"$))
       }
     end
   end