skylight 4.3.2 → 5.1.1

data/lib/skylight/user_config.rb

@@ -0,0 +1,58 @@
+require "yaml"
+require "skylight/errors"
+
+module Skylight
+  class UserConfig
+    attr_accessor :disable_dev_warning, :disable_env_warning
+
+    def initialize(config)
+      @config = config
+      @file_path = nil
+      reload
+    end
+
+    def file_path
+      return @file_path if @file_path
+
+      config_path =
+        @config[:user_config_path] ||
+          begin
+            require "etc"
+            home_dir = ENV["HOME"] || Etc.getpwuid.dir || (ENV["USER"] && File.expand_path("~#{ENV["USER"]}"))
+            if home_dir
+              File.join(home_dir, ".skylight")
+            else
+              raise ConfigError,
+                    "The Skylight `user_config_path` must be defined since the home directory cannot be inferred"
+            end
+          end
+
+      @file_path = File.expand_path(config_path)
+    end
+
+    def disable_dev_warning?
+      disable_dev_warning || ENV["SKYLIGHT_DISABLE_DEV_WARNING"] =~ /^true$/i
+    end
+
+    def disable_env_warning?
+      disable_env_warning
+    end
+
+    def reload
+      config = File.exist?(file_path) ? YAML.load_file(file_path) : false
+      return unless config
+
+      self.disable_dev_warning = !!config["disable_dev_warning"]
+      self.disable_env_warning = !!config["disable_env_warning"]
+    end
+
+    def save
+      FileUtils.mkdir_p(File.dirname(file_path))
+      File.open(file_path, "w") { |f| f.puts YAML.dump(to_hash) }
+    end
+
+    def to_hash
+      { "disable_dev_warning" => disable_dev_warning, "disable_env_warning" => disable_env_warning }
+    end
+  end
+end

data/lib/skylight/util.rb

@@ -0,0 +1,12 @@
+module Skylight
+  # @api private
+  module Util
+    # Used from the main lib
+    require "skylight/util/allocation_free"
+    require "skylight/util/clock"
+    require "skylight/util/instrumenter_method"
+
+    # Used from the CLI
+    autoload :Gzip, "skylight/util/gzip"
+  end
+end

data/lib/skylight/util/allocation_free.rb

@@ -0,0 +1,26 @@
+module Skylight
+  module Util
+    # Helpers to reduce memory allocation
+    module AllocationFree
+      # Find an item in an array without allocation.
+      #
+      # @param array [Array] the array to search
+      # @yield a block called against each item until a match is found
+      # @yieldparam item an item from the array
+      # @yieldreturn [Boolean] whether `item` matches the criteria
+      # return the found item or nil, if nothing found
+      def array_find(array)
+        i = 0
+
+        while i < array.size
+          item = array[i]
+          return item if yield item
+
+          i += 1
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/skylight/util/clock.rb

@@ -0,0 +1,57 @@
+module Skylight
+  module Util
+    # A more precise clock
+    class Clock
+      def self.use_native!
+        class_eval do
+          def tick
+            native_hrtime
+          end
+        end
+      end
+
+      # rubocop:disable Lint/DuplicateMethods
+      def tick
+        now = Time.now
+        now.to_i * 1_000_000_000 + now.usec * 1_000
+      end
+
+      # rubocop:enable Lint/DuplicateMethods
+
+      # TODO: rename to secs
+      def absolute_secs
+        Time.now.to_i
+      end
+
+      # TODO: remove
+      def nanos
+        tick
+      end
+
+      # TODO: remove
+      def secs
+        nanos / 1_000_000_000
+      end
+
+      class << self
+        def absolute_secs
+          default.absolute_secs
+        end
+
+        def nanos
+          default.nanos
+        end
+
+        def secs
+          default.secs
+        end
+
+        def default
+          @default ||= Clock.new
+        end
+
+        attr_writer :default
+      end
+    end
+  end
+end

data/lib/skylight/util/component.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "uri"
 
 module Skylight
@@ -6,16 +7,17 @@ module Skylight
     class Component
       attr_accessor :environment, :name
 
-      NAME_FORMAT = /\A[a-zA-Z0-9_-]+\z/
+      NAME_FORMAT = /\A[a-zA-Z0-9_-]+\z/.freeze
       DEFAULT_NAME = "web"
       WORKER_NAME = "worker"
       DEFAULT_ENVIRONMENT = "production"
 
       def initialize(environment, name, force_worker: false)
         @environment = environment || DEFAULT_ENVIRONMENT
