Rails v7.1 driven 'rails' suite updates

Update the multiverse 'rails' suite for Rails v7.1 compatibility
newrelic · Oct 10, 2023 · 824ef52 · 824ef52
1 parent 4c4cfd0
commit 824ef52
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 7 deletions.
diff --git a/lib/new_relic/control/frameworks/rails.rb b/lib/new_relic/control/frameworks/rails.rb
@@ -10,6 +10,9 @@ module Frameworks
       # Rails specific configuration, instrumentation, environment values,
       # etc.
       class Rails < NewRelic::Control::Frameworks::Ruby
+        INSTALLED_SINGLETON = NewRelic::Agent.config
+        INSTALLED = :@browser_monitoring_installed
+
         def env
           @env ||= (ENV['NEW_RELIC_ENV'] || RAILS_ENV.dup)
         end
@@ -97,9 +100,9 @@ def install_agent_hooks(config)
 
         def install_browser_monitoring(config)
           @install_lock.synchronize do
-            return if defined?(@browser_monitoring_installed) && @browser_monitoring_installed
+            return if browser_agent_already_installed?
 
-            @browser_monitoring_installed = true
+            mark_browser_agent_as_installed
             return if config.nil? || !config.respond_to?(:middleware) || !Agent.config[:'browser_monitoring.auto_instrument']
 
             begin
@@ -112,6 +115,15 @@ def install_browser_monitoring(config)
           end
         end
 
+        def browser_agent_already_installed?
+          INSTALLED_SINGLETON.instance_variable_defined?(INSTALLED) &&
+            INSTALLED_SINGLETON.instance_variable_get(INSTALLED)
+        end
+
+        def mark_browser_agent_as_installed
+          INSTALLED_SINGLETON.instance_variable_set(INSTALLED, true)
+        end
+
         def rails_version
           @rails_version ||= Gem::Version.new(::Rails::VERSION::STRING)
         end

diff --git a/test/multiverse/suites/rails/action_cable_test.rb b/test/multiverse/suites/rails/action_cable_test.rb
@@ -25,6 +25,14 @@ def initialize
         @logger = Logger.new(StringIO.new)
       end
 
+      # In Rails itself, `#config` is delegated via a stub.
+      # See https://github.com/rails/rails/commit/8fff6d609cec2d20972235d3c2cf7d004e2d6983
+      # But seeing as that stub is not distributed in the ActionCable gem, we
+      # use this workaround.
+      def config
+        Rails.application.config
+      end
+
       def transmit(data)
         @transmissions << data
       end

diff --git a/test/multiverse/suites/rails/action_controller_live_rum_test.rb b/test/multiverse/suites/rails/action_controller_live_rum_test.rb
@@ -5,7 +5,6 @@
 require './app'
 
 if defined?(ActionController::Live)
-
   class UndeadController < ApplicationController
     RESPONSE_BODY = '<html><head></head><body>Brains!</body></html>'
 
@@ -44,6 +43,7 @@ def test_excludes_rum_instrumentation_when_streaming_with_action_controller_live
     def test_excludes_rum_instrumentation_when_streaming_with_action_stream_true
       get('/undead/brain_stream', env: {'HTTP_VERSION' => 'HTTP/1.1'})
 
+      assert_predicate(response, :ok?, 'Expected ActionController streaming response to be OK')
       assert_includes(response.body, UndeadController::RESPONSE_BODY)
       assert_not_includes(response.body, JS_LOADER)
     end

diff --git a/test/multiverse/suites/rails/activejob_test.rb b/test/multiverse/suites/rails/activejob_test.rb
@@ -98,7 +98,17 @@ def test_code_information_recorded_with_new_transaction
                     namespace: 'MyJob'}
         segment = MiniTest::Mock.new
         segment.expect(:code_information=, nil, [expected])
-        segment.expect(:finish, [])
+        segment.expect(:code_information=,
+          nil,
+          [{transaction_name: 'OtherTransaction/ActiveJob::Inline/MyJob/execute'}])
+        (NewRelic::Agent::Instrumentation::ActiveJobSubscriber::PAYLOAD_KEYS.size + 1).times do
+          segment.expect(:params, {}, [])
+        end
+        3.times do
+          segment.expect(:finish, [])
+        end
+        segment.expect(:record_scoped_metric=, nil, [false])
+        segment.expect(:notice_error, nil, [])
         NewRelic::Agent::Tracer.stub(:start_segment, segment) do
           MyJob.perform_later
         end

diff --git a/test/multiverse/suites/rails/rails3_app/app_rails3_plus.rb b/test/multiverse/suites/rails/rails3_app/app_rails3_plus.rb
@@ -11,7 +11,6 @@
 # Tests should feel free to define their own Controllers locally, but if they
 # need anything special at the Application level, put it here
 if !defined?(MyApp)
-
   ENV['NEW_RELIC_DISPATCHER'] = 'test'
 
   class NamedMiddleware

diff --git a/test/multiverse/suites/rails/view_instrumentation_test.rb b/test/multiverse/suites/rails/view_instrumentation_test.rb
@@ -98,11 +98,11 @@ class ViewInstrumentationTest < ActionDispatch::IntegrationTest
     end
   end
 
-  (ViewsController.action_methods - %w[raise_render collection_render haml_render]).each do |method|
+  (ViewsController.action_methods - %w[raise_render collection_render haml_render proc_render]).each do |method|
     define_method("test_sanity_#{method}") do
       get "/views/#{method}"
 
-      assert_equal 200, status
+      assert_equal 200, status, "Expected 200, got #{status} for /views/#{method}"
     end
 
     def test_should_allow_uncaught_exception_to_propagate