performance_promise 1.0.1 → 1.0.2

data/README.md

@@ -55,7 +55,7 @@ PerformancePromise.configure do |config|
   # ]
   # config.untagged_methods_are_speedy = true
   # config.speedy_promise = {
-  #   :makes => 2,
+  #   :makes => 2.queries,
   # }
   # config.allowed_environments = [
   #   'development',
@@ -67,6 +67,13 @@ end
 PerformancePromise.start
 ```
 
+Then, extend your `ApplicationController` in `app/controllers/application_controller.rb`:
+```ruby
+class ApplicationController < ActionController::Base
+  extend MethodDecorators
+  ...
+```
+
 ## Usage
 To understand how to use `performance_promise`, let's use a simple [Blog App][rails-getting-started]. A `Blog` has `Article`s, each of which may have one or more `Comment`s.
 
@@ -78,7 +85,7 @@ class ArticlesController < ApplicationController
   end
 end
 ```
-Assuming your routes and views are setup, you should be able to succesfully visit `/articles`.
+Assuming your routes and views are setup, you should be able to successfully visit `/articles`.
 
 You can annotate this action with a promise of how many database queries the action will make so:
 ```ruby
@@ -144,7 +151,7 @@ And now, we've successfully caught and averted a bad code commit!
 By default, `performance_promise` runs only in `development` and `testing`. This ensures that you can identify issues when developing or running your test-suite. Be very careful about enabling this in `production` – you almost certainly don't want to.
 
 #### `throw_exception: bool`
-Tells `performance_promise` whether to throw an exception. Set to `true` by default, but can be overriden if you simply want to ignore failing cases (they will still be written to the log).
+Tells `performance_promise` whether to throw an exception. Set to `true` by default, but can be overridden if you simply want to ignore failing cases (they will still be written to the log).
 
 #### `speedy_promise: hash`
 If you do not care to determine the _exact_ performance of your action, you can still simply mark it as `Speedy`:
@@ -157,7 +164,7 @@ If you do not care to determine the _exact_ performance of your action, you can
 A `Speedy` action is supposed to be well behaved, making lesser than `x` database queries, and taking less than `y` to complete. You can set these defaults using this configuration parameter.
 
 #### `untagged_methods_are_speedy: bool`
-By default, actions that are not annotated aren't validated by `performance_promise`. If you'd like to force all actions to be validated, one option is to simply default them all to be `Speedy`. This allows developers to make _no_ change to their code, while still reaping the benefits of performance validation. Iff a view fails to be `Speedy`, then the developer is forced to acknowledge it in code.
+By default, actions that are not annotated aren't validated by `performance_promise`. If you'd like to force all actions to be validated, one option is to simply default them all to be `Speedy`. This allows developers to make _no_ change to their code, while still reaping the benefits of performance validation. If a view fails to be `Speedy`, then the developer is forced to acknowledge it in code.
 
 
 ## FAQ
@@ -165,11 +172,11 @@ By default, actions that are not annotated aren't validated by `performance_prom
 
 We borrow the coding style from Python's `decorators`. This style allows for a function to be wrapped by another. This is a great use case for that style since it allows for us to express the annotation right above the function definition.
 
-Credit goes to [Yehuda Katz][yehuda-katz] for the [port of decortators][ruby-decorators] into Ruby.
+Credit goes to [Yehuda Katz][yehuda-katz] for the [port of decorators][ruby-decorators] into Ruby.
 
 > **Will this affect my production service?**
 
-By default, `performace_promise` is applied only in `development` and `test` environments. You can choose to override this, but is strongly discouraged.
+By default, `performance_promise` is applied only in `development` and `test` environments. You can choose to override this, but is strongly discouraged.
 
 
 > **What are some other kinds of performance guarantees that I can make with `performance_promise`?**
@@ -192,7 +199,7 @@ If you come up with other validations that you think will be useful, please cons
 
 `performance_promise` can be tuned to not only identify N + 1 queries, but can also alert whenever there's _any_ change in performance.  It allows you to identify expensive actions irrespective of their database query profile.
 
-`performance_promise` also has access to the entire database query object. In the future, `performance_promise` can be tuned to perform additonal checks like how long the most expensive query took, whether the action performed any table scans (available through an `EXPLAIN`) etc.
+`performance_promise` also has access to the entire database query object. In the future, `performance_promise` can be tuned to perform additional checks like how long the most expensive query took, whether the action performed any table scans (available through an `EXPLAIN`) etc.
 
 Finally, the difference between `bullet` and `performance_promise` is akin to testing by refreshing your browser and testing by writing specs. `performance_promise` encourages you to specify your action's performance by declaring it in code itself. This allows both  code-reviewers as well as automated tests to verify your code's performance.
 