-        @name        = resolve_name(name, force_worker)
+        @name = resolve_name(name, force_worker)
 
         raise ArgumentError, "environment can't be blank" if @environment.empty?
+
         validate_string!(@environment, "environment")
         validate_string!(@name, "name")
       end
@@ -38,34 +40,32 @@ module Skylight
 
       # keys here should match those from the main config
       def as_json(*)
-        {
-          component: name,
-          env: environment
-        }
+        { component: name, env: environment }
       end
 
       private
 
-        def program_name
-          $PROGRAM_NAME
-        end
+      def program_name
+        $PROGRAM_NAME
+      end
 
-        def argv
-          ARGV
-        end
+      def argv
+        ARGV
+      end
 
-        def resolve_name(given_name, force_worker)
-          # don't allow workers to be called 'web'
-          return WORKER_NAME if force_worker && (given_name.nil? || given_name == DEFAULT_NAME)
-          return DEFAULT_NAME if given_name.nil?
+      def resolve_name(given_name, force_worker)
+        # don't allow workers to be called 'web'
+        return WORKER_NAME if force_worker && (given_name.nil? || given_name == DEFAULT_NAME)
+        return DEFAULT_NAME if given_name.nil?
 
-          given_name
-        end
+        given_name
+      end
+
+      def validate_string!(string, kind)
+        return true if string =~ NAME_FORMAT
 
-        def validate_string!(string, kind)
-          return true if string =~ NAME_FORMAT
-          raise ArgumentError, "#{kind} can only contain lowercase letters, numbers, and dashes"
-        end
+        raise ArgumentError, "#{kind} can only contain lowercase letters, numbers, and dashes"
+      end
     end
   end
 end

data/lib/skylight/util/deploy.rb

@@ -1,5 +1,5 @@
 require "json"
-require "skylight/core/util/logging"
+require "skylight/util/logging"
 
 module Skylight
   module Util
@@ -13,8 +13,7 @@ module Skylight
       end
 
       class EmptyDeploy
-        attr_reader :config
-        attr_reader :timestamp
+        attr_reader :config, :timestamp
 
         def initialize(config)
           @config = config
@@ -35,8 +34,8 @@ module Skylight
 
         def to_query_hash
           hash = {
-            timestamp:   timestamp,
-            deploy_id:   id.to_s[0..100] # Keep this sane
+            timestamp: timestamp,
+            deploy_id: id.to_s[0..100] # Keep this sane
           }
           hash[:git_sha] = git_sha.to_s[0..40] if git_sha # A valid SHA will never exceed 40
           hash[:description] = description[0..255] if description # Avoid massive descriptions
@@ -45,13 +44,11 @@ module Skylight
       end
 
       class DefaultDeploy < EmptyDeploy
-        include Core::Util::Logging
+        include Util::Logging
 
         def initialize(*)
           super
-          if description && !id
-            warn "The configured deploy will be ignored as an id or git_sha must be provided."
-          end
+          warn "The configured deploy will be ignored as an id or git_sha must be provided." if description && !id
         end
 
         def id
@@ -87,15 +84,13 @@ module Skylight
 
         private
 
-          def get_info
-            info_path = config[:'heroku.dyno_info_path']
+        def get_info
+          info_path = config[:'heroku.dyno_info_path']
 
-            if File.exist?(info_path)
-              if (info = JSON.parse(File.read(info_path)))
-                info["release"]
-              end
-            end
+          if File.exist?(info_path) && (info = JSON.parse(File.read(info_path)))
+            info["release"]
           end
+        end
       end
 
       class GitDeploy < EmptyDeploy
@@ -108,12 +103,12 @@ module Skylight
 
         private
 
-          def get_info
-            Dir.chdir(config.root) do
-              info = `git log -1 --pretty="%H %s" 2>&1`
-              info.split(" ", 2).map(&:strip) if $CHILD_STATUS.success?
-            end
+        def get_info
+          Dir.chdir(config.root) do
+            info = `git log -1 --pretty="%H %s" 2>&1`
+            info.split(" ", 2).map(&:strip) if $CHILD_STATUS.success?
           end
+        end
       end
 
       DEPLOY_TYPES = [DefaultDeploy, HerokuDeploy, GitDeploy].freeze

data/lib/skylight/util/gzip.rb

