skylight-core 3.1.5 → 4.0.0.alpha

data/lib/skylight/core/normalizers/coach/handler_finish.rb

@@ -13,21 +13,21 @@ module Skylight::Core
         # handler name.
         #
         # We can expect the payload to have the :middleware key.
-        def normalize(trace, name, payload)
+        def normalize(trace, _name, payload)
           trace.endpoint = payload[:middleware]
-          [ CAT, payload[:middleware], nil ]
+          [CAT, payload[:middleware], nil]
         end
 
-        def normalize_after(trace, span, name, payload)
+        def normalize_after(trace, _span, _name, payload)
           return unless config.enable_segments?
 
           segments = []
 
-          response_status = payload.fetch(:response, {}).fetch(:status, '').to_s
-          segments << "error" if response_status.start_with?('4', '5')
+          response_status = payload.fetch(:response, {}).fetch(:status, "").to_s
+          segments << "error" if response_status.start_with?("4", "5")
 
           if segments.any?
-            trace.endpoint += "<sk-segment>#{segments.join("+")}</sk-segment>"
+            trace.segment = segments.join("+")
           end
         end
       end

data/lib/skylight/core/normalizers/coach/middleware_finish.rb

@@ -13,9 +13,9 @@ module Skylight::Core
         # within a Coach::Handler.
         #
         # We can expect the payload to have the :middleware key.
-        def normalize(trace, name, payload)
+        def normalize(trace, _name, payload)
           trace.endpoint = payload[:middleware]
-          [ CAT, payload[:middleware], nil ]
+          [CAT, payload[:middleware], nil]
         end
       end
     end

data/lib/skylight/core/normalizers/couch_potato/query.rb

@@ -0,0 +1,20 @@
+require "json"
+
+module Skylight::Core
+  module Normalizers
+    module CouchPotato
+      class Query < Normalizer
+        register "couch_potato.load"
+        register "couch_potato.view"
+
+        CAT = "db.couch_db.query".freeze
+
+        def normalize(_trace, name, payload)
+          description = payload[:name] if payload
+          name = name.sub("couch_potato.", "")
+          [CAT, name, description]
+        end
+      end
+    end
+  end
+end

data/lib/skylight/core/normalizers/data_mapper/sql.rb

@@ -1,4 +1,4 @@
-require 'skylight/core/normalizers/sql'
+require "skylight/core/normalizers/sql"
 
 module Skylight::Core
   module Normalizers

data/lib/skylight/core/normalizers/default.rb

@@ -1,16 +1,14 @@
 module Skylight::Core
   module Normalizers
-
     # The default normalizer, used if no other is found.
     class Default
-
       # @param trace [Skylight::Messages::Trace::Builder] ignored, only present to match API
       # @param name [String]
       # @param payload [Hash]
       # @option payload [String] :title
       # @option payload [String] :description
       # @return [Array, :skip] the normalized array or `:skip` if `name` is not part of a known {Skylight::TIERS tier}
