diffend 0.2.19 → 0.2.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f18edf14b16e7f2ec3ce0c574ade976e78e3eac84f8395e45fc53595a8e3f91
-  data.tar.gz: 292e755dac0d191787b77fb8556b5e2f90f9e040ee9e28486de90601b2c2a67c
+  metadata.gz: 5ce266f8f72de49360adc1e6e1f79c8bf5fa08727ffc990292877c015e1040ee
+  data.tar.gz: 1a71a4a519b1f2afb9bc993726c045b4db5b87833459ba8f7192c2a2f4232aa6
 SHA512:
-  metadata.gz: 73326da64425debc8c27ad1dd216df34313a45795a2c6f555d0e5df067dfc17977ae9ee6e8307ab1df33af58a87ca23511ed3920eaa9c0bcec566fef602c30c3
-  data.tar.gz: eabf666e6c1ef7a08afaadf519011edac2416f0a2fa13152a9112b898b94dde1f598f23866a9823220be308aa091d9dab6b6d03e95191f3d22ba43509d3933fa
+  metadata.gz: '08dd6da1d3984200d9ac07fd9fd1f9a0adf6b7746f86a77ab560b77b356dc6fad819513adea6fe2d714b1f06ed8cf5441d796681fd507b64247a2db3560d3138'
+  data.tar.gz: 2155bbba6da089606b38d36fcec4259054f6cac053bf56eefb303d6d3aa223ba4253ca771249a2543696c636e8c509aa75ceb3ab50f055dd18a2ba9715e5cb9f

data/.github/workflows/ci.yml

@@ -9,6 +9,9 @@ jobs:
       matrix:
         ruby:
           - '2.7'
+          - '2.6'
+          - '2.5'
+          - 'jruby'
         include:
           - ruby: '2.7'
             coverage: 'true'

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Changelog
 
 ## [Unreleased][master]
