marginalia 1.5.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4d1334e6fae088b614c33883053c675e8ce3208
-  data.tar.gz: ea48070a0ad0b210045ff6cc8eb485d9db115e3a
+SHA256:
+  metadata.gz: 31ba959aad96344c36a5044e5eed7affc9e837c1ebf6fefe204dc401e3c02cff
+  data.tar.gz: 5c84a52e9828ff87940bad7ca82ba495f59159fd2154793cc4eeafaacd47da50
 SHA512:
-  metadata.gz: 06d3dc8986bdfc70351ece60860aa79e4822f83e0cbcc0cb8211c9197dbf4fa8320f1017f15cbfa9aac40c296ae6a37f8054aa566fac832fe2f02d628d65d073
-  data.tar.gz: fdee2ee3f3e0bec89b52e54c22056811d7bd4e4cd167d6ef38e00446f25c16cc03f3cd730f4e8456a32ba67ff66b39046a2adb289acb0c9d4a8fc149b75957ba
+  metadata.gz: 422739201b1a3e455b233d37500795fb80c4d92e167e4f5c8b7f70a9ee9f5db510fcee7e6623cdea951a8c8db7929b0ce8fcf2fcc5f7fbc15af8c8cd2445a45a
+  data.tar.gz: f89615ffdfd2cdffe9cef3edabbaf7bc2a9f5fb4124ec03cb3b402a0a0f1368c1616ade7b2f8a18d2292324d9e63589a70b366f1fb1ec7bc72a4ce8a90f498e4

data/.travis.yml

@@ -1,21 +1,24 @@
 language: ruby
+sudo: false
+
+services:
+  - mysql
+  - postgresql
 
 rvm:
-  - 2.1
   - 2.2
-  - 2.3.1
+  - 2.3
+  - 2.4
 
-sudo: false
+services:
+  - mysql
+  - postgresql
 
-script: bundle exec rake db:reset test:all
+script: "bundle exec rake db:reset test:all"
 
-env:
-  - "RAILS_VERSION=3.1.12"
-  - "RAILS_VERSION=3.2.19"
-  - "RAILS_VERSION=4.0.8"
-  - "RAILS_VERSION=4.1.8"
-  - "RAILS_VERSION=4.2.0"
-  - "RAILS_VERSION=3.2.19 TEST_RAILS_API=true"
-  - "RAILS_VERSION=4.0.8 TEST_RAILS_API=true"
-  - "RAILS_VERSION=4.1.8 TEST_RAILS_API=true"
-  - "RAILS_VERSION=4.2.0 TEST_RAILS_API=true"
+gemfile:
+  - gemfiles/4.2.gemfile
+  - gemfiles/4.2.api.gemfile
+  - gemfiles/5.0.gemfile
+  - gemfiles/5.1.gemfile
+  - gemfiles/5.2.gemfile

data/Gemfile

@@ -9,6 +9,8 @@ if "4.2.5" > version
 else
   gem 'mysql2', '>= 0.3.13', '< 0.5'
 end
+gem 'pg', '~> 0.15'
+gem 'sqlite3', '~> 1.3.6'
 
 rails = case version
 when "master"
@@ -22,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/Rakefile

@@ -5,26 +5,26 @@ task :default => ['test:all']
 
 namespace :test do
   desc "test all drivers"
-  task :all => [:mysql, :mysql2, :postgresql, :sqlite]
+  task :all => [:mysql2, :postgresql, :sqlite]
 
   desc "test mysql driver"
   task :mysql do
-    sh "DRIVER=mysql ruby -Ilib -Itest test/*_test.rb"
+    sh "DRIVER=mysql bundle exec ruby -Ilib -Itest test/*_test.rb"
   end
 
   desc "test mysql2 driver"
   task :mysql2 do
-    sh "DRIVER=mysql2 ruby -Ilib -Itest test/*_test.rb"
+    sh "DRIVER=mysql2 bundle exec ruby -Ilib -Itest test/*_test.rb"
   end
