optic-rails 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9768eeeb47c2c8c2eef8cdf95244e88644f2ee9455e8425ff20f184e9caab8ea
-  data.tar.gz: edb291080a2cd6d69fca3cc7ce665dd7035a5a521610ccd93b7820fb5c1796c8
+  metadata.gz: 4862c212205f52f736e51c5b74da8d0bd141d941fe27adb6b872efa715a59aac
+  data.tar.gz: b77ac04f9ae6cccc80168fc5a77ef27c249c75a6767859611022e7aac941d1ef
 SHA512:
-  metadata.gz: 24f8ed8c4713484642f57a814b9e3a4a2855e9094c10077a5d098f684a86109f0428af77cedb0ef76779b1a47b7dc07722d43846ffb5973c01d43a7648d3313a
-  data.tar.gz: aff41fee8f75733a7498c5c112799589bac2e7fd9b6c9b661ef51f75a3fa1e729d4cfafa8773456569f301a88f19f8beb625b33c58bad25ce4dc0f5941c28a3c
+  metadata.gz: 93a490e91f071a3c1089b4072a6ef273f291115d27c828d5e73593329e6ca924833a64991fca2ad0a6534bc52dcef2c357bca92bee4c53b0dbd9959967451a1a
+  data.tar.gz: 5298316a14f2c3668c7a1f2968ee7d0ca5df05a797b8ea75d32f165d54672de3e5441233c327171f5d86b627fb6152e1615f45b3fc7cdc56e5a217de4448e0c1

data/Rakefile

@@ -1,26 +1,28 @@
+# frozen_string_literal: true
+
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Optic::Rails'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Optic::Rails"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 

data/lib/optic/rails.rb

@@ -1,150 +1,65 @@
-require "optic/rails/railtie"
+# frozen_string_literal: true
 
-require "rgl/adjacency"
-require "rgl/dot"
-require "rgl/dijkstra"
+require "optic/rails/railtie"
 
 module Optic
   module Rails
-    # From https://gist.github.com/hongo35/7513104
-    class PageRank
-      EPS = 0.00001
-
-      def initialize(matrix)
-        @dim = matrix.size
-
-        @p = []
-        @dim.times do |i|
-          @p[i] = []
-          @dim.times do |j|
-            total = matrix[i].inject(:+)
-            @p[i][j] = total == 0 ? 0 : matrix[i][j] / (total * 1.0)
-          end
-        end
-      end
-
-      def calc(curr, alpha)
-        loop do
-          prev = curr.clone
-
-          @dim.times do |i|
-            ip = 0
-            @dim.times do |j|
-              ip += @p.transpose[i][j] * prev[j]
+    class << self
+      def entities
+        with_connection do
+          {
+            schema_version: ActiveRecord::Migrator.current_version,
+            entities: active_record_klasses.map do |klass|
+              {
+                name: klass.name,
+                table_name: klass.table_name,
+                attribute_names: klass.attribute_names,
+                table_exists: klass.table_exists?,
+                associations: klass.reflect_on_all_associations.map do |reflection|
+                  {
+                    name: reflection.name,
+                    macro: reflection.macro,
+                    options: reflection.options.map { |k, v| [k, v.to_s] }.to_h,
+                    klass_name: reflection.options[:polymorphic] ? nil : reflection.klass.name,
+                  }
+                end
+              }
             end
-            curr[i] = (alpha * ip) + ((1.0 - alpha) / @dim * 1.0)
-          end
-
-          err = 0
-          @dim.times do |i|
-            err += (prev[i] - curr[i]).abs
-          end
-
-          if err < EPS
-            return curr
-          elsif err.nan?
-            raise "PageRank failed" # TODO just ignore and move on
-          end
-        end
-      end
-    end
-
-    def self.qualified_primary_key(vertex)
-      %Q|"#{vertex.table_name}"."#{vertex.primary_key}"|
-    end
-
-    def self.entity_graph
-      graph = RGL::DirectedAdjacencyGraph.new
-
-      base_klass = ApplicationRecord rescue ActiveRecord::Base
-      klasses = ObjectSpace.each_object(Class).find_all { |klass| klass < base_klass }.find_all(&:table_exists?)
-
-      graph.add_vertices *klasses
-
-      klasses.each do |klass|
-        klass.reflect_on_all_associations(:belongs_to).each do |reflection|
-          next if reflection.options[:polymorphic] # TODO
-
-          # TODO should the source be reflection.active_record or klass?
-          graph.add_edge klass, reflection.klass
+          }
         end
       end
 
-      graph
-    end
-
-    def self.get_entities
-      graph = entity_graph
-
-      # TODO send entire graph to server
-      entities = graph.vertices.map { |v| { name: v.name, table_name: v.table_name } }
-
-      {
-        schema_version: ActiveRecord::Migrator.current_version,
-        entities: entities # TODO also return entity attributes?
-      }
-    end
+      def metrics
+        with_connection do |connection|
+          result = { entity_totals: [] }
+          active_record_klasses.find_all(&:table_exists?).each do |klass|
+            count_query = klass.unscoped.select("COUNT(*)").to_sql
+            result[:entity_totals] << { name: klass.name, total: connection.execute(count_query).first["count"] }
+          end
 
-    # Try to be defensive with our DB connection:
-    # 1) Check a connection out from the thread pool instead of using an implicit one
-    # 2) Make the connection read-only
-    # 3) Time out any queries that take more than 100ms
-    def self.with_connection
-      ActiveRecord::Base.connection_pool.with_connection do |connection|
-        connection.transaction do
-          connection.execute "SET TRANSACTION READ ONLY"
-          connection.execute "SET LOCAL statement_timeout = 100"
-          yield connection
+          result
         end
       end
