active_record-sql_analyzer 0.0.5

data/spec/active_record/sql_analyzer/redacted_logger_spec.rb

@@ -0,0 +1,67 @@
+RSpec.describe ActiveRecord::SqlAnalyzer::RedactedLogger do
+  let(:tmp_dir) { Dir.mktmpdir }
+  after { FileUtils.remove_entry(tmp_dir) }
+
+  context "#filter_event" do
+    let(:event) { {} }
+
+    subject(:filter_event) do
+      instance = described_class.new(tmp_dir, "foo")
+      instance.filter_event(event)
+      event
+    end
+
+    before do
+      ActiveRecord::SqlAnalyzer.configure do |c|
+        c.add_backtrace_redactors [
+          [/erb_erb_[0-9]+_[0-9]+/, ""]
+        ]
+      end
+    end
+
+    context "ambiguous backtraces" do
+      let(:event) do
+        {
+          caller: %w(ambiguous foo bar),
+          sql: ""
+        }
+      end
+
+      before do
+        ActiveRecord::SqlAnalyzer.configure do |c|
+          c.add_ambiguous_tracers [/ambiguous/]
+        end
+      end
+
+      it "switches to ambiguous backtrace logging" do
+        expect(filter_event[:caller]).to eq("ambiguous, foo, bar")
+      end
+    end
+
+    context "backtrace" do
+      let(:event) do
+        {
+          caller: %w(foo-bar-erb_erb_1_5),
+          sql: ""
+        }
+      end
+
+      it "redacts" do
+        expect(filter_event[:caller]).to eq("foo-bar-")
+      end
+    end
+
+    context "sql" do
+      let(:event) do
+        {
+          caller: [""],
+          sql: "SELECT * FROM foo WHERE id = 1234"
+        }
+      end
+
+      it "redacts" do
+        expect(filter_event[:sql]).to eq("SELECT * FROM foo WHERE id = [REDACTED]")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require "rspec"
+require "active_record"
+require "timecop"
+require "tmpdir"
+require "support/db_connection"
+require "support/stub_rails"
+require "support/wait_for_pop"
+require "active_record/sql_analyzer.rb"
+
+DBConnection.setup_db
+ActiveRecord::SqlAnalyzer.install!
+
+RSpec.configure do |c|
+  c.disable_monkey_patching!
+
+  c.before :each do
+    DBConnection.reset
+  end
+
+  c.after :each do
+    # Try and reset our state to something a bit fresher
+    if ActiveRecord::SqlAnalyzer.config
+      thread = ActiveRecord::SqlAnalyzer.background_processor.instance_variable_get(:@thread)
+      thread.terminate if thread
+
+      ActiveRecord::SqlAnalyzer.config[:analyzers].each do |analyzer|
+        analyzer[:logger_instance].close
+      end
+
+      ActiveRecord::SqlAnalyzer.instance_variable_set(:@background_processor, nil)
+      ActiveRecord::SqlAnalyzer.instance_variable_set(:@config, nil)
+    end
+  end
+end

data/spec/support/db_connection.rb

@@ -0,0 +1,65 @@
+class DBConnection
+  def self.db
+    @db ||= ActiveRecord::Base.establish_connection(
+      configuration.merge(database: 'ar_sql_analyzer_test')
+    )
+  end
+
+  def self.connection
+    db.connection
+  end
+
+  def self.configuration
+    {
+      adapter: 'mysql2',
+      host: 'localhost',
+      encoding: 'utf8',
+      usernamme: ENV["TRAVIS"] ? "travis" : "root"
+    }
+  end
+
+  def self.setup_db
+    conn = ActiveRecord::Base.establish_connection(configuration)
+    conn.connection.execute <<-SQL
+      CREATE DATABASE IF NOT EXISTS ar_sql_analyzer_test
+    SQL
+  end
+
+  def self.reset
+    connection.execute <<-SQL
+      DROP TABLE IF EXISTS matching_table
+    SQL
+
+    connection.execute <<-SQL
+      CREATE TABLE `matching_table` (
+        `id` int(11) NOT NULL AUTO_INCREMENT,
+        `test_string` varchar(255) DEFAULT NULL,
+        PRIMARY KEY (`id`)
+      ) ENGINE=InnoDB DEFAULT CHARSET=utf8
+    SQL
+
+    connection.execute <<-SQL
+      DROP TABLE IF EXISTS second_matching_table
+    SQL
+
+    connection.execute <<-SQL
+      CREATE TABLE `second_matching_table` (
+        `id` int(11) NOT NULL AUTO_INCREMENT,
+        `test_string` varchar(255) DEFAULT NULL,
+        PRIMARY KEY (`id`)
+      ) ENGINE=InnoDB DEFAULT CHARSET=utf8
+    SQL
+
+    connection.execute <<-SQL
+      DROP TABLE IF EXISTS nonmatching_table
+    SQL
+
+    connection.execute <<-SQL
+      CREATE TABLE `nonmatching_table` (
+        `id` int(11) NOT NULL AUTO_INCREMENT,
+        `test_string` varchar(255) DEFAULT NULL,
+        PRIMARY KEY (`id`)
+      ) ENGINE=InnoDB DEFAULT CHARSET=utf8
+    SQL
+  end
+end

