skylight 5.0.0.beta4 → 5.1.0.beta2

data/lib/skylight/probes/action_controller.rb

@@ -7,42 +7,46 @@ module Skylight
           ::ActionController::Instrumentation.class_eval do
             private
 
-              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)
+            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)
 
-                payload[:sk_rendered_format] = sk_rendered_mime.try(:ref)
-                payload[:sk_variant] = request.respond_to?(:variant) ? request.variant : nil
-              end
+              payload[:sk_rendered_format] = sk_rendered_mime.try(:ref)
+              payload[:sk_variant] = request.respond_to?(:variant) ? request.variant : nil
+            end
 
-              def sk_rendered_mime
-                if respond_to?(:media_type)
-                  mt = media_type
-                  return mt && Mime::Type.lookup(mt)
-                end
+            def sk_rendered_mime
+              if respond_to?(:media_type)
+                mt = media_type
+                return mt && Mime::Type.lookup(mt)
+              end
 
-                if 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?
-                elsif respond_to?(:rendered_format) && rendered_format
-                  rendered_format
-                end
-              rescue
-                # There are cases in which actionpack can return
-                # a stringified representation of a Mime::NullType instance,
-                # which is invalid for a number of reasons. This string raises
-                # errors when piped through Mime::Type.lookup, so it's probably
-                # best to just return nil in those cases.
-                nil
+              if 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?
+              elsif respond_to?(:rendered_format) && rendered_format
+                rendered_format
               end
+            rescue StandardError
+              # There are cases in which actionpack can return
+              # a stringified representation of a Mime::NullType instance,
+              # which is invalid for a number of reasons. This string raises
+              # errors when piped through Mime::Type.lookup, so it's probably
+              # best to just return nil in those cases.
+              nil
+            end
           end
         end
       end
     end
 
-    register(:action_controller, "ActionController::Instrumentation", "action_controller/metal/instrumentation",
-             ActionController::Probe.new)
+    register(
+      :action_controller,
+      "ActionController::Instrumentation",
+      "action_controller/metal/instrumentation",
+      ActionController::Probe.new
+    )
   end
 end

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

@@ -10,9 +10,9 @@ module Skylight
 
           private
 
-            def internal_request_id
-              @skylight_request_id || super
-            end
+          def internal_request_id
+            @skylight_request_id || super
+          end
         end
 
         class Probe
@@ -23,7 +23,11 @@ module Skylight
       end
     end
 
-    register(:action_dispatch, "ActionDispatch::RequestId", "action_dispatch/middleware/request_id",
-             ActionDispatch::RequestId::Probe.new)
+    register(
+      :action_dispatch,
+      "ActionDispatch::RequestId",
+      "action_dispatch/middleware/request_id",
+      ActionDispatch::RequestId::Probe.new
+    )
   end
 end

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

@@ -7,9 +7,7 @@ module Skylight
         module RouteSet
           module Instrumentation
             def call(env)
-              ActiveSupport::Notifications.instrument("route_set.action_dispatch") do
-                super
-              end
+              ActiveSupport::Notifications.instrument("route_set.action_dispatch") { super }
             end
           end
 
@@ -22,7 +20,11 @@ module Skylight
       end
     end
 
-    register(:rails_router, "ActionDispatch::Routing::RouteSet", "action_dispatch/routing/route_set",
-             ActionDispatch::Routing::RouteSet::Probe.new)
+    register(
+      :rails_router,
+      "ActionDispatch::Routing::RouteSet",
+      "action_dispatch/routing/route_set",
+      ActionDispatch::Routing::RouteSet::Probe.new
+    )
   end
 end

data/lib/skylight/probes/action_view.rb

@@ -5,19 +5,18 @@ module Skylight
     module ActionView
       module Instrumentation
         def render_with_layout(*args) #:nodoc:
-          path, locals = case args.length
-                         when 2
-                           args
-                         when 4
-                           # Rails > 6.0.0.beta3 arguments are (view, template, path, locals)
-                           [args[2], args[3]]
-                         end
+          path, locals =
+            case args.length
+            when 2
+              args
+            when 4
+              # Rails > 6.0.0.beta3 arguments are (view, template, path, locals)
+              [args[2], args[3]]
+            end
 
           layout = nil
 
-          if path
-            layout = find_layout(path, locals.keys, [formats.first])
-          end
+          layout = find_layout(path, locals.keys, [formats.first]) if path
 
           if layout
             ActiveSupport::Notifications.instrument("render_template.action_view", identifier: layout.identifier) do

data/lib/skylight/probes/active_job_enqueue.rb

@@ -14,17 +14,11 @@ module Skylight
             name, job_class_name = Normalizers::ActiveJob::Perform.normalize_title(job)
             descriptors = ["adapter: '#{adapter_name}'", "queue: '#{job.queue_name}'"]
             descriptors << "job: '#{job_class_name}'" if job_class_name
-            desc = "{ #{descriptors.join(', ')} }"
-          rescue
+            desc = "{ #{descriptors.join(", ")} }"
+          rescue StandardError
             block.call
           else
