skylight 3.1.4 → 5.3.4

data/lib/skylight/util/component.rb

@@ -1,33 +1,71 @@
+# frozen_string_literal: true
+
+require "uri"
+
 module Skylight
   module Util
     class Component
-
       attr_accessor :environment, :name
 
-      NAME_FORMAT = /\A[a-z0-9-]+\z/
-      DEFAULT_NAME = 'web'.freeze
-      DEFAULT_ENVIRONMENT = 'production'.freeze
+      NAME_FORMAT = /\A[a-zA-Z0-9_-]+\z/.freeze
+      DEFAULT_NAME = "web"
+      WORKER_NAME = "worker"
+      DEFAULT_ENVIRONMENT = "production"
 
-      def initialize(environment, name)
+      def initialize(environment, name, force_worker: false)
         @environment = environment || DEFAULT_ENVIRONMENT
-        @name        = name || DEFAULT_NAME
+        @name = resolve_name(name, force_worker)
 
         raise ArgumentError, "environment can't be blank" if @environment.empty?
-        validate_string!(@environment, 'environment')
-        validate_string!(@name, 'name')
+
+        validate_string!(@environment, "environment")
+        validate_string!(@name, "name")
       end
 
       def to_s
         "#{name}:#{environment}"
       end
 
+      def to_encoded_s
+        @to_encoded_s ||= URI.encode_www_form_component(to_s)
+      end
+
+      def web?
+        name == DEFAULT_NAME
+      end
+
+      def worker?
+        !web?
+      end
+
+      # keys here should match those from the main config
+      def as_json(*)
+        { component: name, env: environment }
+      end
+
       private
 
+      def program_name
+        $PROGRAM_NAME
+      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?
+
+        given_name
+      end
+
       def validate_string!(string, kind)
         return true if string =~ NAME_FORMAT
+
         raise ArgumentError, "#{kind} can only contain lowercase letters, numbers, and dashes"
       end
     end
   end
 end
-

data/lib/skylight/util/deploy.rb

@@ -1,11 +1,9 @@
-require 'json'
-require 'skylight/core/util/logging'
+require "json"
+require "skylight/util/logging"
 
 module Skylight
   module Util
-
     module Deploy
-
       def self.build(config)
         DEPLOY_TYPES.each do |type|
           deploy = type.new(config)
@@ -15,9 +13,7 @@ module Skylight
       end
 
       class EmptyDeploy
-
-        attr_reader :config
-        attr_reader :timestamp
+        attr_reader :config, :timestamp
 
         def initialize(config)
           @config = config
@@ -38,75 +34,66 @@ 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
           hash
         end
-
       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
-          config.get(:'deploy.id') || git_sha
+          config.get(:"deploy.id") || git_sha
         end
 
         def git_sha
-          config.get(:'deploy.git_sha')
+          config.get(:"deploy.git_sha")
         end
 
         def description
-          config.get(:'deploy.description')
+          config.get(:"deploy.description")
         end
-
       end
 
       class HerokuDeploy < EmptyDeploy
-
         def initialize(*)
           super
           @info = get_info
         end
 
         def id
-          @info ? @info['id'] : nil
+          @info ? @info["id"] : nil
         end
 
         def git_sha
-          @info ? @info['commit'] : nil
+          @info ? @info["commit"] : nil
         end
 
         def description
-          @info ? @info['description'] : nil
+          @info ? @info["description"] : nil
         end
 
         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
-
         attr_reader :git_sha, :description
 
         def initialize(*)
@@ -116,18 +103,15 @@ 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 $?.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]
-
+      DEPLOY_TYPES = [DefaultDeploy, HerokuDeploy, GitDeploy].freeze
     end
-
   end
 end

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/hostname.rb

@@ -1,13 +1,13 @@
-require 'socket'
-require 'securerandom'
+require "socket"
+require "securerandom"
 
 module Skylight
   module Util
     module Hostname
       def self.default_hostname
-        if hostname = Socket.gethostname
+        if (hostname = Socket.gethostname)
           hostname.strip!
-          hostname = nil if hostname == ''
+          hostname = nil if hostname == ""
         end
 
         hostname || "gen-#{SecureRandom.uuid}"

data/lib/skylight/util/http.rb