data/spec/support/stub_logger.rb

@@ -0,0 +1,9 @@
+class Rails
+  def self.root
+    @root ||= Pathname.new(File.expand_path('../../', __FILE__)).freeze
+  end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+end

data/spec/support/stub_rails.rb

@@ -0,0 +1,9 @@
+class Rails
+  def self.root
+    @root ||= Pathname.new(File.expand_path('../../', __FILE__)).freeze
+  end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+end

data/spec/support/wait_for_pop.rb

@@ -0,0 +1,13 @@
+module WaitForPop
+  # This is trying to work around race conditions in a semi-sane manner
+  def wait_for_pop
+    queue = ActiveRecord::SqlAnalyzer.background_processor.instance_variable_get(:@queue)
+
+    4.times do
+      return sleep 0.1 if queue.empty?
+      sleep 0.05
+    end
+
+    raise "Queue failed to drain in 0.2 seconds"
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: active_record-sql_analyzer
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Zachary Anker
+- Gabriel Gilder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: ActiveRecord query logger and analyzer
+email:
+- zanker@squareup.com
+- gabriel@squareup.com
+executables:
+- ar-log-analyzer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- active_record-sql_analyzer.gemspec
+- bin/ar-log-analyzer
+- lib/active_record/sql_analyzer.rb
+- lib/active_record/sql_analyzer/analyzer.rb
+- lib/active_record/sql_analyzer/background_processor.rb
+- lib/active_record/sql_analyzer/backtrace_filter.rb
+- lib/active_record/sql_analyzer/cli.rb
+- lib/active_record/sql_analyzer/cli_processor.rb
+- lib/active_record/sql_analyzer/compact_logger.rb
+- lib/active_record/sql_analyzer/configuration.rb
+- lib/active_record/sql_analyzer/logger.rb
+- lib/active_record/sql_analyzer/monkeypatches/query.rb
+- lib/active_record/sql_analyzer/monkeypatches/tagger.rb
+- lib/active_record/sql_analyzer/redacted_logger.rb
+- lib/active_record/sql_analyzer/redactor.rb
+- lib/active_record/sql_analyzer/version.rb
+- spec/active_record/sql_analyzer/analyzer_spec.rb
+- spec/active_record/sql_analyzer/background_processor_spec.rb
+- spec/active_record/sql_analyzer/backtrace_filter_spec.rb
+- spec/active_record/sql_analyzer/cli_processor_spec.rb
+- spec/active_record/sql_analyzer/cli_spec.rb
+- spec/active_record/sql_analyzer/end_to_end_spec.rb
+- spec/active_record/sql_analyzer/redacted_logger_spec.rb
+- spec/spec_helper.rb
+- spec/support/db_connection.rb
+- spec/support/stub_logger.rb
+- spec/support/stub_rails.rb
+- spec/support/wait_for_pop.rb
+homepage: https://github.com/square/active_record-sql_analyzer
+licenses:
+- Apache License 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Logs a subset of ActiveRecord queries and dumps them for analyses.
+test_files:
+- spec/active_record/sql_analyzer/analyzer_spec.rb
+- spec/active_record/sql_analyzer/background_processor_spec.rb
+- spec/active_record/sql_analyzer/backtrace_filter_spec.rb
+- spec/active_record/sql_analyzer/cli_processor_spec.rb
+- spec/active_record/sql_analyzer/cli_spec.rb
+- spec/active_record/sql_analyzer/end_to_end_spec.rb
+- spec/active_record/sql_analyzer/redacted_logger_spec.rb
+- spec/spec_helper.rb
+- spec/support/db_connection.rb
+- spec/support/stub_logger.rb
+- spec/support/stub_rails.rb
+- spec/support/wait_for_pop.rb