+- 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))
+
+## [0.2.22] (2020-09-03)
+- fix how we build host command
+
+## [0.2.21] (2020-09-03)
+- bring back support for ruby 2.5.x
+
+## [0.2.20] (2020-09-03)
+- expose host command ([#21](https://github.com/diffend-io/diffend-ruby/pull/21))
+- expose host pid ([#20](https://github.com/diffend-io/diffend-ruby/pull/20))
+- use `Bundler.feature_flag.default_cli_command` which is used as the default task if no command provided, instead of `Diffend::Commands::INSTALL` ([#19](https://github.com/diffend-io/diffend-ruby/pull/19))
+- better error handling ([#18](https://github.com/diffend-io/diffend-ruby/pull/18))
+- better detection of gem versions ([#17](https://github.com/diffend-io/diffend-ruby/pull/17))
+- introduce `Diffend::BuildBundlerDefinition` ([#16](https://github.com/diffend-io/diffend-ruby/pull/16))
 
 ## [0.2.19] (2020-08-18)
 
@@ -22,7 +38,10 @@
 
 - initial release
 
-[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.19...HEAD
+[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.22...HEAD
+[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
 [0.2.19]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.18...v0.2.19
 [0.2.18]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.17...v0.2.18
 [0.2.17]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.16...v0.2.17

data/Gemfile

@@ -7,6 +7,7 @@ plugin 'diffend'
 gemspec
 
 group :development, :test do
-  gem 'byebug'
+  gem 'byebug', platform: :ruby
+  gem 'pry', platform: :jruby
   gem 'rspec'
 end

data/Gemfile.lock

@@ -1,13 +1,20 @@
 PATH
   remote: .
   specs:
-    diffend (0.2.19)
+    diffend (0.2.23)
 
 GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.1.3)
+    coderay (1.1.3)
     diff-lcs (1.4.4)
+    ffi (1.13.1-java)
+    method_source (1.0.0)
+    pry (0.13.1-java)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+      spoon (~> 0.0)
     rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -22,14 +29,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    spoon (0.0.6)
+      ffi
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
   bundler
   byebug
   diffend!
+  pry
   rake
   rspec
 

data/lib/diffend.rb

@@ -5,16 +5,21 @@
 ].each(&method(:require))
 
 %w[
+  build_bundler_definition
   errors
   config/fetcher
   config/file_finder
   config/validator
   commands
+  handle_errors/messages
+  handle_errors/build_exception_payload
+  handle_errors/display_to_stdout
+  handle_errors/report
+  request
   voting
 ].each { |file| require "diffend/#{file}" }
 
 %w[
-  request
   versions/local
   versions/remote
 ].each { |file| require "diffend/voting/#{file}" }
@@ -22,7 +27,7 @@
 # Diffend main namespace
 module Diffend
   # Current plugin version
-  VERSION = '0.2.19'
+  VERSION = '0.2.23'
   # Diffend homepage
   HOMEPAGE = 'https://diffend.io'
 
@@ -30,27 +35,28 @@ module Diffend
     # Registers the plugin and add before install all hook
     def register
       Bundler::Plugin.add_hook('before-install-all') do |_|
-        Diffend::Voting.call(
-          command,
-          build_definition(command)
-        )
+        execute
       end
     end
 
-    # Build clean instance of bundler definition, as we don't want to pollute the main one
-    #
-    # @param command [String] bundler command that we are executing
-    #
-    # @return [Bundler::Definition]
-    def build_definition(command)
-      unlock = command == 'update' ? true : nil
+    # Execute diffend plugin
+    def execute
+      config = fetch_config
 
-      Bundler.configure
-
-      Bundler::Definition.build(
-        Bundler.default_gemfile,
-        Bundler.default_lockfile,
-        unlock
+      Diffend::Voting.call(
+        command,
+        Diffend::BuildBundlerDefinition.call(
+          command,
+          Bundler.default_gemfile,
+          Bundler.default_lockfile
+        )
+      )
+    rescue StandardError => e
+      Diffend::HandleErrors::Report.call(
+        exception: e,
+        config: config,
+        message: :unhandled_exception,
+        report: true
       )
     end
 
@@ -58,7 +64,18 @@ module Diffend
     #
     # @return [String]
     def command
-      ARGV.first || Diffend::Commands::INSTALL
+      ARGV.first || Bundler.feature_flag.default_cli_command.to_s
+    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
   end
 end

data/lib/diffend/build_bundler_definition.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Builds bundler definition used within the plugin
+  module BuildBundlerDefinition
+    class << self
+      # Build clean instance of bundler definition, as we don't want to pollute the main one
+      #
+      # @param command [String] bundler command that we are executing
+      # @param gemfile [String] path to Gemfile
+      # @param lockfile [String] path to Gemfile.lock
+      #
+      # @return [Bundler::Definition]
+      def call(command, gemfile, lockfile)
+        unlock = command == 'update' ? true : nil
+
+        Bundler.configure
+        Bundler::Fetcher.disable_endpoint = nil
+
+        Bundler::Definition
+          .build(gemfile, lockfile, unlock)
+          .tap(&:validate_runtime!)
+      end
+    end
+  end
+end

data/lib/diffend/handle_errors/build_exception_payload.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Diffend
+  module HandleErrors
+    # Module responsible for building exception payload
+    module BuildExceptionPayload
+      class << self
+        # Build exception payload
+        #
+        # @param exception [Exception] expection that was raised
+        # @param payload [Hash] with versions to check
+        #
+        # @return [Hash]
+        def call(exception, payload)
+          {
+            request_id: SecureRandom.uuid,
+            payload: payload,
+            exception: {
+              class: exception.class,
+              message: exception.message,
+              backtrace: exception.backtrace
+            }
+          }.freeze
+        end
+      end
+    end
+  end
+end

data/lib/diffend/handle_errors/display_to_stdout.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Diffend
+  module HandleErrors
+    # Module responsible for displaying exception payload to stdout
+    module DisplayToStdout
+      class << self
+        # Display exception payload to stdout
+        #
+        # @param exception_payload [Hash]
+        def call(exception_payload)
+          puts exception_payload.to_json
+        end
+      end
+    end
+  end
+end

data/lib/diffend/handle_errors/messages.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Diffend
+  module HandleErrors
+    module Messages
+      PAYLOAD_DUMP = '^^^ Above is the dump of your request ^^^'
+      UNHANDLED_EXCEPTION = <<~MSG
+        \nSomething went really wrong. 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
+        Create an issue at https://github.com/diffend-io/diffend-ruby/issues\n
+      MSG
+    end
+  end
+end

data/lib/diffend/handle_errors/report.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Diffend
+  module HandleErrors
+    # Module responsible for reporting errors to diffend
+    module Report
+      class << self
+        # Execute request to Diffend
+        #
+        # @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
+        #
+        # @return [Net::HTTPResponse] response from Diffend
+        def call(exception:, payload: {}, config:, message:, report: false)
+          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))
+
+          if report
+            Diffend::Request.call(
+              config,
+              errors_url(config.project_id),
+              exception_payload
+            )
+          end
+
+          exit 1
+        end
+
+        # Prepare exception payload and display it to stdout
+        #
+        # @param exception [Exception] expection that was raised
+        # @param payload [Hash] with versions to check
+        #
+        # @return [Hash]
+        def prepare_exception_payload(exception, payload)
+          Diffend::HandleErrors::BuildExceptionPayload
+            .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
+end

data/lib/diffend/request.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'openssl'
+require 'json'
+
+module Diffend
+  # Module responsible for doing request to Diffend
+  module Request
+    # Message displayed when connection issue occured and we will retry
+    CONNECTION_MESSAGE = 'We experienced a connection issue, retrying...'
+    # List of connection exceptions
+    CONNECTION_EXCEPTIONS = [
+      Errno::ECONNRESET,
+      Errno::ENETUNREACH,
+      Errno::EHOSTUNREACH,
+      Errno::ECONNREFUSED
+    ].freeze
+    # Message displayed when timeout occured and we will retry
+    TIMEOUT_MESSAGE = 'We experienced a connection issue, retrying...'
+    # List of timeout exceptions
+    TIMEOUT_EXCEPTIONS = [
+      Net::OpenTimeout,
+      Net::ReadTimeout
+    ].freeze
+    # Number of retries
+    RETRIES = 3
+    # Request headers
+    HEADERS = { 'Content-Type': 'application/json' }.freeze
+
+    private_constant :HEADERS
+
+    class << self
+      # Execute request
+      #
+      # @param config [OpenStruct] diffend config
+      # @param endpoint_url [String]
+      # @param payload [Hash]
+      #
+      # @return [Net::HTTPResponse] response from Diffend
+      def call(config, endpoint_url, payload)
+        retry_count ||= -1
+
+        build_http(endpoint_url) do |http, uri|
+          http.request(build_request(uri, config, payload))
+        end
+      rescue *CONNECTION_EXCEPTIONS => e
+        retry_count += 1
+
+        retry if handle_retry(CONNECTION_MESSAGE, retry_count)
+
+        Diffend::HandleErrors::Report.call(
+          exception: e,
+          payload: payload,
+          config: config,
+          message: :request_error
+        )
+      rescue *TIMEOUT_EXCEPTIONS => e
+        retry_count += 1
+
+        retry if handle_retry(TIMEOUT_MESSAGE, retry_count)
+
+        Diffend::HandleErrors::Report.call(
+          exception: e,
+          payload: payload,
+          config: config,
+          message: :request_error
+        )
+      end
+
+      # Handle retry
+      #
+      # @param message [String] message we want to display
+      # @param retry_count [Integer]
+      def handle_retry(message, retry_count)
+        return false if retry_count == RETRIES
+
+        Bundler.ui.error(message)
+        sleep(exponential_backoff(retry_count))
+
+        retry_count < RETRIES
+      end
+
+      # Builds http connection object
+      #
+      # @param url [String] command endpoint url
+      def build_http(url)
+        uri = URI(url)
+
+        Net::HTTP.start(
+          uri.host,
+          uri.port,
+          use_ssl: uri.scheme == 'https',
+          verify_mode: OpenSSL::SSL::VERIFY_NONE,
+          open_timeout: 5,
+          read_timeout: 5
+        ) { |http| yield(http, uri) }
+      end
+
+      # Build http post request and assigns headers and payload
+      #
+      # @param uri [URI::HTTPS]
+      # @param config [OpenStruct] Diffend config
+      # @param payload [Hash] with versions to check
+      #
+      # @return [Net::HTTP::Post]
+      def build_request(uri, config, payload)
+        Net::HTTP::Post
+          .new(uri.request_uri, HEADERS)
+          .tap { |request| assign_auth(request, config) }
+          .tap { |request| assign_payload(request, payload) }
+      end
+
+      # Assigns basic authorization if provided in the config
+      #
+      # @param request [Net::HTTP::Post] prepared http post
+      # @param config [OpenStruct] Diffend config
+      def assign_auth(request, config)
+        return unless config
+        return unless config.shareable_id
+        return unless config.shareable_key
+
+        request.basic_auth(config.shareable_id, config.shareable_key)
+      end
+
+      # Assigns payload as json
+      #
+      # @param request [Net::HTTP::Post] prepared http post
+      # @param payload [Hash] with versions to check
+      def assign_payload(request, payload)
+        request.body = JSON.dump(payload: payload)
+      end
+
+      def exponential_backoff(retry_count)
+        2**(retry_count + 1)
+      end
+    end
+  end
+end

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

@@ -65,18 +65,16 @@ module Diffend
         def build_install
           hash = build_main
 
-          @definition.requested_specs.each do |spec|
+          @definition.specs.each do |spec|
             next if skip?(spec.source)
 
             locked_spec = @locked_specs.find { |s| s.name == spec.name }
 
-            spec2 = locked_spec || spec
-
-            hash['dependencies'][spec2.name] = {
-              'platform' => build_spec_platform(spec2),
-              'source' => build_spec_source(spec2),
-              'type' => build_dependency_type(spec2.name),
-              'versions' => build_versions(spec2)
+            hash['dependencies'][spec.name] = {
+              'platform' => build_spec_platform(spec, locked_spec),
+              'source' => build_spec_source(spec),
+              'type' => build_dependency_type(spec.name),
+              'versions' => build_versions(spec, locked_spec)
             }
           end
 
@@ -89,13 +87,13 @@ module Diffend
         def build_update
           hash = build_main
 
-          @definition.requested_specs.each do |spec|
+          @definition.specs.each do |spec|
             next if skip?(spec.source)
 
             locked_spec = @locked_specs.find { |s| s.name == spec.name }
 
             hash['dependencies'][spec.name] = {
-              'platform' => build_spec_platform(spec),
+              'platform' => build_spec_platform(spec, locked_spec),
               'source' => build_spec_source(spec),
               'type' => build_dependency_type(spec.name),
               'versions' => build_versions(spec, locked_spec)
@@ -126,7 +124,11 @@ module Diffend
         #
         # @return [Array<String>]
         def build_versions(spec, locked_spec = nil)
-          locked_spec ? [locked_spec.version.to_s, spec.version.to_s] : [spec.version.to_s]
+          if locked_spec && locked_spec.version.to_s != spec.version.to_s
+            [locked_spec.version.to_s, spec.version.to_s]
+          else
+            [spec.version.to_s]
+          end
         end
 
         # @param specs [Array] specs that are direct dependencies
@@ -144,10 +146,25 @@ module Diffend
         # Build gem platform
         #
         # @param spec [Bundler::StubSpecification, Bundler::LazySpecification, Gem::Specification]
+        # @param locked_spec [Bundler::LazySpecification, Gem::Specification, NilClass]
         #
         # @return [String]
-        def build_spec_platform(spec)
-          spec.platform || spec.send(:generic_local_platform)
+        def build_spec_platform(spec, locked_spec)
+          spec.platform || locked_spec&.platform || build_spec_generic_platform(spec)
+        end
+
+        # Build gem generic platform
+        #
+        # @param spec [Bundler::StubSpecification, Bundler::LazySpecification, Gem::Specification]
+        #
+        # @return [String]
+        def build_spec_generic_platform(spec)
+          platform = spec.send(:generic_local_platform)
+
+          case platform
+          when String then platform
+          when Gem::Platform then platform.os
+          end
         end
 
         # Build gem source type
@@ -229,17 +246,17 @@ module Diffend
         # @return [Array<Hash>]
         def build_sources
           sources = @definition.send(:sources).rubygems_sources
-          hash = []
+          hash = {}
 
           sources.each do |source|
             type = build_source_type(source.remotes)
 
             source.remotes.each do |src|
-              hash << { 'name' => source_name(src), 'type' => type }
+              hash[source_name(src)] = type
             end
           end
 
-          hash
+          hash.map { |name, type| { 'name' => name, 'type' => type } }
         end
 
         # Build gem source type

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

@@ -23,11 +23,23 @@ module Diffend
           def call(command, definition)
             config = fetch_config
 
-            response = Request.call(
-              command, payload(command, config&.project_id, definition), config
+            payload = payload(command, config.project_id, definition)
+
+            response = Diffend::Request.call(
+              config,
+              commands_url(command, config.project_id),
+              payload
             )
 
             JSON.parse(response.body)
+          rescue StandardError => e
+            Diffend::HandleErrors::Report.call(
+              exception: e,
+              payload: payload,
+              config: config,
+              message: :unhandled_exception,
+              report: true
+            )
           end
 
           # Build diffend, host, packages, and platform specific information
@@ -85,6 +97,9 @@ module Diffend
             }.freeze
           end
 
+          # Build platform ruby information
+          #
+          # @return [Hash]
           def build_platform_ruby
             if defined?(JRUBY_VERSION)
               revision = JRUBY_REVISION.to_s
@@ -117,7 +132,7 @@ module Diffend
             uname = Etc.uname
 
             {
-              'command' => { 'name' => '', 'options' => '' },
+              'command' => build_host_command,
               'ips' => build_host_ips,
               'name' => uname[:nodename],
               'system' => {
@@ -127,10 +142,24 @@ module Diffend
                 'version' => uname[:version]
               },
               'tags' => build_host_tags,
-              'user' => Etc.getpwuid(Process.uid).name
+              'user' => Etc.getpwuid(Process.uid).name,
+              'pid' => Process.pid
             }.freeze
           end
 
+          # Build host command information
+          #
+          # @return [Hash]
+          def build_host_command
+            {
+              'name' => $PROGRAM_NAME.split('/').last.strip,
+              'options' => ARGV.join(' ')
+            }
+          end
+
+          # Build host ips, except localhost and loopback
+          #
+          # @return [Array<String>]
           def build_host_ips
             Socket.ip_address_list.map do |ip|
               next if ip.ipv4_loopback? || ip.ipv6_loopback? || ip.ipv6_linklocal?
@@ -139,6 +168,9 @@ module Diffend
             end.compact
           end
 
+          # Build host tags
+          #
+          # @return [Array]
           def build_host_tags
             tags = []
 
@@ -155,7 +187,7 @@ module Diffend
             tags
           end
 
-          # Fetch coditsu config file
+          # Fetch diffend config file
           #
           # @return [OpenStruct, nil] configuration object
           #
@@ -165,6 +197,18 @@ module Diffend
               File.expand_path('..', Bundler.bin_path)
             )
           end
+
+          # Provides diffend command endpoint url
+          #
+          # @param command [String] either install or update
+          # @param project_id [String] diffend project_id
+          #
+          # @return [String] diffend endpoint
+          def commands_url(command, project_id)
+            return ENV['DIFFEND_COMMAND_URL'] if ENV.key?('DIFFEND_COMMAND_URL')
+
+            "https://my.diffend.io/api/projects/#{project_id}/bundle/#{command}"
+          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diffend
 version: !ruby/object:Gem::Version
-  version: 0.2.19
+  version: 0.2.23
 platform: ruby
 authors:
 - Tomasz Pajor
@@ -34,7 +34,7 @@ cert_chain:
   9MmF6uCQa1EjK2p8tYT0MnbHrFkoehxdX4VO9y99GAkhZyJNKPYPtyAUFV27sT2V
   LfCJRk4ifKIN/FUCwDSn8Cz0m6oH265q0p6wdzI6qrWOjP8tGOMBTA==
   -----END CERTIFICATE-----
-date: 2020-08-18 00:00:00.000000000 Z
+date: 2020-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,13 +92,18 @@ files:
 - certs/tomaszpajor.pem
 - diffend.gemspec
 - lib/diffend.rb
+- lib/diffend/build_bundler_definition.rb
 - lib/diffend/commands.rb
 - lib/diffend/config/fetcher.rb
 - lib/diffend/config/file_finder.rb
 - lib/diffend/config/validator.rb
 - lib/diffend/errors.rb
+- lib/diffend/handle_errors/build_exception_payload.rb
+- lib/diffend/handle_errors/display_to_stdout.rb
+- lib/diffend/handle_errors/messages.rb
+- lib/diffend/handle_errors/report.rb
+- lib/diffend/request.rb
 - lib/diffend/voting.rb
-- lib/diffend/voting/request.rb
 - lib/diffend/voting/versions/local.rb
 - lib/diffend/voting/versions/remote.rb
 - plugins.rb

data/lib/diffend/voting/request.rb

@@ -1,191 +0,0 @@
-# frozen_string_literal: true
-
-require 'net/http'
-require 'openssl'
-require 'json'
-require 'securerandom'
-
-module Diffend
-  module Voting
-    # Module responsible for doing request to Diffend
-    module Request
-      # List of connection exceptions
-      CONNECTION_EXCEPTIONS = [
-        Errno::ECONNRESET,
-        Errno::ENETUNREACH,
-        Errno::EHOSTUNREACH,
-        Errno::ECONNREFUSED
-      ].freeze
-      # List of timeout exceptions
-      TIMEOUT_EXCEPTIONS = [
-        Net::OpenTimeout,
-        Net::ReadTimeout
-      ].freeze
-      # Request headers
-      HEADERS = { 'Content-Type': 'application/json' }.freeze
-
-      private_constant :HEADERS
-
-      class << self
-        # Execute request to Diffend
-        #
-        # @param command [String] either install or update
-        # @param payload [Hash] with versions to check
-        # @param config [OpenStruct] Diffend config
-        #
-        # @return [Net::HTTPResponse] response from Diffend
-        def call(command, payload, config)
-          retry_count ||= 0
-
-          build_http(commands_url(command, config.project_id)) do |http, uri|
-            http.request(build_request(uri, config, payload))
-          end
-        rescue *CONNECTION_EXCEPTIONS => e
-          Bundler.ui.error('We experienced a connection issue, retrying...')
-          sleep(exponential_backoff(retry_count))
-          retry_count += 1
-
-          retry if retry_count < 3
-
-          output_report(build_report(payload, e))
-          Bundler.ui.error('^^^ Above is the dump of your request ^^^')
-          Bundler.ui.error(build_request_error_message)
-
-          exit 1
-        rescue *TIMEOUT_EXCEPTIONS => e
-          Bundler.ui.error('We experienced a timeout issue, retrying...')
-          sleep(exponential_backoff(retry_count))
-          retry_count += 1
-
-          retry if retry_count < 3
-
-          output_report(build_report(payload, e))
-          Bundler.ui.error('^^^ Above is the dump of your request ^^^')
-          Bundler.ui.error(build_request_error_message)
-
-          exit 1
-        rescue StandardError => e
-          exception_payload = build_report(payload, e)
-          output_report(exception_payload)
-          Bundler.ui.error('^^^ Above is the dump of your request ^^^')
-          Bundler.ui.error(build_unhandled_exception_message)
-
-          build_http(errors_url(config.project_id)) do |http, uri|
-            http.request(build_request(uri, config, exception_payload))
-          end
-
-          exit 1
-        end
-
-        # Builds http connection object
-        #
-        # @param url [String] command endpoint url
-        def build_http(url)
-          uri = URI(url)
-
-          Net::HTTP.start(
-            uri.host,
-            uri.port,
-            use_ssl: uri.scheme == 'https',
-            verify_mode: OpenSSL::SSL::VERIFY_NONE,
-            open_timeout: 5,
-            read_timeout: 5
-          ) { |http| yield(http, uri) }
-        end
-
-        # Build http post request and assigns headers and payload
-        #
-        # @param uri [URI::HTTPS]
-        # @param config [OpenStruct] Diffend config
-        # @param payload [Hash] with versions to check
-        #
-        # @return [Net::HTTP::Post]
-        def build_request(uri, config, payload)
-          Net::HTTP::Post
-            .new(uri.request_uri, HEADERS)
-            .tap { |request| assign_auth(request, config) }
-            .tap { |request| assign_payload(request, payload) }
-        end
-
-        # Assigns basic authorization if provided in the config
-        #
-        # @param request [Net::HTTP::Post] prepared http post
-        # @param config [OpenStruct] Diffend config
-        def assign_auth(request, config)
-          return unless config
-          return unless config.shareable_id
-          return unless config.shareable_key
-
-          request.basic_auth(config.shareable_id, config.shareable_key)
-        end
-
-        # Assigns payload as json
-        #
-        # @param request [Net::HTTP::Post] prepared http post
-        # @param payload [Hash] with versions to check
-        def assign_payload(request, payload)
-          request.body = JSON.dump(payload: payload)
-        end
-
-        # Provides diffend command endpoint url
-        #
-        # @param command [String] either install or update
-        # @param project_id [String] diffend project_id
-        #
-        # @return [String] diffend endpoint
-        def commands_url(command, project_id)
-          return ENV['DIFFEND_COMMAND_URL'] if ENV.key?('DIFFEND_COMMAND_URL')
-
-          "https://my.diffend.io/api/projects/#{project_id}/bundle/#{command}"
-        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
-
-        def exponential_backoff(retry_count)
-          2**(retry_count + 1)
-        end
-
-        def build_request_error_message
-          <<~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
-            Create an issue on https://github.com/diffend-io/diffend-ruby/issues\n
-          MSG
-        end
-
-        def build_unhandled_exception_message
-          <<~MSG
-            \nSomething went really wrong. We recorded this incident in our system and will review it.\n
-            This is a bug, don't hesitate.\n
-            Create an issue on https://github.com/diffend-io/diffend-ruby/issues\n
-          MSG
-        end
-
-        def build_report(payload, exception)
-          {
-            request_id: SecureRandom.uuid,
-            payload: payload,
-            exception: {
-              class: exception.class,
-              message: exception.message,
-              backtrace: exception.backtrace
-            }
-          }
-        end
-
-        def output_report(report)
-          puts report.to_json
-        end
-      end
-    end
-  end
-end