newrelic_rpm 8.15.0 → 9.6.0

data/lib/tasks/helpers/newrelicyml.rb

@@ -0,0 +1,144 @@
+# 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
+
+require_relative '../../new_relic/agent/configuration/default_source'
+
+module NewRelicYML
+  CRITICAL = [:'agent_enabled', :'app_name', :'license_key', :'log_level']
+  DEFAULTS = NewRelic::Agent::Configuration::DEFAULTS
+  # Skip because not configurable via yml
+  SKIP = [:'defer_rails_initialization']
+  # Don't evaluate Procs, instead use set values
+  PROCS = {:'config_path' => 'newrelic.yml',
+           :'process_host.display_name' => 'default hostname',
+           :'transaction_tracer.transaction_threshold' => 1.0}
+
+  HEADER = <<~HEADER
+    #
+    # This file configures the New Relic Agent.  New Relic monitors Ruby, Java,
+    # .NET, PHP, Python, Node, and Go applications with deep visibility and low
+    # overhead.  For more information, visit www.newrelic.com.
+
+    # Generated <%= Time.now.strftime('%B %d, %Y') %><%= ", for version \#{@agent_version}" if @agent_version %>
+    #<%= "\\n# \#{generated_for_user}\\n#" if generated_for_user %>
+    # For full documentation of agent configuration options, please refer to
+    # https://docs.newrelic.com/docs/agents/ruby-agent/installation-configuration/ruby-agent-configuration
+
+    common: &default_settings
+      # Required license key associated with your New Relic account.
+      license_key: <%= license_key %>
+
+      # Your application name. Renaming here affects where data displays in New
+      # Relic. For more details, see https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/renaming-applications
+      app_name: <%= app_name %>
+
+      # To disable the agent regardless of other settings, uncomment the following:
+      # agent_enabled: false
+
+      # Logging level for log/newrelic_agent.log; options are error, warn, info, or
+      # debug.
+      log_level: info
+
+      # All of the following configuration options are optional. Review them, and
+      # uncomment or edit them if they appear relevant to your application needs.
+
+  HEADER
+
+  FOOTER = <<~FOOTER
+    # Environment-specific settings are in this section.
+    # RAILS_ENV or RACK_ENV (as appropriate) is used to determine the environment.
+    # If your application has other named environments, configure them here.
+    development:
+      <<: *default_settings
+      app_name: <%= app_name %> (Development)
+
+    test:
+      <<: *default_settings
+      # It doesn't make sense to report to New Relic from automated test runs.
+      monitor_mode: false
+
+    staging:
+      <<: *default_settings
+      app_name: <%= app_name %> (Staging)
+
+    production:
+      <<: *default_settings
+  FOOTER
+
+  def self.get_configs(defaults)
+    defaults.sort.each_with_object({}) do |(key, value), final_configs|
+      next if CRITICAL.include?(key) || SKIP.include?(key)
+
+      next unless public_config?(value) && !deprecated?(value)
+
+      sanitized_description = sanitize_description(value[:description])
+      description = format_description(sanitized_description)
+      default = default_value(key, value)
+      final_configs[key] = {description: description, default: default}
+    end
+  end
+
+  def self.public_config?(value)
+    value[:public] == true
+  end
+
+  def self.deprecated?(value)
+    value[:deprecated] == true
+  end
+
+  def self.sanitize_description(description)
+    # remove callouts
+    description = description.split("\n").reject { |line| line.match?('</?Callout') }.join("\n")
+    # remove InlinePopover, keep the text inside type
+    description.gsub!(/<InlinePopover type="(.*)" \/>/, '\1')
+    # remove hyperlinks
+    description.gsub!(/\[([^\]]+)\]\([^\)]+\)/, '\1')
+    # remove single pairs of backticks
+    description.gsub!(/`([^`]+)`/, '\1')
+    # removed href links
+    description.gsub!(/<a href="(.*)">(.*)<\/a>/, '\2')
+
+    description
+  end
+
+  def self.format_description(description)
+    # remove leading and trailing whitespace
+    description.strip!
+    # wrap text after 80 characters
+    description.gsub!(/(.{1,80})(\s+|\Z)/, "\\1\n")
+    # add hashtags to lines
+    description = description.split("\n").map { |line| "  # #{line}" }.join("\n")
+
+    description
+  end
+
+  def self.default_value(key, config_hash)
+    if PROCS.include?(key)
+      PROCS[key]
+    else
+      default = config_hash[:documentation_default].nil? ? config_hash[:default] : config_hash[:documentation_default]
+      default = 'nil' if default.nil?
+      default = '""' if default == ''
+
+      default
+    end
+  end
+
+  def self.build_string(defaults)
+    configs = get_configs(defaults)
+    yml_string = ''
+
+    configs.each do |key, value|
+      yml_string += "#{value[:description]}\n  # #{key}: #{value[:default]}\n\n"
+    end
+
+    yml_string
+  end
+
+  # :nocov:
+  def self.write_file(defaults = DEFAULTS)
+    File.write('newrelic.yml', HEADER + build_string(defaults) + FOOTER)
+  end
+  # :nocov:
+end

data/lib/tasks/helpers/version_bump.rb

@@ -0,0 +1,62 @@
+# 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
+
+module VersionBump
+  MAJOR = 0
+  MINOR = 1
+  TINY = 2
+  VERSION = {major: MAJOR, minor: MINOR, tiny: TINY}
+
+  # Updates version.rb with new version number
+  def self.update_version
+    bump_type = determine_bump_type
+    file = read_file('lib/new_relic/version.rb')
+    new_version = {}
+
+    VERSION.each do |key, current|
+      file.gsub!(/(#{key.to_s.upcase} = )(\d+)/) do
+        match = Regexp.last_match
+
+        new_version[key] = if bump_type == current # bump type, increase by 1
+          match[2].to_i + 1
+        elsif bump_type < current # right of bump type, goes to 0
+          0
+        else # left of bump type, stays the same
+          match[2].to_i
+        end
+
+        match[1] + new_version[key].to_s
+      end
+    end
+
+    write_file('lib/new_relic/version.rb', file)
+    new_version.values.join('.')
+  end
+
+  def self.read_file(path)
+    File.read(File.expand_path(path))
+  end
+
+  def self.write_file(path, file)
+    File.write(File.expand_path(path), file)
+  end
+
+  # Determined version based on if changelog has a feature or not for version
+  def self.determine_bump_type
+    file = read_file('CHANGELOG.md')
+    lines = file.split('## ')[1].split('- **')
+    return MAJOR if lines.first.include?('Major version')
+    return MINOR if lines.any? { |line| line.include?('Feature:') }
+
+    TINY
+  end
+
+  # Replace dev with version number in changelog
+  def self.update_changelog(version)
+    file = read_file('CHANGELOG.md')
+    file.gsub!('## dev', "## v#{version}")
+    file.gsub!('Version <dev>', "Version #{version}")
+    write_file('CHANGELOG.md', file)
+  end
+end

data/lib/tasks/install.rake

@@ -3,13 +3,13 @@
 # frozen_string_literal: true
 
 namespace :newrelic do
-  desc "Install a default config/newrelic.yml file"
+  desc 'Install a default config/newrelic.yml file'
   task :install do
-    load File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "install.rb"))
+    load File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'install.rb'))
   end
 
-  desc "Gratefulness is always appreciated"
+  desc 'Gratefulness is always appreciated'
   task :thanks do
-    puts "The Ruby agent team is grateful to Jim Weirich for his kindness and his code. He will be missed."
+    puts 'The Ruby agent team is grateful to Jim Weirich for his kindness and his code. He will be missed.'
   end
 end

data/lib/tasks/instrumentation_generator/instrumentation.thor

@@ -14,7 +14,7 @@ class Instrumentation < Thor
   NEWRELIC_YML_LOCATION = 'newrelic.yml'
 
   desc('scaffold NAME', 'Scaffold the required files for adding new instrumentation')
-  long_desc <<-LONGDESC
+  long_desc <<~LONGDESC
     `instrumentation scaffold` requires one parameter by default: the name of the
     library or class you are instrumenting. This task generates the basic
     file structure needed to add new instrumentation to the Ruby agent.
@@ -82,7 +82,7 @@ class Instrumentation < Thor
     insert_into_file(
       DEFAULT_SOURCE_LOCATION,
       config_block(name.downcase),
-      after: ":description => 'Controls auto-instrumentation of bunny at start up.  May be one of [auto|prepend|chain|disabled].'
+      after: ":description => 'Controls auto-instrumentation of bunny at start-up.  May be one of [auto|prepend|chain|disabled].'
         },\n"
     )
   end
@@ -96,28 +96,25 @@ class Instrumentation < Thor
   end
 
   def config_block(name)
-    <<-CONFIG
-        :'instrumentation.#{name.downcase}' => {
-          :default => 'auto',
-          :public => true,
-          :type => String,
-          :dynamic_name => true,
-          :allowed_from_server => false,
-          :description => 'Controls auto-instrumentation of the #{name} library at start up. May be one of [auto|prepend|chain|disabled].'
-        },
+    <<~CONFIG
+      :'instrumentation.#{name.downcase}' => {
+        :default => 'auto',
+        :public => true,
+        :type => String,
+        :dynamic_name => true,
+        :allowed_from_server => false,
+        :description => 'Controls auto-instrumentation of the #{name} library at start-up. May be one of [auto|prepend|chain|disabled].'
+      },
     CONFIG
   end
 
-  # TODO: OLD RUBIES - RUBY_VERSION 2.2
-  # When we only support 2.3+ this can be changed to a sqiggle heredoc (<<~)
-  # and use standard indentation
   def yaml_block(name)
-<<HEREDOC # rubocop:disable Layout/IndentationWidth
+    <<~HEREDOC
 
-  # Controls auto-instrumentation of #{name} at start up.
-  # May be one of [auto|prepend|chain|disabled]
-  # instrumentation.#{name.downcase}: auto
-HEREDOC
+      # Controls auto-instrumentation of #{name} at start-up.
+      # May be one of [auto|prepend|chain|disabled]
+      # instrumentation.#{name.downcase}: auto
+    HEREDOC
   end
 end
 

data/lib/tasks/instrumentation_generator/templates/Envfile.tt

@@ -4,6 +4,6 @@
 
 instrumentation_methods :chain, :prepend
 
-gemfile <<-RB
+gemfile <<~RB
   gem '<%= @name.downcase %>'
 RB

data/lib/tasks/instrumentation_generator/templates/chain.tt

@@ -3,7 +3,7 @@
 # frozen_string_literal: true
 
 module NewRelic::Agent::Instrumentation
-  module <%= @class_name %>
+  module <%= @class_name %>::Chain
     def self.instrument!
       ::<%= @class_name %>.class_eval do
         include NewRelic::Agent::Instrumentation::<%= @class_name %>

data/lib/tasks/instrumentation_generator/templates/dependency_detection.tt

@@ -23,7 +23,7 @@ DependencyDetection.defer do
     if use_prepend?
       prepend_instrument ::<%= @class_name %>, NewRelic::Agent::Instrumentation::<%= @class_name %>::Prepend
     else
-      chain_instrument NewRelic::Agent::Instrumentation::<%= @class_name %>
+      chain_instrument NewRelic::Agent::Instrumentation::<%= @class_name %>::Chain
     end
   end
 end

data/lib/tasks/newrelic.rb

@@ -1,6 +1,7 @@
 # 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
+
 #
 # If you are looking to instrument rake tasks in a Rails environment, but the
 # task doesn't depend on :environment, this task may be included to ensure that

data/lib/tasks/newrelicyml.rake

@@ -0,0 +1,13 @@
+# 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
+
+require_relative 'helpers/newrelicyml'
+
+namespace :newrelic do
+  desc 'Update newrelic.yml with latest config options from default_source.rb'
+  task :update_newrelicyml do
+    NewRelicYML.write_file
+    puts 'newrelic.yml updated'
+  end
+end

data/lib/tasks/tests.rake

@@ -11,21 +11,92 @@ rescue LoadError
 end
 
 if defined? Rake::TestTask
+  def name_for_number(content, number)
+    (number - 1).downto(0).each do |i|
+      return Regexp.last_match(1) if content[i] =~ /^\s*def (test_.+)\s*$/
+    end
+  end
+
+  def info_from_test_var
+    return {} unless ENV['TEST'].to_s =~ /^(.+)((?::\d+)+)/
+
+    file = Regexp.last_match(1)
+    numbers = Regexp.last_match(2).split(':').reject(&:empty?).uniq.map(&:to_i)
+    abs = File.expand_path(File.join('../../..', file), __FILE__)
+    raise "File >>#{abs}<< does not exist!" unless File.exist?(abs)
+
+    content = File.read(abs).split("\n")
+    {file: file, numbers: numbers, content: content}
+  end
+
+  def test_names_from_test_file(info)
+    info[:numbers].each_with_object([]) do |number, names|
+      name = name_for_number(info[:content], number)
+      unless name
+        warn "Unable to determine a test name given line >>#{number}<< for file >>#{info[:file]}<<"
+        next
+      end
+      names << name
+    end
+  end
+
+  # Allow ENV['TEST'] to be set to a test file path with one or more
+  # `:<line number>` patterns on the end of it.
+  #
+  # For example:
+  #   TEST=test/new_relic/agent/autostart_test.rb:57 bundle exec rake test
+  #
+  # The `autostart_test.rb` file will be read, and starting from line 57 and
+  # working upwards in the file (downwards by line number), a test definition
+  # will be searched for that matches `def test_<rest of the test name>`.
+  #
+  # Multiple line numbers can be specified like so:
+  #   TEST=test/new_relic/agent/autostart_test.rb:57:26 bundle exec rake test
+  #
+  # For this multiple line number based example, both lines 57 and 26 will
+  # serve as separate starting points for the search for a test name.
+  #
+  # All test names that are discovered will be "ORed" into a regex pattern with
+  # pipes ('|') that is passed to Minitest via
+  #   `TESTOPTS="--name='test_name1|test_name2'"`
+  #
+  # Once a line with one or more `:<line number>` values on the end of it has
+  # been found, replace the value of ENV['TEST'] with the path leading up to
+  # the first colon before invoking Minitest.
+  #
+  # Why refer to a test by line number instead of just supplying the name
+  # directly? The primary use case is text editor integration. A text editor
+  # can be taught to "run the single unit test containing the line the cursor is
+  # on" by building a string containing the path to the file, a colon, (':'),
+  # and the line number.
+  def process_line_numbers
+    info = info_from_test_var
+    return unless info.key?(:file)
+
+    test_names = test_names_from_test_file(info)
+    raise "Could not determine any test names for file >>#{abs}<< given numbers >>#{numbers}" if test_names.empty?
+
+    ENV['TESTOPTS'] = "#{ENV['TESTOPTS']} --name='#{test_names.map { |n| Regexp.escape(n) }.join('|')}'"
+    ENV['TEST'] = info[:file]
+  end
+
   namespace :test do
     tasks = Rake.application.top_level_tasks
-    ENV["TESTOPTS"] ||= ""
-    if tasks.any? { |t| t.include?("verbose") }
-      ENV["TESTOPTS"] += " -v"
+    ENV['TESTOPTS'] ||= ''
+    if tasks.any? { |t| t.include?('verbose') }
+      ENV['TESTOPTS'] += ' -v'
     end
     if seed = look_for_seed(tasks)
-      ENV["TESTOPTS"] += " --" + seed
+      ENV['TESTOPTS'] += ' --' + seed
     end
 
+    process_line_numbers
+
     agent_home = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
 
     Rake::TestTask.new(:newrelic) do |t|
-      file_pattern = ENV["file"]
-      file_pattern = file_pattern.split(",").map { |f| "#{agent_home}/#{f}".gsub("//", "/") } if file_pattern
+      file_pattern = ENV['file']
+      file_pattern = file_pattern.split(',').map { |f| "#{agent_home}/#{f}".gsub('//', '/') } if file_pattern
       file_pattern ||= "#{agent_home}/test/new_relic/**/*_test.rb"
 
       t.libs << "#{agent_home}/test"