sql_tracer 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af23a3259abebd3425188fe447b819f32ec9e7f5
-  data.tar.gz: 9db84e52fffe16f05c5967d9ca2e48d4a5f82711
+  metadata.gz: 5134ce3a708e62d524bfe5fd28c2ce93657a964f
+  data.tar.gz: 12db129a6e5c27b178712cc0ec85ecc40ba892ea
 SHA512:
-  metadata.gz: ca816309a83bdf9ae2abb7c3a24116c6093e959820e65dbf1ab6b148739fbc1a22365db9d93968b9b7c2f358aafa6ce4c4cf4ccc404f91746024a282f01fa92d
-  data.tar.gz: feb5dad7d36ff82215602ca9c233189ded04d15785da54b9876f5535076aa68fe50ac0660470b6802548c60e692b7081a87a03c6eed1ca519befac891f087b24
+  metadata.gz: 90ae4ff59999ae3ffba9a6d0bd8a86fd11af19d1b9fba722a6d9428dba2cc132a683078ae4dcc7abcab7e5841d257453050cf8f5dbb7a5511af6fe456429b170
+  data.tar.gz: 6b373a3605333c9f3a70c365c90d61e6263c5b5e2f3343797de21b2160360e81a743ae089a39745df9a1da5b5a94fedb219d3dcac552a492df1925cf68d06b4c

data/lib/sql_tracer/formatter.rb

