diffend 0.2.26 → 0.2.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f22ef308037176744a8795a6371eb3340f01d597b706c66e45b8355dbf2d41a9
-  data.tar.gz: 1e5734925c51663f20e804ecef8d329f7b24a05dfce891b33366f1e867edbf78
+  metadata.gz: f6539b727e33d38eb0b3fb6f38f25c3fd2abda05f337f50af2db1fe135575510
+  data.tar.gz: c6808082290c195a846117fd4c16a4fa4cb20f65cc289cbadbd71532f8ae5713
 SHA512:
-  metadata.gz: 8930d5dfc0e3c8438515069ab5c472ae93aaf934c6d16c595c70b9167384347d7c0358c4c50fc49d18b1a4024ed959be4fff00485731c9e622b8c8e89f7c1a98
-  data.tar.gz: e9741f2fe2db83a7650dd2272b9f79cfa7e5bc4b3c2989cae0d8390215459a386a545f23eb0163e350e6e32a7dca7963c9a9bfcdb65496dfa062051a2c023aad
+  metadata.gz: 9eb4e7749b9a9a0824770921d150e180ed5b40ba19a7f22d1f65154474347110221dc96049c2b4b5d7136c850c5775c07bc4e840b005dda13043742ac74238d2
+  data.tar.gz: 427d6b00c913174e535de300020f8fe715bda9b3f946f1fbe25906dfa734bb4dd3c349735470fbacb9740c287dd5252bcf6b481e40120daba3138afda6f334e9

data/CHANGELOG.md

@@ -2,8 +2,13 @@
 
 ## [Unreleased][master]
 
