skylight 5.1.0.beta → 5.1.0.beta2

data/CLA.md

@@ -6,4 +6,4 @@ right (whether now known or hereinafter invented), title, and interest,
 throughout the world, including any copyrights and renewals or extensions
 thereto, in the contributions to Skylight made by Assignor.
 
-IN WITNESS THEREOF, Assignor has duly executed this Agreement.
+IN WITNESS THEREOF, Assignor has duly executed this Agreement.

data/LICENSE.md

@@ -28,19 +28,15 @@ brand (if any) provided by Tilde.
 Unless otherwise expressly agreed by Tilde in a separate written
 license agreement, these files are provided AS IS, WITHOUT WARRANTY OF
 ANY KIND, including without any implied warranties of MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE, TITLE, or NON-INFRINGEMENT.  As a
+FITNESS FOR A PARTICULAR PURPOSE, TITLE, or NON-INFRINGEMENT. As a
 condition to your use of these files, you are solely responsible for
 such use. Tilde will have no liability to you for direct,
 indirect, consequential, incidental, special, or punitive damages or
 for lost profits or data.
 
+# Other Licenses
 
-
-Other Licenses
-==============
-
-Ruby on Rails
--------------
+## Ruby on Rails
 
 Copyright (c) 2005-2016 David Heinemeier Hansson
 
@@ -48,9 +44,7 @@ Released under the MIT License.
 
 Original source at https://github.com/rails/rails.
 
-
-HighLine
---------
+## HighLine
 
 Copyright (c) 2014 James Edward Gray II, Gregory Brown, et al.
 
@@ -58,9 +52,7 @@ Distributed under the user's choice of the GPL Version 2 or the Ruby software li
 
 Original source at https://github.com/JEG2/highline.
 
-
-Thor
-----
+## Thor
 
 Copyright (c) 2008 Yehuda Katz, Eric Hodel, et al.
 
@@ -68,12 +60,10 @@ Released under the MIT License.
 
 Original source at https://github.com/erikhuda/thor.
 
-
-ThreadSafe
-----------
+## ThreadSafe
 
 Copyright (c) 2014 Charles Oliver Nutter, thedarkone, et al.
 
 Distributed under Apache License, Version 2.0, January 2004
 
-Original source at https://github.com/ruby-concurrency/thread_safe.
+Original source at https://github.com/ruby-concurrency/thread_safe.

data/README.md

@@ -1,4 +1,5 @@
 # Skylight Ruby Agent