data/lib/performance_promise.rb

@@ -81,7 +81,11 @@ module PerformancePromise
 
   def self.validate_promise(method, db_queries, render_time, options)
     return if options[:skip]
+
     promise_broken = false
+    error_messages = []
+    backtraces = []
+
     self.configuration.validations.each do |validation|
       promised = options[validation]
       if promised
@@ -89,28 +93,30 @@ module PerformancePromise
         passed, error_message, backtrace =
           PerformanceValidations.send(validation_method, db_queries, render_time, promised)
         unless passed
-          if PerformancePromise.configuration.throw_exception
-            bp = BrokenPromise.new("Broken promise: #{error_message}")
-            bp.set_backtrace(backtrace)
-            raise bp
-          else
-            PerformancePromise.configuration.logger.warn '-' * 80
-            PerformancePromise.configuration.logger.warn Utils.colored(:red, error_message)
-            backtrace.each do |trace|
-              PerformancePromise.configuration.logger.warn Utils.colored(:cyan, error_message)
-            end
-            PerformancePromise.configuration.logger.warn '-' * 80
-          end
+          error_messages << error_message
+          backtraces << '-'*80
+          backtraces << "#{validation.to_s.upcase}"
+          backtraces << backtrace
           promise_broken = true
         end
       end
     end
-    PerformanceValidations.report_promise_passed(method, db_queries, options) unless promise_broken
+    if promise_broken
+      combined_error_message = "#{method}: Try Performance #{error_messages.join(', ')}"
+      if PerformancePromise.configuration.throw_exception
+        bp = BrokenPromise.new(combined_error_message)
+        bp.set_backtrace(backtraces.flatten)
+        raise bp
+      else
+        PerformancePromise.configuration.logger.warn '-' * 80
+        PerformancePromise.configuration.logger.warn Utils.colored(:red, combined_error_message)
+        backtraces.flatten.each do |trace|
+          PerformancePromise.configuration.logger.warn Utils.colored(:cyan, trace)
+        end
+        PerformancePromise.configuration.logger.warn '-' * 80
+      end
+    else
+      PerformanceValidations.report_promise_passed(method, db_queries, options)
+    end
   end
-
-end
-
-
-class ApplicationController < ActionController::Base
-  extend MethodDecorators
 end

data/lib/performance_promise/sql_recorder.rb

@@ -13,9 +13,27 @@ class SQLRecorder
 
   def record(payload, duration)
     return if invalid_payload?(payload)
+
+    # do not record/analyze explain queries used in dev
+    return if payload[:sql].include?('EXPLAIN')
+
     sql = payload[:sql]
     cleaned_trace = clean_trace(caller)
-    explained = ActiveRecord::Base.connection.execute("EXPLAIN QUERY PLAN #{sql}", 'SQLR-EXPLAIN')
+    if sql.include?('SELECT')
+      connection = ActiveRecord::Base.connection
+      adapter_name = connection.adapter_name
+      if adapter_name == 'Mysql2'
+        explained = connection.explain(connection, sql).as_json
+      elsif adapter_name == 'SQLite'
+        explained = connection.execute("EXPLAIN QUERY PLAN #{sql}", 'SQLR-EXPLAIN')
+      elsif
+        PerformancePromise.configuration.logger.warn("Unkown database adapter {adapter_name}")
+        explained = connection.execute("EXPLAIN QUERY PLAN #{sql}", 'SQLR-EXPLAIN')
+      end
+    else
+      explained = nil
+    end
+
     @db_queries << {
       :sql => sql,
       :duration => duration,
@@ -29,7 +47,7 @@ class SQLRecorder
       'SCHEMA',
       'SQLR-EXPLAIN',
     ]
-    payload[:name] && ignore_query_names.any? { |name| payload[:name].in?(name) }
+    payload[:name] && ignore_query_names.any? { |name| payload[:name].include?(name) }
   end
 
   def clean_trace(trace)

data/lib/performance_promise/utils.rb

@@ -9,10 +9,11 @@ module Utils
 
   def self.guess_order(db_queries)
     order = []
+    single_queries = 0
     queries_with_count = summarize_queries(db_queries)
     queries_with_count.each do |query, count|
       if count == 1
