marginalia 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 652f9d4885b38bec5a45af1fe9a6e2b32b2d0efe
-  data.tar.gz: 9f11163229b538432b7128497066dd8de3d7f06b
+  metadata.gz: d2bf4536bf33fce1b7c806d0b2fec3cbe221b166
+  data.tar.gz: ed2d7dfeac456ce8a9f63f5257e63e7d05526f6d
 SHA512:
-  metadata.gz: 338835145956ad4a5b83c73f0587d08646d6828377afe51ea6af8e5ec903bd6451c936114fd47fbd7191c8f20a5fba997f66bcc06e550125cb9ed33b230d7ec3
-  data.tar.gz: 0233a2cb61340a679f96fa9119e9c382121074c3b8874821e96b52952cee4c59c88a6f1efd7a983dbf9527b0e694f31f44dfb83e7ee74079eb40a0564bff5812
+  metadata.gz: 255f216a7e47faa1a4d5e36f38a922d6abca36ce2f3a9c3189f2849a50c543237c9be76c1bf8abe9064f1b97d0c9d78379883271405e3e3781359be22ec08ed3
+  data.tar.gz: 0983b7a057ecb4cf56cd031572d6f498c8906daf8b7f67b8a5d7a9e7944128d23d27f78b8020d93c52ef5f6670d127e1a1c47da4aee6d96df1a7b0104f65887f

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,12 +49,21 @@ 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.include?(inline_comment)
-        sql = "#{sql} /*#{inline_comment}*/"
+        sql = if Marginalia::Comment.prepend_comment
+          "/*#{inline_comment}*/ #{sql}"
+        else
+          "#{sql} /*#{inline_comment}*/"
+        end
       end
+
       sql
     end
 

data/lib/marginalia/comment.rb

@@ -2,7 +2,7 @@ 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)

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

data/test/query_comments_test.rb

@@ -348,6 +348,15 @@ class MarginaliaTest < MiniTest::Test
     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.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Noah Lorang
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-19 00:00:00.000000000 Z
+date: 2019-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack