marginalia 1.6.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bda214f48d77afb13f9c9182a550272d4e654c4f
-  data.tar.gz: 5d199a1edd3a808254824a2bb45e22deca536e22
+SHA256:
+  metadata.gz: d87c1e1a9f2c0653a979e4bc598c686c8fb7e7af4281f6571c915cb76eee2742
+  data.tar.gz: 18b9c7227dc0fedf7fc74954023274484a79a30fe8d9cc47d09c6ecb46010538
 SHA512:
-  metadata.gz: 7f7ee0ed6593d2a639c31787a559a86db0367b63ed79dde39966a4264904bbbd77d822e01be212ae40e7a573330281cb75489fc08e577c28e4d059712bcd2a86
-  data.tar.gz: 4963089d9d9609fd5dbdae17c36e6ed001cea24b81550febdf0826fc3fe13d574f34c8bb51a1ffc6b270e30ba68dd6c14b3d693cec8fcc6bfa4370d8fdee144a
+  metadata.gz: 88df0c3b95e116f53a63f6acb1dd6ba63baba048b11e09b47e723d394588c20bab9fadd7035da5a5183fa120fc6871dc2d04205f6397744669f564f684a9f8d5
+  data.tar.gz: d91e987e20e1d6a9c257cd5c68b2251b3ced7194f20c38b35e28711088ad030823b0f7018667ce5cb9e02015f472c0fe0a0a34d4ff614dac38194f78e191327b

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.6.6

data/.travis.yml

@@ -1,18 +1,34 @@
 language: ruby
+sudo: false
+
+services:
+  - mysql
+  - postgresql
 
 rvm:
-  - 2.3.1
-  - 2.4.4
-  - 2.5.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
 
-sudo: false
+services:
+  - mysql
+  - postgresql
+
+script: "bundle exec rake db:reset test:all"
 
-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
 
-env:
-  - "RAILS_VERSION=4.2.0"
-  - "RAILS_VERSION=5.0.6"
-  - "RAILS_VERSION=5.1.5"
-  - "RAILS_VERSION=4.2.0 TEST_RAILS_API=true"
-  - "RAILS_VERSION=5.0.6 TEST_RAILS_API=true"
-  - "RAILS_VERSION=5.1.5 TEST_RAILS_API=true"
+matrix:
+  exclude:
+    - rvm: 2.7
+      gemfile: gemfiles/4.2.gemfile
+    - rvm: 2.7
+      gemfile: gemfiles/4.2.api.gemfile

data/Gemfile

@@ -10,7 +10,7 @@ else
   gem 'mysql2', '>= 0.3.13', '< 0.5'
 end
 gem 'pg', '~> 0.15'
-gem 'sqlite3'
+gem 'sqlite3', '~> 1.3.6'
 
 rails = case version
 when "master"
@@ -24,3 +24,7 @@ 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'
+end

data/README.md

@@ -56,6 +56,8 @@ Optionally, you can set the application name shown in the log like so in an init
 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.
 
+#### 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:
 
@@ -100,6 +102,37 @@ With ActiveRecord >= 3.2.19:
 
 Pull requests for other included comment components are welcome.
 
+#### 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
+block-based API.
+
+For example, the following code:
+
+    Marginalia.with_annotation("foo") do
+      Account.where(queenbee_id: 1234567890).first
+    end
+
+will issue this query:
+
+    Account Load (0.3ms)  SELECT `accounts`.* FROM `accounts`
+    WHERE `accounts`.`queenbee_id` = 1234567890
+    LIMIT 1
+    /*application:BCX,controller:project_imports,action:show*/ /*foo*/
+
+Nesting `with_annotation` blocks will concatenate the comment strings.
+
 ## Contributing
 
 Start by bundling and creating the test database:

data/gemfiles/4.2.api.gemfile

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,8 @@
+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/lib/marginalia.rb

@@ -1,5 +1,6 @@
 require 'marginalia/railtie'
 require 'marginalia/comment'
+require 'marginalia/sidekiq_instrumentation'
 
 module Marginalia
   mattr_accessor :application_name