-        order << "1.query"
+        single_queries += 1
       else
         if (lookup_field = /WHERE .*"(.*?_id)" = \?/.match(query[:sql]))
           klass = lookup_field[1].humanize
@@ -23,6 +24,11 @@ module Utils
       end
     end
 
+    if single_queries == 1
+      order << '1.query'
+    elsif single_queries > 1
+      order << "#{single_queries}.queries"
+    end
     order.join(" + ")
   end
 

data/lib/performance_promise/validations/full_table_scans.rb

@@ -1,15 +1,44 @@
 module ValidateFullTableScans
   def validate_full_table_scans(db_queries, render_time, promised)
     full_table_scans = []
+    backtrace = []
 
     # check the explained queries to see if there were any
     # SCAN TABLEs
     db_queries.each do |db_query|
-      detail = db_query[:explained][0]['detail']
-      makes_full_table_scan = detail.match(/SCAN TABLE (.*)/)
-      if makes_full_table_scan
-        table_name = makes_full_table_scan[1]
-        full_table_scans << table_name
+      if db_query[:explained]
+        join_type = db_query[:explained].first[3]
+        if join_type
+
+          adapter_name = ActiveRecord::Base.connection.adapter_name
+          if adapter_name == 'Mysql2'
+            makes_full_table_scan = join_type.match(/ALL/)
+            table_name = db_query[:explained][0][2]
+          elsif adapter_name == 'SQLite'
+            makes_full_table_scan = join_type.match(/SCAN TABLE (.*)/)
+            table_name = makes_full_table_scan[1]
+          else
+            PerformancePromise.configuration.logger.warn("Unkown database adapter {adapter_name}")
+            makes_full_table_scan = join_type.match(/SCAN TABLE (.*)/)
+            table_name = makes_full_table_scan[1]
+          end
+
+          if makes_full_table_scan
+            full_table_scans << table_name
+
+            backtrace << db_query[:sql]
+            db_query[:trace].each do |trace|
+              if trace.starts_with?('app')
+                file, line_number = trace.split(':')
+                trace = '    |_' +
+                  File.read(file).split("\n")[line_number.to_i - 1].strip +
+                  ' (' + trace + ')'
+              end
+              backtrace << trace
+            end
+
+          end
+        end
       end
     end
 
@@ -22,10 +51,10 @@ module ValidateFullTableScans
     # check that the performed FTSs are a subset of the promised FTSs
     passes = (full_table_scans & promised_full_table_scans == full_table_scans)
     error_message = ''
-    backtrace = []
 
     unless passes
-        error_message = "Promised table scans on #{promised_full_table_scans}, made: #{full_table_scans}"
+        model_names = full_table_scans.map { |table_name| table_name.classify }
+        error_message = ":full_table_scans => [#{model_names.join(', ')}]"
     end
 
     return passes, error_message, backtrace

data/lib/performance_promise/validations/number_of_db_queries.rb

@@ -11,7 +11,7 @@ module ValidateNumberOfQueries
     end
 
     guessed_order = Utils.guess_order(db_queries)
-    error_message = "promised #{makes}, made #{db_queries.length} (possibly #{guessed_order})"
+    error_message = ":makes => #{guessed_order}"
     backtrace = []
     Utils.summarize_queries(db_queries).each do |db_query, count|
       statement = "#{count} x #{db_query[:sql]}"

data/performance_promise.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'performance_promise'
-  s.version     = '1.0.1'
+  s.version     = '1.0.2'
   s.date        = '2016-01-11'
   s.summary     = 'Validate your Rails actions\' performance'
   s.description = 'Validate your Rails actions\' performance'

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: performance_promise
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Bipin Suresh
@@ -16,7 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE
 - README.md
@@ -41,26 +42,27 @@ files:
 homepage: https://github.com/bipsandbytes/performance_promise
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Validate your Rails actions' performance
 test_files:
 - spec/performance_promise_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 08746655e263efe79e8f620979c2035a5b9b18ee
-  data.tar.gz: a1d134f39f8a458779282c5c8dbddfd5a93d412a
-SHA512:
-  metadata.gz: 7d459fb634862cbc63727408f3ce899366e49ef422310e64801ee509fc513da694a5e33c7e45225e7e994fbdf408f122f8420a81bc59612b0c9157468533bb4f
-  data.tar.gz: a123885620753e8a00eec917765d709dc2969b14dfb1e23cac40c2061bef9bf19129ce038329fcde77be927c1bac376aa40cf785347974e1a635006aca563fa1