marginalia 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bda214f48d77afb13f9c9182a550272d4e654c4f
-  data.tar.gz: 5d199a1edd3a808254824a2bb45e22deca536e22
+  metadata.gz: da6b70d12c22d141f4283d2e99b5550afaf8da14
+  data.tar.gz: fb2a34d6aee5b051fc9611ba792f4c14a50b2e9b
 SHA512:
-  metadata.gz: 7f7ee0ed6593d2a639c31787a559a86db0367b63ed79dde39966a4264904bbbd77d822e01be212ae40e7a573330281cb75489fc08e577c28e4d059712bcd2a86
-  data.tar.gz: 4963089d9d9609fd5dbdae17c36e6ed001cea24b81550febdf0826fc3fe13d574f34c8bb51a1ffc6b270e30ba68dd6c14b3d693cec8fcc6bfa4370d8fdee144a
+  metadata.gz: af483022b150c72a218aa51dadb6db0865272cd81faa53db211b1b08e81a0b18b560908e92f553e93eb8b0d47029bd927f6fe6e61c811ab11e9d4b63339bed9d
+  data.tar.gz: e688057959cfd654dc027f03b1a8720ad21c90113d5478d18ed6897d5e4ab0a21297e703cfca85275e5d4495bce0e354acd9612f97f395cad6b1c70cdb39c8fa

data/.travis.yml

@@ -1,18 +1,16 @@
 language: ruby
+sudo: false
 
 rvm:
-  - 2.3.1
-  - 2.4.4
-  - 2.5.1
-
-sudo: false
+  - 2.2
+  - 2.3
+  - 2.4
 
-script: bundle exec rake db:reset test:all
+script: "bundle exec rake db:reset test:all"
 
-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"
+gemfile:
+  - gemfiles/4.2.gemfile
+  - gemfiles/4.2.api.gemfile
+  - gemfiles/5.0.gemfile
+  - gemfiles/5.1.gemfile
+  - gemfiles/5.2.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

@@ -100,6 +100,27 @@ With ActiveRecord >= 3.2.19:
 
 Pull requests for other included comment components are welcome.
 
+## 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,13 @@ module Marginalia
       Marginalia::Comment.update_adapter!(self)
       comment = Marginalia::Comment.construct_comment
       if comment.present? && !sql.include?(comment)
-        "#{sql} /*#{comment}*/"
-      else
-        sql
+        sql = "#{sql} /*#{comment}*/"
       end
+      inline_comment = Marginalia::Comment.construct_inline_comment
+      if inline_comment.present?
+        sql = "#{sql} /*#{inline_comment}*/"
+      end
+      sql
     end
 
     def execute_with_marginalia(sql, name = nil)
@@ -100,4 +104,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

@@ -30,6 +30,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,6 +101,10 @@ module Marginalia
         marginalia_controller.action_name if marginalia_controller.respond_to? :action_name
       end
 
+      def self.sidekiq_job
+        marginalia_job["class"] if marginalia_job
+      end
+
       def self.line
         Marginalia::Comment.lines_to_ignore ||= /\.rvm|gem|vendor\/|marginalia|rbenv/
         last_line = caller.detect do |line|
@@ -154,6 +163,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

@@ -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.7.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
@@ -275,6 +284,23 @@ class MarginaliaTest < MiniTest::Test
     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
@@ -284,6 +310,37 @@ 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 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.7.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: 2019-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -124,13 +124,26 @@ 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 +153,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

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