@@ -1,70 +1,68 @@
-require 'uri'
-require 'json'
-require 'openssl'
-require 'net/http'
-require 'net/https'
-require 'skylight/core/util/gzip'
-require 'skylight/util/ssl'
+require "uri"
+require "json"
+require "openssl"
+require "net/http"
+require "net/https"
+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
-      APPLICATION_JSON = 'application/json'.freeze
-      AUTHORIZATION    = 'authorization'.freeze
-      DEFLATE          = 'deflate'.freeze
-      GZIP             = 'gzip'.freeze
-
-      include Core::Util::Logging
+      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
+      APPLICATION_JSON = "application/json".freeze
+      AUTHORIZATION = "authorization".freeze
+      DEFLATE = "deflate".freeze
+      GZIP = "gzip".freeze
+
+      include Logging
 
       attr_accessor :authentication
       attr_reader :host, :port, :config
 
-      READ_EXCEPTIONS = [Timeout::Error, EOFError]
-      # This doesn't exist on Ruby 1.9.3
-      READ_EXCEPTIONS << Net::ReadTimeout if defined?(Net::ReadTimeout)
-      READ_EXCEPTIONS.freeze
+      READ_EXCEPTIONS = [Timeout::Error, EOFError, Net::ReadTimeout].freeze
 
       class StartError < StandardError
         attr_reader :original
 
-        def initialize(e)
-          @original = e
-          super e.inspect
+        def initialize(error)
+          @original = error
+          super error.inspect
         end
-
       end
 
-      class ReadResponseError < StandardError; end
+      class ReadResponseError < StandardError
+      end
 
       def initialize(config, service = :auth, opts = {})
         @config = config
 
-        unless url = config["#{service}_url"]
+        unless (url = config["#{service}_url"])
           raise ArgumentError, "no URL specified for #{service}"
         end
 
         url = URI.parse(url)
 
-        @ssl  = url.scheme == 'https'
+        @ssl = url.scheme == "https"
         @host = url.host
         @port = url.port
 
-        if proxy_url = config[:proxy_url]
+        if (proxy_url = config[:proxy_url])
           proxy_url = URI.parse(proxy_url)
-          @proxy_addr, @proxy_port = proxy_url.host, proxy_url.port
-          @proxy_user, @proxy_pass = (proxy_url.userinfo || '').split(/:/)
+          @proxy_addr = proxy_url.host
+          @proxy_port = proxy_url.port
+          @proxy_user, @proxy_pass = (proxy_url.userinfo || "").split(/:/)
         end
 
         @open_timeout = get_timeout(:connect, config, service, opts)
         @read_timeout = get_timeout(:read, config, service, opts)
 
         @deflate = config["#{service}_http_deflate"]
-        @authentication = config[:'authentication']
+        @authentication = config[:authentication]
       end
 
       def get(endpoint, hdrs = {})
@@ -82,25 +80,22 @@ module Skylight
         execute(request, body)
       end
 
-    private
+      private
 
       def get_timeout(type, config, service, opts)
-        config.duration_ms("#{service}_http_#{type}_timeout") ||
-          opts[:timeout] || 15
+        config.duration_ms("#{service}_http_#{type}_timeout") || opts[:timeout] || 15
       end
 
-      def build_request(type, endpoint, hdrs, length=nil)
+      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_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)
       end
@@ -108,7 +103,7 @@ module Skylight
       def do_request(http, req)
         begin
           client = http.start
-        rescue => e
+        rescue StandardError => e
           # TODO: Retry here
           raise StartError, e
         end
@@ -121,20 +116,24 @@ module Skylight
 
         yield res
       ensure
-        client.finish if client
+        client&.finish
       end
 
-      def execute(req, body=nil)
-        t { fmt "executing HTTP request; host=%s; port=%s; path=%s, body=%s",
-              @host, @port, req.path, body && body.bytesize }
+      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
 
-        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
@@ -142,9 +141,7 @@ module Skylight
         if @ssl
           http.use_ssl = true
 
-          unless SSL.ca_cert_file?
-            http.ca_file = SSL.ca_cert_file_or_default
-          end
+          http.ca_file = SSL.ca_cert_file_or_default unless SSL.ca_cert_file?
 
           http.verify_mode = OpenSSL::SSL::VERIFY_PEER
         end
@@ -167,7 +164,7 @@ module Skylight
         attr_reader :status, :headers, :body, :exception
 
         def initialize(status, headers, body)
-          @status  = status
+          @status = status
           @headers = headers
 
           if (headers[CONTENT_TYPE] || "").include?(APPLICATION_JSON)
@@ -190,16 +187,10 @@ module Skylight
         end
 
         def get(key)
-          return nil unless Hash === body
-
-          res = body
-          key.split('.').each do |part|
-            return unless res = res[part]
-          end
-          res
+          body.dig(*key.split(".")) if body.is_a?(Hash)
         end
 
-        def respond_to_missing?(name, include_all=false)
+        def respond_to_missing?(name, include_all = false)
           super || body.respond_to?(name, include_all)
         end
 
