shiba 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7eada3a6681422e90d6dc44bf19121abb12986defaabeb31ca779ed4cb0418a
-  data.tar.gz: e0e38dbc12379a611b621eec501c677860721945833cd4248c22e53f0d1f203c
+  metadata.gz: 12302c0e4fc56d8c8fc0d14dc6e10a5ae84aeaac2c328937b78b9e14b8122faa
+  data.tar.gz: d0ae437286d3c4975630c5dab8dc5aa109eb38f3ed0f6e606cded20a1201b09f
 SHA512:
-  metadata.gz: cef76568f5300e5a57ecd8c53f247a889fb3e09f40b2e5c15572f31fc81a5923cde7de6a71407fc1fe6022d95e612b8f66775f982ddbf576303d7e06d23e44d9
-  data.tar.gz: bd0b080bfafde25a487ad2e47ee44c96b26e4e7b762cdb9fb62473727b775dae80ec22205d6fe767ce493659ddaa7774ed183ead5f806583beea6d4cc850a1c9
+  metadata.gz: 92d5a42d2b68381a8f07025dec47e289d75c642a2d53823658966c8032e0e1f2a826f6285b1834747dda798fa25968f27f05c00029f60345303dddc9e2b20c2a
+  data.tar.gz: f4911585fe1a38695b587e11b908265d480523b6e2fcb8966780d80f34ab9612c1a798f612f0a3262f77349d5686a27f4c3da3886824753b36021354c33b267e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shiba (0.9.1)
+    shiba (0.9.2)
       activesupport
 
 GEM

data/bin/explain

@@ -42,7 +42,7 @@ file = $stdin if file.nil?
 
 if options["verbose"]
   $stderr.puts "Reading queries from '#{file.inspect}'..."
-  $stderr.puts "Analyzing SQL to '#{json.inspect}'..."
+  $stderr.puts "Analyzing SQL to '#{options["json"].inspect}'..."
 end
 
 table_stats = Shiba::TableStats.new(Shiba.index_config, Shiba.connection, {})

data/lib/shiba/activerecord_integration.rb

@@ -39,7 +39,7 @@ module Shiba
         {
           'host' =>     c[:host],
           'database' => c[:database],
-          'user' =>     c[:username],
+          'username' => c[:username],
           'password' => c[:password],
           'port' =>     c[:port],
           'server' =>   c[:server],
@@ -72,16 +72,28 @@ module Shiba
     def self.when_done
       return false if @done_hook
 
-      case
-      when defined?(Minitest.after_run)
-        MiniTest.after_run { yield }
+      # define both minitest and rspec hooks -- it can be
+      # unclear in some envs which one is active.  maybe even both could run in one process?  not sure.
+      @shiba_done = false
+      if defined?(Minitest.after_run)
+        MiniTest.after_run do
+          yield unless @shiba_done
+          @shiba_done = true
+        end
         @done_hook = :minitest
-      when defined?(RSpec.configure)
+      end
+
+      if defined?(RSpec.configure)
         RSpec.configure do |config|
-          config.after(:suite) { yield }
+          config.after(:suite) do
+            yield unless @shiba_done
+            @shiba_done = true
+          end
         end
         @done_hook = :rspec
-      else
+      end
+
+      if !@done_hook
         $stderr.puts "Warning: shiba could not find Minitest or RSpec."
         $stderr.puts "If tests are running with one of these libraries, ensure shiba is required after them."
         at_exit { yield }

data/lib/shiba/console.rb

@@ -7,9 +7,7 @@ require 'shiba/reviewer'
 
 module Shiba
   # Provides a 'shiba' command to analyze queries from the console.
-  # If required in IRB or Pry, the shiba command will automatically be available,
-  # as it's injected into those consoles at the bottom of this file.
-  #
+  # If required in IRB or Pry, the 'shiba' command will become available.
   # Example:
   # require 'shiba/console'
   #

data/lib/shiba/explain.rb

@@ -48,6 +48,7 @@ module Shiba
         table: @query.from_table,
         md5: @query.md5,
         messages: @result.messages,
+        global: global,
         cost: @result.cost,
         severity: severity,
         raw_explain: humanized_explain,
@@ -55,6 +56,12 @@ module Shiba
       }
     end
 
+    def global
+      {
+        server: Shiba.connection.mysql? ? 'mysql' : 'postgres'
+      }
+    end
+
     def messages
       @result.messages
     end

data/lib/shiba/index_stats.rb

@@ -15,14 +15,14 @@ module Shiba
 
     Table = Struct.new(:name, :count, :indexes) do
       def encode_with(coder)
