appsignal 3.9.2 → 3.9.3

data/.rubocop.yml

@@ -51,6 +51,20 @@ Style/Lambda:
 Style/WordArray:
   Enabled: false
 
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  Exclude:
+    - "spec/**/*.rb"
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/RedundantConstantBase:
+  Enabled: false
+
 Lint/ConstantDefinitionInBlock:
   Exclude:
     - "spec/**/*.rb"
@@ -59,6 +73,10 @@ Lint/EmptyClass:
   Exclude:
     - "spec/**/*.rb"
 
+Lint/EmptyFile:
+  Exclude:
+    - "spec/**/*.rb"
+
 Layout/HashAlignment:
   EnforcedLastArgumentHashStyle: ignore_implicit
 
@@ -83,20 +101,27 @@ Layout/MultilineMethodCallIndentation:
 Layout/MultilineOperationIndentation:
   EnforcedStyle: indented
 
-Lint/EmptyFile:
-  Exclude:
-    - "spec/**/*.rb"
+Layout/LineLength:
+  Max: 100
 
 Naming/FileName:
   Exclude:
     - "ext/Rakefile"
 
+Naming/AccessorMethodName:
+  Exclude:
+    - "lib/appsignal/helpers/instrumentation.rb"
+    - "lib/appsignal/transaction.rb"
+
 Naming/RescuedExceptionsVariableName:
   Enabled: false
 
 Naming/VariableNumber:
   Enabled: false
 
+Metrics/ModuleLength:
+  Enabled: false
+
 Metrics/ClassLength:
   Enabled: false
 
@@ -104,22 +129,5 @@ Metrics/BlockLength:
   Exclude:
     - "Rakefile"
 
-Style/FrozenStringLiteralComment:
-  Enabled: true
-  Exclude:
-    - "spec/**/*.rb"
-
-Style/NumericPredicate:
-  Enabled: false
-
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-Style/RedundantConstantBase:
-  Enabled: false
-
 Gemspec/DevelopmentDependencies:
   Enabled: false
-
-Layout/LineLength:
-  Max: 100

data/.rubocop_todo.yml

@@ -1,66 +1,49 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-04-12 14:23:03 UTC using RuboCop version 1.50.0.
+# on 2024-06-27 09:42:06 UTC using RuboCop version 1.64.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
-# URISchemes: http, https
-Layout/LineLength:
-  Max: 112
-
 # Offense count: 2
+# Configuration parameters: AllowedParentClasses.
 Lint/MissingSuper:
   Exclude:
     - 'lib/appsignal/extension.rb'
     - 'lib/appsignal/logger.rb'
 
-# Offense count: 1
-Lint/NoReturnInBeginEndBlocks:
-  Exclude:
-    - 'lib/appsignal/environment.rb'
-
 # Offense count: 1
 Lint/StructNewOverride:
   Exclude:
     - 'spec/lib/appsignal/probes/sidekiq_spec.rb'
 
-# Offense count: 53
+# Offense count: 63
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 44
 
-# Offense count: 5
+# Offense count: 6
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
   Max: 31
 
-# Offense count: 17
+# Offense count: 21
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
   Max: 11
 
-# Offense count: 127
+# Offense count: 139
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 56
 
-# Offense count: 12
+# Offense count: 18
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
   Max: 13
 
-# Offense count: 7
-Naming/AccessorMethodName:
-  Exclude:
-    - 'lib/appsignal/helpers/instrumentation.rb'
-    - 'lib/appsignal/transaction.rb'
-
 # Offense count: 2
 Security/Open:
   Exclude:
@@ -82,15 +65,6 @@ Style/Alias:
     - 'lib/appsignal/helpers/instrumentation.rb'
     - 'lib/appsignal/transaction.rb'
 
