diffend 0.2.23 → 0.2.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ce266f8f72de49360adc1e6e1f79c8bf5fa08727ffc990292877c015e1040ee
-  data.tar.gz: 1a71a4a519b1f2afb9bc993726c045b4db5b87833459ba8f7192c2a2f4232aa6
+  metadata.gz: 5bc33803e8086ca502424fae528475182c196daf3b5971200a7988fca0936822
+  data.tar.gz: 138b0750cff7e555d62f82ca8716b4d21dbd32fd5c6de898fd7c7653d7c56501
 SHA512:
-  metadata.gz: '08dd6da1d3984200d9ac07fd9fd1f9a0adf6b7746f86a77ab560b77b356dc6fad819513adea6fe2d714b1f06ed8cf5441d796681fd507b64247a2db3560d3138'
-  data.tar.gz: 2155bbba6da089606b38d36fcec4259054f6cac053bf56eefb303d6d3aa223ba4253ca771249a2543696c636e8c509aa75ceb3ab50f055dd18a2ba9715e5cb9f
+  metadata.gz: bf6b14a1ca18e978b709905159b17caacb5cc5a2812ecb1b655961041e44134eed33d840ac3679b451aa49b33f2dcf7f96ffa6e5535a102f7799cf927fb8e9af
+  data.tar.gz: 39e1f326632af4f2f658d027ebb8277fd1b24262a9e1fd90a10747c8d85e1bf7ead72c65c44716af7a4d4f06a746d0be008b1a76fb82ba88034c1b1c6cdcf04f

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Changelog
 
 ## [Unreleased][master]