@@ -48,10 +49,22 @@ module Marginalia
       Marginalia::Comment.update_adapter!(self)
       comment = Marginalia::Comment.construct_comment
       if comment.present? && !sql.include?(comment)
-        "#{sql} /*#{comment}*/"
-      else
-        sql
+        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.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)
@@ -63,9 +76,9 @@ module Marginalia
     end
 
     if ActiveRecord::VERSION::MAJOR >= 5
-      def exec_query_with_marginalia(sql, name = 'SQL', binds = [], options = {})
+      def exec_query_with_marginalia(sql, name = 'SQL', binds = [], **options)
         options[:prepare] ||= false
-        exec_query_without_marginalia(annotate_sql(sql), name, binds, options)
+        exec_query_without_marginalia(annotate_sql(sql), name, binds, **options)
       end
     end
 
@@ -77,9 +90,15 @@ module Marginalia
       exec_update_without_marginalia(annotate_sql(sql), name, binds)
     end
 
-    def execute_and_clear_with_marginalia(sql, *args, &block)
-      execute_and_clear_without_marginalia(annotate_sql(sql), *args, &block)
+if ActiveRecord::VERSION::MAJOR >= 5
+    def execute_and_clear_with_marginalia(sql, *args, **kwargs, &block)
+      execute_and_clear_without_marginalia(annotate_sql(sql), *args, **kwargs, &block)
     end
+ else
+   def execute_and_clear_with_marginalia(sql, *args, &block)
+     execute_and_clear_without_marginalia(annotate_sql(sql), *args, &block)
+   end
+ end
   end
 
   module ActionControllerInstrumentation
@@ -100,4 +119,11 @@ module Marginalia
       Marginalia::Comment.clear!
     end
   end
+
+  def self.with_annotation(comment, &block)
+    Marginalia::Comment.inline_annotations.push(comment)
+    block.call if block.present?
+  ensure
+    Marginalia::Comment.inline_annotations.pop
+  end
 end

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!
@@ -30,6 +32,11 @@ module Marginalia
       ret
     end
 
+    def self.construct_inline_comment
+      return nil if inline_annotations.none?
+      escape_sql_comment(inline_annotations.join)
+    end
+
     def self.escape_sql_comment(str)
       while str.include?('/*') || str.include?('*/')
         str = str.gsub('/*', '').gsub('*/', '')
@@ -96,8 +103,15 @@ module Marginalia
         marginalia_controller.action_name if marginalia_controller.respond_to? :action_name
       end
 
+      def self.sidekiq_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
@@ -154,6 +168,10 @@ module Marginalia
           marginalia_adapter.pool.spec.config
         end
       end
+
+      def self.inline_annotations
+        Thread.current[:marginalia_inline_annotations] ||= []
+      end
   end
 
 end

data/lib/marginalia/sidekiq_instrumentation.rb