@@ -0,0 +1,69 @@
+require 'anbt-sql-formatter/formatter'
+
+module SqlTracer
+  class Formatter
+    HEADER_PROMPT= '='*10 << '>'
+    FOOTER_PROMPT= '<' << '='*10
+    FORMATTER_CONFIG_TIP =
+<<-TIP
+  You can add config to ui_config.yml to acquire advanced features
+    SQL_TRACER_FORMAT_SQL_ENABLED   : true     # show formatted and colored sql
+    SQL_TRACER_FORMAT_STACK_ENABLED : false    # show colored paths
+    SQL_TRACER_SKIP_LIB             : false    # show all paths including the files in ruby gems
+TIP
+
+    def self.start_print
+      puts HEADER_PROMPT
+    end
+
+    def self.end_print
+      puts FOOTER_PROMPT
+    end
+
+    def self.print_tips
+      puts 'Tips:'
+      puts FORMATTER_CONFIG_TIP
+    end
+
+    def self.print_sql(sql)
+      puts 'SQL:'
+      return sql if sql.blank?
+      formatted_sql = '  ' << (Helper.format_sql_enabled? ? colorize(sql_formatter.format(sql.squeeze(' ')), 32) : sql)
+      puts formatted_sql
+    end
+
+    def self.print_backtrace(backtrace)
+      puts Helper.should_skip_lib? ? 'Backtrace: note that paths in ruby libs have been hidden' : 'Backtrace:'
+
+      stacktrace = backtrace.map do |call|
+        line = (call.include?('/.rvm/gems/') && Helper.should_skip_lib?) ? nil : call
+        line = format_line(line) if (line && Helper.format_stack_enabled?)
+        line
+      end
+      stacktrace.compact.each { |line| puts '  ' << line }
+    end
+
+    def self.sql_formatter
+      return @formatter if @formatter
+      rule = AnbtSql::Rule.new
+      rule.keyword = AnbtSql::Rule::KEYWORD_UPPER_CASE
+      rule.function_names += %w(count sum)
+      rule.indent_string = '  '
+      @formatter = AnbtSql::Formatter.new(rule)
+    end
+
+    def self.format_line(line)
+      parts = line.match(/^(?<file>.+):(?<line>\d+):in `(?<code>.*)'$/)
+      if parts
+        "#{colorize(parts[:file], 32)}:#{colorize(parts[:line], 36)}:#{colorize(parts[:code], 31)}"
+      else
+        "#{colorize(line, 32)}"
+      end
+    end
+
+    def self.colorize(text, color_code)
+      "\e[#{color_code}m#{text}\e[0m"
+    end
+
+  end
+end

data/lib/sql_tracer/helper.rb

@@ -0,0 +1,17 @@
+require 'anbt-sql-formatter/formatter'
+
+module SqlTracer
+  class Helper
+    def self.format_sql_enabled?
+      @format_sql_enabled ||= (UIConfig && UIConfig.get(:SQL_TRACER_FORMAT_SQL_ENABLED))
+    end
+
+    def self.format_stack_enabled?
+      @format_stack_enabled ||= (UIConfig && UIConfig.get(:SQL_TRACER_FORMAT_STACK_ENABLED))
+    end
+
+    def self.should_skip_lib?
+      @should_skip_lib ||= (UIConfig && UIConfig.get(:SQL_TRACER_SKIP_LIB)!=true)
+    end
+  end
+end

data/lib/sql_tracer/sql_logger.rb

@@ -0,0 +1,27 @@
+require 'anbt-sql-formatter/formatter'
+
+module SqlTracer
+  module SqlLogger
+    extend ActiveSupport::Concern
+    included do
+      alias_method :execute_without_sql_tracer, :execute
+
+      def execute(*args)
+        begin
+          sql = args.first
+          if sql =~ /^\s*(insert|update|delete)\s/i
+            Formatter.start_print
+            Formatter.print_sql(sql)
+            Formatter.print_backtrace(Thread.current.backtrace)
+            Formatter.print_tips
+            Formatter.end_print
+          end
+        rescue => e
+          Rails.logger.error "Failed to log sql in SqlTracer. Error: #{e.message}"
+          Rails.logger.error e.backtrace.join("\n")
+        end
+        execute_without_sql_tracer(*args)
+      end
+    end
+  end
+end

data/lib/sql_tracer.rb

@@ -1,28 +1,17 @@
-module SqlTracer
-  module SqlLogger
-
-    extend ActiveSupport::Concern
-
-    included do
-
-      alias_method :execute_without_stack, :execute
+require 'anbt-sql-formatter/formatter'
 
-      def execute(*args)
-        sql = args.first
-        if sql =~ /^\s*(insert|update|delete)\s/i
-          puts sql
-          puts Thread.current.backtrace.select { |path| !path.include?('/.rvm/gems/') }
-        end
-        execute_without_stack(*args)
-      end
-    end
-  end
+module SqlTracer
+  autoload :SqlLogger, 'sql_tracer/sql_logger'
+  autoload :Helper, 'sql_tracer/helper'
+  autoload :Formatter, 'sql_tracer/formatter'
 end
 
-ActiveSupport.on_load(:active_record) do
-  begin
-    require 'active_record/connection_adapters/mysql2_adapter'
-    ActiveRecord::ConnectionAdapters::Mysql2Adapter.send(:include, SqlTracer::SqlLogger)
-  rescue LoadError, NameError
-  end
+# why does not work when wrapped in block ActiveSupport.on_load(:active_record) do
+begin
+  require 'active_record/connection_adapters/mysql2_adapter'
+  ActiveRecord::ConnectionAdapters::Mysql2Adapter.send(:include, SqlTracer::SqlLogger)
+rescue LoadError, NameError => e
+  Rails.logger.error('Failed to injuect SqlTracer to ActiveRecord due to :' + e.message)
 end
+
+

metadata

@@ -1,16 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: sql_tracer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
-- UI
+- xiaoye
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-15 00:00:00.000000000 Z
-dependencies: []
-description: log sql and backtrace when execute sql
+date: 2017-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: anbt-sql-formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: log backtrace when sql is executed
 email:
 - eng-ui@freewheel.tv
 executables: []
@@ -18,6 +32,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/sql_tracer.rb
+- lib/sql_tracer/formatter.rb
+- lib/sql_tracer/helper.rb
+- lib/sql_tracer/sql_logger.rb
 homepage: http://git.dev.fwmrm.net/ui/ui
 licenses: []
 metadata: {}
@@ -40,5 +57,5 @@ rubyforge_project:
 rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
-summary: UI Redis Framework Extension
+summary: log backtrace when sql is executed
 test_files: []