+
+## [0.2.24] (2020-09-08)
+- better error handling of response ([#28](https://github.com/diffend-io/diffend-ruby/pull/28))
+- fix jruby specs ([#29](https://github.com/diffend-io/diffend-ruby/pull/29))
+- handle request server errors ([#30](https://github.com/diffend-io/diffend-ruby/pull/30))
+- better detection of gem source ([#31](https://github.com/diffend-io/diffend-ruby/pull/31))
+- detect if we are running outdated version of the plugin ([#32](https://github.com/diffend-io/diffend-ruby/pull/32))
+
+## [0.2.23] (2020-09-06)
 - fix how we build gem platform ([#26](https://github.com/diffend-io/diffend-ruby/pull/26))
 - test against jruby, ruby-2.5 and ruby-2.6 ([#25](https://github.com/diffend-io/diffend-ruby/pull/25))
 
@@ -38,7 +47,9 @@
 
 - initial release
 
-[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.22...HEAD
+[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.24...HEAD
+[0.2.24]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.23...v0.2.24
+[0.2.23]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.22...v0.2.23
 [0.2.22]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.21...v0.2.22
 [0.2.21]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.20...v0.2.21
 [0.2.20]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.19...v0.2.20

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    diffend (0.2.23)
+    diffend (0.2.24)
 
 GEM
   remote: https://rubygems.org/

data/lib/diffend.rb

@@ -27,7 +27,7 @@
 # Diffend main namespace
 module Diffend
   # Current plugin version
-  VERSION = '0.2.23'
+  VERSION = '0.2.24'
   # Diffend homepage
   HOMEPAGE = 'https://diffend.io'
 
@@ -41,10 +41,13 @@ module Diffend
 
     # Execute diffend plugin
     def execute
+      detect_installed_version
+
       config = fetch_config
 
       Diffend::Voting.call(
         command,
+        config,
         Diffend::BuildBundlerDefinition.call(
           command,
           Bundler.default_gemfile,
@@ -60,6 +63,36 @@ module Diffend
       )
     end
 
+    def detect_installed_version
+      return if installed_version == VERSION
+
+      build_outdated_version_message(installed_version)
+        .tap(&Bundler.ui.method(:error))
+
+      exit 1
+    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
+
+    # @return [String] installed plugin version
+    def installed_version
+      Bundler::Plugin
+        .index
+        .plugin_path('diffend')
+        .basename
+        .to_s
+        .split('-')
+        .last
+    end
+
     # Command that was run with bundle
     #
     # @return [String]

data/lib/diffend/errors.rb

@@ -19,9 +19,7 @@ module Diffend
     ShareableKeyMissingInConfigurationFile = Class.new(BaseError)
     # Raised when build_path is missing in configuration file
     BuildPathMissingInConfigurationFile = Class.new(BaseError)
-    # When unsupported response returned from the endpoint
-    UnsupportedResponse = Class.new(BaseError)
-    # When unsupported action returned from the endpoint
-    UnsupportedAction = Class.new(BaseError)
+    # Raised when server-side error occurs
+    RequestServerError = Class.new(BaseError)
   end
 end

data/lib/diffend/handle_errors/build_exception_payload.rb

@@ -9,7 +9,7 @@ module Diffend
       class << self
         # Build exception payload
         #
-        # @param exception [Exception] expection that was raised
+        # @param exception [Exception, NilClass] expection that was raised
         # @param payload [Hash] with versions to check
         #
         # @return [Hash]
@@ -18,9 +18,9 @@ module Diffend
             request_id: SecureRandom.uuid,
             payload: payload,
             exception: {
-              class: exception.class,
-              message: exception.message,
-              backtrace: exception.backtrace
+              class: exception&.class,
+              message: exception&.message,
+              backtrace: exception&.backtrace
             }
           }.freeze
         end

data/lib/diffend/handle_errors/messages.rb

@@ -9,6 +9,16 @@ module Diffend
         This is a bug, don't hesitate.\n
         Create an issue at https://github.com/diffend-io/diffend-ruby/issues\n
       MSG
+      UNSUPPORTED_RESPONSE = <<~MSG
+        \nAPI returned an unsupported response. We recorded this incident in our system and will review it.\n
+        This is a bug, don't hesitate.\n
+        Create an issue at https://github.com/diffend-io/diffend-ruby/issues\n
+      MSG
+      UNSUPPORTED_VERDICT = <<~MSG
+        \nAPI returned an unsupported verdict. We recorded this incident in our system and will review it.\n
+        This is a bug, don't hesitate.\n
+        Create an issue at https://github.com/diffend-io/diffend-ruby/issues\n
+      MSG
       REQUEST_ERROR = <<~MSG
         \nWe were unable to process your request at this time. We recorded this incident in our system and will review it.\n
         If you think that this is a bug, don't hesitate.\n

data/lib/diffend/handle_errors/report.rb

@@ -14,7 +14,7 @@ module Diffend
         # @param report [Boolean] if true we will report the issue to diffend
         #
         # @return [Net::HTTPResponse] response from Diffend
-        def call(exception:, payload: {}, config:, message:, report: false)
+        def call(config:, message:, exception: nil, payload: {}, report: false)
           exception_payload = prepare_exception_payload(exception, payload)
 
           Bundler.ui.error(Diffend::HandleErrors::Messages::PAYLOAD_DUMP)

data/lib/diffend/request.rb

@@ -23,6 +23,15 @@ module Diffend
       Net::OpenTimeout,
       Net::ReadTimeout
     ].freeze
+    # Message displayed when server issue occured and we will retry
+    SERVER_ERROR_MESSAGE = 'We experienced a server-side issue, retrying...'
+    # List of server issues
+    #
+    # 500 - Internal Server Error
+    # 502 - Bad Gateway
+    # 503 - Service Unavailable
+    # 504 - Gateway Timeout
+    SERVER_ERRORS = [500, 502, 503, 504].freeze
     # Number of retries
     RETRIES = 3
     # Request headers
@@ -42,8 +51,25 @@ module Diffend
         retry_count ||= -1
 
         build_http(endpoint_url) do |http, uri|
-          http.request(build_request(uri, config, payload))
+          response = http.request(build_request(uri, config, payload))
+
+          if SERVER_ERRORS.include?(response.code.to_i)
+            raise Diffend::Errors::RequestServerError, response.code.to_i
+          end
+
+          response
         end
+      rescue Diffend::Errors::RequestServerError => e
+        retry_count += 1
+
+        retry if handle_retry(SERVER_ERROR_MESSAGE, retry_count)
+
+        Diffend::HandleErrors::Report.call(
+          exception: e,
+          payload: payload,
+          config: config,
+          message: :request_error
+        )
       rescue *CONNECTION_EXCEPTIONS => e
         retry_count += 1
 

data/lib/diffend/voting.rb

@@ -7,23 +7,33 @@ module Diffend
       # Build verdict
       #
       # @param command [String] either install or update
+      # @param config [OpenStruct] diffend config
       # @param definition [Bundler::Definition] definition for your source
-      def call(command, definition)
+      def call(command, config, definition)
         Versions::Remote
-          .call(command, definition)
-          .tap { |response| build_message(command, response) }
+          .call(command, config, definition)
+          .tap { |response| build_message(command, config, response) }
       end
 
-      def build_message(command, response)
+      # @param command [String] either install or update
+      # @param config [OpenStruct] diffend config
+      # @param response [Hash] response from diffend API
+      def build_message(command, config, response)
         if response.key?('error')
           build_error(response)
         elsif response.key?('action')
-          build_verdict(command, response)
+          build_verdict(command, config, response)
         else
-          raise UnsupportedResponse, response['action']
+          Diffend::HandleErrors::Report.call(
+            config: config,
+            message: :unsupported_response,
+            payload: response,
+            report: true
+          )
         end
       end
 
+      # @param response [Hash] response from diffend API
       def build_error(response)
         build_error_message(response)
           .tap(&Bundler.ui.method(:error))
@@ -31,7 +41,10 @@ module Diffend
         exit 1
       end
 
-      def build_verdict(command, response)
+      # @param command [String] either install or update
+      # @param config [OpenStruct] diffend config
+      # @param response [Hash] response from diffend API
+      def build_verdict(command, config, response)
         case response['action']
         when 'allow'
           build_allow_message(command, response)
@@ -42,10 +55,18 @@ module Diffend
 
           exit 1
         else
-          raise UnsupportedAction, response['action']
+          Diffend::HandleErrors::Report.call(
+            config: config,
+            message: :unsupported_verdict,
+            payload: response,
+            report: true
+          )
         end
       end
 
+      # @param response [Hash] response from diffend API
+      #
+      # @return [String]
       def build_error_message(response)
         <<~MSG
           \nDiffend returned an error for your request.\n
@@ -53,6 +74,10 @@ module Diffend
         MSG
       end
 
+      # @param command [String] either install or update
+      # @param response [Hash] response from diffend API
+      #
+      # @return [String]
       def build_allow_message(command, response)
         <<~MSG
           \nDiffend reported an allow verdict for #{command} command for this project.\n
@@ -61,6 +86,10 @@ module Diffend
         MSG
       end
 
+      # @param command [String] either install or update
+      # @param response [Hash] response from diffend API
+      #
+      # @return [String]
       def build_deny_message(command, response)
         <<~MSG
           \nDiffend reported a deny verdict for #{command} command for this project.\n

data/lib/diffend/voting/versions/local.rb

@@ -54,7 +54,6 @@ module Diffend
         def initialize(definition)
           @definition = definition
           @direct_dependencies = Hash[definition.dependencies.map { |val| [val.name, val] }]
-          @main_source = definition.send(:sources).rubygems_sources.last
           # Support case without Gemfile.lock
           @locked_specs = @definition.locked_gems ? @definition.locked_gems.specs : []
         end
@@ -150,17 +149,17 @@ module Diffend
         #
         # @return [String]
         def build_spec_platform(spec, locked_spec)
-          spec.platform || locked_spec&.platform || build_spec_generic_platform(spec)
+          parse_platform(
+            spec.platform || locked_spec&.platform || spec.send(:generic_local_platform)
+          )
         end
 
-        # Build gem generic platform
+        # Parse gem platform
         #
-        # @param spec [Bundler::StubSpecification, Bundler::LazySpecification, Gem::Specification]
+        # @param platform [String, Gem::Platform]
         #
         # @return [String]
-        def build_spec_generic_platform(spec)
-          platform = spec.send(:generic_local_platform)
-
+        def parse_platform(platform)
           case platform
           when String then platform
           when Gem::Platform then platform.os
@@ -176,7 +175,7 @@ module Diffend
           case source
           when Bundler::Source::Metadata
             GEM_SOURCES_TYPES[:local]
-          when Bundler::Source::Rubygems
+          when Bundler::Source::Rubygems, Bundler::Source::Rubygems::Remote
             GEM_SOURCES_TYPES[:gemfile_source]
           when Bundler::Source::Git
             GEM_SOURCES_TYPES[:gemfile_git]
@@ -207,10 +206,20 @@ module Diffend
         #
         # @return [Bundler::Source] gem source type
         def source_for_spec(spec)
-          if @direct_dependencies.key?(spec.name)
-            @direct_dependencies[spec.name].source || @main_source
-          else
+          return spec.remote if spec.remote
+
+          case spec.source
+          when Bundler::Source::Rubygems
+            spec
+              .source
+              .send(:remote_specs)
+              .search(Bundler::Dependency.new(spec.name, spec.version))
+              .last
+              .remote
+          when Bundler::Source::Metadata, Bundler::Source::Git, Bundler::Source::Path
             spec.source
+          else
+            raise ArgumentError, "unknown source #{spec.source.class}"
           end
         end
 
@@ -223,10 +232,10 @@ module Diffend
           case source
           when Bundler::Source::Metadata
             ''
-          when Bundler::Source::Rubygems
-            source_name(source.remotes.first)
+          when Bundler::Source::Rubygems::Remote
+            source_name(source.anonymized_uri)
           when Bundler::Source::Git
-            source.uri
+            source.instance_variable_get(:@safe_uri)
           when Bundler::Source::Path
             source.path
           else
@@ -234,11 +243,11 @@ module Diffend
           end
         end
 
-        # @param name [Bundler::URI]
+        # @param uri [Bundler::URI]
         #
-        # @return [String] cleaned source name
-        def source_name(name)
-          name.to_s[0...-1]
+        # @return [String]
+        def source_name(uri)
+          uri.to_s[0...-1]
         end
 
         # Build sources used in the Gemfile

data/lib/diffend/voting/versions/remote.rb

@@ -20,9 +20,8 @@ module Diffend
         class << self
           # @param command [String] either install or update
           # @param definition [Bundler::Definition] definition for your source
-          def call(command, definition)
-            config = fetch_config
-
+          # @param config [OpenStruct] diffend config
+          def call(command, config, definition)
             payload = payload(command, config.project_id, definition)
 
             response = Diffend::Request.call(
@@ -35,7 +34,7 @@ module Diffend
           rescue StandardError => e
             Diffend::HandleErrors::Report.call(
               exception: e,
-              payload: payload,
+              payload: payload || {},
               config: config,
               message: :unhandled_exception,
               report: true
@@ -187,17 +186,6 @@ module Diffend
             tags
           end
 
-          # Fetch diffend config file
-          #
-          # @return [OpenStruct, nil] configuration object
-          #
-          # @raise [Errors::MissingConfigurationFile] when no config file
-          def fetch_config
-            Config::Fetcher.call(
-              File.expand_path('..', Bundler.bin_path)
-            )
-          end
-
           # Provides diffend command endpoint url
           #
           # @param command [String] either install or update

data/scripts/generate_payload_for_file.rb

@@ -10,6 +10,6 @@ project_id = nil
 gemfile = ARGV[0]
 lockfile = ARGV[1]
 
-definition = Bundler::Definition.build(gemfile, lockfile, true)
+definition = Diffend::BuildBundlerDefinition.call(command, gemfile lockfile)
 
 pp Diffend::Voting::Versions::Remote.payload(command, project_id, definition)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diffend
 version: !ruby/object:Gem::Version
-  version: 0.2.23
+  version: 0.2.24
 platform: ruby
 authors:
 - Tomasz Pajor
@@ -34,7 +34,7 @@ cert_chain:
   9MmF6uCQa1EjK2p8tYT0MnbHrFkoehxdX4VO9y99GAkhZyJNKPYPtyAUFV27sT2V
   LfCJRk4ifKIN/FUCwDSn8Cz0m6oH265q0p6wdzI6qrWOjP8tGOMBTA==
   -----END CERTIFICATE-----
-date: 2020-09-06 00:00:00.000000000 Z
+date: 2020-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler