marginalia 1.7.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: da6b70d12c22d141f4283d2e99b5550afaf8da14
-  data.tar.gz: fb2a34d6aee5b051fc9611ba792f4c14a50b2e9b
+SHA256:
+  metadata.gz: b26b4f3d01f3649b2575559ad58cdc8d7efec99e5f7907ecada07248a25b3a53
+  data.tar.gz: f0b948325e17595049e27eeb16180e078bad1058172403d218750b8821387459
 SHA512:
-  metadata.gz: af483022b150c72a218aa51dadb6db0865272cd81faa53db211b1b08e81a0b18b560908e92f553e93eb8b0d47029bd927f6fe6e61c811ab11e9d4b63339bed9d
-  data.tar.gz: e688057959cfd654dc027f03b1a8720ad21c90113d5478d18ed6897d5e4ab0a21297e703cfca85275e5d4495bce0e354acd9612f97f395cad6b1c70cdb39c8fa
+  metadata.gz: b3a2103e22bf2c3a2221b93caf4df7f27bbc90ac865377dd9b49663ce842c070a1712a20388ffcd51221f7a3f906874784c0053aec95bfa154c18dd863c0a40e
+  data.tar.gz: d2c54a0bfbc653cdab8391373bcb8aaa663cd782282bbd7421e2860535fe727051499e1696aad7e5c49d34ddbd45aaed5df882f674bed394593739e9c043e6a3

checksums.yaml.gz.sig

@@ -0,0 +1,3 @@
+�⟢�K�����ݹ�%�lA�������t'i�}w�$������O�B��.��
+���H���UhgH2
+?�eT�VkŘ�ܭW*x��8	�O��6���7��^u

data/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ["2.6", "2.7", "3.0"]
+        rails-version: ["5.2.0", "6.0.0", "6.1.0"]
+        exclude:
+          # Rails 5.2 does not support Ruby 3.0
+          - {ruby-version: "3.0", rails-version: "5.2.0"}
+
+    services:
+      mysql:
+        image: mysql
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+        ports:
+          - 3306:3306
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: password
+          POSTGRES_HOST_AUTH_METHOD: trust
+        ports:
+          - 5432:5432
+
+    env:
+      RAILS_VERSION: ${{ matrix.rails-version }}
+      MYSQL_HOST: 127.0.0.1
+      PGHOST: 127.0.0.1
+      DB_HOST: 127.0.0.1
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+
+    - name: Run tests
+      run: bundle exec rake db:reset test:all
+

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.6.8

data/Gemfile

@@ -2,29 +2,9 @@ source "https://rubygems.org"
 
 gemspec
 
-version = ENV["RAILS_VERSION"] || "4.2.0"
-
-if "4.2.5" > version
-  gem 'mysql2', '~> 0.3.13'
+rails_version = ENV["RAILS_VERSION"] || "6.1.0"
+if rails_version == "main"
+  gem "rails", github: "rails/rails"
 else
-  gem 'mysql2', '>= 0.3.13', '< 0.5'
-end
-gem 'pg', '~> 0.15'
-gem 'sqlite3', '~> 1.3.6'
-
-rails = case version
-when "master"
-  {:github => "rails/rails"}
-else
-  "~> #{version}"
-end
-
-gem "rails", rails
-
-if ENV["TEST_RAILS_API"] == "true"
-  gem "rails-api", "~> 0.2.1"
-end
-
-if RUBY_VERSION.start_with?('2.3')
-  gem 'mysql'
+  gem "rails", "~> #{rails_version}"
 end

data/README.md

@@ -1,4 +1,4 @@
-# marginalia [![Build Status](https://travis-ci.org/basecamp/marginalia.svg?branch=master)](https://travis-ci.org/basecamp/marginalia)
+# marginalia [![Build Status](https://github.com/basecamp/marginalia/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/basecamp/marginalia/actions/workflows/ci.yml)
 
 Attach comments to your ActiveRecord queries. By default, it adds the application, controller, and action names as a
 comment at the end of each query.
@@ -18,43 +18,28 @@ to automate identification of controllers and actions that are hotspots for slow
 This gem was created at 37signals. You can read more about how we use it [on
 our blog](http://37signals.com/svn/posts/3130-tech-note-mysql-query-comments-in-rails).
 
-This has been tested and used in production with both the mysql and mysql2 gems, 
-tested on Rails 2.3.5 through 4.1.x. It has also been tested for sqlite3 and postgres.
+This has been tested and used in production with the mysql2 and pg gems, and is
+tested on Rails 5.2 through 6.1, and Ruby 2.6 through 3.0. It is also tested
+for sqlite3.
+
+Rails version support will follow supported versions in the [Ruby on Rails maintenance policy](https://guides.rubyonrails.org/maintenance_policy.html)
+and Ruby support will follow maintained versions in the [Ruby maintenance policy](https://www.ruby-lang.org/en/downloads/branches/).
 
 Patches are welcome for other database adapters. 
 
 ## Installation
 
-### For Rails 3.x and 4.x:
-
     # Gemfile
     gem 'marginalia'
 
-### For Rails 2.x:
-
-If using cached externals, add to your `config/externals.yml` file.
-
-Or, if your prefer using `config.gem`, you can use:
-
-    config.gem 'marginalia'
-
-Finally, if bundled, you'll need to manually run the initialization step in an
-initializer, e.g.:
-    
-    # Gemfile
-    gem 'marginalia', :require => false
-
-    #config/initializers/marginalia.rb
-    require 'marginalia'
-    Marginalia::Railtie.insert
-
 ### Customization
 Optionally, you can set the application name shown in the log like so in an initializer (e.g. `config/initializers/marginalia.rb`):
 
     Marginalia.application_name = "BCX"
 
-For Rails 3 applications, the name will default to your Rails application name.
-For Rails 2 applications, "rails" is used as the default application name.
+The name will default to your Rails application name.
+
+#### Components
 
 You can also configure the components of the comment that will be appended,
 by setting `Marginalia::Comment.components`. By default, this is set to:
@@ -92,15 +77,23 @@ default. In addition, implementation is provided for:
   * `:job` to include the classname of the ActiveJob being performed.
   * `:hostname` to include ```Socket.gethostname```.
   * `:pid` to include current process id. 
-
-With ActiveRecord >= 3.2.19:
   * `:db_host` to include the configured database hostname.
   * `:socket` to include the configured database socket.
   * `:database` to include the configured database name.
 
 Pull requests for other included comment components are welcome.
 
-## Inline query annotations
+#### Prepend comments
+
+By default marginalia appends the comments at the end of the query. Certain databases, such as MySQL will truncate
+the query text. This is the case for slow query logs and the results of querying some InnoDB internal tables where the
+length of the query is more than 1024 bytes.
+
+In order to not lose the marginalia comments from your logs, you can prepend the comments using this option:
+
+    Marginalia::Comment.prepend_comment = true
+
+#### Inline query annotations
 
 In addition to the request or job-level component-based annotations,
 Marginalia may be used to add inline annotations to specific queries using a
@@ -121,6 +114,16 @@ will issue this query:
 
 Nesting `with_annotation` blocks will concatenate the comment strings.
 
+### Caveats
+
+#### Prepared statements
+
+Be careful when using Marginalia with prepared statements. If you use a component
+like `request_id` then every query will be unique and so ActiveRecord will create
+a new prepared statement for each potentially exhausting system resources.
+[Disable prepared statements](https://guides.rubyonrails.org/configuring.html#configuring-a-postgresql-database)
+if you wish to use components with high cardinality values.
+
 ## Contributing
 
 Start by bundling and creating the test database:

data/Rakefile

@@ -7,11 +7,6 @@ namespace :test do
   desc "test all drivers"
   task :all => [:mysql2, :postgresql, :sqlite]
 
-  desc "test mysql driver"
-  task :mysql do
-    sh "DRIVER=mysql bundle exec ruby -Ilib -Itest test/*_test.rb"
-  end
-
   desc "test mysql2 driver"
   task :mysql2 do
     sh "DRIVER=mysql2 bundle exec ruby -Ilib -Itest test/*_test.rb"

data/lib/marginalia/comment.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'socket'
 
 module Marginalia
   module Comment
-    mattr_accessor :components, :lines_to_ignore
+    mattr_accessor :components, :lines_to_ignore, :prepend_comment
     Marginalia::Comment.components ||= [:application, :controller, :action]
 
     def self.update!(controller = nil)
@@ -18,11 +20,11 @@ module Marginalia
     end
 
     def self.construct_comment
-      ret = ''
+      ret = String.new
       self.components.each do |c|
         component_value = self.send(c)
         if component_value.present?
-          ret << "#{c.to_s}:#{component_value.to_s},"
+          ret << "#{c}:#{component_value},"
         end
       end
       ret.chop!
@@ -102,11 +104,14 @@ module Marginalia
       end
 
       def self.sidekiq_job
-        marginalia_job["class"] if marginalia_job
+        marginalia_job["class"] if marginalia_job && marginalia_job.respond_to?(:[])
       end
 
+      DEFAULT_LINES_TO_IGNORE_REGEX = %r{\.rvm|/ruby/gems/|vendor/|marginalia|rbenv|monitor\.rb.*mon_synchronize}
+
       def self.line
-        Marginalia::Comment.lines_to_ignore ||= /\.rvm|gem|vendor\/|marginalia|rbenv/
+        Marginalia::Comment.lines_to_ignore ||= DEFAULT_LINES_TO_IGNORE_REGEX
+
         last_line = caller.detect do |line|
           line !~ Marginalia::Comment.lines_to_ignore
         end
@@ -118,7 +123,7 @@ module Marginalia
           else
             ""
           end
-          if last_line.starts_with? root
+          if last_line.start_with? root
             last_line = last_line[root.length..-1]
           end
           last_line
@@ -139,29 +144,35 @@ module Marginalia
         end
       end
 
-      if Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new('3.2.19')
-        def self.socket
-          if self.connection_config.present?
-            self.connection_config[:socket]
-          end
+      def self.socket
+        if self.connection_config.present?
+          self.connection_config[:socket]
         end
+      end
 
-        def self.db_host
-          if self.connection_config.present?
-            self.connection_config[:host]
-          end
+      def self.db_host
+        if self.connection_config.present?
+          self.connection_config[:host]
         end
+      end
 
-        def self.database
-          if self.connection_config.present?
-            self.connection_config[:database]
-          end
+      def self.database
+        if self.connection_config.present?
+          self.connection_config[:database]
         end
+      end
 
+      if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new('6.1')
         def self.connection_config
           return if marginalia_adapter.pool.nil?
           marginalia_adapter.pool.spec.config
         end
+      else
+        def self.connection_config
+          # `pool` might be a NullPool which has no db_config
+          return unless marginalia_adapter.pool.respond_to?(:db_config)
+          marginalia_adapter.pool.db_config.configuration_hash
+        end
       end
 
       def self.inline_annotations

data/lib/marginalia/railtie.rb

@@ -1,27 +1,22 @@
 require 'marginalia'
+require 'rails/railtie'
 
 module Marginalia
-  if defined? Rails::Railtie
-    require 'rails/railtie'
-
-    class Railtie < Rails::Railtie
-      initializer 'marginalia.insert' do
-        ActiveSupport.on_load :active_record do
-          Marginalia::Railtie.insert_into_active_record
-        end
+  class Railtie < Rails::Railtie
+    initializer 'marginalia.insert' do
+      ActiveSupport.on_load :active_record do
+        Marginalia::Railtie.insert_into_active_record
+      end
 
-        ActiveSupport.on_load :action_controller do
-          Marginalia::Railtie.insert_into_action_controller
-        end
+      ActiveSupport.on_load :action_controller do
+        Marginalia::Railtie.insert_into_action_controller
+      end
 
-        ActiveSupport.on_load :active_job do
-          Marginalia::Railtie.insert_into_active_job
-        end
+      ActiveSupport.on_load :active_job do
+        Marginalia::Railtie.insert_into_active_job
       end
     end
-  end
 
-  class Railtie
     def self.insert
       insert_into_active_record
       insert_into_action_controller

data/lib/marginalia/sidekiq_instrumentation.rb

@@ -1,7 +1,6 @@
 module Marginalia
 
   # Alternative to ActiveJob Instrumentation for Sidekiq.
-  # Apt for Instrumenting Sidekiq with Rails version < 4.2.
   module SidekiqInstrumentation
 
     class Middleware

data/lib/marginalia.rb

@@ -19,8 +19,8 @@ module Marginalia
         else
           is_mysql2 = defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter) &&
             ActiveRecord::ConnectionAdapters::Mysql2Adapter == instrumented_class
-          # Dont instrument exec_query on mysql2 and AR 3.2+, as it calls execute internally
-          unless is_mysql2 && ActiveRecord::VERSION::STRING > "3.1"
+          # Dont instrument exec_query on mysql2 as it calls execute internally
+          unless is_mysql2
             if instrumented_class.method_defined?(:exec_query)
               alias_method :exec_query_without_marginalia, :exec_query
               alias_method :exec_query, :exec_query_with_marginalia
@@ -29,9 +29,9 @@ module Marginalia
 
           is_postgres = defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter) &&
             ActiveRecord::ConnectionAdapters::PostgreSQLAdapter == instrumented_class
-          # Instrument exec_delete and exec_update on AR 3.2+, since they don't
-          # call execute internally
-          if is_postgres && ActiveRecord::VERSION::STRING > "3.1"
+          # Instrument exec_delete and exec_update since they don't call
+          # execute internally
+          if is_postgres
             if instrumented_class.method_defined?(:exec_delete)
               alias_method :exec_delete_without_marginalia, :exec_delete
               alias_method :exec_delete, :exec_delete_with_marginalia
@@ -49,41 +49,48 @@ module Marginalia
       Marginalia::Comment.update_adapter!(self)
       comment = Marginalia::Comment.construct_comment
       if comment.present? && !sql.include?(comment)
-        sql = "#{sql} /*#{comment}*/"
+        sql = if Marginalia::Comment.prepend_comment
+          "/*#{comment}*/ #{sql}"
+        else
+          "#{sql} /*#{comment}*/"
+        end
       end
       inline_comment = Marginalia::Comment.construct_inline_comment
-      if inline_comment.present?
-        sql = "#{sql} /*#{inline_comment}*/"
+      if inline_comment.present? && !sql.include?(inline_comment)
+        sql = if Marginalia::Comment.prepend_comment
+          "/*#{inline_comment}*/ #{sql}"
+        else
+          "#{sql} /*#{inline_comment}*/"
+        end
       end
-      sql
-    end
 
-    def execute_with_marginalia(sql, name = nil)
-      execute_without_marginalia(annotate_sql(sql), name)
+      sql
     end
 
-    def exec_query_with_marginalia(sql, name = 'SQL', binds = [])
-      exec_query_without_marginalia(annotate_sql(sql), name, binds)
+    def execute_with_marginalia(sql, *args)
+      execute_without_marginalia(annotate_sql(sql), *args)
     end
+    ruby2_keywords :execute_with_marginalia if respond_to?(:ruby2_keywords, true)
 
-    if ActiveRecord::VERSION::MAJOR >= 5
-      def exec_query_with_marginalia(sql, name = 'SQL', binds = [], options = {})
-        options[:prepare] ||= false
-        exec_query_without_marginalia(annotate_sql(sql), name, binds, options)
-      end
+    def exec_query_with_marginalia(sql, *args, **options)
+      options[:prepare] ||= false
+      exec_query_without_marginalia(annotate_sql(sql), *args, **options)
     end
 
-    def exec_delete_with_marginalia(sql, name = 'SQL', binds = [])
-      exec_delete_without_marginalia(annotate_sql(sql), name, binds)
+    def exec_delete_with_marginalia(sql, *args)
+      exec_delete_without_marginalia(annotate_sql(sql), *args)
     end
+    ruby2_keywords :exec_delete_with_marginalia if respond_to?(:ruby2_keywords, true)
 
-    def exec_update_with_marginalia(sql, name = 'SQL', binds = [])
-      exec_update_without_marginalia(annotate_sql(sql), name, binds)
+    def exec_update_with_marginalia(sql, *args)
+      exec_update_without_marginalia(annotate_sql(sql), *args)
     end
+    ruby2_keywords :exec_update_with_marginalia if respond_to?(:ruby2_keywords, true)
 
     def execute_and_clear_with_marginalia(sql, *args, &block)
       execute_and_clear_without_marginalia(annotate_sql(sql), *args, &block)
     end
+    ruby2_keywords :execute_and_clear_with_marginalia if respond_to?(:ruby2_keywords, true)
   end
 
   module ActionControllerInstrumentation

data/marginalia.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.authors       = ["Noah Lorang", "Nick Quaranto", "Taylor Weibley"]
-  gem.email         = ["noah@37signals.com", "arthurnn@github.com"]
+  gem.email         = ["arthurnn@github.com"]
   gem.homepage      = "https://github.com/basecamp/marginalia"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -8,11 +8,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test}/*`.split("\n")
   gem.name          = "marginalia"
   gem.require_paths = ["lib"]
-  gem.version       = "1.7.0"
+  gem.version       = "1.11.1"
   gem.license       = "MIT"
 
-  gem.add_runtime_dependency "actionpack", ">= 2.3"
-  gem.add_runtime_dependency "activerecord", ">= 2.3"
+  gem.add_runtime_dependency "actionpack", ">= 5.2"
+  gem.add_runtime_dependency "activerecord", ">= 5.2"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "mysql2"
   gem.add_development_dependency "pg"

data/test/query_comments_test.rb

@@ -5,16 +5,8 @@ def using_rails_api?
   ENV["TEST_RAILS_API"] == true
 end
 
-def request_id_available?
-  Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('3.2')
-end
-
-def active_job_available?
-  Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('4.2')
-end
-
-def adapter_pool_available?
-  Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new('3.2.19')
+def pool_db_config?
+  Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new('6.1')
 end
 
 require "minitest/autorun"
@@ -23,16 +15,11 @@ require 'logger'
 require 'pp'
 require 'active_record'
 require 'action_controller'
+require 'active_job'
 require 'sidekiq'
 require 'sidekiq/testing'
 
-if request_id_available?
-  require 'action_dispatch/middleware/request_id'
-end
-
-if active_job_available?
-  require 'active_job'
-end
+require 'action_dispatch/middleware/request_id'
 
 if using_rails_api?
   require 'rails-api/action_controller/api'
@@ -55,7 +42,7 @@ RAILS_ROOT = File.expand_path(File.dirname(__FILE__))
 
 ActiveRecord::Base.establish_connection({
   :adapter  => ENV["DRIVER"] || "mysql",
-  :host     => "localhost",
+  :host     => ENV["DB_HOST"] || "localhost",
   :username => ENV["DB_USERNAME"] || "root",
   :database => "marginalia_test"
 })
@@ -81,11 +68,9 @@ module API
   end
 end
 
-if active_job_available?
-  class PostsJob < ActiveJob::Base
-    def perform
-      Post.first
-    end
+class PostsJob < ActiveJob::Base
+  def perform
+    Post.first
   end
 end
 
@@ -116,11 +101,15 @@ Marginalia::Railtie.insert
 
 class MarginaliaTest < MiniTest::Test
   def setup
+    # Touch the model to avoid spurious schema queries
+    Post.first
+
     @queries = []
     ActiveSupport::Notifications.subscribe "sql.active_record" do |*args|
       @queries << args.last[:sql]
     end
     @env = Rack::MockRequest.env_for('/')
+    ActiveJob::Base.queue_adapter = :inline
   end
 
   def test_double_annotate
@@ -131,7 +120,6 @@ class MarginaliaTest < MiniTest::Test
   end
 
   def test_exists
-    skip if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new('3.2')
     Post.exists?
     assert_match %r{/\*application:rails\*/$}, @queries.last
   end
