marginalia 1.7.0 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: da6b70d12c22d141f4283d2e99b5550afaf8da14
-  data.tar.gz: fb2a34d6aee5b051fc9611ba792f4c14a50b2e9b
+SHA256:
+  metadata.gz: 8dba7f58a767008578f36af3a2bedc77139f11b62025e1dcd022c1ebd3658c3c
+  data.tar.gz: 9d4728cbc7b673514cce7076a60c28592646fbc68ac59d8310c7ebe3aa71eac6
 SHA512:
-  metadata.gz: af483022b150c72a218aa51dadb6db0865272cd81faa53db211b1b08e81a0b18b560908e92f553e93eb8b0d47029bd927f6fe6e61c811ab11e9d4b63339bed9d
-  data.tar.gz: e688057959cfd654dc027f03b1a8720ad21c90113d5478d18ed6897d5e4ab0a21297e703cfca85275e5d4495bce0e354acd9612f97f395cad6b1c70cdb39c8fa
+  metadata.gz: 35dfdc97e0745484719266a9c616c257072dfbdf0ee8ff6b4c7055d051510a562bf12d863eae670c382f14eda7ba895f4a988baa031ea43904fd9a2a31fd7c0e
+  data.tar.gz: 3fbfdeacc57e3a8e78490e991527610a3249c0b3e748de7410a427e9e085e6b420a12d916b0c15d87a7240743a81e9be14727508743d25d7cc82d850924ad126

data/.ruby-version

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

data/.travis.yml

@@ -1,10 +1,21 @@
 language: ruby
 sudo: false
 
+services:
+  - mysql
+  - postgresql
+
 rvm:
   - 2.2
   - 2.3
   - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+
+services:
+  - mysql
+  - postgresql
 
 script: "bundle exec rake db:reset test:all"
 
@@ -14,3 +25,10 @@ gemfile:
   - gemfiles/5.0.gemfile
   - gemfiles/5.1.gemfile
   - gemfiles/5.2.gemfile
+
+matrix:
+  exclude:
+    - rvm: 2.7
+      gemfile: gemfiles/4.2.gemfile
+    - rvm: 2.7
+      gemfile: gemfiles/4.2.api.gemfile

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,7 +102,17 @@ With ActiveRecord >= 3.2.19:
 
 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

data/lib/marginalia.rb

@@ -49,41 +49,61 @@ 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)
+    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)
 
-    def exec_query_with_marginalia(sql, name = 'SQL', binds = [])
-      exec_query_without_marginalia(annotate_sql(sql), name, binds)
+    def exec_query_with_marginalia(sql, *args)
+      exec_query_without_marginalia(annotate_sql(sql), *args)
     end
+    ruby2_keywords :exec_query_with_marginalia if respond_to?(:ruby2_keywords, true)
 
     if ActiveRecord::VERSION::MAJOR >= 5
-      def exec_query_with_marginalia(sql, name = 'SQL', binds = [], options = {})
+      def exec_query_with_marginalia(sql, *args, **options)
         options[:prepare] ||= false
-        exec_query_without_marginalia(annotate_sql(sql), name, binds, options)
+        exec_query_without_marginalia(annotate_sql(sql), *args, **options)
       end
     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)
 
+if ActiveRecord::VERSION::MAJOR >= 5
     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)
+ 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

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

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.7.0"
+  gem.version       = "1.10.1"
   gem.license       = "MIT"
 
   gem.add_runtime_dependency "actionpack", ">= 2.3"

data/test/query_comments_test.rb

@@ -121,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
@@ -215,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)
@@ -282,6 +293,15 @@ 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
@@ -290,13 +310,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 +362,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,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: marginalia
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.10.1
 platform: ruby
 authors:
 - Noah Lorang
 - Nick Quaranto
 - Taylor Weibley
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-15 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -140,7 +140,6 @@ dependencies:
         version: '0'
 description: Attach comments to your ActiveRecord queries.
 email:
-- noah@37signals.com
 - arthurnn@github.com
 executables: []
 extensions: []
@@ -169,7 +168,7 @@ homepage: https://github.com/basecamp/marginalia
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -184,9 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Attach comments to your ActiveRecord queries.
 test_files: []