-            Skylight.instrument(
-              title:       "Enqueue #{name}",
-              category:    CAT,
-              description: desc,
-              internal:    true,
-              &block
-            )
+            Skylight.instrument(title: "Enqueue #{name}", category: CAT, description: desc, internal: true, &block)
           end
 
           self.class.instance_eval do

data/lib/skylight/probes/active_model_serializers.rb

@@ -18,9 +18,7 @@ module Skylight
           rescue LoadError # rubocop:disable Lint/SuppressedException
           end
 
-          if Gem.loaded_specs["active_model_serializers"]
-            version = Gem.loaded_specs["active_model_serializers"].version
-          end
+          version = Gem.loaded_specs["active_model_serializers"].version if Gem.loaded_specs["active_model_serializers"]
 
           if !version || version < Gem::Version.new("0.5.0")
             Skylight.error "Instrumention is only available for ActiveModelSerializers version 0.5.0 and greater."
@@ -37,14 +35,16 @@ module Skylight
           # End users could override as_json without calling super, but it's likely safer
           # than overriding serializable_array/hash/object.
 
-          [::ActiveModel::Serializer, ::ActiveModel::ArraySerializer].each do |klass|
-            klass.prepend(Instrumentation)
-          end
+          [::ActiveModel::Serializer, ::ActiveModel::ArraySerializer].each { |klass| klass.prepend(Instrumentation) }
         end
       end
     end
 
-    register(:active_model_serializers, "ActiveModel::Serializer", "active_model/serializer",
-             ActiveModelSerializers::Probe.new)
+    register(
+      :active_model_serializers,
+      "ActiveModel::Serializer",
+      "active_model/serializer",
+      ActiveModelSerializers::Probe.new
+    )
   end
 end

data/lib/skylight/probes/delayed_job.rb

@@ -10,13 +10,9 @@ module Skylight
 
         class Plugin < ::Delayed::Plugin
           callbacks do |lifecycle|
-            lifecycle.around(:perform) do |worker, job, &block|
-              sk_instrument(worker, job, &block)
-            end
+            lifecycle.around(:perform) { |worker, job, &block| sk_instrument(worker, job, &block) }
 
-            lifecycle.after(:error) do |_worker, _job|
-              Skylight.trace&.segment = "error"
-            end
+            lifecycle.after(:error) { |_worker, _job| Skylight.trace&.segment = "error" }
           end
 
           class << self
@@ -25,15 +21,19 @@ module Skylight
             def sk_instrument(_worker, job)
               endpoint = Skylight::Probes::DelayedJob.handler_name(job)
 
-              Skylight.trace(endpoint,
-                             "app.delayed_job.worker",
-                             "Delayed::Worker#run",
-                             component: :worker,
-                             segment:   job.queue,
-                             meta:      { source_location: "delayed_job" }) do
-                               t { "Delayed::Job beginning trace" }
-                               yield
-                             end
+              Skylight.trace(
+                endpoint,
+                "app.delayed_job.worker",
+                "Delayed::Worker#run",
+                component: :worker,
+                segment: job.queue,
+                meta: {
+                  source_location: "delayed_job"
+                }
+              ) do
+                t { "Delayed::Job beginning trace" }
+                yield
+              end
             end
           end
         end
@@ -44,11 +44,8 @@ module Skylight
       UNKNOWN = "<Delayed::Job Unknown>"
 
       def self.handler_name(job)
-        payload_object = if job.respond_to?(:payload_object_without_sk)
-                           job.payload_object_without_sk
-                         else
-                           job.payload_object
-                         end
+        payload_object =
+          job.respond_to?(:payload_object_without_sk) ? job.payload_object_without_sk : job.payload_object
 
         payload_object_name(payload_object)
       end
@@ -62,7 +59,7 @@ module Skylight
           # Use class name instead to avoid this.
           payload_object.class.name
         end
-      rescue
+      rescue StandardError
         UNKNOWN
       end
 
@@ -84,8 +81,10 @@ module Skylight
 
           opts = {
             category: "app.delayed_job.job",
-            title:    format_source(*source_meta),
-            meta:     { source_location_hint: source_meta },
+            title: format_source(*source_meta),
+            meta: {
+              source_location_hint: source_meta
+            },
             internal: true
           }
 
@@ -99,13 +98,9 @@ module Skylight
 
         private
 
-          def format_source(method_type, constant_name, method_name)
-            if method_type == :instance_method
-              "#{constant_name}##{method_name}"
-            else
-              "#{constant_name}.#{method_name}"
-            end
-          end
+        def format_source(method_type, constant_name, method_name)
+          method_type == :instance_method ? "#{constant_name}##{method_name}" : "#{constant_name}.#{method_name}"
+        end
       end
 
       class Probe
@@ -124,23 +119,23 @@ module Skylight
 
         private
 
-          def plugin_defined?
-            defined?(::Skylight::Probes::DelayedJob::Plugin)
-          end
+        def plugin_defined?
+          defined?(::Skylight::Probes::DelayedJob::Plugin)
+        end
 
-          def validate_version
-            spec = Gem.loaded_specs["delayed_job"]
-            version = spec&.version
+        def validate_version
+          spec = Gem.loaded_specs["delayed_job"]
+          version = spec&.version
 