-# Offense count: 2
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: nested, compact
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'lib/appsignal/integrations/hanami.rb'
-    - 'lib/appsignal/integrations/padrino.rb'
-
 # Offense count: 1
 Style/ClassVars:
   Exclude:

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.9.3
+
+_Published on 2024-07-02._
+
+### Added
+
+- [0230ab4d](https://github.com/appsignal/appsignal-ruby/commit/0230ab4da00d75e4fc72fd493fc98441b5d7254d) patch - Track error response status for web requests. When an unhandled exception reaches the AppSignal EventHandler instrumentation, report the response status as `500` for the `response_status` tag on the transaction and on the `response_status` metric.
+
+### Changed
+
+- [b3a80038](https://github.com/appsignal/appsignal-ruby/commit/b3a800380c0d83422d7f3c0e9c93551d343c50c0) patch - Require the AppSignal gem in the Grape integration file. Previously `require "appsignal"` had to be called before `require "appsignal/integrations/grape"`. This `require "appsignal"` is no longer required.
+- [e9aa0603](https://github.com/appsignal/appsignal-ruby/commit/e9aa06031b6c17f9f2704250bb1775a4cb72b276) patch - Report Global VM Lock metrics per process. In addition to the existing `hostname` tag, add `process_name` and `process_id` tags to the `gvl_global_timer` and `gvl_waiting_threads` metrics emitted by the [GVL probe](https://docs.appsignal.com/ruby/integrations/global-vm-lock.html), allowing these metrics to be tracked in a per-process basis.
+
+### Deprecated
+
+- [844aa0af](https://github.com/appsignal/appsignal-ruby/commit/844aa0afa3311860dca84badc27c2be8996bfd3c) patch - Deprecate `Appsignal::Grape::Middleware` constant in favor of `Appsignal::Rack::GrapeMiddleware` constant.
+  
+  To fix this deprecation warning, update the usage of `Appsignal::Grape::Middleware` like this:
+  
+  ```ruby
+  # Grape only apps
+  insert_before Grape::Middleware::Error, Appsignal::Rack::GrapeMiddleware
+  # or
+  use Appsignal::Rack::GrapeMiddleware
+  
+  # Grape on Rails app
+  use Appsignal::Rack::GrapeMiddleware
+  ```
+- [1f648ab4](https://github.com/appsignal/appsignal-ruby/commit/1f648ab4d0372f37d15a980a9902779834811531) patch - Deprecate the `Appsignal.start_logger` method. Remove this method call from apps if it is present. Calling `Appsignal.start` will now initialize the logger.
+
+### Fixed
+
+- [0bb29809](https://github.com/appsignal/appsignal-ruby/commit/0bb29809f1750bdac2b66a1132a3638c58e6d1f8) patch - Fix an issue with invalid request methods raising an error in the GenericInstrumentation middleware when using a request class that throws an error when calling the `request_method` method, like `ActionDispatch::Request`.
+- [66bb7a60](https://github.com/appsignal/appsignal-ruby/commit/66bb7a60cafd3fb1a91d4ed0430d51ee8ac8de46) patch - Support Grape apps that are nested in other apps like Sinatra and Rails, that also include AppSignal middleware for instrumentation.
+- [a7b056bd](https://github.com/appsignal/appsignal-ruby/commit/a7b056bd333912b3b6388d68d6dd3af0b2cb9a75) patch - Support Hanami version 2.1. On older versions of our Ruby gem it would error on an unknown keyword argument "sessions_enabled".
+- [00b7ac6a](https://github.com/appsignal/appsignal-ruby/commit/00b7ac6a9128d47fa9d3a1556f73a14304de8944) patch - Fix issue with AppSignal getting stuck in a boot loop when loading the Hanami integration with: `require "appsignal/integrations/hanami"`
+  This could happen in nested applications, like a Hanami app in a Rails app. It will now use the first config AppSignal starts with.
+
 ## 3.9.2
 
 _Published on 2024-06-26._

data/Rakefile

@@ -20,98 +20,113 @@ VERSION_MANAGERS = {
   }
 }.freeze
 
-def env_map(key, value)
+def build_job(ruby_version, ruby_gem = nil)
   {
-    "name" => key,
-    "value" => value
+    "name" => "Ruby #{ruby_version}#{" - #{ruby_gem}" if ruby_gem}",
+    "needs" => "validation",
+    "runs-on" => "ubuntu-latest",
+    "steps" => [
+      {
+        "name" => "Check out repository",
+        "uses" => "actions/checkout@v4"
+      },
+      {
+        "name" => "Install Ruby",
+        "uses" => "ruby/setup-ruby@v1",
+        "with" => {
+          "ruby-version" => ruby_version,
+          "bundler-cache" => true
+        }
+      },
+      {
+        "name" => "Install gem extension",
+        "run" => "./support/bundler_wrapper exec rake extension:install"
+      },
+      {
+        "name" => "Print extension install report",
+        "run" => "[ -e ext/install.report ] && cat ext/install.report || echo 'No ext/install.report file found'" # rubocop:disable Layout/LineLength
+      },
+      {
+        "name" => "Print Makefile log file",
+        "run" => "[ -f ext/mkmf.log ] && cat ext/mkmf.log || echo 'No ext/mkmf.log file found'"
+      }
+    ]
   }
 end
 
-def build_task(matrix, ruby_version, type = nil)
-  {
-    "name" => "Ruby #{ruby_version}#{type ? " - #{type}" : nil}",
-    "dependencies" => ["Validation"],
-    "task" => {
-      "prologue" => matrix["prologue"].merge(
-        "commands" => matrix["prologue"]["commands"] + [
-          "./support/bundler_wrapper exec rake extension:install",
-          "[ -e ext/install.report ] && cat ext/install.report || echo 'No ext/install.report file found'", # rubocop:disable Metrics/LineLength
-          "[ -f ext/mkmf.log ] && cat ext/mkmf.log || echo 'No ext/mkmf.log file found'"
-        ]
-      ),
-      "epilogue" => matrix["epilogue"],
-      "jobs" => []
-    }
-  }
+def build_matrix_key(ruby_version, ruby_gem = nil)
+  base = "ruby_#{ruby_version}"
+  base = "#{base}__#{ruby_gem}" if ruby_gem
+  base.downcase.gsub(/\W/, "-")
 end
 
 def gems_with_gemfiles
   YAML.load_file("build_matrix.yml")["matrix"]["gems"].map { |g| g["gem"] }.freeze
 end
 
+GITHUB_ACTION_WORKFLOW_FILE = ".github/workflows/ci.yml"
+
 namespace :build_matrix do
-  namespace :semaphore do
+  namespace :github do
     task :generate do
       yaml = YAML.load_file("build_matrix.yml")
       matrix = yaml["matrix"]
-      defaults = matrix["defaults"]
-      semaphore = yaml["semaphore"]
+      github = yaml["github"]
 
-      builds = []
+      builds = {}
       matrix["ruby"].each do |ruby|
         ruby_version = ruby["ruby"]
-        ruby_primary_block = build_task(matrix, ruby_version)
-        ruby_secondary_block = build_task(matrix, ruby_version, "Gems").tap do |t|
-          t["dependencies"] = ["Ruby #{ruby_version}"]
-        end
-        gemset_for_ruby(ruby, matrix).each do |gem|
-          next unless included_for_ruby?(matrix, gem, ruby)
-
-          env = matrix["env_vars"] + [
-            env_map("RUBY_VERSION", ruby_version),
-            env_map("GEMSET", gem["gem"]),
-            env_map("BUNDLE_GEMFILE", "gemfiles/#{gem["gem"]}.gemfile")
-          ]
-          rubygems = gem["rubygems"] || ruby["rubygems"] || defaults["rubygems"]
-          env << env_map("_RUBYGEMS_VERSION", rubygems) if rubygems
-          bundler = gem["bundler"] || ruby["bundler"] || defaults["bundler"]
-          env << env_map("_BUNDLER_VERSION", bundler) if bundler
-
-          job = {
-            "name" => "Ruby #{ruby_version} for #{gem["gem"]}",
-            "env_vars" => env + ruby.fetch("env_vars", []),
-            "commands" => [
-              "./support/bundler_wrapper exec rake test"
-            ]
+        gemset_for_ruby(ruby, matrix).each do |ruby_gem|
+          next unless included_for_ruby?(matrix, ruby_gem, ruby)
+
+          is_primary_job = ruby_gem["gem"] == "no_dependencies"
+          job =
+            if is_primary_job
+              build_job(ruby_version)
+            else
+              build_job(ruby_version, ruby_gem["gem"])
+            end
+          job["env"] = matrix["env"]
+            .merge("BUNDLE_GEMFILE" => "gemfiles/#{ruby_gem["gem"]}.gemfile")
+
+          test_step = {
+            "name" => "Run tests",
+            "run" => "./support/bundler_wrapper exec rake test"
           }
-          if gem["gem"] == "no_dependencies"
+
+          if is_primary_job
+            job["steps"] << test_step
             # Only test the failure scenarios once per Ruby version
-            job["commands"] << "./support/bundler_wrapper exec rake test:failure"
-            ruby_primary_block["task"]["jobs"] << job
+            job["steps"] << {
+              "name" => "Run tests without extension",
+              "run" => "./support/bundler_wrapper exec rake test:failure"
+            }
+            builds[build_matrix_key(ruby["ruby"])] = job
           else
-            ruby_secondary_block["task"]["jobs"] << job
+            job["needs"] = build_matrix_key(ruby["ruby"])
+            job["steps"] << test_step
+            builds[build_matrix_key(ruby["ruby"], ruby_gem["gem"])] = job
           end
         end
-        builds << ruby_primary_block
-        builds << ruby_secondary_block if ruby_secondary_block["task"]["jobs"].count.nonzero?
       end
-      semaphore["blocks"] += builds
+      github["jobs"] = github["jobs"].merge(builds)
 
+      job_count = github["jobs"].count
       header = "# DO NOT EDIT\n" \
-        "# This is a generated file by the `rake build_matrix:semaphore:generate` task.\n" \
+        "# This is a generated file by the `rake build_matrix:github:generate` task.\n" \
         "# See `build_matrix.yml` for the build matrix.\n" \
-        "# Generate this file with `rake build_matrix:semaphore:generate`.\n"
-      generated_yaml = header + YAML.dump(semaphore)
-      File.write(".semaphore/semaphore.yml", generated_yaml)
-      puts "Generated `.semaphore/semaphore.yml`"
-      puts "Task count: #{builds.length}"
-      puts "Job count: #{builds.sum { |block| block["task"]["jobs"].count }}"
+        "# Generate this file with `rake build_matrix:github:generate`.\n" \
+        "# Generated job count: #{job_count}\n"
+      generated_yaml = header + YAML.dump(github)
+      File.write(GITHUB_ACTION_WORKFLOW_FILE, generated_yaml)
+      puts "Generated `#{GITHUB_ACTION_WORKFLOW_FILE}`"
+      puts "Job count: #{job_count}"
     end
 
     task :validate => :generate do
       output = `git status`
-      if output.include? ".semaphore/semaphore.yml"
-        puts "The `.semaphore/semaphore.yml` is modified. The changes were not committed."
+      if output.include? GITHUB_ACTION_WORKFLOW_FILE
+        puts "The `#{GITHUB_ACTION_WORKFLOW_FILE}` is modified. The changes were not committed."
         puts "Please run `rake build_matrix:semaphore:generate` and commit the changes."
         exit 1
       end
@@ -191,11 +206,11 @@ namespace :build_matrix do
     if included_rubies.any?
       # If this gem only runs on these specific Ruby version
       included_rubies.each { |version| check_if_ruby_version_exists!(matrix, version) }
-      return true if included_rubies.include?(ruby["ruby"])
+      true if included_rubies.include?(ruby["ruby"])
     else
       # If this gem is excluded from running on this Ruby version
       excluded_rubies.each { |version| check_if_ruby_version_exists!(matrix, version) }
-      return true unless excluded_rubies.include?(ruby["ruby"])
+      true unless excluded_rubies.include?(ruby["ruby"])
     end
   end
 

data/appsignal.gemspec

@@ -40,7 +40,7 @@ Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
   gem.add_development_dependency "pry"
   gem.add_development_dependency "rake", ">= 12"
   gem.add_development_dependency "rspec", "~> 3.8"
-  gem.add_development_dependency "rubocop", "1.50.0"
+  gem.add_development_dependency "rubocop", "1.64.1"
   gem.add_development_dependency "timecop"
   gem.add_development_dependency "webmock"
   gem.add_development_dependency "yard", ">= 0.9.20"