@@ -215,6 +203,16 @@ class MarginaliaTest < MiniTest::Test
     assert_match %r{/\*line:.*lib/marginalia/comment.rb:[0-9]+}, @queries.first
   end
 
+  def test_default_lines_to_ignore_regex
+    line = "/gems/a_gem/lib/a_gem.rb:1:in `some_method'"
+    call_stack = [line] + caller
+
+    assert_match(
+      call_stack.detect { |line| line !~ Marginalia::Comment::DEFAULT_LINES_TO_IGNORE_REGEX },
+      line
+    )
+  end
+
   def test_hostname_and_pid
     Marginalia::Comment.components = [:hostname, :pid]
     PostsController.action(:driver_only).call(@env)
@@ -227,19 +225,29 @@ class MarginaliaTest < MiniTest::Test
     assert_match %r{/\*controller_with_namespace:API::V1::PostsController}, @queries.first
   end
 
-  if adapter_pool_available?
-    def test_db_host
-      Marginalia::Comment.components = [:db_host]
-      API::V1::PostsController.action(:driver_only).call(@env)
-      assert_match %r{/\*db_host:localhost}, @queries.first
-    end
+  def test_db_host
+    Marginalia::Comment.components = [:db_host]
+    API::V1::PostsController.action(:driver_only).call(@env)
+    assert_match %r{/\*db_host:#{ENV["DB_HOST"] || "localhost"}}, @queries.first
+  end
 
-    def test_database
-      Marginalia::Comment.components = [:database]
+  def test_database
+    Marginalia::Comment.components = [:database]
+    API::V1::PostsController.action(:driver_only).call(@env)
+    assert_match %r{/\*database:marginalia_test}, @queries.first
+  end
+
+  if pool_db_config?
+    def test_socket
+      # setting socket in configuration would break some connections - mock it instead
+      pool = ActiveRecord::Base.connection_pool
+      pool.db_config.stubs(:configuration_hash).returns({:socket => "marginalia_socket"})
+      Marginalia::Comment.components = [:socket]
       API::V1::PostsController.action(:driver_only).call(@env)
-      assert_match %r{/\*database:marginalia_test}, @queries.first
+      assert_match %r{/\*socket:marginalia_socket}, @queries.first
+      pool.db_config.unstub(:configuration_hash)
     end
-
+  else
     def test_socket
       # setting socket in configuration would break some connections - mock it instead
       pool = ActiveRecord::Base.connection_pool
@@ -251,37 +259,34 @@ class MarginaliaTest < MiniTest::Test
     end
   end
 
-  if request_id_available?
-    def test_request_id
-      @env["action_dispatch.request_id"] = "some-uuid"
-      Marginalia::Comment.components = [:request_id]
-      PostsController.action(:driver_only).call(@env)
-      assert_match %r{/\*request_id:some-uuid.*}, @queries.first
+  def test_request_id
+    @env["action_dispatch.request_id"] = "some-uuid"
+    Marginalia::Comment.components = [:request_id]
+    PostsController.action(:driver_only).call(@env)
+    assert_match %r{/\*request_id:some-uuid.*}, @queries.first
 
-      if using_rails_api?
-        PostsApiController.action(:driver_only).call(@env)
-        assert_match %r{/\*request_id:some-uuid.*}, @queries.second
-      end
+    if using_rails_api?
+      PostsApiController.action(:driver_only).call(@env)
+      assert_match %r{/\*request_id:some-uuid.*}, @queries.second
     end
+  end
 
-  else
-    def test_request_id_is_noop_on_old_rails
-      @env["action_dispatch.request_id"] = "some-uuid"
-      Marginalia::Comment.components = [:request_id]
-      PostsController.action(:driver_only).call(@env)
-      assert_match %r{^select id from posts$}, @queries.first
-    end
+  def test_active_job
+    Marginalia::Comment.components = [:job]
+    PostsJob.perform_later
+    assert_match %{job:PostsJob}, @queries.first
+
+    Post.first
+    refute_match %{job:PostsJob}, @queries.last
   end
 
-  if active_job_available?
-    def test_active_job
-      Marginalia::Comment.components = [:job]
-      PostsJob.perform_later
-      assert_match %{job:PostsJob}, @queries.first
+  def test_active_job_with_sidekiq
+    Marginalia::Comment.components = [:job, :sidekiq_job]
+    PostsJob.perform_later
+    assert_match %{job:PostsJob}, @queries.first
 
-      Post.first
-      refute_match %{job:PostsJob}, @queries.last
-    end
+    Post.first
+    refute_match %{job:PostsJob}, @queries.last
   end
 
   def test_sidekiq_job
@@ -290,13 +295,14 @@ class MarginaliaTest < MiniTest::Test
 
     # Test harness does not run Sidekiq middlewares by default so include testing middleware.
     Sidekiq::Testing.server_middleware do |chain|
-     chain.add Marginalia::SidekiqInstrumentation::Middleware
+      chain.add Marginalia::SidekiqInstrumentation::Middleware
     end
 
     Sidekiq::Testing.fake!
     PostsSidekiqJob.perform_async
     PostsSidekiqJob.drain
     assert_match %{sidekiq_job:PostsSidekiqJob}, @queries.first
+
     Post.first
     refute_match %{sidekiq_job:PostsSidekiqJob}, @queries.last
   end
@@ -341,6 +347,22 @@ class MarginaliaTest < MiniTest::Test
     assert_match %r{/\*; DROP TABLE USERS;\*/$}, @queries.last
   end
 
+  def test_inline_annotations_are_deduped
+    Marginalia.with_annotation("foo") do
+      ActiveRecord::Base.connection.execute "select id from posts /*foo*/"
+    end
+    assert_match %r{select id from posts /\*foo\*/ /\*application:rails\*/$}, @queries.first
+  end
+
+  def test_add_comments_to_beginning_of_query
+    Marginalia::Comment.prepend_comment = true
+
+    ActiveRecord::Base.connection.execute "select id from posts"
+    assert_match %r{/\*application:rails\*/ select id from posts$}, @queries.first
+  ensure
+    Marginalia::Comment.prepend_comment = nil
+  end
+
   def teardown
     Marginalia.application_name = nil
     Marginalia::Comment.lines_to_ignore = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marginalia
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.11.1
 platform: ruby
 authors:
 - Noah Lorang
@@ -9,8 +9,28 @@ authors:
 - Taylor Weibley
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2019-03-15 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDKDCCAhCgAwIBAgIBCDANBgkqhkiG9w0BAQsFADA6MQ0wCwYDVQQDDARzajI2
+  MRQwEgYKCZImiZPyLGQBGRYEc2oyNjETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0y
+  MTA0MjcwMzIxMjZaFw0yMjA0MjcwMzIxMjZaMDoxDTALBgNVBAMMBHNqMjYxFDAS
+  BgoJkiaJk/IsZAEZFgRzajI2MRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkq
+  hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsr60Eo/ttCk8GMTMFiPr3GoYMIMFvLak
+  xSmTk9YGCB6UiEePB4THSSA5w6IPyeaCF/nWkDp3/BAam0eZMWG1IzYQB23TqIM0
+  1xzcNRvFsn0aQoQ00k+sj+G83j3T5OOV5OZIlu8xAChMkQmiPd1NXc6uFv+Iacz7
+  kj+CMsI9YUFdNoU09QY0b+u+Rb6wDYdpyvN60YC30h0h1MeYbvYZJx/iZK4XY5zu
+  4O/FL2ChjL2CPCpLZW55ShYyrzphWJwLOJe+FJ/ZBl6YXwrzQM9HKnt4titSNvyU
+  KzE3L63A3PZvExzLrN9u09kuWLLJfXB2sGOlw3n9t72rJiuBr3/OQQIDAQABozkw
+  NzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU99dfRjEKFyczTeIz
+  m3ZsDWrNC80wDQYJKoZIhvcNAQELBQADggEBAInkmTwBeGEJ7Xu9jjZIuFaE197m
+  YfvrzVoE6Q1DlWXpgyhhxbPIKg2acvM/Z18A7kQrF7paYl64Ti84dC64seOFIBNx
+  Qj/lxzPHMBoAYqeXYJhnYIXnvGCZ4Fkic5Bhs+VdcDP/uwYp3adqy+4bT/XDFZQg
+  tSjrAOTg3wck5aI+Tz90ONQJ83bnCRr1UPQ0T3PbWMjnNsEa9CAxUB845Sg+9yUz
+  Tvf+pbX8JT9rawFDogxPhL7eRAbjg4MH9amp5l8HTVCAsW8vqv7wM4rtMNAaXmik
+  LJghfDEf70fTtbs4Zv57pPhn1b7wBNf8fh+TZOlYAA6dFtQXoCwfE6bWgQU=
+  -----END CERTIFICATE-----
+date: 2021-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -18,28 +38,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -140,25 +160,18 @@ dependencies:
         version: '0'
 description: Attach comments to your ActiveRecord queries.
 email:
-- noah@37signals.com
 - arthurnn@github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/4.2.api.gemfile
-- gemfiles/4.2.gemfile
-- gemfiles/5.0.gemfile
-- gemfiles/5.1.gemfile
-- gemfiles/5.2.gemfile
-- init.rb
 - lib/marginalia.rb
 - lib/marginalia/comment.rb
 - lib/marginalia/railtie.rb
@@ -184,8 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: Attach comments to your ActiveRecord queries.

metadata.gz.sig

@@ -0,0 +1,2 @@
+��������mqF�X'�jk+8���
�㴞�C}}0Y��`ԯ�+hI$�S��E��6u��#��X��&p�l凬Y��r��3X�=#K��!�Aku���΁)�f�L8GJ��mF�l���1O{����0�u��������\����|'�v>gNc+��Â��9�x����`ՑR[.��M�
Q�¾��M(na���khcX���F�����"������C��
+�ҕ̹��3��S}��E�t༄O�6ۦm�ݵ

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-sudo: false
-
-rvm:
-  - 2.2
-  - 2.3
-  - 2.4
-
-script: "bundle exec rake db:reset test:all"
-
-gemfile:
-  - gemfiles/4.2.gemfile
-  - gemfiles/4.2.api.gemfile
-  - gemfiles/5.0.gemfile
-  - gemfiles/5.1.gemfile
-  - gemfiles/5.2.gemfile

data/gemfiles/4.2.api.gemfile

@@ -1,9 +0,0 @@
-source "https://rubygems.org"
-
-gem "mysql2", "~> 0.3.13"
-gem "pg", "~> 0.15"
-gem "sqlite3", "~> 1.3.6"
-gem "rails", "= 4.2.11.1"
-gem "rails-api", "~> 0.2.1"
-
-gemspec :path => "../"

data/gemfiles/4.2.gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-gem "mysql2", "~> 0.3.13"
-gem "pg", "~> 0.15"
-gem "sqlite3", "~> 1.3.6"
-gem "rails", "= 4.2.11.1"
-
-gemspec :path => "../"

data/gemfiles/5.0.gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-gem "mysql2", "~> 0.3.13"
-gem "pg", "~> 0.15"
-gem "sqlite3", "~> 1.3.6"
-gem "rails", "= 5.0.7.2"
-
-gemspec :path => "../"

data/gemfiles/5.1.gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-gem "mysql2", "~> 0.3.13"
-gem "pg", "~> 0.15"
-gem "sqlite3", "~> 1.3.6"
-gem "rails", "= 5.1.6.2"
-
-gemspec :path => "../"

data/gemfiles/5.2.gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-gem "mysql2", "~> 0.4.10"
-gem "pg", "~> 0.15"
-gem "sqlite3", "~> 1.3.6"
-gem "rails", "= 5.2.2.1"
-
-gemspec :path => "../"

data/init.rb

@@ -1,2 +0,0 @@
-require 'marginalia/railtie'
-Marginalia::Railtie.insert