-    end
-
-    def self.get_metrics(pivot_name)
-      with_connection do |connection|
-        result = {entity_totals: []}
-        pivot = nil
 
-        if pivot_name
-          pivot = pivot_name.constantize
-          result[:pivot_name] = pivot.name
-          result[:pivot_values] = connection.execute(pivot.unscoped.select("*").to_sql).to_a
-          result[:pivoted_totals] = []
-        end
-
-        graph = entity_graph
-
-        # Spit out counts for each entity by the customer pivot
-
-        edge_weights = lambda { |_| 1 }
-
-        graph.vertices.each do |vertex|
-          count_query = vertex.unscoped.select("COUNT(*)").to_sql
-          result[:entity_totals] << { name: vertex.name, total: connection.execute(count_query).first["count"] }
-
-          if pivot && vertex != pivot
-            # TODO weight edges to give preference to non-optional belongs_to (and other attributes?)
-            path = graph.dijkstra_shortest_path(edge_weights, vertex, pivot)
-            if path
-              # Generate a SQL query to count the number of vertex instances grouped by pivot id, with appropriate joins from the path
-              belongs_to_names = path.each_cons(2).map do |join_from, join_to|
-                # TODO we shouldn't have to look up the edge again - use a graph model that allows us to annotate the edges with the reflections
-                reflections = join_from.reflect_on_all_associations(:belongs_to).find_all { |reflection| !reflection.options[:polymorphic] && reflection.klass == join_to }
-                # TODO warn if more than one reflection
-                reflection = reflections.min_by { |r| r.options.size }
-                reflection.name
-              end
-
-              joins = belongs_to_names.reverse.inject { |acc, elt| { elt => acc } }
-              query = vertex.unscoped.joins(joins).group(qualified_primary_key(pivot)).select(qualified_primary_key(pivot), "COUNT(*)").to_sql
-
-              result[:pivoted_totals] << { entity_name: vertex.name, totals: Hash[connection.execute(query).map { |record| [record["id"], record["count"]] }] }
-            else
-              # TODO print warning that we couldn't find a path from the pivot to the vertex
-            end
+      private
+
+      # Try to be defensive with our DB connection:
+      # 1) Check a connection out from the thread pool instead of using an implicit one
+      # 2) Make the connection read-only
+      # 3) Time out any queries that take more than 100ms
+      def with_connection
+        ActiveRecord::Base.connection_pool.with_connection do |connection|
+          connection.transaction do
+            connection.execute "SET TRANSACTION READ ONLY"
+            connection.execute "SET LOCAL statement_timeout = 100"
+            yield connection
           end
         end
+      end
 
-        result
+      def active_record_klasses
+        base_klass = ApplicationRecord rescue ActiveRecord::Base
+        ObjectSpace.each_object(Class).find_all { |klass| klass < base_klass }
       end
     end
   end

data/lib/optic/rails/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "action_cable_client"
 require "eventmachine"
 require "logger"
@@ -31,7 +33,7 @@ module Optic
             logger.debug "Starting worker thread"
             worker = Thread.new do
               EventMachine.run do
-                client = ActionCableClient.new(uri, { channel: "MetricsChannel" }, true, { "Authorization" => "Bearer #{project_key}" })
+                client = ActionCableClient.new(uri, { channel: "MetricsChannel" }, true, "Authorization" => "Bearer #{project_key}")
 
                 client.connected do
                   logger.debug "Optic agent connected"
@@ -64,11 +66,11 @@ module Optic
                   case command
                   when "request_schema"
                     logger.debug "Optic agent got schema request"
-                    client.perform "schema", message: Optic::Rails.get_entities
+                    client.perform "schema", message: Optic::Rails.entities
                     logger.debug "Optic agent sent schema"
                   when "request_metrics"
                     logger.debug "Optic agent got metrics request"
-                    client.perform "metrics", message: Optic::Rails.get_metrics(message["message"]["pivot"])
+                    client.perform "metrics", message: Optic::Rails.metrics
                     logger.debug "Optic agent sent metrics"
                   else
                     logger.warn "Optic agent got unknown command: #{command}"

data/lib/optic/rails/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Optic
   module Rails
-    VERSION = '1.0.0'
+    VERSION = "1.0.1"
   end
 end

metadata

@@ -1,20 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: optic-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Anton Vaynshtok
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-31 00:00:00.000000000 Z
+date: 2018-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: action_cable_client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
   type: :runtime
@@ -22,6 +25,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
 - !ruby/object:Gem::Dependency
@@ -52,35 +58,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rgl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.3
-- !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'
-description: Rails plugin for Optic.
+description: optic.watch is the easiest way to get notified when business metrics
+  change. This gem intelligently collects metrics from your production database using
+  ActiveRecord to automatically understand your data.
 email:
 - avaynshtok@gmail.com
 executables: []
@@ -93,7 +73,6 @@ files:
 - lib/optic/rails.rb
 - lib/optic/rails/railtie.rb
 - lib/optic/rails/version.rb
-- lib/tasks/optic/rails_tasks.rake
 homepage: https://www.sutrolabs.com/
 licenses:
 - MIT
@@ -117,5 +96,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Rails plugin for Optic.
+summary: optic.watch for Rails
 test_files: []

data/lib/tasks/optic/rails_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :optic_rails do
-#   # Task goes here
-# end