skylight 4.2.2 → 5.0.0.beta2

data/lib/skylight/user_config.rb

@@ -0,0 +1,61 @@
+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") do |f|
+        f.puts YAML.dump(to_hash)
+      end
+    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,56 @@
+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,7 +7,7 @@ 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"
@@ -16,6 +17,7 @@ module Skylight
         @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
@@ -40,7 +42,7 @@ module Skylight
       def as_json(*)
         {
           component: name,
-          env: environment
+          env:       environment
         }
       end
 
@@ -64,6 +66,7 @@ module Skylight
 
         def validate_string!(string, kind)
           return true if string =~ NAME_FORMAT
+
           raise ArgumentError, "#{kind} can only contain lowercase letters, numbers, and dashes"
         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,7 +44,7 @@ module Skylight
       end
 
       class DefaultDeploy < EmptyDeploy
-        include Core::Util::Logging
+        include Util::Logging
 
         def initialize(*)
           super
@@ -90,10 +89,8 @@ module Skylight
           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
+            if File.exist?(info_path) && (info = JSON.parse(File.read(info_path)))
+              info["release"]
             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/http.rb

@@ -3,7 +3,7 @@ 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
@@ -19,7 +19,7 @@ module Skylight
       DEFLATE          = "deflate".freeze
       GZIP             = "gzip".freeze
 
-      include Core::Util::Logging
+      include Logging
 
       attr_accessor :authentication
       attr_reader :host, :port, :config
@@ -118,7 +118,7 @@ module Skylight
 
           yield res
         ensure
-          client.finish if client
+          client&.finish
         end
 
         def execute(req, body = nil)
@@ -189,16 +189,10 @@ module Skylight
           end
 
           def get(key)
-            return nil unless body.is_a?(Hash)
-
-            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) # rubocop:disable Style/OptionalBooleanParameter
             super || body.respond_to?(name, include_all)
           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)
+              unless instrumenter
+                return yield if block_given?
+                return
+              end
+
+              instrumenter.#{name}(*args) { yield }
+            end
+          RUBY
+        else
+          module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{name}(*args)
+              instrumenter&.#{name}(*args)
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/skylight/util/logging.rb

@@ -0,0 +1,138 @@
+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
+        if logger_out != $stdout && logger_out != $stderr
+          @logger.<<(*args)
+        end
+      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, format(msg, *args)
+            else
+              logger.send level, msg
+            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