appsignal 3.0.18 → 3.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94a1813b156130efc3fa3b4b2e8d9160c59c41ba146515b1a4859508000cc818
-  data.tar.gz: cc3bd58933c8f423bc3040b7725dc8d5d82c5c82ef121d607829cb6cb6ce5eb1
+  metadata.gz: ff92b4ae6715fa80b1910e0023b49e0032a28fa1ea13b7b64587568ceae07edf
+  data.tar.gz: 6faac0d1b0fa8abefc0908628a98918d3cbec6eae45ae4a7d275c4537eb03b59
 SHA512:
-  metadata.gz: 539ae7ae14b48ef21f035d0983f2a7901a1bdf0b8fb9498fa4bca424375d6a16c3c30bfbd5eefa5819c38cfb6363c2eb2e3d5dd02aa469c020d877ed55cc441c
-  data.tar.gz: 5a643b37eabc5c53e7e79e115e2de1b31e88f9c7cf2a2d2a39a0db2496dd6463bbc34d936a0a5b92274c4e3496e23e321b7a8321cd7ce8eef6bae36cadf8849a
+  metadata.gz: 1cd66bc7159a7ce2817d5190073d4af45e5f7dcb7c5f7c5c9ebdf6b986af9f3e3b46f7149a3fabf81ce03a03c62734c87984f92b5f0a468240b9d3a7b513168f
+  data.tar.gz: cf0735657d7c4ebcaff3c28863d7ee8e5b244f8945dbe16d0d764130826d99bce49aca1c13a5adbd62a196acbf23827fcbfe8a3558843298e56585896a3a0812

data/.semaphore/semaphore.yml

@@ -446,6 +446,25 @@ blocks:
       commands:
       - "./support/bundler_wrapper exec rake test"
       - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 2.5.8 for rails-6.1
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 2.5.8
+      - name: GEMSET
+        value: rails-6.1
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/rails-6.1.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
 - name: Ruby 2.6.9
   dependencies:
   - Validation
@@ -683,6 +702,25 @@ blocks:
       commands:
       - "./support/bundler_wrapper exec rake test"
       - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 2.6.9 for rails-6.1
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 2.6.9
+      - name: GEMSET
+        value: rails-6.1
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/rails-6.1.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
     - name: Ruby 2.6.9 for resque-1
       env_vars:
       - *2
@@ -1034,6 +1072,25 @@ blocks:
       commands:
       - "./support/bundler_wrapper exec rake test"
       - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 2.7.5 for rails-6.1
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 2.7.5
+      - name: GEMSET
+        value: rails-6.1
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/rails-6.1.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
     - name: Ruby 2.7.5 for rails-7.0
       env_vars:
       - *2
@@ -1347,6 +1404,25 @@ blocks:
       commands:
       - "./support/bundler_wrapper exec rake test"
       - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 3.0.3 for rails-6.1
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 3.0.3
+      - name: GEMSET
+        value: rails-6.1
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/rails-6.1.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
     - name: Ruby 3.0.3 for rails-7.0
       env_vars:
       - *2
@@ -1603,6 +1679,44 @@ blocks:
       commands:
       - "./support/bundler_wrapper exec rake test"
       - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 3.1.0 for rails-6.1
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 3.1.0
+      - name: GEMSET
+        value: rails-6.1
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/rails-6.1.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby 3.1.0 for rails-7.0
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: 3.1.0
+      - name: GEMSET
+        value: rails-7.0
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/rails-7.0.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"
     - name: Ruby 3.1.0 for resque-2
       env_vars:
       - *2
@@ -1769,3 +1883,23 @@ blocks:
       commands:
       - "./support/bundler_wrapper exec rake test"
       - "./support/bundler_wrapper exec rake test:failure"
