newrelic · fallwith · Oct 11, 2023 · Oct 10, 2023 · Oct 10, 2023 · Oct 10, 2023
@@ -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

@@ -3,6 +3,7 @@
 # frozen_string_literal: true
 
 RAILS_VERSIONS = [
+  ["github: 'rails'", 3.0], # Rails Edge
   [nil, 2.7],
   ['7.0.4', 2.7],
   ['6.1.7', 2.5],

@@ -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

@@ -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

@@ -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

@@ -0,0 +1,23 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+# These are hacks to make the 'rails' multiverse test suite compatible with
+# Rails v7.1 released on 2023-10-05.
+#
+# TODO: refactor these out with non-hack replacements as time permits
+
+if Gem::Version.new(Rails.version) >= Gem::Version.new('7.1.0')
+  # NoMethodError (undefined method `to_ary' for an instance of ActionController::Streaming::Body):
+  # actionpack (7.1.0) lib/action_dispatch/http/response.rb:107:in `to_ary'
+  # actionpack (7.1.0) lib/action_dispatch/http/response.rb:509:in `to_ary'
+  # rack (3.0.8) lib/rack/body_proxy.rb:41:in `method_missing'
+  # rack (3.0.8) lib/rack/etag.rb:32:in `call'
+  # newrelic-ruby-agent/lib/new_relic/agent/instrumentation/middleware_tracing.rb:99:in `call'
+  require 'action_controller/railtie'
+  class ActionController::Streaming::Body
+    def to_ary
+      self
+    end
+  end
+end
@@ -4,125 +4,9 @@
 
 require 'action_controller/railtie'
 require 'active_model'
-require 'rails/test_help'
 require 'filtering_test_app'
-
-# We define our single Rails application here, one time, upon the first inclusion
-# 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
-    def initialize(app, options = {})
-      @app = app
-    end
-
-    def call(env)
-      status, headers, body = @app.call(env)
-      headers['NamedMiddleware'] = '1'
-      [status, headers, body]
-    end
-  end
-
-  class InstanceMiddleware
-    attr_reader :name
-
-    def initialize
-      @app = nil
-      @name = 'InstanceMiddleware'
-    end
-
-    def new(app)
-      @app = app
-      self
-    end
-
-    def call(env)
-      status, headers, body = @app.call(env)
-      headers['InstanceMiddleware'] = '1'
-      [status, headers, body]
-    end
-  end
-
-  if defined?(Sinatra)
-    module Sinatra
-      class Application < Base
-        # Override to not accidentally start the app in at_exit handler
-        set :run, proc { false }
-      end
-    end
-
-    class SinatraTestApp < Sinatra::Base
-      get '/' do
-        raise 'Intentional error' if params['raise']
-
-        'SinatraTestApp#index'
-      end
-    end
-  end
-
-  class MyApp < Rails::Application
-    # We need a secret token for session, cookies, etc.
-    config.active_support.deprecation = :log
-    config.secret_token = '49837489qkuweoiuoqwehisuakshdjksadhaisdy78o34y138974xyqp9rmye8yrpiokeuioqwzyoiuxftoyqiuxrhm3iou1hrzmjk'
-    config.eager_load = false
-    config.filter_parameters += [:secret]
-    config.secret_key_base = fake_guid(64)
-    if Rails::VERSION::STRING >= '7.0.0'
-      config.action_controller.default_protect_from_forgery = true
-    end
-    if config.respond_to?(:hosts)
-      config.hosts << 'www.example.com'
-    end
-    initializer 'install_error_middleware' do
-      config.middleware.use(ErrorMiddleware)
-    end
-    initializer 'install_middleware_by_name' do
-      config.middleware.use(NamedMiddleware)
-    end
-    initializer 'install_middleware_instance' do
-      config.middleware.use(InstanceMiddleware.new)
-    end
-  end
-  MyApp.initialize!
-
-  MyApp.routes.draw do
-    get('/bad_route' => 'test#controller_error',
-      :constraints => lambda do |_|
-        raise ActionController::RoutingError.new('this is an uncaught routing error')
-      end)
-
-    mount SinatraTestApp, :at => '/sinatra_app' if defined?(Sinatra)
-
-    post '/filtering_test' => FilteringTestApp.new
-
-    post '/parameter_capture', :to => 'parameter_capture#create'
-
-    get '/:controller(/:action(/:id))'
-  end
-
-  class ApplicationController < ActionController::Base
-    if Rails::VERSION::STRING.to_i >= 7
-      # forgery protection explicitly prevents application/javascript content types
-      # as originating from the same origin
-      # this allows view_instrumentation_test to pass
-      skip_before_action :verify_authenticity_token, only: :js_render
-    end
-
-    # The :text option to render was deprecated in Rails 4.1 in favor of :body.
-    # With the patch below we can write our tests using render :body but have
-    # that converted to render :text for Rails versions that do not support
-    # render :body.
-    if Rails::VERSION::STRING < '4.1.0'
-      def render(*args)
-        options = args.first
-        if Hash === options && options.key?(:body)
-          options[:text] = options.delete(:body)
-        end
-        super
-      end
-    end
-  end
-end
+# NOTE: my_app should be brought in before rails/test_help,
+#       but after filtering_test_app. This is because logic to maintain
+#       the test db schema will expect a Rails app to be in play.
+require_relative 'my_app'
+require 'rails/test_help'
@@ -0,0 +1,122 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+# We define our single Rails application here, one time, upon the first inclusion
+# 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
+    def initialize(app, options = {})
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      headers['NamedMiddleware'] = '1'
+      [status, headers, body]
+    end
+  end
+
+  class InstanceMiddleware
+    attr_reader :name
+
+    def initialize
+      @app = nil
+      @name = 'InstanceMiddleware'
+    end
+
+    def new(app)
+      @app = app
+      self
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      headers['InstanceMiddleware'] = '1'
+      [status, headers, body]
+    end
+  end
+
+  if defined?(Sinatra)
+    module Sinatra
+      class Application < Base
+        # Override to not accidentally start the app in at_exit handler
+        set :run, proc { false }
+      end
+    end
+
+    class SinatraTestApp < Sinatra::Base
+      get '/' do
+        raise 'Intentional error' if params['raise']
+
+        'SinatraTestApp#index'
+      end
+    end
+  end
+
+  class MyApp < Rails::Application
+    # We need a secret token for session, cookies, etc.
+    config.active_support.deprecation = :log
+    config.secret_token = '49837489qkuweoiuoqwehisuakshdjksadhaisdy78o34y138974xyqp9rmye8yrpiokeuioqwzyoiuxftoyqiuxrhm3iou1hrzmjk'
+    config.eager_load = false
+    config.filter_parameters += [:secret]
+    config.secret_key_base = fake_guid(64)
+    if Rails::VERSION::STRING >= '7.0.0'
+      config.action_controller.default_protect_from_forgery = true
+    end
+    if config.respond_to?(:hosts)
+      config.hosts << 'www.example.com'
+    end
+    initializer 'install_error_middleware' do
+      config.middleware.use(ErrorMiddleware)
+    end
+    initializer 'install_middleware_by_name' do
+      config.middleware.use(NamedMiddleware)
+    end
+    initializer 'install_middleware_instance' do
+      config.middleware.use(InstanceMiddleware.new)
+    end
+  end
+  MyApp.initialize!
+
+  MyApp.routes.draw do
+    get('/bad_route' => 'test#controller_error',
+      :constraints => lambda do |_|
+        raise ActionController::RoutingError.new('this is an uncaught routing error')
+      end)
+
+    mount SinatraTestApp, :at => '/sinatra_app' if defined?(Sinatra)
+
+    post '/filtering_test' => FilteringTestApp.new
+
+    post '/parameter_capture', :to => 'parameter_capture#create'
+
+    get '/:controller(/:action(/:id))'
+  end
+
+  class ApplicationController < ActionController::Base
+    if Rails::VERSION::STRING.to_i >= 7
+      # forgery protection explicitly prevents application/javascript content types
+      # as originating from the same origin
+      # this allows view_instrumentation_test to pass
+      skip_before_action :verify_authenticity_token, only: :js_render
+    end
+
+    # The :text option to render was deprecated in Rails 4.1 in favor of :body.
+    # With the patch below we can write our tests using render :body but have
+    # that converted to render :text for Rails versions that do not support
+    # render :body.
+    if Rails::VERSION::STRING < '4.1.0'
+      def render(*args)
+        options = args.first
+        if Hash === options && options.key?(:body)
+          options[:text] = options.delete(:body)
+        end
+        super
+      end
+    end
+  end
+end
@@ -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