+## [0.2.27] (2020-09-16)
+- introduce `Diffend::RequestObject` ([#40](https://github.com/diffend-io/diffend-ruby/pull/40))
+- clean up error codes and introduce `DIFFEND_INGORE_EXCEPTIONS` ([#41](https://github.com/diffend-io/diffend-ruby/pull/41))
+- introduce `Diffend::Monitor` and `Diffend::Track` ([#15](https://github.com/diffend-io/diffend-ruby/pull/15))
+
 ## [0.2.26] (2020-09-10)
-- introduce DIFFEND_DEVELOPMENT environment variable ([#36](https://github.com/diffend-io/diffend-ruby/pull/36))
+- introduce `DIFFEND_DEVELOPMENT` environment variable ([#36](https://github.com/diffend-io/diffend-ruby/pull/36))
 - adjust message for allow verdict ([#37](https://github.com/diffend-io/diffend-ruby/pull/37))
 - do not run the plugin when it is not enabled ([#38](https://github.com/diffend-io/diffend-ruby/pull/38))
 
@@ -55,7 +60,8 @@
 
 - initial release
 
-[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.26...HEAD
+[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.27...HEAD
+[0.2.27]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.26...v0.2.27
 [0.2.26]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.25...v0.2.26
 [0.2.25]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.24...v0.2.25
 [0.2.24]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.23...v0.2.24

data/Gemfile.lock

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

data/lib/diffend.rb

@@ -15,8 +15,10 @@
   handle_errors/build_exception_payload
   handle_errors/display_to_stdout
   handle_errors/report
+  request_object
   request
   voting
+  track
 ].each { |file| require "diffend/#{file}" }
 
 %w[
@@ -27,7 +29,7 @@
 # Diffend main namespace
 module Diffend
   # Current plugin version
-  VERSION = '0.2.26'
+  VERSION = '0.2.27'
   # Diffend homepage
   HOMEPAGE = 'https://diffend.io'
 
@@ -56,13 +58,22 @@ module Diffend
           Bundler.default_lockfile
         )
       )
+    rescue Diffend::Errors::HandledException
+      return if ENV['DIFFEND_IGNORE_ERRORS'] == 'true'
+
+      exit 255
     rescue StandardError => e
       Diffend::HandleErrors::Report.call(
         exception: e,
         config: config,
         message: :unhandled_exception,
-        report: true
+        report: true,
+        raise_exception: false
       )
+
+      return if ENV['DIFFEND_IGNORE_ERRORS'] == 'true'
+
+      exit 255
     end
 
     def verify_version
@@ -72,7 +83,7 @@ module Diffend
       build_outdated_version_message(installed_version)
         .tap(&Bundler.ui.method(:error))
 
-      exit 1
+      exit 2
     end
 
     # @return [String] installed plugin version

data/lib/diffend/commands.rb

@@ -3,9 +3,11 @@
 module Diffend
   # Modules grouping supported bundler commands
   module Commands
-    # Install bundler command
+    # Bundler install command
     INSTALL = 'install'
-    # Update bundler command
+    # Bundler update command
     UPDATE = 'update'
+    # Bundler exec command
+    EXEC = 'exec'
   end
 end

data/lib/diffend/config/fetcher.rb

@@ -27,16 +27,20 @@ module Diffend
           build(build_path)
         rescue Errors::MissingConfigurationFile
           Bundler.ui.error(build_missing_error_message(build_path))
-          exit 1
+
+          raise Diffend::Errors::HandledException
         rescue Errors::EmptyConfigurationFile
           Bundler.ui.error(build_empty_error_message(build_path))
-          exit 1
+
+          raise Diffend::Errors::HandledException
         rescue Errors::MalformedConfigurationFile
           Bundler.ui.error(build_malformed_error_message(build_path))
-          exit 1
+
+          raise Diffend::Errors::HandledException
         rescue *MISSING_KEY_ERRORS => e
           Bundler.ui.error(build_missing_key_error_message(e))
-          exit 1
+
+          raise Diffend::Errors::HandledException
         end
 
         private

data/lib/diffend/errors.rb

@@ -21,5 +21,7 @@ module Diffend
     BuildPathMissingInConfigurationFile = Class.new(BaseError)
     # Raised when server-side error occurs
     RequestServerError = Class.new(BaseError)
+    # Raised when we had an exception that we know how to handle
+    HandledException = Class.new(BaseError)
   end
 end

data/lib/diffend/handle_errors/report.rb

@@ -12,9 +12,10 @@ module Diffend
         # @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
         #
         # @return [Net::HTTPResponse] response from Diffend
-        def call(config:, message:, exception: nil, payload: {}, report: false)
+        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)
@@ -22,13 +23,24 @@ module Diffend
 
           if report
             Diffend::Request.call(
-              config,
-              errors_url(config.project_id),
-              exception_payload
+              build_request_object(config, exception_payload)
             )
           end
 
-          exit 1
+          raise Diffend::Errors::HandledException if raise_exception
+        end
+
+        # @param config [OpenStruct] 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),
+            payload: payload,
+            request_method: :post
+          )
         end
 
         # Prepare exception payload and display it to stdout

data/lib/diffend/monitor.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+%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_object
+  request
+  voting
+  track
+].each { |file| require "diffend/#{file}" }
+
+%w[
+  versions/local
+  versions/remote
+].each { |file| require "diffend/voting/#{file}" }
+
+Thread.new do
+  track = Diffend::Track.new
+  track.start
+end

data/lib/diffend/request.rb

@@ -42,16 +42,21 @@ module Diffend
     class << self
       # Execute request
       #
-      # @param config [OpenStruct] diffend config
-      # @param endpoint_url [String]
-      # @param payload [Hash]
+      # @param request_object [Diffend::RequestObject]
       #
       # @return [Net::HTTPResponse] response from Diffend
-      def call(config, endpoint_url, payload)
+      def call(request_object)
         retry_count ||= -1
 
-        build_http(endpoint_url) do |http, uri|
-          response = http.request(build_request(uri, config, payload))
+        build_http(request_object.url) do |http, uri|
+          response = http.request(
+            build_request(
+              uri,
+              request_object.request_method,
+              request_object.config,
+              request_object.payload
+            )
+          )
 
           if SERVER_ERRORS.include?(response.code.to_i)
             raise Diffend::Errors::RequestServerError, response.code.to_i
@@ -66,8 +71,8 @@ module Diffend
 
         Diffend::HandleErrors::Report.call(
           exception: e,
-          payload: payload,
-          config: config,
+          payload: request_object.payload,
+          config: request_object.config,
           message: :request_error
         )
       rescue *CONNECTION_EXCEPTIONS => e
@@ -77,8 +82,8 @@ module Diffend
 
         Diffend::HandleErrors::Report.call(
           exception: e,
-          payload: payload,
-          config: config,
+          payload: request_object.payload,
+          config: request_object.config,
           message: :request_error
         )
       rescue *TIMEOUT_EXCEPTIONS => e
@@ -88,8 +93,8 @@ module Diffend
 
         Diffend::HandleErrors::Report.call(
           exception: e,
-          payload: payload,
-          config: config,
+          payload: request_object.payload,
+          config: request_object.config,
           message: :request_error
         )
       end
@@ -126,17 +131,32 @@ module Diffend
       # Build http post request and assigns headers and payload
       #
       # @param uri [URI::HTTPS]
+      # @param request_method [Symbol]
       # @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
+      # @return [Net::HTTP::Post, Net::HTTP::Put]
+      def build_request(uri, request_method, config, payload)
+        pick_request_method(request_method)
           .new(uri.request_uri, HEADERS)
           .tap { |request| assign_auth(request, config) }
           .tap { |request| assign_payload(request, payload) }
       end
 
+      # Pick request method
+      #
+      # @param request_method [Symbol]
+      #
+      # @return [Net::HTTP::Post, Net::HTTP::Put]
+      def pick_request_method(request_method)
+        case request_method
+        when :post
+          Net::HTTP::Post
+        when :put
+          Net::HTTP::Put
+        end
+      end
+
       # Assigns basic authorization if provided in the config
       #
       # @param request [Net::HTTP::Post] prepared http post

data/lib/diffend/request_object.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Class responsible for preparing diffend request object
+  RequestObject = Struct.new(:config, :url, :payload, :request_method, keyword_init: true)
+end

data/lib/diffend/track.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Track what is run in production
+  class Track
+    # Time that we want to wait between track requests
+    TRACK_SLEEP = 15
+    # Time that we want to wait before we retry
+    RETRY_SLEEP = 15
+
+    # Initialize tracking
+    def initialize
+      @mutex = Mutex.new
+      @config = fetch_config
+    end
+
+    # Start tracking
+    def start
+      response = exec_request
+
+      perform(response['id'])
+    rescue Diffend::Errors::HandledException
+      sleep(RETRY_SLEEP)
+
+      retry
+    rescue StandardError => e
+      Diffend::HandleErrors::Report.call(
+        exception: e,
+        config: @config,
+        message: :unhandled_exception,
+        report: true,
+        raise_exception: false
+      )
+
+      sleep(RETRY_SLEEP)
+
+      retry
+    end
+
+    # @param request_id [String]
+    def perform(request_id)
+      loop do
+        @mutex.synchronize do
+          track_request(request_id)
+        end
+
+        sleep(TRACK_SLEEP)
+      end
+    end
+
+    # Perform an exec request
+    def exec_request
+      Diffend::Voting.call(
+        Diffend::Commands::EXEC,
+        @config,
+        Diffend::BuildBundlerDefinition.call(
+          Diffend::Commands::EXEC,
+          Bundler.default_gemfile,
+          Bundler.default_lockfile
+        )
+      )
+    end
+
+    # Perform a track request
+    #
+    # @param request_id [String]
+    def track_request(request_id)
+      Diffend::Request.call(
+        build_request_object(request_id)
+      )
+    end
+
+    # @param request_id [String]
+    #
+    # @return [Diffend::RequestObject]
+    def build_request_object(request_id)
+      Diffend::RequestObject.new(
+        config: @config,
+        url: track_url(@config.project_id, request_id),
+        payload: { id: request_id }.freeze,
+        request_method: :put
+      ).freeze
+    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
+
+    # @param project_id [String] diffend project_id
+    # @param request_id [String]
+    #
+    # @return [String]
+    def track_url(project_id, request_id)
+      "https://my.diffend.io/api/projects/#{project_id}/bundle/#{request_id}/track"
+    end
+  end
+end

data/lib/diffend/voting.rb

@@ -38,7 +38,7 @@ module Diffend
         build_error_message(response)
           .tap(&Bundler.ui.method(:error))
 
-        exit 1
+        raise Diffend::Errors::HandledException
       end
 
       # @param command [String] either install or update

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

@@ -40,7 +40,7 @@ module Diffend
             instance = new(definition)
 
             case command
-            when Commands::INSTALL then instance.build_install
+            when Commands::INSTALL, Commands::EXEC then instance.build_install
             when Commands::UPDATE then instance.build_update
             else
               raise ArgumentError, "invalid command: #{command}"

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

@@ -25,9 +25,7 @@ module Diffend
             payload = payload(command, config.project_id, definition)
 
             response = Diffend::Request.call(
-              config,
-              commands_url(command, config.project_id),
-              payload
+              build_request_object(command, config, payload)
             )
 
             JSON.parse(response.body)
@@ -41,6 +39,20 @@ module Diffend
             )
           end
 
+          # @param command [String] either install or update
+          # @param config [OpenStruct] diffend config
+          # @param payload [Hash]
+          #
+          # @return [Diffend::RequestObject]
+          def build_request_object(command, config, payload)
+            Diffend::RequestObject.new(
+              config: config,
+              url: commands_url(command, config.project_id),
+              payload: payload,
+              request_method: :post
+            )
+          end
+
           # Build diffend, host, packages, and platform specific information
           #
           # @param command [String] either install or update

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diffend
 version: !ruby/object:Gem::Version
-  version: 0.2.26
+  version: 0.2.27
 platform: ruby
 authors:
 - Tomasz Pajor
@@ -34,7 +34,7 @@ cert_chain:
   9MmF6uCQa1EjK2p8tYT0MnbHrFkoehxdX4VO9y99GAkhZyJNKPYPtyAUFV27sT2V
   LfCJRk4ifKIN/FUCwDSn8Cz0m6oH265q0p6wdzI6qrWOjP8tGOMBTA==
   -----END CERTIFICATE-----
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,7 +102,10 @@ files:
 - lib/diffend/handle_errors/display_to_stdout.rb
 - lib/diffend/handle_errors/messages.rb
 - lib/diffend/handle_errors/report.rb
+- lib/diffend/monitor.rb
 - lib/diffend/request.rb
+- lib/diffend/request_object.rb
+- lib/diffend/track.rb
 - lib/diffend/voting.rb
 - lib/diffend/voting/versions/local.rb
 - lib/diffend/voting/versions/remote.rb