@@ -212,16 +203,16 @@ module Skylight
         end
       end
 
-      class ErrorResponse < Struct.new(:request, :exception)
-        def status
-          nil
-        end
+      ErrorResponse =
+        Struct.new(:request, :exception) do
+          def status
+            nil
+          end
 
-        def success?
-          false
+          def success?
+            false
+          end
         end
-      end
-
     end
   end
 end

data/lib/skylight/util/instrumenter_method.rb

@@ -0,0 +1,26 @@
+module Skylight
+  module Util
+    module InstrumenterMethod
+      def instrumenter_method(name, block: false)
+        if block
+          module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{name}(*args)                      # def mute(*args)
+              unless instrumenter                   #   unless instrumenter
+                return yield if block_given?        #     return yield if block_given?
+                return                              #     return
+              end                                   #   end
+                                                    #
+              instrumenter.#{name}(*args) { yield } #   instrumenter.mute(*args) { yield }
+            end                                     # end
+          RUBY
+        else
+          module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{name}(*args)              # def config(*args)
+              instrumenter&.#{name}(*args)  #   instrumenter&.config(*args)
+            end                             # end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/skylight/util/logging.rb

@@ -0,0 +1,136 @@
+require "logger"
+
+module Skylight
+  module Util
+    # Log both to the specified logger and STDOUT
+    class AlertLogger
+      def initialize(logger)
+        @logger = logger
+      end
+
+      def write(*args)
+        $stderr.write(*args)
+
+        # Try to avoid writing to STDOUT/STDERR twice
+        logger_logdev = @logger.instance_variable_get(:@logdev)
+        logger_out = logger_logdev.respond_to?(:dev) ? logger_logdev.dev : nil
+        @logger.<<(*args) if logger_out != $stdout && logger_out != $stderr
+      end
+
+      def close; end
+    end
+
+    module Logging
+      def log_context
+        {}
+      end
+
+      def trace?
+        !!ENV[-"SKYLIGHT_ENABLE_TRACE_LOGS"]
+      end
+
+      def raise_on_error?
+        !!ENV[-"SKYLIGHT_RAISE_ON_ERROR"]
+      end
+
+      # Logs if tracing
+      #
+      # @param (see #debug)
+      #
+      # See {trace?}.
+      def trace(msg, *args)
+        return unless trace?
+
+        log :debug, msg, *args
+      end
+
+      # Evaluates and logs the result of the block if tracing
+      #
+      # @yield block to be evaluted
+      # @yieldreturn arguments for {#debug}
+      #
+      # See {trace?}.
+      def t
+        return unless trace?
+
+        log :debug, yield
+      end
+
+      # @param msg (see #log)
+      # @param args (see #log)
+      def debug(msg, *args)
+        log :debug, msg, *args
+      end
+
+      # @param msg (see #log)
+      # @param args (see #log)
+      def info(msg, *args)
+        log :info, msg, *args
+      end
+
+      # @param msg (see #log)
+      # @param args (see #log)
+      def warn(msg, *args)
+        log :warn, msg, *args
+      end
+
+      # @param msg (see #log)
+      # @param args (see #log)
+      def error(msg, *args)
+        log :error, msg, *args
+        raise format(msg, *args) if raise_on_error?
+      end
+
+      alias log_trace trace
+      alias log_debug debug
+      alias log_info info
+      alias log_warn warn
+      alias log_error error
+
+      # Alias for `Kernel#sprintf`
+      # @return [String]
+      def fmt(*args)
+        sprintf(*args)
+      end
+
+      def config_for_logging
+        if respond_to?(:config)
+          config
+        elsif is_a?(Skylight::Config)
+          self
+        end
+      end
+
+      # @param level [String,Symbol] the method on `logger` to use for logging
+      # @param msg [String] the message to log
+      # @param args [Array] values for `Kernel#sprintf` on `msg`
+      def log(level, msg, *args)
+        c = config_for_logging
+        logger = c ? c.logger : nil
+
+        msg = log_context.map { |(k, v)| "#{k}=#{v}; " }.join << msg
+
+        if logger
+          if logger.respond_to?(level)
+            if args.empty?
+              logger.send level, msg
+            else
+              logger.send level, format(msg, *args)
+            end
+            return # rubocop:disable Style/RedundantReturn
+          else
+            Kernel.warn "Invalid logger"
+          end
+          # Fallback to stderr for warn and error levels
+        elsif %i[warn error].include?(level)
+          $stderr.puts format("[SKYLIGHT] #{msg}", *args)
+        end
+      rescue Exception => e
+        if trace?
+          puts "[ERROR] #{e.message}"
+          puts e.backtrace
+        end
+      end
+    end
+  end
+end