@@ -0,0 +1,25 @@
+module Marginalia
+
+  # Alternative to ActiveJob Instrumentation for Sidekiq.
+  # Apt for Instrumenting Sidekiq with Rails version < 4.2.
+  module SidekiqInstrumentation
+
+    class Middleware
+      def call(worker, msg, queue)
+        Marginalia::Comment.update_job! msg
+        yield
+      ensure
+        Marginalia::Comment.clear_job!
+      end
+    end
+
+    def self.enable!
+      Sidekiq.configure_server do |config|
+        config.server_middleware do |chain|
+          chain.add Marginalia::SidekiqInstrumentation::Middleware
+        end
+      end
+    end
+  end
+
+end

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,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test}/*`.split("\n")
   gem.name          = "marginalia"
   gem.require_paths = ["lib"]
-  gem.version       = "1.6.0"
+  gem.version       = "1.10.0"
   gem.license       = "MIT"
 
   gem.add_runtime_dependency "actionpack", ">= 2.3"
@@ -19,8 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "sqlite3"
   gem.add_development_dependency "minitest"
   gem.add_development_dependency "mocha"
+  gem.add_development_dependency "sidekiq"
 
   gem.summary = gem.description = %q{Attach comments to your ActiveRecord queries.}
-
-  gem.extensions = ["ext/mkrf_conf.rb"]
 end

data/test/query_comments_test.rb

@@ -23,6 +23,8 @@ require 'logger'
 require 'pp'
 require 'active_record'
 require 'action_controller'
+require 'sidekiq'
+require 'sidekiq/testing'
 
 if request_id_available?
   require 'action_dispatch/middleware/request_id'
@@ -87,6 +89,13 @@ if active_job_available?
   end
 end
 
+class PostsSidekiqJob
+  include Sidekiq::Worker
+  def perform
+    Post.first
+  end
+end
+
 if using_rails_api?
   class PostsApiController < ActionController::API
     def driver_only
@@ -112,6 +121,7 @@ class MarginaliaTest < MiniTest::Test
       @queries << args.last[:sql]
     end
     @env = Rack::MockRequest.env_for('/')
+    ActiveJob::Base.queue_adapter = :inline
   end
 
   def test_double_annotate
@@ -206,6 +216,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)
@@ -273,6 +293,33 @@ class MarginaliaTest < MiniTest::Test
       Post.first
       refute_match %{job:PostsJob}, @queries.last
     end
+
+    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
+  end
+
+  def test_sidekiq_job
+    Marginalia::Comment.components = [:sidekiq_job]
+    Marginalia::SidekiqInstrumentation.enable!
+
+    # Test harness does not run Sidekiq middlewares by default so include testing middleware.
+    Sidekiq::Testing.server_middleware do |chain|
+      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
 
   def test_good_comment
@@ -284,6 +331,53 @@ class MarginaliaTest < MiniTest::Test
     assert_equal Marginalia::Comment.escape_sql_comment('**//; DROP TABLE USERS;/*'), '; DROP TABLE USERS;'
   end
 
+  def test_inline_annotations
+    Marginalia.with_annotation("foo") do
+      Post.first
+    end
+    Post.first
+    assert_match %r{/\*foo\*/$}, @queries.first
+    refute_match %r{/\*foo\*/$}, @queries.last
+    # Assert we're not adding an empty comment, either
+    refute_match %r{/\*\s*\*/$}, @queries.last
+  end
+
+  def test_nested_inline_annotations
+    Marginalia.with_annotation("foo") do
+      Marginalia.with_annotation("bar") do
+        Post.first
+      end
+    end
+    assert_match %r{/\*foobar\*/$}, @queries.first
+  end
+
+  def test_bad_inline_annotations
+    Marginalia.with_annotation("*/; DROP TABLE USERS;/*") do
+      Post.first
+    end
+    Marginalia.with_annotation("**//; DROP TABLE USERS;//**") do
+      Post.first
+    end
+    assert_match %r{/\*; DROP TABLE USERS;\*/$}, @queries.first
+    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.6.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Noah Lorang
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2021-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -124,13 +124,25 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Attach comments to your ActiveRecord queries.
 email:
-- noah@37signals.com
 - arthurnn@github.com
 executables: []
-extensions:
-- ext/mkrf_conf.rb
+extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
@@ -140,11 +152,16 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- ext/mkrf_conf.rb
+- 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
+- lib/marginalia/sidekiq_instrumentation.rb
 - marginalia.gemspec
 - test/query_comments_test.rb
 homepage: https://github.com/basecamp/marginalia
@@ -166,8 +183,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.0.3
 signing_key: 
 specification_version: 4
 summary: Attach comments to your ActiveRecord queries.

data/ext/mkrf_conf.rb

@@ -1,21 +0,0 @@
-require 'rubygems'
-require 'rubygems/command.rb'
-require 'rubygems/dependency_installer.rb'
-
-begin
-  Gem::Command.build_args = ARGV
-  rescue NoMethodError
-end
-
-installer = Gem::DependencyInstaller.new
-begin
-  if RUBY_VERSION < "2.4"
-    installer.install "mysql", ">=0"
-  end
-rescue
-  exit(1)
-end
-
-f = File.open(File.join(File.dirname(__FILE__), "Rakefile"), "w")
-f.write("task :default\n")
-f.close