-        coder.map = self.to_h.stringify_keys
-        coder.map.delete('name')
-
         if self.count.nil?
           #uuuugly.  No unique keys.  we'll take our best guess.
           self.count = indexes.map { |i, parts| parts.columns.map { |v| v.raw_cardinality } }.flatten.max
         end
 
+        coder.map = self.to_h.stringify_keys
+        coder.map.delete('name')
+
         coder.map['column_sizes'] = column_sizes
         coder.tag = nil
       end
@@ -110,7 +110,7 @@ module Shiba
           ratio_threshold = 0.1
         elsif count <= 1_000_000
           ratio_threshold = 0.01
-        elsif count <= 1_000_000_000
+        else
           ratio_threshold = 0.001
         end
 
@@ -165,9 +165,13 @@ module Shiba
     end
 
     def set_column_size(table_name, column, size)
-      table = @tables[table_name]
-      raise "couldn't find table: #{table_name}" unless table
+      if !@tables[table_name]
+        # we get here when a table has no indices.  Should really do something smarter long term,
+        # as we'll have zero-counts, stuff like that.
+        build_table(table_name)
+      end
 
+      table = @tables[table_name]
       table.column_sizes[column] = size
     end
 

data/lib/shiba/output/tags.yaml

@@ -15,12 +15,12 @@ possible_key_check:
     key possible.  Sometimes "possible_keys" will be inaccurate and no keys were possible.
 access_type_const:
   title: One row
-  summary: The database only needs to read a single row from <b>{{table}}</b>.
+  summary: "{{ server }} reads one row from <b>{{table}}</b>."
   description: |
     This query selects at *most* one row, which is about as good as things get.
 access_type_ref:
   title: Index Scan
-  summary: The database reads {{ formatted_cost }} rows in <b>{{ table }}</b> via the <i>{{ index }}</i> index ({{ key_parts }}).
+  summary: "{{ server }} reads {{ formatted_cost }} rows from <b>{{ table }}</b> via <i>{{ index }}</i> ({{ key_parts }})."
   description: |
     This query uses an index to find rows that match a single value.  Often this
     has very good performance, but it depends on how many rows match that value.
@@ -31,8 +31,8 @@ join_type_ref:
   title: Indexed Join
   summary: <b>{{ table }}</b> is joined to <b>{{ join_to }}</b> via <i>{{ index }}</i>, reading {{ formatted_cost }} rows per joined item.
 access_type_range:
-  title: Indexed
-  summary: The database uses a "range scan" to read more than {{ formatted_cost }} rows in {{ table }} via the <b>{{ index }}</b> index ({{ key_parts }})
+  title: Range Scan
+  summary: "{{ server }} reads more than {{ formatted_cost }} rows from {{ table }} via <i>{{ index }}</i> ({{ key_parts }})"
   description: |
     This query uses an index to find rows that match a range of values, for instance
     `WHERE indexed_value in (1,2,5,6)` or `WHERE indexed_value >= 5 AND indexed_value <= 15`.
@@ -40,10 +40,10 @@ access_type_range:
     upped the formatted_cost of this query.
 access_type_index:
   title: Index Scan
-  summary: The database reads {{ formatted_cost }} of the rows in <b>{{ table }}</b> via <i>{{ index }}</i>
+  summary: "{{ server }} reads {{ formatted_cost }} of the rows in <b>{{ table }}</b> via <i>{{ index }}</i>"
 access_type_tablescan:
   title: Table Scan
-  summary: The database reads {{ formatted_cost }} of the rows in <b>{{ table }}</b>, skipping any indexes.
+  summary: "{{ server }} reads {{ formatted_cost }} of the rows in <b>{{ table }}</b>, skipping any indexes."
   description: |
     This query doesn't use any indexes to find data, meaning this query will need to evaluate
     every single row in the table.  This is about the worst of all possible worlds.
@@ -53,7 +53,7 @@ access_type_tablescan:
     a world of pain.
 limited_scan:
   title: Limited Scan
-  summary: The database reads {{ formatted_cost }} rows from {{ table }}.
+  summary: "{{ server }} reads {{ formatted_cost }} rows from {{ table }}."
   description: |
     This query doesn't use any indexes to find data, but since it doesn't care about
     ordering and it doesn't have any conditions, it only ever reads {{ formatted_cost }} rows.
@@ -71,4 +71,4 @@ index_walk:
   level: success
 retsize:
   title: Results
-  summary: The database returns {{ formatted_result }} to the client.
+  summary: "{{ server }} returns {{ formatted_result }} to the client."

data/lib/shiba/review/cli.rb