@@ -0,0 +1,20 @@
+require "zlib"
+
+module Skylight
+  module Util
+    # Provides Gzip compressing support
+    module Gzip
+      # Compress a string with Gzip
+      #
+      # @param str [String] uncompressed string
+      # @return [String] compressed string
+      def self.compress(str)
+        output = StringIO.new
+        gz = Zlib::GzipWriter.new(output)
+        gz.write(str)
+        gz.close
+        output.string
+      end
+    end
+  end
+end

data/lib/skylight/util/http.rb

@@ -3,23 +3,23 @@ require "json"
 require "openssl"
 require "net/http"
 require "net/https"
-require "skylight/core/util/gzip"
+require "skylight/util/gzip"
 require "skylight/util/ssl"
 
 module Skylight
   module Util
     class HTTP
       CONTENT_ENCODING = "content-encoding".freeze
-      CONTENT_LENGTH   = "content-length".freeze
-      CONTENT_TYPE     = "content-type".freeze
-      ACCEPT           = "Accept".freeze
-      X_VERSION_HDR    = "x-skylight-agent-version".freeze
+      CONTENT_LENGTH = "content-length".freeze
+      CONTENT_TYPE = "content-type".freeze
+      ACCEPT = "Accept".freeze
+      X_VERSION_HDR = "x-skylight-agent-version".freeze
       APPLICATION_JSON = "application/json".freeze
-      AUTHORIZATION    = "authorization".freeze
-      DEFLATE          = "deflate".freeze
-      GZIP             = "gzip".freeze
+      AUTHORIZATION = "authorization".freeze
+      DEFLATE = "deflate".freeze
+      GZIP = "gzip".freeze
 
-      include Core::Util::Logging
+      include Logging
 
       attr_accessor :authentication
       attr_reader :host, :port, :config
@@ -35,7 +35,8 @@ module Skylight
         end
       end
 
-      class ReadResponseError < StandardError; end
+      class ReadResponseError < StandardError
+      end
 
       def initialize(config, service = :auth, opts = {})
         @config = config
@@ -46,7 +47,7 @@ module Skylight
 
         url = URI.parse(url)
 
-        @ssl  = url.scheme == "https"
+        @ssl = url.scheme == "https"
         @host = url.host
         @port = url.port
 
@@ -81,137 +82,129 @@ module Skylight
 
       private
 
-        def get_timeout(type, config, service, opts)
-          config.duration_ms("#{service}_http_#{type}_timeout") ||
-            opts[:timeout] || 15
-        end
+      def get_timeout(type, config, service, opts)
+        config.duration_ms("#{service}_http_#{type}_timeout") || opts[:timeout] || 15
+      end
 
-        def build_request(type, endpoint, hdrs, length = nil)
-          headers = {}
+      def build_request(type, endpoint, hdrs, length = nil)
+        headers = {}
 
-          headers[CONTENT_LENGTH]   = length.to_s if length
-          headers[AUTHORIZATION]    = authentication if authentication
-          headers[ACCEPT]           = APPLICATION_JSON
-          headers[X_VERSION_HDR]    = VERSION
-          headers[CONTENT_ENCODING] = GZIP if length && @deflate
+        headers[CONTENT_LENGTH] = length.to_s if length
+        headers[AUTHORIZATION] = authentication if authentication
+        headers[ACCEPT] = APPLICATION_JSON
+        headers[X_VERSION_HDR] = VERSION
+        headers[CONTENT_ENCODING] = GZIP if length && @deflate
 
-          hdrs.each do |k, v|
-            headers[k] = v
-          end
+        hdrs.each { |k, v| headers[k] = v }
 
-          type.new(endpoint, headers)
+        type.new(endpoint, headers)
+      end
+
+      def do_request(http, req)
+        begin
+          client = http.start
+        rescue StandardError => e
+          # TODO: Retry here
+          raise StartError, e
         end
 
-        def do_request(http, req)
-          begin
-            client = http.start
-          rescue => e
-            # TODO: Retry here
-            raise StartError, e
-          end
+        begin
+          res = client.request(req)
+        rescue *READ_EXCEPTIONS => e
+          raise ReadResponseError, e.inspect
+        end
 
-          begin
-            res = client.request(req)
-          rescue *READ_EXCEPTIONS => e
-            raise ReadResponseError, e.inspect
-          end
+        yield res
+      ensure
+        client&.finish
+      end
 