-  
+
   desc "test PostgreSQL driver"
   task :postgresql do
-    sh "DRIVER=postgresql DB_USERNAME=postgres ruby -Ilib -Itest test/*_test.rb"
+    sh "DRIVER=postgresql DB_USERNAME=postgres bundle exec ruby -Ilib -Itest test/*_test.rb"
   end
-  
+
   desc "test sqlite3 driver"
   task :sqlite do
-    sh "DRIVER=sqlite3 ruby -Ilib -Itest test/*_test.rb"
+    sh "DRIVER=sqlite3 bundle exec ruby -Ilib -Itest test/*_test.rb"
   end
 end
 
@@ -62,5 +62,4 @@ namespace :db do
       sh 'psql -d postgres -U postgres -c "DROP DATABASE IF EXISTS marginalia_test"'
     end
   end
-
 end

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
 
@@ -100,4 +113,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,17 +20,30 @@ 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!
+      ret = self.escape_sql_comment(ret)
       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('*/', '')
+      end
+      str
+    end
+
     def self.clear!
       self.marginalia_controller = nil
     end
@@ -88,8 +103,13 @@ 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
+
       def self.line
-        Marginalia::Comment.lines_to_ignore ||= /\.rvm|gem|vendor\/|marginalia|rbenv/
+        Marginalia::Comment.lines_to_ignore ||= /\.rvm|gem|vendor\/|marginalia|rbenv|monitor\.rb.*mon_synchronize/
+
         last_line = caller.detect do |line|
           line !~ Marginalia::Comment.lines_to_ignore
         end
@@ -146,6 +166,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", "github@arthurnn.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,18 +8,18 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test}/*`.split("\n")
   gem.name          = "marginalia"
   gem.require_paths = ["lib"]
-  gem.version       = "1.5.0"
+  gem.version       = "1.9.0"
   gem.license       = "MIT"
 
   gem.add_runtime_dependency "actionpack", ">= 2.3"
   gem.add_runtime_dependency "activerecord", ">= 2.3"
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "mysql"
   gem.add_development_dependency "mysql2"
   gem.add_development_dependency "pg"
   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.}
 end

data/test/query_comments_test.rb

@@ -18,11 +18,13 @@ def adapter_pool_available?
 end
 
 require "minitest/autorun"
-require 'mocha/test_unit'
+require "mocha/minitest"
 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'
@@ -64,7 +66,11 @@ end
 class PostsController < ActionController::Base
   def driver_only
     ActiveRecord::Base.connection.execute "select id from posts"
-    render :nothing => true
+    if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('5')
+      render body: nil
+    else
+      render nothing: true
+    end
   end
 end
 
@@ -83,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
@@ -101,7 +114,6 @@ end
 
 Marginalia::Railtie.insert
 
-
 class MarginaliaTest < MiniTest::Test
   def setup
     @queries = []
@@ -109,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
@@ -270,6 +283,89 @@ 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
+    assert_equal Marginalia::Comment.escape_sql_comment('app:foo'), 'app:foo'
+  end
+
+  def test_bad_comments
+    assert_equal Marginalia::Comment.escape_sql_comment('*/; DROP TABLE USERS;/*'), '; DROP TABLE USERS;'
+    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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marginalia
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Noah Lorang
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-19 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -55,7 +55,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -69,7 +69,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -83,7 +83,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -97,7 +97,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -111,7 +111,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -125,7 +125,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -140,8 +140,7 @@ dependencies:
         version: '0'
 description: Attach comments to your ActiveRecord queries.
 email:
-- noah@37signals.com
-- github@arthurnn.com
+- arthurnn@github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -153,10 +152,16 @@ files:
 - 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
+- lib/marginalia/sidekiq_instrumentation.rb
 - marginalia.gemspec
 - test/query_comments_test.rb
 homepage: https://github.com/basecamp/marginalia
@@ -178,8 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Attach comments to your ActiveRecord queries.