-            if !version || version < Gem::Version.new("4.0.0")
-              Skylight.error "The installed version of DelayedJob is not supported on Skylight. " \
+          if !version || version < Gem::Version.new("4.0.0")
+            Skylight.error "The installed version of DelayedJob is not supported on Skylight. " \
                              "Your jobs will not be tracked."
 
-              return false
-            end
-
-            true
+            return false
           end
+
+          true
+        end
       end
     end
 

data/lib/skylight/probes/elasticsearch.rb

@@ -9,16 +9,14 @@ module Skylight
             def perform_request(method, path, *args, &block)
               ActiveSupport::Notifications.instrument(
                 "request.elasticsearch",
-                name:   "Request",
+                name: "Request",
                 method: method,
-                path:   path
+                path: path
               ) do
                 # Prevent HTTP-related probes from firing
                 Skylight::Normalizers::Faraday::Request.disable do
                   disable_skylight_probe(:NetHTTP) do
-                    disable_skylight_probe(:HTTPClient) do
-                      perform_request_without_sk(method, path, *args, &block)
-                    end
+                    disable_skylight_probe(:HTTPClient) { perform_request_without_sk(method, path, *args, &block) }
                   end
                 end
               end
@@ -26,7 +24,7 @@ module Skylight
 
             def disable_skylight_probe(class_name)
               klass = ::ActiveSupport::Inflector.safe_constantize("Skylight::Probes::#{class_name}::Probe")
-              (klass ? klass.disable { yield } : yield).tap { puts "re-enabling: #{klass}" }
+              (klass ? klass.disable { yield } : yield).tap { Skylight.log(:debug, "re-enabling: #{klass}") }
             end
           end
         end

data/lib/skylight/probes/excon.rb

@@ -14,7 +14,7 @@ module Skylight
             ::Excon.defaults[:middlewares].insert(idx, Probes::Excon::Middleware)
           else
             Skylight.error "The installed version of Excon doesn't support Middlewares. " \
-                           "The Excon probe will be disabled."
+                             "The Excon probe will be disabled."
           end
         end
       end

data/lib/skylight/probes/excon/middleware.rb

@@ -33,33 +33,32 @@ module Skylight
 
         private
 
-          def begin_instrumentation(datum)
-            method = datum[:method].to_s
-            scheme = datum[:scheme]
-            host   = datum[:host]
-            # TODO: Maybe don't show other default ports like 443
-            port   = datum[:port] == 80 ? nil : datum[:port]
-            path   = datum[:path]
-            query  = datum[:query]
+        def begin_instrumentation(datum)
+          method = datum[:method].to_s
+          scheme = datum[:scheme]
+          host = datum[:host]
 
-            opts = Formatters::HTTP.build_opts(method, scheme, host, port, path, query)
+          # TODO: Maybe don't show other default ports like 443
+          port = datum[:port] == 80 ? nil : datum[:port]
+          path = datum[:path]
+          query = datum[:query]
 
-            @requests[datum] = Skylight.instrument(opts)
-          rescue Exception => e
-            Skylight.error "failed to begin instrumentation for Excon; msg=%s", e.message
-          end
+          opts = Formatters::HTTP.build_opts(method, scheme, host, port, path, query)
+
+          @requests[datum] = Skylight.instrument(opts)
+        rescue Exception => e
+          Skylight.error "failed to begin instrumentation for Excon; msg=%s", e.message
+        end
 
-          def end_instrumentation(datum)
-            if (request = @requests.delete(datum))
-              meta = {}
-              if datum[:error].is_a?(Exception)
-                meta[:exception_object] = datum[:error]
-              end
-              Skylight.done(request, meta)
-            end
-          rescue Exception => e
-            Skylight.error "failed to end instrumentation for Excon; msg=%s", e.message
+        def end_instrumentation(datum)
+          if (request = @requests.delete(datum))
+            meta = {}
+            meta[:exception_object] = datum[:error] if datum[:error].is_a?(Exception)
+            Skylight.done(request, meta)
           end
+        rescue Exception => e
+          Skylight.error "failed to end instrumentation for Excon; msg=%s", e.message
+        end
       end
     end
   end

data/lib/skylight/probes/graphql.rb

@@ -20,16 +20,11 @@ module Skylight
       class Probe
         def install
           tracing_klass_name = "::GraphQL::Tracing::ActiveSupportNotificationsTracing"
-          klasses_to_probe = %w[
-            ::GraphQL::Execution::Multiplex
-            ::GraphQL::Query
-          ]
+          klasses_to_probe = %w[::GraphQL::Execution::Multiplex ::GraphQL::Query]
 
           return unless ([tracing_klass_name] + klasses_to_probe).all?(&method(:safe_constantize))
 
-          klasses_to_probe.each do |klass_name|
-            safe_constantize(klass_name).prepend(Instrumentation)
-          end
+          klasses_to_probe.each { |klass_name| safe_constantize(klass_name).prepend(Instrumentation) }
         end
 
         def safe_constantize(klass_name)