-      def normalize(trace, name, payload)
+      def normalize(_trace, name, payload)
         if name =~ Skylight::TIER_REGEX
           [
             name,
@@ -21,7 +19,6 @@ module Skylight::Core
           :skip
         end
       end
-
     end
   end
 end

data/lib/skylight/core/normalizers/elasticsearch/request.rb

@@ -6,13 +6,13 @@ module Skylight::Core
 
         CAT = "db.elasticsearch.request".freeze
 
-        def normalize(trace, name, payload)
-          path = payload[:path].split('/')
-          title = [payload[:method], path[0]].compact.join(' ')
+        def normalize(_trace, _name, payload)
+          path = payload[:path].split("/")
+          title = [payload[:method], path[0]].compact.join(" ")
           desc = {}
           desc[:type] = path[1] if path[1]
-          desc[:id] = '?' if path[2]
-          [ CAT, title, desc.empty? ? nil : desc.to_json ]
+          desc[:id] = "?" if path[2]
+          [CAT, title, desc.empty? ? nil : desc.to_json]
         end
       end
     end

data/lib/skylight/core/normalizers/grape/endpoint.rb

@@ -2,13 +2,15 @@ module Skylight::Core
   module Normalizers
     module Grape
       class Endpoint < Normalizer
-        %w(run
-            render
-            run_filters).each do |type|
+        %w[
+          run
+          render
+          run_filters
+        ].each do |type|
           require "skylight/core/normalizers/grape/endpoint_#{type}"
         end
 
-        require 'skylight/core/normalizers/grape/format_response'
+        require "skylight/core/normalizers/grape/format_response"
 
         private
 
@@ -25,7 +27,6 @@ module Skylight::Core
           def get_namespace(endpoint)
             ::Grape::Namespace.joined_space(endpoint.namespace_stackable(:namespace))
           end
-
       end
     end
   end

data/lib/skylight/core/normalizers/grape/endpoint_render.rb

@@ -6,20 +6,19 @@ module Skylight::Core
 
         CAT = "app.grape.endpoint".freeze
 
-        def normalize(trace, name, payload)
-          if endpoint = payload[:endpoint]
+        def normalize(_trace, _name, payload)
+          if (endpoint = payload[:endpoint])
             path = get_path(endpoint)
             namespace = get_namespace(endpoint)
             method = get_method(endpoint)
 
-            title = [method, namespace, path].join(' ').gsub(/\s+/, ' ')
+            title = [method, namespace, path].join(" ").gsub(/\s+/, " ")
 
             [CAT, title, nil]
           else
             :skip
           end
         end
-
       end
     end
   end

data/lib/skylight/core/normalizers/grape/endpoint_run.rb

@@ -4,7 +4,7 @@ module Skylight::Core
       class EndpointRun < Endpoint
         register "endpoint_run.grape"
 
-        def normalize(trace, name, payload)
+        def normalize(trace, _name, payload)
           trace.endpoint = get_endpoint_name(payload[:endpoint]) if payload[:endpoint]
 
           # We don't necessarily want this to be all instrumented since it's fairly internal.
@@ -20,7 +20,7 @@ module Skylight::Core
             namespace = get_namespace(endpoint)
 
             if namespace && !namespace.empty?
-              path = "/#{path}" if path[0] != '/'
+              path = "/#{path}" if path[0] != "/"
               path = "#{namespace}#{path}"
             end
 
@@ -35,7 +35,6 @@ module Skylight::Core
               ep.base.name
             end
           end
-
       end
     end
   end

data/lib/skylight/core/normalizers/grape/endpoint_run_filters.rb

@@ -6,7 +6,7 @@ module Skylight::Core
 
         CAT = "app.grape.filters".freeze
 
-        def normalize(trace, name, payload)
+        def normalize(_trace, _name, payload)
           filters = payload[:filters]
           type = payload[:type]
 
@@ -16,7 +16,6 @@ module Skylight::Core
 
           [CAT, "#{type.to_s.capitalize} Filters", nil]
         end
-
       end
     end
   end

data/lib/skylight/core/normalizers/grape/format_response.rb

@@ -8,13 +8,12 @@ module Skylight::Core
 
         def normalize(_trace, _name, payload)
           if (formatter = payload[:formatter])
-            title = formatter.is_a?(Module) ?  formatter.to_s : formatter.class.to_s
+            title = formatter.is_a?(Module) ? formatter.to_s : formatter.class.to_s
             [CAT, title, nil]
           else
             :skip
           end
         end
-
       end
     end
   end

data/lib/skylight/core/normalizers/moped/query.rb

@@ -15,7 +15,7 @@ module Skylight::Core
         #   `Query`, `GetMore`, `Insert`, `Update`, and `Delete`.
         # @option payload [String] :prefix ignored, provided by Moped
         # @return [Array, :skip] the normalized array or `:skip` if not a known operation type
-        def normalize(trace, name, payload)
+        def normalize(_trace, _name, payload)
           # payload: { prefix: "  MOPED: #{address.resolved}", ops: operations }
 
           # We can sometimes have multiple operations. However, it seems like this only happens when doing things
@@ -33,67 +33,62 @@ module Skylight::Core
           end
         end
 
-      private
+        private
 
-        def normalize_query(operation)
-          title = normalize_title("QUERY".freeze, operation)
+          def normalize_query(operation)
+            title = normalize_title("QUERY".freeze, operation)
 
-          hash = extract_binds(operation.selector)
-          description = hash.to_json
+            hash = extract_binds(operation.selector)
+            description = hash.to_json
 
-          [CAT, title, description, { database: operation.database }]
-        end
+            [CAT, title, description, { database: operation.database }]
+          end
 
-        def normalize_get_more(operation)
-          title = normalize_title("GET_MORE".freeze, operation)
+          def normalize_get_more(operation)
+            title = normalize_title("GET_MORE".freeze, operation)
 
-          [CAT, title, nil, { database: operation.database }]
-        end
+            [CAT, title, nil, { database: operation.database }]
+          end
 
-        def normalize_insert(operation)
-          title = normalize_title("INSERT".freeze, operation)
+          def normalize_insert(operation)
+            title = normalize_title("INSERT".freeze, operation)
 
-          [CAT, title, nil, { database: operation.database }]
-        end
+            [CAT, title, nil, { database: operation.database }]
+          end
 
-        def normalize_update(operation)
-          title = normalize_title("UPDATE".freeze, operation)
+          def normalize_update(operation)
+            title = normalize_title("UPDATE".freeze, operation)
 
-          selector_hash = extract_binds(operation.selector)
-          update_hash = extract_binds(operation.update)
+            selector_hash = extract_binds(operation.selector)
+            update_hash = extract_binds(operation.update)
 
-          description = { selector: selector_hash, update: update_hash }.to_json
+            description = { selector: selector_hash, update: update_hash }.to_json
 
-          [CAT, title, description, { database: operation.database }]
-        end
+            [CAT, title, description, { database: operation.database }]
+          end
 
-        def normalize_delete(operation)
-          title = normalize_title("DELETE".freeze, operation)
+          def normalize_delete(operation)
+            title = normalize_title("DELETE".freeze, operation)
 
-          hash = extract_binds(operation.selector)
-          description = hash.to_json
+            hash = extract_binds(operation.selector)
+            description = hash.to_json
 
-          [CAT, title, description, { database: operation.database }]
-        end
+            [CAT, title, description, { database: operation.database }]
+          end
 
-        def normalize_title(type, operation)
-          "#{type} #{operation.collection}"
-        end
+          def normalize_title(type, operation)
+            "#{type} #{operation.collection}"
+          end
 
-        def extract_binds(hash)
-          ret = {}
+          def extract_binds(hash)
+            ret = {}
 
-          hash.each do |k,v|
-            if v.is_a?(Hash)
-              ret[k] = extract_binds(v)
-            else
-              ret[k] = '?'.freeze
+            hash.each do |k, v|
+              ret[k] = v.is_a?(Hash) ? extract_binds(v) : "?".freeze
             end
-          end
-
-          ret
-        end
 
+            ret
+          end
       end
     end
   end

data/lib/skylight/core/normalizers/render.rb

@@ -5,7 +5,7 @@ module Skylight::Core
       include Util::AllocationFree
 
       def setup
-        @paths = config['normalizers.render.view_paths'] || []
+        @paths = config["normalizers.render.view_paths"] || []
       end
 
       # Generic normalizer for renders
@@ -14,12 +14,11 @@ module Skylight::Core
       # @option payload [String] :identifier
       # @return [Array]
       def normalize_render(category, payload)
-        if path = payload[:identifier]
+        if (path = payload[:identifier])
           title = relative_path(path)
-          path = nil if path == title
         end
 
-        [ category, title, nil ]
+        [category, title, nil]
       end
 
       def relative_path(path)
@@ -46,32 +45,34 @@ module Skylight::Core
         end
       end
 
-    private
-      def relative_path?(path)
-        !absolute_path?(path)
-      end
+      private
+
+        def relative_path?(path)
+          !absolute_path?(path)
+        end
 
-      SEPARATOR_BYTE = File::SEPARATOR.ord
+        SEPARATOR_BYTE = File::SEPARATOR.ord
 
-      if File.const_defined?(:NULL) ? File::NULL == "NUL" : RbConfig::CONFIG['host_os'] =~ /mingw|mswin32/
-        # This is a DOSish environment
-        ALT_SEPARATOR_BYTE = File::ALT_SEPARATOR && File::ALT_SEPARATOR.ord
-        COLON_BYTE = ":".ord
-        def absolute_path?(path)
-          if alpha?(path.getbyte(0)) && path.getbyte(1) == COLON_BYTE
-            byte2 = path.getbyte(2)
-            byte2 == SEPARATOR_BYTE || byte2 == ALT_SEPARATOR_BYTE
+        if File.const_defined?(:NULL) ? File::NULL == "NUL" : RbConfig::CONFIG["host_os"] =~ /mingw|mswin32/
+          # This is a DOSish environment
+          ALT_SEPARATOR_BYTE = File::ALT_SEPARATOR && File::ALT_SEPARATOR.ord
+          COLON_BYTE = ":".ord
+          SEPARATOR_BYTES = [SEPARATOR_BYTE, ALT_SEPARATOR_BYTE].freeze
+
+          def absolute_path?(path)
+            if alpha?(path.getbyte(0)) && path.getbyte(1) == COLON_BYTE
+              SEPARATOR_BYTES.include?(path.getbyte(2))
+            end
           end
-        end
 
-        def alpha?(byte)
-          byte >= 65 and byte <= 90 || byte >= 97 and byte <= 122
-        end
-      else
-        def absolute_path?(path)
-          path.getbyte(0) == SEPARATOR_BYTE
+          def alpha?(byte)
+            (byte >= 65 && byte <= 90) || (byte >= 97 && byte <= 122)
+          end
+        else
+          def absolute_path?(path)
+            path.getbyte(0) == SEPARATOR_BYTE
+          end
         end
-      end
     end
   end
 end

data/lib/skylight/core/normalizers/sequel/sql.rb

@@ -1,4 +1,4 @@
-require 'skylight/core/normalizers/sql'
+require "skylight/core/normalizers/sql"
 
 module Skylight::Core
   module Normalizers

data/lib/skylight/core/normalizers/sql.rb

@@ -29,7 +29,7 @@ module Skylight::Core
 
         begin
           extracted_title, sql = extract_binds(trace.instrumenter, payload, binds)
-          [ name, extracted_title || title, sql ]
+          [name, extracted_title || title, sql]
         rescue => e
           if defined?(Skylight::SqlLexError) && e.is_a?(Skylight::SqlLexError)
             if config[:log_sql_parse_errors]
@@ -41,15 +41,15 @@ module Skylight::Core
             config.logger.error "Failed to extract binds in SQL; sql=#{payload[:sql].inspect}; exception=#{e.inspect}"
           end
 
-          [ name, title, nil ]
+          [name, title, nil]
         end
       end
 
       private
 
-      def extract_binds(instrumenter, payload, _precalculated)
-        instrumenter.process_sql(payload[:sql])
-      end
+        def extract_binds(instrumenter, payload, _precalculated)
+          instrumenter.process_sql(payload[:sql])
+        end
     end
   end
 end

data/lib/skylight/core/normalizers.rb

@@ -1,17 +1,16 @@
-require 'skylight/core/normalizers/default'
+require "skylight/core/normalizers/default"
 
 module Skylight::Core
   # @api private
   # Convert AS::N events to Skylight events
   module Normalizers
-
     DEFAULT = Default.new
 
     def self.registry
       @registry ||= {}
     end
 
-    def self.register(name, klass, opts={})
+    def self.register(name, klass, opts = {})
       enabled = opts[:enabled] != false
       registry[name] = [klass, enabled]
     end
@@ -22,9 +21,9 @@ module Skylight::Core
 
     def self.enable(*names, enabled: true)
       names.each do |name|
-        matches = registry.select{|n,_| n =~ /(^|\.)#{name}$/ }
+        matches = registry.select { |n, _| n =~ /(^|\.)#{name}$/ }
         raise ArgumentError, "no normalizers match #{name}" if matches.empty?
-        matches.values.each{|v| v[1] = enabled }
+        matches.values.each { |v| v[1] = enabled }
       end
     end
 
@@ -36,7 +35,7 @@ module Skylight::Core
       normalizers = {}
 
       registry.each do |key, (klass, enabled)|
-        next if !enabled
+        next unless enabled
 
         unless klass.method_defined?(:normalize)
           # TODO: Warn
@@ -50,7 +49,7 @@ module Skylight::Core
     end
 
     class Normalizer
-      def self.register(name, opts={})
+      def self.register(name, opts = {})
         Normalizers.register(name, self, opts)
       end
 
@@ -61,12 +60,11 @@ module Skylight::Core
         setup if respond_to?(:setup)
       end
 
-      def normalize(trace, name, payload)
+      def normalize(_trace, _name, _payload)
         :skip
       end
 
-      def normalize_after(trace, span, name, payload)
-      end
+      def normalize_after(trace, span, name, payload); end
     end
 
     class Container
@@ -94,7 +92,7 @@ module Skylight::Core
       end
     end
 
-    %w( action_controller/process_action
+    %w[ action_controller/process_action
         action_controller/send_file
         action_view/render_collection
         action_view/render_partial
@@ -106,12 +104,13 @@ module Skylight::Core
         active_support/cache
         coach/handler_finish
         coach/middleware_finish
+        couch_potato/query
         data_mapper/sql
         elasticsearch/request
         faraday/request
         grape/endpoint
         moped/query
-        sequel/sql).each do |file|
+        sequel/sql].each do |file|
       require "skylight/core/normalizers/#{file}"
     end
   end

data/lib/skylight/core/probes/action_controller.rb

@@ -5,22 +5,23 @@ module Skylight::Core
         def install
           ::ActionController::Instrumentation.class_eval do
             private
-            alias append_info_to_payload_without_sk append_info_to_payload
-            def append_info_to_payload(payload)
-              append_info_to_payload_without_sk(payload)
-              rendered_mime = begin
-                if respond_to?(:rendered_format)
-                  rendered_format
-                elsif content_type.is_a?(Mime::Type)
-                  content_type
-                elsif content_type.respond_to?(:to_s)
-                  type_str = content_type.to_s.split(';').first
-                  Mime::Type.lookup(type_str) unless type_str.blank?
+
+              alias_method :append_info_to_payload_without_sk, :append_info_to_payload
+              def append_info_to_payload(payload)
+                append_info_to_payload_without_sk(payload)
+                rendered_mime = begin
+                  if respond_to?(:rendered_format)
+                    rendered_format
+                  elsif content_type.is_a?(Mime::Type)
+                    content_type
+                  elsif content_type.respond_to?(:to_s)
+                    type_str = content_type.to_s.split(";").first
+                    Mime::Type.lookup(type_str) unless type_str.blank?
+                  end
                 end
+                payload[:rendered_format] = rendered_mime.try(:ref)
+                payload[:variant] = request.respond_to?(:variant) ? request.variant : nil
               end
-              payload[:rendered_format] = rendered_mime.try(:ref)
-              payload[:variant] = request.respond_to?(:variant) ? request.variant : nil
-            end
           end
         end
       end

data/lib/skylight/core/probes/action_dispatch/request_id.rb

@@ -5,7 +5,7 @@ module Skylight::Core
         class Probe
           def install
             ::ActionDispatch::RequestId.class_eval do
-              alias call_without_sk call
+              alias_method :call_without_sk, :call
 
               def call(env)
                 @skylight_request_id = env["skylight.request_id"]
@@ -14,12 +14,11 @@ module Skylight::Core
 
               private
 
-                alias internal_request_id_without_sk internal_request_id
+                alias_method :internal_request_id_without_sk, :internal_request_id
 
                 def internal_request_id
                   @skylight_request_id || internal_request_id_without_sk
                 end
-
             end
           end
         end

data/lib/skylight/core/probes/action_dispatch/routing/route_set.rb

@@ -6,11 +6,11 @@ module Skylight::Core
           class Probe
             def install
               ::ActionDispatch::Routing::RouteSet.class_eval do
-                alias call_without_sk call
+                alias_method :call_without_sk, :call
 
                 def call(env)
                   Skylight::Core::Fanout.endpoint = self.class.name
-                  Skylight::Core::Fanout.instrument(title: self.class.name, category: 'rack.app') do
+                  Skylight::Core::Fanout.instrument(title: self.class.name, category: "rack.app") do
                     call_without_sk(env)
                   end
                 end
@@ -19,7 +19,6 @@ module Skylight::Core
           end
         end
       end
-
     end
 
     register(:rails_router, "ActionDispatch::Routing::RouteSet", "action_dispatch/routing/route_set", ActionDispatch::Routing::RouteSet::Probe.new)

data/lib/skylight/core/probes/action_dispatch.rb

@@ -1,2 +1,2 @@
-Skylight::Core::Probes.probe('action_dispatch/request_id')
-Skylight::Core::Probes.probe('action_dispatch/routing/route_set')
+Skylight::Core::Probes.probe("action_dispatch/request_id")
+Skylight::Core::Probes.probe("action_dispatch/routing/route_set")