Merge pull request #2256 from broadinstitute/jb-sentry-ruby

Updating to sentry-ruby gem for error reporting (SCP-5260)

Author: bistline

Gemfile

@@ -65,7 +65,8 @@ gem 'ruby_native_statistics'
 gem 'mongoid_rails_migrations'
 gem 'secure_headers'
 gem 'swagger-blocks'
-gem 'sentry-raven'
+gem 'sentry-ruby'
+gem "sentry-rails"
 gem 'rubyzip'
 gem 'rack-brotli'
 gem 'time_difference'

Gemfile.lock

@@ -479,8 +479,12 @@ GEM
     sdoc (2.1.0)
       rdoc (>= 5.0)
     secure_headers (6.3.2)
-    sentry-raven (3.1.2)
-      faraday (>= 1.0)
+    sentry-rails (5.23.0)
+      railties (>= 5.0)
+      sentry-ruby (~> 5.23.0)
+    sentry-ruby (5.23.0)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
     signet (0.17.0)
       addressable (~> 2.8)
       faraday (>= 0.17.5, < 3.a)
@@ -626,7 +630,8 @@ DEPENDENCIES
   sass-rails (>= 6)
   sdoc
   secure_headers
-  sentry-raven
+  sentry-rails
+  sentry-ruby
   simplecov
   simplecov-lcov
   stackprof

app/controllers/api/v1/search_controller.rb

@@ -170,7 +170,7 @@ class SearchController < ApiBaseController
 
       def index
         @viewable = Study.viewable(current_api_user)
-        @search_type = params[:type].to_sym
+        @search_type = params[:type]&.to_sym || :study # handle empty type
 
         # filter results by branding group, if specified
         if @selected_branding_group.present?

config/initializers/sentry.rb

@@ -0,0 +1,6 @@
+Sentry.init do |config|
+  config.dsn = ENV['SENTRY_DSN']
+  # Add data like request headers and IP for users, if applicable;
+  # see https://docs.sentry.io/platforms/ruby/data-management/data-collected/ for more info
+  config.send_default_pii = true
+end

lib/error_tracker.rb

@@ -7,7 +7,7 @@ def self.report_exception(exception, user, *context_objects)
     if %w(development test).include?(Rails.env) || ENV['SENTRY_DSN'].nil?
       Rails.logger.error "Suppressing error reporting to Sentry: #{exception.class.name}:#{exception.message}, context: #{context}"
     else
-      Raven.capture_exception(exception, user: {identifer: extract_user_identifier(user)}, extra: context)
+      Sentry.capture_exception(exception, user: {identifer: extract_user_identifier(user)}, extra: context)
     end
   end
 

test/lib/summary_stats_utils_test.rb

@@ -168,7 +168,7 @@ class SummaryStatsUtilsTest < ActiveSupport::TestCase
     end
     file_mock.expect :any?, true
     bucket_mock.expect :files, file_mock
-    client_mock.expect :get_workspace_bucket, bucket_mock, [@study.bucket_id]
+    client_mock.expect :get_workspace_bucket, bucket_mock, [String]
     FireCloudClient.stub :new, client_mock do
       SummaryStatsUtils.stub :bytes_and_last_created_for,
                              [250.gigabytes, created_at],

test/services/study_search_service_test.rb

@@ -18,7 +18,7 @@ class StudySearchServiceTest < ActiveSupport::TestCase
                                            name: 'cell_type',
                                            type: 'group',
                                            values: [
-                                             'B cell', 'amacrine cell', 'retinal cone cell'
+                                             'B cell', 'amacrine cell', 'retinal cone cell', 'bipolar neuron'
                                            ]
                                          }
                                        ])