-          yield res
-        ensure
-          client.finish if client
+      def execute(req, body = nil)
+        t do
+          fmt "executing HTTP request; host=%s; port=%s; path=%s, body=%s",
+              @host,
+              @port,
+              req.path,
+              body && body.bytesize
         end
 
-        def execute(req, body = nil)
-          t do
-            fmt "executing HTTP request; host=%s; port=%s; path=%s, body=%s",
-                @host, @port, req.path, body && body.bytesize
-          end
+        if body
+          body = Gzip.compress(body) if @deflate
+          req.body = body
+        end
 
-          if body
-            body = Gzip.compress(body) if @deflate
-            req.body = body
-          end
+        http = Net::HTTP.new(@host, @port, @proxy_addr, @proxy_port, @proxy_user, @proxy_pass)
 
-          http = Net::HTTP.new(@host, @port,
-                               @proxy_addr, @proxy_port, @proxy_user, @proxy_pass)
+        http.open_timeout = @open_timeout
+        http.read_timeout = @read_timeout
 
-          http.open_timeout = @open_timeout
-          http.read_timeout = @read_timeout
+        if @ssl
+          http.use_ssl = true
 
-          if @ssl
-            http.use_ssl = true
+          http.ca_file = SSL.ca_cert_file_or_default unless SSL.ca_cert_file?
 
-            unless SSL.ca_cert_file?
-              http.ca_file = SSL.ca_cert_file_or_default
-            end
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        end
 
-            http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        do_request(http, req) do |res|
+          unless res.code =~ /2\d\d/
+            debug "server responded with #{res.code}"
+            t { fmt "body=%s", res.body }
           end
 
-          do_request(http, req) do |res|
-            unless res.code =~ /2\d\d/
-              debug "server responded with #{res.code}"
-              t { fmt "body=%s", res.body }
-            end
+          Response.new(res.code.to_i, res, res.body)
+        end
+      rescue Exception => e
+        error "http %s %s failed; error=%s; msg=%s", req.method, req.path, e.class, e.message
+        t { e.backtrace.join("\n") }
+        ErrorResponse.new(req, e)
+      end
 
-            Response.new(res.code.to_i, res, res.body)
-          end
-        rescue Exception => e
-          error "http %s %s failed; error=%s; msg=%s", req.method, req.path, e.class, e.message
-          t { e.backtrace.join("\n") }
-          ErrorResponse.new(req, e)
-        end
-
-        class Response
-          attr_reader :status, :headers, :body, :exception
-
-          def initialize(status, headers, body)
-            @status  = status
-            @headers = headers
-
-            if (headers[CONTENT_TYPE] || "").include?(APPLICATION_JSON)
-              begin
-                @body = JSON.parse(body)
-              rescue JSON::ParserError
-                @body = body # not really JSON I guess
-              end
-            else
-              @body = body
-            end
-          end
+      class Response
+        attr_reader :status, :headers, :body, :exception
 
-          def success?
-            status >= 200 && status < 300
-          end
+        def initialize(status, headers, body)
+          @status = status
+          @headers = headers
 
-          def to_s
-            body.to_s
+          if (headers[CONTENT_TYPE] || "").include?(APPLICATION_JSON)
+            begin
+              @body = JSON.parse(body)
+            rescue JSON::ParserError
+              @body = body # not really JSON I guess
+            end
+          else
+            @body = body
           end
+        end
 
-          def get(key)
-            return nil unless body.is_a?(Hash)
+        def success?
+          status >= 200 && status < 300
+        end
 
-            res = body
-            key.split(".").each do |part|
-              return unless (res = res[part])
-            end
-            res
-          end
+        def to_s
+          body.to_s
+        end
 
-          def respond_to_missing?(name, include_all = false)
-            super || body.respond_to?(name, include_all)
-          end
+        def get(key)
+          body.dig(*key.split(".")) if body.is_a?(Hash)
+        end
 
-          def method_missing(name, *args, &blk)
-            if respond_to_missing?(name)
-              body.send(name, *args, &blk)
-            else
-              super
-            end
+        def respond_to_missing?(name, include_all = false)
+          super || body.respond_to?(name, include_all)
+        end
+
+        def method_missing(name, *args, &blk)
+          if respond_to_missing?(name)
+            body.send(name, *args, &blk)
+          else
+            super
           end
         end
+      end
 
-        ErrorResponse = Struct.new(:request, :exception) do
+      ErrorResponse =
+        Struct.new(:request, :exception) do
           def status
             nil
           end