+
 [![Gem Version](https://badge.fury.io/rb/skylight.svg)](https://badge.fury.io/rb/skylight)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=skylight&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=skylight&package-manager=bundler&version-scheme=semver)
 
@@ -9,7 +10,6 @@ Sign up at https://www.skylight.io.
 
 For more documentation see https://www.skylight.io/support.
 
-
 ## Bug Reports and Feature Requests
 
 If you've got a bug report or have a feature you'd like to request, please contact us at support@skylight.io or use the built-in messenger in the Skylight web interface. We'll be much quicker to respond that way :)

data/ext/extconf.rb

@@ -27,13 +27,13 @@ end
 include Skylight::Util
 
 SKYLIGHT_INSTALL_LOG = File.expand_path("install.log", __dir__)
-SKYLIGHT_REQUIRED   = ENV.key?("SKYLIGHT_REQUIRED") && ENV["SKYLIGHT_REQUIRED"] !~ /^false$/i
-SKYLIGHT_FETCH_LIB  = !ENV.key?("SKYLIGHT_FETCH_LIB") || ENV["SKYLIGHT_FETCH_LIB"] !~ /^false$/i
+SKYLIGHT_REQUIRED = ENV.key?("SKYLIGHT_REQUIRED") && ENV["SKYLIGHT_REQUIRED"] !~ /^false$/i
+SKYLIGHT_FETCH_LIB = !ENV.key?("SKYLIGHT_FETCH_LIB") || ENV["SKYLIGHT_FETCH_LIB"] !~ /^false$/i
 
 # Directory where skylight.h exists
 SKYLIGHT_HDR_PATH = ENV["SKYLIGHT_HDR_PATH"] || ENV["SKYLIGHT_LIB_PATH"] || "."
-SKYLIGHT_LIB_PATH = ENV["SKYLIGHT_LIB_PATH"] ||
-                    File.expand_path("../../lib/skylight/native/#{Platform.tuple}", __FILE__)
+SKYLIGHT_LIB_PATH =
+  ENV["SKYLIGHT_LIB_PATH"] || File.expand_path("../../lib/skylight/native/#{Platform.tuple}", __FILE__)
 
 SKYLIGHT_SOURCE_URL = ENV["SKYLIGHT_SOURCE_URL"]
 SKYLIGHT_VERSION = ENV["SKYLIGHT_VERSION"]
@@ -66,26 +66,26 @@ end
 # Check that Xcode license has been approved
 # Based on Homebrew's implementation
 # https://github.com/Homebrew/homebrew/blob/03708b016755847facc4f19a43ee9f7a44141ed7/Library/Homebrew/cmd/doctor.rb#L1183
-if Platform::OS == "darwin"
-  # If the user installs Xcode-only, they have to approve the
-  # license or no "xc*" tool will work.
-  if `/usr/bin/xcrun clang 2>&1` =~ /license/ && !$CHILD_STATUS.success? # rubocop:disable Style/SoleNestedConditional
-    fail <<~MESSAGE
-      You have not agreed to the Xcode license and so we are unable to build the native agent.
-      To resolve this, you can agree to the license by opening Xcode.app or running:
-          sudo xcodebuild -license
-    MESSAGE
-  end
+# If the user installs Xcode-only, they have to approve the
+# license or no "xc*" tool will work.
+
+# prettier-ignore
+if Platform::OS == "darwin" && (`/usr/bin/xcrun clang 2>&1` =~ /license/ && !$CHILD_STATUS.success?)
+  fail <<~MESSAGE
+    You have not agreed to the Xcode license and so we are unable to build the native agent.
+    To resolve this, you can agree to the license by opening Xcode.app or running:
+        sudo xcodebuild -license
+  MESSAGE
 end
 
 #
 # === Setup paths
 #
-root              = File.expand_path(__dir__)
-hdrpath           = File.expand_path(SKYLIGHT_HDR_PATH)
-libpath           = File.expand_path(SKYLIGHT_LIB_PATH)
-libskylight       = File.expand_path("libskylight.#{Platform.libext}", libpath)
-libskylight_yml   = File.expand_path("libskylight.yml", root)
+root = File.expand_path(__dir__)
+hdrpath = File.expand_path(SKYLIGHT_HDR_PATH)
+libpath = File.expand_path(SKYLIGHT_LIB_PATH)
+libskylight = File.expand_path("libskylight.#{Platform.libext}", libpath)
+libskylight_yml = File.expand_path("libskylight.yml", root)
 skylight_dlopen_h = File.expand_path("skylight_dlopen.h", hdrpath)
 skylight_dlopen_c = File.expand_path("skylight_dlopen.c", hdrpath)
 
@@ -97,14 +97,10 @@ LOG.info "file exists; path=#{skylight_dlopen_h}" if File.exist?(skylight_dlopen
 
 # If libskylight is not present, fetch it
 if !File.exist?(libskylight) && !File.exist?(skylight_dlopen_c) && !File.exist?(skylight_dlopen_h)
-  unless SKYLIGHT_FETCH_LIB
-    fail "libskylight.#{LIBEXT} not found -- remote download disabled; aborting install"
-  end
+  fail "libskylight.#{LIBEXT} not found -- remote download disabled; aborting install" unless SKYLIGHT_FETCH_LIB
 
   # Ensure that libskylight.yml is present and load it
-  unless File.exist?(libskylight_yml)
-    fail "`#{libskylight_yml}` does not exist"
-  end
+  fail "`#{libskylight_yml}` does not exist" unless File.exist?(libskylight_yml)
 
   unless (libskylight_info = YAML.load_file(libskylight_yml))
     fail "`#{libskylight_yml}` does not contain data"
@@ -133,26 +129,26 @@ if !File.exist?(libskylight) && !File.exist?(skylight_dlopen_c) && !File.exist?(
 
     unless (checksum = checksums[Platform.tuple])
       fail "no checksum entry for requested architecture -- " \
-              "this probably means the requested architecture is not supported; " \
-              "platform=#{Platform.tuple}; available=#{checksums.keys}", :info
+             "this probably means the requested architecture is not supported; " \
+             "platform=#{Platform.tuple}; available=#{checksums.keys}",
+           :info
     end
   end
 
   begin
-    res = Skylight::NativeExtFetcher.fetch(
-      source:   SKYLIGHT_SOURCE_URL,
-      version:  version,
-      target:   hdrpath,
-      checksum: checksum,
-      arch:     Platform.tuple,
-      required: SKYLIGHT_REQUIRED,
-      platform: Platform.tuple,
-      logger:   LOG
-    )
-
-    unless res
-      fail "could not fetch archive -- aborting skylight native extension build"
-    end
+    res =
+      Skylight::NativeExtFetcher.fetch(
+        source: SKYLIGHT_SOURCE_URL,
+        version: version,
+        target: hdrpath,
+        checksum: checksum,
+        arch: Platform.tuple,
+        required: SKYLIGHT_REQUIRED,
+        platform: Platform.tuple,
+        logger: LOG
+      )
+
+    fail "could not fetch archive -- aborting skylight native extension build" unless res
 
     # Move skylightd & libskylight to appropriate directory
     if hdrpath != libpath
@@ -160,15 +156,11 @@ if !File.exist?(libskylight) && !File.exist?(skylight_dlopen_c) && !File.exist?(
       FileUtils.mkdir_p libpath
 
       # Move
-      FileUtils.mv "#{hdrpath}/libskylight.#{Platform.libext}",
-                   "#{libpath}/libskylight.#{Platform.libext}",
-                   force: true
+      FileUtils.mv "#{hdrpath}/libskylight.#{Platform.libext}", "#{libpath}/libskylight.#{Platform.libext}", force: true
 
-      FileUtils.mv "#{hdrpath}/skylightd",
-                   "#{libpath}/skylightd",
-                   force: true
+      FileUtils.mv "#{hdrpath}/skylightd", "#{libpath}/skylightd", force: true
     end
-  rescue => e
+  rescue StandardError => e
     fail "unable to fetch native extension; msg=#{e.message}\n#{e.backtrace.join("\n")}"
   end
 end
@@ -182,9 +174,7 @@ end
 def find_file(file, root = nil)
   path = File.expand_path(file, root || ".")
 
-  unless File.exist?(path)
-    fail "#{file} missing; path=#{root}"
-  end
+  fail "#{file} missing; path=#{root}" unless File.exist?(path)
 end
 
 $VPATH << libpath
@@ -218,9 +208,7 @@ end
 #   flag can cause issues for some customers we're turning it off by default. However,
 #   in development and CI, we still have the option of turning it back on to help catch
 #   potential issues.
-if SKYLIGHT_EXT_STRICT
-  $CFLAGS << " -Werror"
-end
+$CFLAGS << " -Werror" if SKYLIGHT_EXT_STRICT
 
 checking_for "fast thread local storage" do
   if try_compile("__thread int foo;")

data/lib/skylight.rb

@@ -23,13 +23,12 @@ require "active_support/notifications"
 
 # Specifically check for Railtie since we've had at least one case of a
 #   customer having Rails defined without having all of Rails loaded.
-if defined?(Rails::Railtie)
-  require "skylight/railtie"
-end
+require "skylight/railtie" if defined?(Rails::Railtie)
 
 module Skylight
   # Used from the CLI
   autoload :CLI, "skylight/cli"
+
   # Is this autoload even useful?
   autoload :Normalizers, "skylight/normalizers"
 
@@ -38,18 +37,10 @@ module Skylight
   LOCK = Mutex.new
 
   # @api private
-  TIERS = %w[
-    rack
-    api
-    app
-    view
-    db
-    noise
-    other
-  ].freeze
+  TIERS = %w[rack api app view db noise other].freeze
 
   # @api private
-  TIER_REGEX = /^(?:#{TIERS.join('|')})(?:\.|$)/u.freeze
+  TIER_REGEX = /^(?:#{TIERS.join("|")})(?:\.|$)/u.freeze
 
   # @api private
   CATEGORY_REGEX = /^[a-z0-9_-]+(?:\.[a-z0-9_-]+)*$/iu.freeze
@@ -91,14 +82,15 @@ module Skylight
 
         @instrumenter = Instrumenter.new(config).start!
       end
-    rescue => e
+    rescue StandardError => e
       level, message =
         if e.is_a?(ConfigError)
-          [:warn, format("Unable to start Instrumenter due to a configuration error: %<message>s",
-                         message: e.message)]
+          [:warn, format("Unable to start Instrumenter due to a configuration error: %<message>s", message: e.message)]
         else
-          [:error, format("Unable to start Instrumenter; msg=%<message>s; class=%<klass>s",
-                          message: e.message, klass: e.class)]
+          [
+            :error,
+            format("Unable to start Instrumenter; msg=%<message>s; class=%<klass>s", message: e.message, klass: e.class)
+          ]
         end
 
       if config.respond_to?("log_#{level}") && config.respond_to?(:log_trace)
@@ -182,16 +174,16 @@ module Skylight
       end
 
       if opts.is_a?(Hash)
-        category    = opts[:category] || DEFAULT_CATEGORY
-        title       = opts[:title]
-        desc        = opts[:description]
-        meta        = opts[:meta]
+        category = opts[:category] || DEFAULT_CATEGORY
+        title = opts[:title]
+        desc = opts[:description]
+        meta = opts[:meta]
       else
-        category    = DEFAULT_CATEGORY
-        title       = opts.to_s
-        desc        = nil
-        meta        = nil
-        opts        = {}
+        category = DEFAULT_CATEGORY
+        title = opts.to_s
+        desc = nil
+        meta = nil
+        opts = {}
       end
 
       # NOTE: unless we have `:internal` (indicating a built-in Skylight instrument block),
@@ -225,9 +217,7 @@ module Skylight
     # Runs the shutdown procedure in the background.
     # This should do little more than unsubscribe from all ActiveSupport::Notifications
     def spawn_shutdown_thread!
-      @shutdown_thread || const_get(:LOCK).synchronize do
-        @shutdown_thread ||= Thread.new { @instrumenter&.shutdown }
-      end
+      @shutdown_thread || const_get(:LOCK).synchronize { @shutdown_thread ||= Thread.new { @instrumenter&.shutdown } }
     end
   end
 end

data/lib/skylight/api.rb

@@ -8,11 +8,14 @@ module Skylight
 
     attr_reader :config
 
-    class Error < StandardError; end
+    class Error < StandardError
+    end
 
-    class Unauthorized < Error; end
+    class Unauthorized < Error
+    end
 
-    class Conflict < Error; end
+    class Conflict < Error
+    end
 
     class CreateFailed < Error
       attr_reader :res
@@ -71,6 +74,7 @@ module Skylight
       def token_valid?
         # Don't prevent boot if it's an error response, so assume token is valid
         return true if error_response?
+
         # A 2xx response means everything is good!
         return true if raw_response.success?
         return false if status == 401
@@ -139,22 +143,22 @@ module Skylight
 
     private
 
-      # TODO: Improve handling here: https://github.com/tildeio/direwolf-agent/issues/274
-      def http_request(service, method, *args)
-        http = Util::HTTP.new(config, service)
-        uri = URI.parse(config.get("#{service}_url"))
-        http.send(method, uri.path, *args)
-      end
+    # TODO: Improve handling here: https://github.com/tildeio/direwolf-agent/issues/274
+    def http_request(service, method, *args)
+      http = Util::HTTP.new(config, service)
+      uri = URI.parse(config.get("#{service}_url"))
+      http.send(method, uri.path, *args)
+    end
 
-      def error_for_status(code)
-        case code
-        when 401
-          Unauthorized
-        when 409
-          Conflict
-        else
-          Error
-        end
+    def error_for_status(code)
+      case code
+      when 401
+        Unauthorized
+      when 409
+        Conflict
+      else
+        Error
       end
+    end
   end
 end

data/lib/skylight/cli.rb

@@ -28,12 +28,13 @@ module Skylight
             Visit your app at https://www.skylight.io/app or remove config/skylight.yml
             to set it up as a new app in Skylight.
           OUT
+
           return
         end
 
         res = api.create_app(app_name, token)
 
-        config[:application]    = res.get("app.id")
+        config[:application] = res.get("app.id")
         config[:authentication] = res.get("app.token")
         config.write(config_path)
 
@@ -71,8 +72,9 @@ module Skylight
         say "Development mode warning disabled", :green
       end
 
-      desc "disable_env_warning", "Disables warning about running Skylight in environments not defined in " \
-                                  "config.skylight.environments"
+      desc "disable_env_warning",
+           "Disables warning about running Skylight in environments not defined in " \
+             "config.skylight.environments"
       def disable_env_warning
         user_config.disable_env_warning = true
         user_config.save
@@ -82,57 +84,56 @@ module Skylight
 
       private
 
-        def app_name
-          @app_name ||=
-            begin
-              name = nil
-
-              if rails?
-                # Get the name in a process so that we don't pollute our environment here
-                # This is especially important since users may have things like WebMock that
-                # will prevent us from communicating with the Skylight API
-                begin
-                  namefile = Tempfile.new("skylight-app-name")
-                  # Windows appears to need double quotes for `rails runner`
-                  `rails runner "File.open('#{namefile.path}', 'w') {|f| f.write(Rails.application.class.name) rescue '' }"` # rubocop:disable Layout/LineLength
-                  name = namefile.read.split("::").first.underscore.titleize
-                  name = nil if name.empty?
-                rescue => e
-                  if ENV["DEBUG"]
-                    puts e.class.name
-                    puts e.to_s
-                    puts e.backtrace.join("\n")
-                  end
-                ensure
-                  namefile.close
-                  namefile.unlink
-                end
-
-                unless name
-                  warn "Unable to determine Rails application name. Using directory name."
+      def app_name
+        @app_name ||=
+          begin
+            name = nil
+
+            if rails?
+              # Get the name in a process so that we don't pollute our environment here
+              # This is especially important since users may have things like WebMock that
+              # will prevent us from communicating with the Skylight API
+              begin
+                namefile = Tempfile.new("skylight-app-name")
+
+                # Windows appears to need double quotes for `rails runner`
+                `rails runner "File.open('#{namefile.path}', 'w') {|f| f.write(Rails.application.class.name) rescue '' }"`
+                name = namefile.read.split("::").first.underscore.titleize
+                name = nil if name.empty?
+              rescue StandardError => e
+                if ENV["DEBUG"]
+                  puts e.class.name
+                  puts e.to_s
+                  puts e.backtrace.join("\n")
                 end
+              ensure
+                namefile.close
+                namefile.unlink
               end
 
-              name || File.basename(File.expand_path(".")).titleize
+              warn "Unable to determine Rails application name. Using directory name." unless name
             end
-        end
 
-        # Is this duplicated?
-        def relative_config_path
-          "config/skylight.yml"
-        end
+            name || File.basename(File.expand_path(".")).titleize
+          end
+      end
 
-        def config_path
-          File.expand_path(relative_config_path)
-        end
+      # Is this duplicated?
+      def relative_config_path
+        "config/skylight.yml"
+      end
 
-        def api
-          @api ||= Api.new(config)
-        end
+      def config_path
+        File.expand_path(relative_config_path)
+      end
 
-        def user_config
-          config.user_config
-        end
+      def api
+        @api ||= Api.new(config)
+      end
+
+      def user_config
+        config.user_config
+      end
     end
   end
 end