diffend 0.2.30 → 0.2.35

data/lib/diffend/handle_errors/report.rb

@@ -7,10 +7,10 @@ module Diffend
       class << self
         # Execute request to Diffend
         #
+        # @param config [Diffend::Config]
+        # @param message [Symbol] message that we want to display
         # @param exception [Exception] expection that was raised
         # @param payload [Hash] with versions to check
-        # @param config [OpenStruct] Diffend config
-        # @param message [Symbol] message that we want to display
         # @param report [Boolean] if true we will report the issue to diffend
         # @param raise_exception [Boolean] if true we will raise an exception
         #
@@ -18,8 +18,11 @@ module Diffend
         def call(config:, message:, exception: nil, payload: {}, report: false, raise_exception: true)
           exception_payload = prepare_exception_payload(exception, payload)
 
-          Bundler.ui.error(Diffend::HandleErrors::Messages::PAYLOAD_DUMP)
-          Bundler.ui.error(Diffend::HandleErrors::Messages.const_get(message.to_s.upcase))
+          Diffend::HandleErrors::Messages::PAYLOAD_DUMP
+            .tap(&config.logger.method(:error))
+          Diffend::HandleErrors::Messages
+            .const_get(message.to_s.upcase)
+            .tap(&config.logger.method(:error))
 
           if report
             Diffend::Request.call(
@@ -30,14 +33,14 @@ module Diffend
           raise Diffend::Errors::HandledException if raise_exception
         end
 
-        # @param config [OpenStruct] diffend config
+        # @param config [Diffend::Config]
         # @param payload [Hash]
         #
         # @return [Diffend::RequestObject]
         def build_request_object(config, payload)
           Diffend::RequestObject.new(
             config: config,
-            url: errors_url(config.project_id),
+            url: config.errors_url,
             payload: payload,
             request_method: :post
           )
@@ -54,17 +57,6 @@ module Diffend
             .call(exception, payload)
             .tap(&Diffend::HandleErrors::DisplayToStdout.method(:call))
         end
-
-        # Provides diffend errors endpoint url
-        #
-        # @param project_id [String] diffend project_id
-        #
-        # @return [String] diffend endpoint
-        def errors_url(project_id)
-          return ENV['DIFFEND_ERROR_URL'] if ENV.key?('DIFFEND_ERROR_URL')
-
-          "https://my.diffend.io/api/projects/#{project_id}/errors"
-        end
       end
     end
   end

data/lib/diffend/latest_version.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Verify if we are running latest version of the plugin
+  module LatestVersion
+    class << self
+      # Verify if we are running latest version of the plugin
+      #
+      # @param config [Diffend::Config]
+      def call(config)
+        return if config.development?
+        return if installed_version == Diffend::VERSION
+
+        print_message(config, installed_version)
+
+        exit 2
+      end
+
+      private
+
+      # @return [String] installed plugin version
+      def installed_version
+        ::Bundler::Plugin
+          .index
+          .plugin_path('diffend')
+          .basename
+          .to_s
+          .split('-')
+          .last
+      end
+
+      # @param config [Diffend::Config]
+      # @param version [Hash] installed version
+      def print_message(config, version)
+        build_message(version)
+          .tap(&config.logger.method(:error))
+      end
+
+      # @param version [Hash] installed version
+      #
+      # @return [String]
+      def build_message(version)
+        <<~MSG
+          \nYou are running an outdated version (#{version}) of the plugin, which will lead to issues.
+          \nPlease upgrade to the latest one (#{Diffend::VERSION}) by executing "rm -rf .bundle/plugin".\n
+        MSG
+      end
+    end
+  end
+end

data/lib/diffend/local_context.rb

@@ -6,16 +6,15 @@ module Diffend
     class << self
       # Build diffend, host, packages, and platform specific information
       #
-      # @param command [String] either install or update
-      # @param project_id [String] diffend project_id
+      # @param config [Diffend::Config]
       # @param definition [Bundler::Definition] definition for your source
       #
       # @return [Hash] payload for diffend endpoint
-      def call(command, project_id, definition)
+      def call(config, definition)
         {
-          'diffend' => Diffend.call(project_id),
+          'diffend' => Diffend.call(config),
           'host' => Host.call,
-          'packages' => Packages.call(command, definition),
+          'packages' => Packages.call(config.command, definition),
           'platform' => Platform.call
         }.freeze
       end

data/lib/diffend/local_context/diffend.rb

@@ -15,14 +15,14 @@ module Diffend
       class << self
         # Build diffend information
         #
-        # @param project_id [String, nil] diffend project_id
+        # @param config [Diffend::Config]
         #
         # @return [Hash]
-        def call(project_id)
+        def call(config)
           {
             'api_version' => API_VERSION,
-            'environment' => ENV['DIFFEND_ENV'],
-            'project_id' => project_id,
+            'environment' => config.env,
+            'project_id' => config.project_id,
             'type' => PLATFORM_TYPE,
             'version' => ::Diffend::VERSION
           }.freeze

data/lib/diffend/local_context/host.rb

@@ -47,9 +47,9 @@ module Diffend
               command = "#{name} #{array.join(' ')}"
             end
 
-            { 'name' => command, 'title' => '' }
+            { 'name' => clean(command), 'title' => '' }
           else
-            { 'name' => ARGV.join(' '), 'title' => $PROGRAM_NAME }
+            { 'name' => clean(ARGV.join(' ')), 'title' => clean($PROGRAM_NAME) }
           end
         end
 
@@ -82,6 +82,14 @@ module Diffend
 
           tags
         end
+
+        # @param str [String] that we want to clean and truncate
+        def clean(str)
+          str
+            .dup
+            .gsub(/[[:space:]]+/, ' ')
+            .strip[0...255]
+        end
       end
     end
   end

data/lib/diffend/local_context/packages.rb

@@ -31,7 +31,7 @@ module Diffend
       }.freeze
 
       class << self
-        # @param command [String] either install or update
+        # @param command [String] command executed via bundler
         # @param definition [Bundler::Definition] definition for your source
         def call(command, definition)
           Bundler.ui.silence { definition.resolve_remotely! }
@@ -161,7 +161,7 @@ module Diffend
       def parse_platform(platform)
         case platform
         when String then platform
-        when Gem::Platform then platform.os
+        when Gem::Platform then platform.to_s
         end
       end
 

data/lib/diffend/logger.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Diffend logging
+  class Logger
+    # Low-level information, mostly for developers.
+    DEBUG = 0
+    # Generic (useful) information about system operation.
+    INFO = 1
+    # A warning.
+    WARN = 2
+    # A handleable error condition.
+    ERROR = 3
+    # An unhandleable error that results in a program crash.
+    FATAL = 4
+    # An unknown message that should always be logged.
+    UNKNOWN = 5
+
+    # @param level [Integer] logging severity threshold
+    def initialize(level = INFO)
+      @level = level
+    end
+
+    # @param message [String]
+    def debug(message)
+      log(DEBUG, message)
+    end
+
+    # @param message [String]
+    def info(message)
+      log(INFO, message)
+    end
+
+    # @param message [String]
+    def warn(message)
+      log(WARN, message)
+    end
+
+    # @param message [String]
+    def error(message)
+      log(ERROR, message)
+    end
+
+    # @param message [String]
+    def fatal(message)
+      log(FATAL, message)
+    end
+
+    private
+
+    # @param severity [Integer]
+    # @param message [String]
+    def log(severity, message)
+      return if severity < @level
+
+      case severity
+      when INFO
+        Bundler.ui.confirm(message)
+      when WARN
+        Bundler.ui.warn(message)
+      when ERROR, FATAL
+        Bundler.ui.error(message)
+      end
+    end
+  end
+end

data/lib/diffend/monitor.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
-ENV['DIFFEND_ENV'] ||= 'development'
-
 %w[
   version
+  logger
   errors
   build_bundler_definition
   commands
   config
-  config/fetcher
-  config/file_finder
-  config/validator
+  configs/fetcher
+  configs/validator
   handle_errors/messages
   handle_errors/build_exception_payload
   handle_errors/display_to_stdout
@@ -27,10 +25,19 @@ ENV['DIFFEND_ENV'] ||= 'development'
   track
 ].each { |file| require "diffend/#{file}" }
 
-return if ENV['DIFFEND_ENV'].strip.empty?
-return if %w[development test].include?(ENV['DIFFEND_ENV'])
+begin
+  config = Diffend::Config.new(
+    command: Diffend::Commands::EXEC,
+    severity: Diffend::Logger::FATAL
+  )
+rescue Diffend::Errors::HandledException
+  # we silent exit here because we don't want to break client boot
+  return
+end
+
+return if %w[development test].include?(config.env)
 
 Thread.new do
-  track = Diffend::Track.new
+  track = Diffend::Track.new(config)
   track.start
 end

data/lib/diffend/plugin.rb

@@ -1,20 +1,19 @@
 # frozen_string_literal: true
 
-ENV['DIFFEND_ENV'] ||= 'development'
-
 %w[
   bundler
 ].each(&method(:require))
 
 %w[
   version
+  logger
+  latest_version
   errors
   build_bundler_definition
   commands
   config
-  config/fetcher
-  config/file_finder
-  config/validator
+  configs/fetcher
+  configs/validator
   handle_errors/messages
   handle_errors/build_exception_payload
   handle_errors/display_to_stdout
@@ -45,13 +44,14 @@ module Diffend
       def execute
         return unless enabled?
 
-        verify_version
+        config = Diffend::Config.new(severity: Diffend::Logger::INFO)
 
-        config = Diffend::Config.call
+        Diffend::LatestVersion.call(config)
 
-        Diffend::Execute.call(command, config)
+        Diffend::Execute.call(config)
       rescue Diffend::Errors::HandledException
-        return if ENV['DIFFEND_IGNORE_ERRORS'] == 'true'
+        # config will not be initialized when configuration file is missing
+        return if config&.ignore_errors?
 
         exit 255
       rescue StandardError => e
@@ -63,32 +63,11 @@ module Diffend
           raise_exception: false
         )
 
-        return if ENV['DIFFEND_IGNORE_ERRORS'] == 'true'
+        return if config.ignore_errors?
 
         exit 255
       end
 
-      def verify_version
-        return if ENV['DIFFEND_DEVELOPMENT'] == 'true'
-        return if installed_version == Diffend::VERSION
-
-        build_outdated_version_message(installed_version)
-          .tap(&::Bundler.ui.method(:error))
-
-        exit 2
-      end
-
-      # @return [String] installed plugin version
-      def installed_version
-        ::Bundler::Plugin
-          .index
-          .plugin_path('diffend')
-          .basename
-          .to_s
-          .split('-')
-          .last
-      end
-
       # Checks if plugin is enabled
       #
       # @return [Boolean] true if enabled, false otherwise
@@ -102,23 +81,6 @@ module Diffend
           .select { |line| line.start_with?('plugin') }
           .any? { |line| line.include?('diffend') }
       end
-
-      # @param version [Hash] installed version
-      #
-      # @return [String]
-      def build_outdated_version_message(version)
-        <<~MSG
-          \nYou are running an outdated version (#{version}) of the plugin, which will lead to issues.
-          \nPlease upgrade to the latest one (#{VERSION}) by executing "rm -rf .bundle/plugin".\n
-        MSG
-      end
-
-      # Command that was run with bundle
-      #
-      # @return [String]
-      def command
-        ARGV.first || ::Bundler.feature_flag.default_cli_command.to_s
-      end
     end
   end
 end

data/lib/diffend/request.rb

@@ -14,7 +14,8 @@ module Diffend
       Errno::ECONNRESET,
       Errno::ENETUNREACH,
       Errno::EHOSTUNREACH,
-      Errno::ECONNREFUSED
+      Errno::ECONNREFUSED,
+      SocketError
     ].freeze
     # Message displayed when timeout occured and we will retry
     TIMEOUT_MESSAGE = 'We experienced a connection issue, retrying...'
@@ -67,7 +68,7 @@ module Diffend
       rescue Diffend::Errors::RequestServerError => e
         retry_count += 1
 
-        retry if handle_retry(SERVER_ERROR_MESSAGE, retry_count)
+        retry if handle_retry(request_object.config, SERVER_ERROR_MESSAGE, retry_count)
 
         Diffend::HandleErrors::Report.call(
           exception: e,
@@ -78,7 +79,7 @@ module Diffend
       rescue *CONNECTION_EXCEPTIONS => e
         retry_count += 1
 
-        retry if handle_retry(CONNECTION_MESSAGE, retry_count)
+        retry if handle_retry(request_object.config, CONNECTION_MESSAGE, retry_count)
 
         Diffend::HandleErrors::Report.call(
           exception: e,
@@ -89,7 +90,7 @@ module Diffend
       rescue *TIMEOUT_EXCEPTIONS => e
         retry_count += 1
 
-        retry if handle_retry(TIMEOUT_MESSAGE, retry_count)
+        retry if handle_retry(request_object.config, TIMEOUT_MESSAGE, retry_count)
 
         Diffend::HandleErrors::Report.call(
           exception: e,
@@ -101,12 +102,13 @@ module Diffend
 
       # Handle retry
       #
+      # @param config [Diffend::Config]
       # @param message [String] message we want to display
       # @param retry_count [Integer]
-      def handle_retry(message, retry_count)
+      def handle_retry(config, message, retry_count)
         return false if retry_count == RETRIES
 
-        Bundler.ui.error(message)
+        config.logger.warn(message)
         sleep(exponential_backoff(retry_count))
 
         retry_count < RETRIES
@@ -123,8 +125,8 @@ module Diffend
           uri.port,
           use_ssl: uri.scheme == 'https',
           verify_mode: OpenSSL::SSL::VERIFY_NONE,
-          open_timeout: 5,
-          read_timeout: 5
+          open_timeout: 15,
+          read_timeout: 15
         ) { |http| yield(http, uri) }
       end
 
@@ -132,7 +134,7 @@ module Diffend
       #
       # @param uri [URI::HTTPS]
       # @param request_method [Symbol]
-      # @param config [OpenStruct] Diffend config
+      # @param config [Diffend::Config]
       # @param payload [Hash] with versions to check
       #
       # @return [Net::HTTP::Post, Net::HTTP::Put]
@@ -160,9 +162,8 @@ module Diffend
       # Assigns basic authorization if provided in the config
       #
       # @param request [Net::HTTP::Post] prepared http post
-      # @param config [OpenStruct] Diffend config
+      # @param config [Diffend::Config]
       def assign_auth(request, config)
-        return unless config
         return unless config.shareable_id
         return unless config.shareable_key