@@ -67,6 +67,7 @@ module Shiba
           begin
             explains = explain_file.each_line.map { |json| JSON.parse(json) }
             bad = explains.select { |explain| explain["severity"] && explain["severity"] != 'none' }
+            bad = bad.sort_by { |explain| explain["cost"] }
             bad.map { |explain| [ "#{explain["sql"]}:-2", explain ] }
           rescue Interrupt
             @err.puts "SIGINT: Canceled reading from STDIN. To read from an explain log, provide the --file option."

data/lib/shiba/review/comment_renderer.rb

@@ -16,13 +16,15 @@ module Shiba
         explain["messages"].each do |message|
           tag = message['tag']
           data = present(message)
+          data.merge!(explain["global"])
+          body << " * "
           body << @templates[tag]["title"]
           body << ": "
           body << render_template(@templates[tag]["summary"], data)
           body << "\n"
         end
 
-        body << "Estimated query time: %.2fs" % explain['cost']
+        body << " * Estimated query time: %.2fs" % explain['cost']
         body
       end
 

data/lib/shiba/version.rb

@@ -1,3 +1,3 @@
 module Shiba
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

data/web/src/App.vue

@@ -34,7 +34,7 @@
         </div>
         <a name="lowExapnded"></a>
         <div class="queries" v-if="lowExpanded">
-          <query v-for="query in queriesLow" v-bind:query="query" v-bind:key="query.sql" v-bind:tags="tags" v-bind:url="url"></query>
+          <query v-for="query in queriesLow" v-bind:query="query" v-bind:key="query.sql" v-bind:tags="tags" v-bind:url="url" v-bind:global="global"></query>
         </div>
       </div>
       <div style="height:50px"></div>
@@ -90,6 +90,7 @@ export default {
     highQ: [],
     lowQ: [],
     tags: {},
+    global: {},
     lowExpanded: false,
     hasFuzzed: false,
     search: '',
@@ -112,6 +113,7 @@ export default {
     setupData: function(data) {
       this.url = data.url;
       this.tags = data.tags;
+      this.global = data.global;
 
       Object.keys(this.tags).forEach((k) => {
         registerMessage(k, this.tags[k].title, this.tags[k].summary);

data/web/src/components/Message.js

@@ -94,7 +94,7 @@ export default function (tag, title, summary) {
 
   Vue.component(`tag-${tag}`, {
     template: tmpl,
-    props: [ 'table_size', 'result_size', 'table', 'cost', 'index', 'join_to', 'index_used', 'running_cost', 'tables', 'rows_read', 'result_bytes' ],
+    props: [ 'table_size', 'result_size', 'table', 'cost', 'index', 'join_to', 'index_used', 'running_cost', 'tables', 'rows_read', 'result_bytes', 'server' ],
     computed: templateComputedFunctions,
     data: function () {
       return { lastRunnningCost: undefined };

data/web/src/components/Query.vue

@@ -19,7 +19,7 @@
             <backtrace v-bind:backtrace="query.backtrace" v-bind:url="url"></backtrace>
           </div>
           <table class="shiba-messages">
-            <component v-for="message in query.messages" v-bind:is="'tag-' + message.tag" v-bind="message" v-bind:key="query.md5 + ':' + message.tag"></component>
+            <component v-for="message in messages" v-bind:is="'tag-' + message.tag" v-bind="message" v-bind:key="query.md5 + ':' + message.tag"></component>
           </table>
           <div v-if="debug" style="font-size: 10px">md5: {{ query.md5 }}</div>
           <div v-if="!rawExpanded">
@@ -42,7 +42,7 @@
   export default {
     name: 'Query',
     template: '#query-template',
-    props: ['query', 'tags', 'url', 'debug'],
+    props: ['query', 'tags', 'url', 'debug', 'global'],
     data: function () {
       return {
         expanded: false,
@@ -95,6 +95,12 @@
       },
     },
     computed: {
+      messages: function () {
+        var array = this.query.messages.map((m) =>
+          Object.assign({}, { server: 'MySQL' }, m)
+        );
+        return array;
+      },
       expandText: function() {
         return this.expanded ? "-" : "+";
       }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shiba
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Ben Osheroff
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-19 00:00:00.000000000 Z
+date: 2019-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -159,8 +159,8 @@ files:
 - web/babel.config.js
 - web/dist/example_data.json
 - web/dist/index.html
-- web/dist/js/app.2ba8a5da.js
-- web/dist/js/app.2ba8a5da.js.map
+- web/dist/js/app.91a7529a.js
+- web/dist/js/app.91a7529a.js.map
 - web/package-lock.json
 - web/package.json
 - web/public/index.html