dblint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a456608b04d3132f18e4c9de00ab708d799e0373
+  data.tar.gz: 17a007e706e33f5d7a72406d8c98dfebe3783c8d
+SHA512:
+  metadata.gz: fe6ca2ea60ab241e5e680751ad05c96bf58045f0a0fa947812f4add848264dbc3f55adade3e92b041715d2a252ec6a1d5a34b074603998373124518c5f836caf
+  data.tar.gz: 838612d7f6f26f839228a115c5168ff00dc23ee9098de039dfa5c098e7f3164f31b38d3f4f15fddd62e166eed72ab92e374f5ae4f52fef4f0f8b1fd73e405a5a

data/.env.example

@@ -0,0 +1 @@
+DATABASE_URL=postgresql://user@localhost:5432/dblint

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/.env
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,26 @@
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - spec/**/*
+
+Documentation:
+  Enabled: false
+
+LineLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lukas Fittl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# dblint [ ![Codeship Status for lfittl/dblint](https://img.shields.io/codeship/db703270-cfa3-0132-a2bb-623bdb9b8d89.svg)](https://codeship.com/projects/76752)
+
+Automatically checks all SQL queries that are executed during your tests, to find common mistakes, including missing indices and locking issues due to long transactions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dblint', group: :test
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Run your tests as usual, `dblint` will raise an exception or output a warning should it detect a problem.
+
+Note that it will check the callstack for the problematic query, and only count it as an error if the callstack first line from within your app is not the `test` or `spec` directory. Therefore, should you use non-optimized code directly in your tests (e.g. as part of a factory), `dblint` will not raise an error.
+
+## Missing indices
+
+`dblint` will find SELECT queries that might be missing an index:
+
+```
+Failures:
+
+  1) FeedsController#show 
+     Failure/Error: get :show, format: :atom
+     Dblint::Checks::MissingIndex::Error:
+       Missing index on oauth_applications for '((twitter_app_name)::text = 'My Feed App'::text)' in 'SELECT  "oauth_applications".* FROM "oauth_applications" WHERE "oauth_applications"."twitter_app_name" = $1 LIMIT 1', called by app/controllers/feeds_controller.rb:6:in `show'
+     # ./app/controllers/feeds_controller.rb:6:in `show'
+     # ./spec/controllers/feeds_controller_spec.rb:12:in `block (3 levels) in <top (required)>'
+     # ./spec/spec_helper.rb:78:in `block (2 levels) in <top (required)>'
+```
+
+This is done by `EXPLAIN`ing every SELECT statement run during your tests, and checking whether the execution plan contains a Sequential Scan that is filtered by a condition. Thus, if you were to do a count of all records, this check would not trigger.
+
+Nonetheless, there might still be false positives or simply cases where you don't want an index - use the ignore list in those cases.
+
+Note: `EXPLAIN` is run with `enable_seqscan = off` in order to avoid seeing a false positive Sequential Scan on indexed, but small tables (likely to happen with tests).
+
+## Long held locks
+
+`dblint` will find long held locks in database transactions, causing delays and possibly deadlocks:
+
+```
+  1) Invites::AcceptInvite test
+     Failure/Error: described_class.call(user: invited_user)
+     Dblint::LongHeldLock:
+       Lock on ["users", 3] held for 29 statements (0.13 ms) by 'UPDATE "users" SET "invited_by_id" = $1, "role" = $2, "updated_at" = $3 WHERE "users"."id" = $4', transaction started by app/services/invites/accept_invite.rb:20:in `run'
+     # ./app/services/invites/accept_invite.rb:20:in `run'
+     # ./app/services/invites/accept_invite.rb:7:in `call'
+     # ./spec/services/invites/accept_invite_spec.rb:8:in `accept_invite'
+     # ./spec/services/invites/accept_invite_spec.rb:64:in `block (3 levels) in <top (required)>'
+     # ./spec/spec_helper.rb:78:in `block (2 levels) in <top (required)>'
+```
+
+In this case it means that the `users` row has been locked for 29 statements (which took `0.13ms` in test, but this would be much more on any cloud setup), which can lead to lock contention issues on the `users` table, assuming other transactions are also updating that same row.
+
+The correct fix for this depends on whether this is in user written code (i.e. a manual `ActiveRecord::Base.transaction` call), or caused by Rails built-ins like `touch: true` and `counter_cache: true`. In general you want to move that `UPDATE` to happen towards the end of the transaction, or move it completely outside (if you don't need the atomicity guarantee of the transaction).
+
+Note: Right now the lock check can't detect possible problems caused by non-DB activities (e.g. updating your search index inside the transaction).
+
+## Ignoring false positives
+
+Since in some cases there might be a valid reason to not have an index, or to hold a lock for longer,
+you can add ignores to the `.dblint.yml` file like this:
+
+```
+IgnoreList:
+  MissingIndex:
+    # Explain why you ignore it
+    - app/models/my_model.rb:20:in `load'
+  LongHeldLock:
+    # Explain why you ignore it
+    - app/models/my_model.rb:20:in `load'
+```
+
+The line you need to add is the first caller in the callstack from your main
+application, also included in the error message for the check.
+
+## Contributing
+
+1. Fork it ( https://github.com/lfittl/dblint/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'dotenv/tasks'
+
+RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
+
+task default: [:lint, :spec]
+task test: :spec
+task lint: :rubocop

data/dblint.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dblint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dblint'
+  spec.version       = Dblint::VERSION
+  spec.authors       = ['Lukas Fittl']
+  spec.email         = ['lukas@fittl.com']
+
+  spec.summary       = 'Automatically tests your Rails app for common database query mistakes'
+  spec.homepage      = 'https://github.com/lfittl/dblint'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activerecord', '>= 4.0'
+  spec.add_runtime_dependency 'railties', '>= 4.0'
+  spec.add_runtime_dependency 'pg'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'rubocop', '~> 0.30'
+  spec.add_development_dependency 'rubocop-rspec'
+end

data/lib/dblint/checks/base.rb

@@ -0,0 +1,33 @@
+require 'active_support/core_ext/string/inflections'
+
+module Dblint
+  module Checks
+    class Base
+      def check_name
+        self.class.name.demodulize
+      end
+
+      def find_main_app_caller(callstack)
+        main_app_caller = callstack.find { |f| f.start_with?(Rails.root.to_s) }
+        main_app_caller.slice!(Rails.root.to_s + '/')
+        main_app_dir    = main_app_caller[/^\w+/]
+        return if %w(spec test).include?(main_app_dir)
+        main_app_caller
+      end
+
+      def ignored?(main_app_caller)
+        return false unless config && config['IgnoreList']
+
+        ignores = config['IgnoreList'][check_name]
+        ignores.present? && ignores.include?(main_app_caller)
+      end
+
+      def config
+        @config ||= begin
+          config_file = Rails.root.join('.dblint.yml')
+          YAML.load(File.read(config_file)) if File.exist?(config_file)
+        end
+      end
+    end
+  end
+end

data/lib/dblint/checks/long_held_lock.rb

@@ -0,0 +1,94 @@
+module Dblint
+  module Checks
+    class LongHeldLock < Base
+      class Error < StandardError; end
+
+      def initialize
+        @locks_held = {}
+        @existing_ids = {}
+      end
+
+      def statement_started(_name, _id, _payload)
+        # Ignored
+      end
+
+      def statement_finished(_name, _id, payload)
+        if payload[:sql] == 'BEGIN'
+          handle_begin
+        elsif payload[:sql] == 'COMMIT'
+          handle_commit
+        elsif payload[:sql] == 'ROLLBACK'
+          # do nothing
+        elsif @existing_ids.present?
+          increment_locks_held
+          add_new_locks_held(payload)
+        end
+      end
+
+      private
+
+      def increment_locks_held
+        @locks_held.each do |_, lock|
+          lock[:count] += 1
+        end
+      end
+
+      def add_new_locks_held(payload)
+        locked_table = payload[:sql].match(/^UPDATE\s+"?([\w.]+)"?/i).try(:[], 1)
+
+        return unless locked_table.present?
+
+        bind = payload[:binds].find { |b| b[0].name == 'id' }
+        return unless bind.present?
+
+        tuple = [locked_table, bind[1]]
+
+        # We only want tuples that were not created in this transaction
+        existing_ids = @existing_ids[tuple[0]]
+        return unless existing_ids.present? && existing_ids.include?(tuple[1])
+
+        # We've done two UPDATEs to the same row in this transaction
+        return if @locks_held[tuple].present?
+
+        @locks_held[tuple] = {}
+        @locks_held[tuple][:sql]   = payload[:sql]
+        @locks_held[tuple][:count] = 0
+        @locks_held[tuple][:started_at] = Time.now
+      end
+
+      def handle_begin
+        @locks_held = {}
+        @existing_ids = {}
+
+        ActiveRecord::Base.connection.tables.each do |table|
+          next if table == 'schema_migrations'
+          @existing_ids[table] = ActiveRecord::Base.connection.select_values("SELECT id FROM #{table}", 'DBLINT').map(&:to_i)
+        end
+      end
+
+      def handle_commit
+        @locks_held.each do |table, details|
+          next if details[:count] < 10
+
+          main_app_caller = find_main_app_caller(caller)
+          next unless main_app_caller.present?
+
+          next if ignored?(main_app_caller)
+
+          error_msg = format("Lock on %s held for %d statements (%0.2f ms) by '%s', transaction started by %s",
+                             table.inspect, details[:count], Time.now - details[:started_at], details[:sql],
+                             main_app_caller)
+
+          next unless details[:count] > 15
+
+          # We need an explicit begin here since we're interrupting the transaction flow
+          ActiveRecord::Base.connection.execute('BEGIN')
+          fail Error, error_msg
+
+          # TODO: Add a config setting for enabling this as a warning
+          # puts format('Warning: %s', error_msg)
+        end
+      end
+    end
+  end
+end

data/lib/dblint/checks/missing_index.rb

@@ -0,0 +1,46 @@
+module Dblint
+  module Checks
+    class MissingIndex < Base
+      class Error < StandardError; end
+
+      def statement_started(_name, _id, payload)
+        return if payload[:sql].include?(';')
+        return unless payload[:sql].starts_with?('SELECT')
+
+        ActiveRecord::Base.connection.execute 'SET enable_seqscan = off', 'DBLINT'
+        plan = explain(payload)
+        raise_on_seqscan(plan[0]['Plan'], payload)
+        ActiveRecord::Base.connection.execute 'SET enable_seqscan = on', 'DBLINT'
+      end
+
+      def statement_finished(_name, _id, _payload)
+        # Ignored
+      end
+
+      private
+
+      def explain(payload)
+        plan = ActiveRecord::Base.connection.select_value(format('EXPLAIN (FORMAT JSON) %s', payload[:sql]),
+                                                          'DBLINT', payload[:binds])
+        JSON.parse(plan)
+      end
+
+      def raise_on_seqscan(plan, payload)
+        if plan['Node Type'] == 'Seq Scan' && plan['Filter'].present?
+          main_app_caller = find_main_app_caller(caller)
+          return unless main_app_caller.present?
+
+          return if ignored?(main_app_caller)
+
+          error_msg = format("Missing index on %s for '%s' in '%s', called by %s",
+                             plan['Relation Name'], plan['Filter'], payload[:sql], main_app_caller)
+          fail Error, error_msg
+        end
+
+        (plan['Plans'] || []).each do |subplan|
+          raise_on_seqscan(subplan, payload)
+        end
+      end
+    end
+  end
+end

data/lib/dblint/rails_integration.rb

@@ -0,0 +1,36 @@
+require 'active_support/notifications'
+
+module Dblint
+  class RailsIntegration
+    CHECKS = [
+      Dblint::Checks::LongHeldLock,
+      Dblint::Checks::MissingIndex
+    ]
+
+    def check_instance_for_connection(connid, klass)
+      @checks ||= {}
+      @checks[connid] ||= {}
+      @checks[connid][klass] ||= klass.new
+    end
+
+    def start(name, id, payload)
+      return if %w(CACHE DBLINT SCHEMA).include?(payload[:name])
+
+      CHECKS.each do |check_klass|
+        check = check_instance_for_connection(payload[:connection_id], check_klass)
+        check.statement_started(name, id, payload)
+      end
+    end
+
+    def finish(name, id, payload)
+      return if %w(CACHE DBLINT SCHEMA).include?(payload[:name])
+
+      CHECKS.each do |check_klass|
+        check = check_instance_for_connection(payload[:connection_id], check_klass)
+        check.statement_finished(name, id, payload)
+      end
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe('sql.active_record', RailsIntegration.new)
+end

data/lib/dblint/version.rb

@@ -0,0 +1,3 @@
+module Dblint
+  VERSION = '0.1.0'
+end

data/lib/dblint.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+
+require 'dblint/version'
+
+require 'dblint/checks/base'
+require 'dblint/checks/long_held_lock'
+require 'dblint/checks/missing_index'
+
+require 'dblint/rails_integration'

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: dblint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lukas Fittl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-04 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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: 
+email:
+- lukas@fittl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dblint.gemspec
+- lib/dblint.rb
+- lib/dblint/checks/base.rb
+- lib/dblint/checks/long_held_lock.rb
+- lib/dblint/checks/missing_index.rb
+- lib/dblint/rails_integration.rb
+- lib/dblint/version.rb
+homepage: https://github.com/lfittl/dblint
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 4
+summary: Automatically tests your Rails app for common database query mistakes
+test_files: []