+    - name: Ruby jruby-9.2.19.0 for rails-6.1
+      env_vars:
+      - *2
+      - *3
+      - *4
+      - *5
+      - name: RUBY_VERSION
+        value: jruby-9.2.19.0
+      - name: GEMSET
+        value: rails-6.1
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/rails-6.1.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      - *6
+      commands:
+      - "./support/bundler_wrapper exec rake test"
+      - "./support/bundler_wrapper exec rake test:failure"

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.0.19
+
+### Changed
+
+- [2587eae3](https://github.com/appsignal/appsignal-ruby/commit/2587eae30f17e0f0b5e27cb61982301220cc77b1) patch - Store the extension install report as JSON, instead of YAML. Reduces internal complexity.
+
+### Fixed
+
+- [243c1ed4](https://github.com/appsignal/appsignal-ruby/commit/243c1ed444f3351ca158200a47836673f851cb31) patch - Improve compatibility with the sequel-rails gem by tracking the performed SQL query in instrumentation events.
+
 ## 3.0.18
 
 ### Added

data/build_matrix.yml

@@ -164,6 +164,7 @@ matrix:
       - "no_dependencies"
       - "rails-5.2"
       - "rails-6.0"
+      - "rails-6.1"
       - "rails-7.0"
 
   ruby:
@@ -241,6 +242,13 @@ matrix:
           - "2.3.8"
           - "2.4.10"
           - "3.1.0"
+    - gem: "rails-6.1"
+      exclude:
+        ruby:
+          - "2.1.10"
+          - "2.2.10"
+          - "2.3.8"
+          - "2.4.10"
     - gem: "rails-7.0"
       exclude:
         ruby:
@@ -250,7 +258,6 @@ matrix:
           - "2.4.10"
           - "2.5.8"
           - "2.6.9"
-          - "3.1.0"
           - "jruby-9.2.19.0"
     - gem: "resque-1"
       bundler: "1.17.3"

data/ext/base.rb

@@ -2,6 +2,7 @@ require "digest"
 require "fileutils"
 require "open-uri"
 require "zlib"
+require "json"
 require "yaml"
 require "rubygems/package"
 require File.expand_path("../../lib/appsignal/version.rb", __FILE__)
@@ -60,7 +61,7 @@ end
 
 def write_report
   File.open(File.join(EXT_PATH, "install.report"), "w") do |file|
-    file.write YAML.dump(report)
+    file.write JSON.generate(report)
   end
 end
 

data/gemfiles/rails-6.1.gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 6.1.0"
+gem "net-smtp", require: false
+gem "sidekiq"
+
+gemspec :path => "../"

data/gemfiles/rails-7.0.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rails', '~> 7.0.0'
+gem 'rails', "~> 7.0.1"
 gem "sidekiq"
 gem "rake", "> 12.2"
 

data/lib/appsignal/cli/diagnose/utils.rb

@@ -32,20 +32,6 @@ module Appsignal
 
           IO.binread(path, length, offset)
         end
-
-        def self.parse_yaml(contents)
-          if YAML.respond_to? :safe_load
-            if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
-              # Use keyword params for Ruby 2.6 and up
-              YAML.safe_load(contents, :permitted_classes => [Time])
-            else
-              YAML.safe_load(contents, [Time])
-            end
-          else
-            # Support for Ruby versions without YAML.safe_load
-            YAML.load(contents) # rubocop:disable Security/YAMLLoad
-          end
-        end
       end
     end
   end

data/lib/appsignal/cli/diagnose.rb

@@ -352,8 +352,8 @@ module Appsignal
         def fetch_installation_report
           path = File.expand_path("../../../../ext/install.report", __FILE__)
           raw_report = File.read(path)
-          Utils.parse_yaml(raw_report)
-        rescue StandardError, Psych::SyntaxError => e # rubocop:disable Lint/ShadowedException
+          JSON.parse(raw_report)
+        rescue StandardError, JSON::ParserError => e # rubocop:disable Lint/ShadowedException
           {
             "parsing_error" => {
               "error" => "#{e.class}: #{e}",
@@ -411,7 +411,7 @@ module Appsignal
         def print_installation_build_report(report)
           report = report.fetch("build", {})
           puts "  Build details"
-          puts_format "Install time", report["time"].to_s, :level => 2
+          puts_format "Install time", report["time"], :level => 2
           puts_format "Architecture", report["architecture"], :level => 2
           puts_format "Target", report["target"], :level => 2
           puts_format "Musl override", report["musl_override"], :level => 2

data/lib/appsignal/event_formatter/sequel/sql_formatter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Appsignal
+  class EventFormatter
+    # @api private
+    module Sequel
+      # Compatability with the sequel-rails gem.
+      # The sequel-rails gem adds its own ActiveSupport::Notifications events
+      # that conflict with our own sequel instrumentor. Without this event
+      # formatter the sequel-rails events are recorded without the SQL query
+      # that's being executed.
+      class SqlFormatter
+        def format(payload)
+          [payload[:name].to_s, payload[:sql], SQL_BODY_FORMAT]
+        end
+      end
+    end
+  end
+end
+
+Appsignal::EventFormatter.register(
+  "sql.sequel",
+  Appsignal::EventFormatter::Sequel::SqlFormatter
+)

data/lib/appsignal/system.rb

@@ -106,9 +106,5 @@ module Appsignal
     def self.jruby?
       RUBY_PLATFORM == "java"
     end
-
-    def self.ruby_2_7_or_newer?
-      RUBY_VERSION > "2.7"
-    end
   end
 end

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.0.18".freeze
+  VERSION = "3.0.19".freeze
 end

data/spec/lib/appsignal/cli/diagnose_spec.rb

@@ -251,7 +251,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
 
       it "adds the installation report to the diagnostics report" do
         run
-        jruby = DependencyHelper.running_jruby?
+        jruby = Appsignal::System.jruby?
         expect(received_report["installation"]).to match(
           "result" => {
             "status" => "success"
@@ -321,7 +321,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
           expect(File).to receive(:read)
             .with(File.expand_path("../../../../../ext/install.report", __FILE__))
             .and_return(
-              YAML.dump(
+              JSON.generate(
                 "result" => {
                   "status" => "error",
                   "error" => "RuntimeError: some error",
@@ -384,8 +384,8 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
         end
       end
 
-      context "when report is invalid YAML" do
-        let(:raw_report) { "foo:\nbar" }
+      context "when report is invalid JSON" do
+        let(:raw_report) { "{}-" }
         before do
           allow(File).to receive(:read).and_call_original
           expect(File).to receive(:read)

data/spec/lib/appsignal/event_formatter/active_record/sql_formatter_spec.rb

@@ -1,5 +1,5 @@
-describe Appsignal::EventFormatter::ActiveRecord::InstantiationFormatter do
-  let(:klass)     { Appsignal::EventFormatter::ActiveRecord::SqlFormatter }
+describe Appsignal::EventFormatter::ActiveRecord::SqlFormatter do
+  let(:klass)     { described_class }
   let(:formatter) { klass.new }
 
   it "should register sql.active_record" do

data/spec/lib/appsignal/event_formatter/sequel/sql_formatter_spec.rb

@@ -0,0 +1,30 @@
+describe Appsignal::EventFormatter::Sequel::SqlFormatter do
+  let(:klass)     { described_class }
+  let(:formatter) { klass.new }
+
+  it "registers the sql.sequel event formatter" do
+    expect(Appsignal::EventFormatter.registered?("sql.sequel", klass)).to be_truthy
+  end
+
+  describe "#format" do
+    before do
+      stub_const(
+        "SequelDatabaseTypeClass",
+        Class.new do
+          def self.to_s
+            "SequelDatabaseTypeClassToString"
+          end
+        end
+      )
+    end
+    let(:payload) do
+      {
+        :name => SequelDatabaseTypeClass,
+        :sql => "SELECT * FROM users"
+      }
+    end
+    subject { formatter.format(payload) }
+
+    it { is_expected.to eq ["SequelDatabaseTypeClassToString", "SELECT * FROM users", 1] }
+  end
+end

data/spec/lib/appsignal/hooks/activejob_spec.rb

@@ -30,6 +30,7 @@ if DependencyHelper.active_job_present?
   end
 
   describe Appsignal::Hooks::ActiveJobHook::ActiveJobClassInstrumentation do
+    include ActiveJobHelpers
     let(:time) { Time.parse("2001-01-01 10:00:00UTC") }
     let(:namespace) { Appsignal::Transaction::BACKGROUND_JOB }
     let(:queue) { "default" }
@@ -65,7 +66,7 @@ if DependencyHelper.active_job_present?
       ]
     end
     let(:expected_perform_events) do
-      if DependencyHelper.rails_version >= Gem::Version.new("7.0.0")
+      if DependencyHelper.rails7_present?
         ["perform.active_job", "perform_start.active_job"]
       else
         ["perform_start.active_job", "perform.active_job"]
@@ -597,23 +598,5 @@ if DependencyHelper.active_job_present?
         "_aj_symbol_keys"
       end
     end
-
-    def active_job_args_wrapper(args: [], params: nil)
-      if DependencyHelper.rails_version >= Gem::Version.new("7.0.0")
-        wrapped_args = {
-          "_aj_ruby2_keywords" => ["args"],
-          "args" => args
-        }
-
-        unless params.nil?
-          wrapped_args["params"] = params
-          wrapped_args["_aj_ruby2_keywords"] = ["params", "args"]
-        end
-
-        [wrapped_args]
-      else
-        params.nil? ? args : args + [params]
-      end
-    end
   end
 end

data/spec/lib/appsignal/hooks/sequel_spec.rb

@@ -1,7 +1,7 @@
 describe Appsignal::Hooks::SequelHook do
   if DependencyHelper.sequel_present?
     let(:db) do
-      if Appsignal::System.jruby?
+      if DependencyHelper.running_jruby?
         Sequel.connect("jdbc:sqlite::memory:")
       else
         Sequel.sqlite

data/spec/lib/appsignal/integrations/sidekiq_spec.rb

@@ -339,6 +339,7 @@ if DependencyHelper.active_job_present?
   require "sidekiq/testing"
 
   describe "Sidekiq ActiveJob integration" do
+    include ActiveJobHelpers
     let(:namespace) { Appsignal::Transaction::BACKGROUND_JOB }
     let(:time) { Time.parse("2001-01-01 10:00:00UTC") }
     let(:log) { StringIO.new }
@@ -367,7 +368,7 @@ if DependencyHelper.active_job_present?
       ]
     end
     let(:expected_wrapped_args) do
-      if DependencyHelper.rails_version >= Gem::Version.new("7.0.0")
+      if (DependencyHelper.rails6_1_present? && DependencyHelper.ruby_3_1_or_newer?) || DependencyHelper.rails7_present?
         [{
           "_aj_ruby2_keywords" => ["args"],
           "args" => expected_args
@@ -385,7 +386,7 @@ if DependencyHelper.active_job_present?
       end
     end
     let(:expected_perform_events) do
-      if DependencyHelper.rails_version >= Gem::Version.new("7.0.0")
+      if DependencyHelper.rails7_present?
         ["perform_job.sidekiq", "perform.active_job", "perform_start.active_job"]
       else
         ["perform_job.sidekiq", "perform_start.active_job", "perform.active_job"]

data/spec/lib/appsignal_spec.rb

@@ -86,8 +86,7 @@ describe Appsignal do
           expect_environment_metadata("ruby_gc_instrumentation_enabled", "true")
         end
 
-        unless Appsignal::System.jruby?
-
+        unless DependencyHelper.running_jruby?
           it "installs the allocation event hook" do
             expect(Appsignal::Extension).to receive(:install_allocation_event_hook)
               .and_call_original

data/spec/support/helpers/activejob_helpers.rb

@@ -0,0 +1,27 @@
+module ActiveJobHelpers
+  def active_job_args_wrapper(args: [], params: nil)
+    if (DependencyHelper.rails6_1_present? && DependencyHelper.ruby_3_1_or_newer?) || DependencyHelper.rails7_present?
+      wrapped_args = {}
+
+      if params
+        if DependencyHelper.rails7_present?
+          wrapped_args["_aj_ruby2_keywords"] = ["params", "args"]
+          wrapped_args["args"] = []
+          wrapped_args["params"] = {
+            "_aj_symbol_keys" => ["foo"]
+          }.merge(params)
+        else
+          wrapped_args["_aj_symbol_keys"] = ["foo"]
+          wrapped_args.merge!(params)
+        end
+      else
+        wrapped_args["_aj_ruby2_keywords"] = ["args"]
+        wrapped_args["args"] = args
+      end
+
+      [wrapped_args]
+    else
+      params.nil? ? args : args + [params]
+    end
+  end
+end

data/spec/support/helpers/dependency_helper.rb

@@ -9,8 +9,12 @@ module DependencyHelper
     ruby_version.segments.take(2) == [2, 0]
   end
 
+  def ruby_3_1_or_newer?
+    ruby_version >= Gem::Version.new("3.1.0")
+  end
+
   def running_jruby?
-    defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
+    Appsignal::System.jruby?
   end
 
   def rails_present?
@@ -21,6 +25,14 @@ module DependencyHelper
     rails_present? && rails_version >= Gem::Version.new("6.0.0")
   end
 
+  def rails6_1_present?
+    rails_present? && rails_version >= Gem::Version.new("6.1.0")
+  end
+
+  def rails7_present?
+    rails_present? && rails_version >= Gem::Version.new("7.0.0")
+  end
+
   def rails_version
     Gem.loaded_specs["rails"].version
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.0.18
+  version: 3.0.19
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -171,6 +171,7 @@ files:
 - gemfiles/rails-5.1.gemfile
 - gemfiles/rails-5.2.gemfile
 - gemfiles/rails-6.0.gemfile
+- gemfiles/rails-6.1.gemfile
 - gemfiles/rails-7.0.gemfile
 - gemfiles/resque-1.gemfile
 - gemfiles/resque-2.gemfile
@@ -199,6 +200,7 @@ files:
 - lib/appsignal/event_formatter/faraday/request_formatter.rb
 - lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter.rb
 - lib/appsignal/event_formatter/moped/query_formatter.rb
+- lib/appsignal/event_formatter/sequel/sql_formatter.rb
 - lib/appsignal/extension.rb
 - lib/appsignal/extension/jruby.rb
 - lib/appsignal/garbage_collection_profiler.rb
@@ -297,6 +299,7 @@ files:
 - spec/lib/appsignal/event_formatter/faraday/request_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/moped/query_formatter_spec.rb
+- spec/lib/appsignal/event_formatter/sequel/sql_formatter_spec.rb
 - spec/lib/appsignal/event_formatter_spec.rb
 - spec/lib/appsignal/extension/jruby_spec.rb
 - spec/lib/appsignal/extension_install_failure_spec.rb
@@ -368,6 +371,7 @@ files:
 - spec/support/fixtures/projects/valid/log/.gitkeep
 - spec/support/fixtures/uploaded_file.txt
 - spec/support/helpers/action_mailer_helpers.rb
+- spec/support/helpers/activejob_helpers.rb
 - spec/support/helpers/api_request_helper.rb
 - spec/support/helpers/cli_helpers.rb
 - spec/support/helpers/config_helpers.rb
@@ -448,6 +452,7 @@ test_files:
 - spec/lib/appsignal/event_formatter/faraday/request_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/moped/query_formatter_spec.rb
+- spec/lib/appsignal/event_formatter/sequel/sql_formatter_spec.rb
 - spec/lib/appsignal/event_formatter_spec.rb
 - spec/lib/appsignal/extension/jruby_spec.rb
 - spec/lib/appsignal/extension_install_failure_spec.rb
@@ -519,6 +524,7 @@ test_files:
 - spec/support/fixtures/projects/valid/log/.gitkeep
 - spec/support/fixtures/uploaded_file.txt
 - spec/support/helpers/action_mailer_helpers.rb
+- spec/support/helpers/activejob_helpers.rb
 - spec/support/helpers/api_request_helper.rb
 - spec/support/helpers/cli_helpers.rb
 - spec/support/helpers/config_helpers.rb