knapsack_pro 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 406093c37a1985ce7cf5b2c89f625a226c4d42d8c4554eaac9037901fcfc3707
-  data.tar.gz: b299828d599720303c5203caee6bebe3d5b96e122fbf878924ac00c6cf4b6db2
+  metadata.gz: 59483963a5cda7dabf89075bf4aebff864e813d0192db2c10e8162918ecbef11
+  data.tar.gz: c4e50a75d402de63289db9b6126df9f6fbced9a562776125d94903752961b10a
 SHA512:
-  metadata.gz: aa7533794502874dee1c1275197166f99a5cb8ff63e3e37736fc4c2d66586af7a53088ca4a3a194f54a50a94d62c071253f421255a608bf9250cb5a9521bd3ef
-  data.tar.gz: 59b4abd2a72a5f979aa0dbde8cab8a62f1e8c06f37415bba258649ae6c9d7e373cdbe131514e7ad2f7b6870b8251a3c25ae50c37fd1847650e1761802ce39378
+  metadata.gz: b8341410b23dc56c9843734d6f264dc679eca71e8cda951f5594f782433f2c20b7998b708d21b8e76616a41b1cc5b14d4d80d9e468c61bc015edd605aac2a9b1
+  data.tar.gz: df0e11899060062d5ad447f749263ce05ab4c7dd11b93cbcb837e3c380c9879a08ee247292c9fed32839d17b13ac8a6b696493032b71d92d3d6d914b458eeed0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 1.6.0
+
+* Retry request 3 times when API returns 5xx HTTP status
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/78
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v1.5.0...v1.6.0
+
 ### 1.5.0
 
 * Add support for Semaphore CI 2.0

data/README.md

@@ -144,6 +144,7 @@ You can see list of questions for common problems and tips in below [Table of Co
       - [for knapack_pro regular mode](#for-knapack_pro-regular-mode-1)
       - [for knapsack_pro queue mode](#for-knapsack_pro-queue-mode-1)
     - [How can I change log level?](#how-can-i-change-log-level)
+    - [How to write knapack_pro logs to a file?](#how-to-write-knapack_pro-logs-to-a-file)
     - [How to split tests based on test level instead of test file level?](#how-to-split-tests-based-on-test-level-instead-of-test-file-level)
       - [A. Create multiple small test files](#a-create-multiple-small-test-files)
       - [B. Use tags to mark set of tests in particular test file](#b-use-tags-to-mark-set-of-tests-in-particular-test-file)
@@ -1752,6 +1753,36 @@ Recommended log levels you can use:
 * `debug` is default log level and it is recommended to log details about requests to Knapsack Pro API. Thanks to that you can debug things or ensure everything works. For instance in [user dashboard](https://knapsackpro.com/dashboard) you can find tips referring to debug logs.
 * `info` level shows message like how to retry tests in development or info why something works this way or the other (for instance why tests were not executed on the CI node). You can use `info` level when you really don't want to see all debug messages from default log level.
 
+#### How to write knapack_pro logs to a file?
+
+In your `rails_helper.rb` or `spec_helper.rb` you can set custom Knapsack Pro logger and write to custom log file.
+
+```ruby
+require 'logger'
+KnapsackPro.logger = Logger.new(Rails.root.join('log', "knapsack_pro_node_#{KnapsackPro::Config::Env.ci_node_index}.log"))
+KnapsackPro.logger.level = Logger::DEBUG
+```
+
+Note if you run knapsack_pro in Queue Mode then the very first request to Knapsack Pro API still will be shown to stdout because we need to have set of test files needed to run RSpec before we load `rails_helper.rb`/`spec_helper.rb` where the configuration of logger actually is loaded for the first time.
+
+If you would like to keep knapsack_pro logs after your CI build finished then you could use artifacts or some cache mechanize for your CI provider.
+
+For instance, for [CircleCI 2.0 artifacts](https://circleci.com/docs/2.0/artifacts/) you can specify log directory:
+
+```yaml
+- run:
+  name: RSpec via knapsack_pro Queue Mode
+  command: |
+    # export word is important here!
+    export RAILS_ENV=test
+    bundle exec rake "knapsack_pro:queue:rspec[--format documentation]"
+
+- store_artifacts:
+  path: log
+```
+
+Now you can preview logs in `Artifacts` tab in the Circle CI build view.
+
 #### How to split tests based on test level instead of test file level?
 
 If you want to split one big test file (test file with long time execution) across multiple CI nodes then you can:

data/lib/knapsack_pro/client/connection.rb

@@ -1,7 +1,10 @@
 module KnapsackPro
   module Client
     class Connection
+      class ServerError < StandardError; end
+
       TIMEOUT = 15
+      MAX_RETRY = 3
       REQUEST_RETRY_TIMEBOX = 2
 
       def initialize(action)
@@ -23,6 +26,11 @@ module KnapsackPro
         !!(response_body && (response_body['errors'] || response_body['error']))
       end
 
+      def server_error?
+        status = http_response.code.to_i
+        status >= 500 && status < 600
+      end
+
       private
 
       attr_reader :action, :http_response, :response_body
@@ -91,7 +99,7 @@ module KnapsackPro
         @http_response = http.post(uri.path, request_body, json_headers)
         @response_body = parse_response_body(http_response.body)
 
-        request_uuid = http_response.header['X-Request-Id']
+        request_uuid = http_response.header['X-Request-Id'] || 'N/A'
 
         logger.debug("API request UUID: #{request_uuid}")
         logger.debug("Test suite split seed: #{seed}") if has_seed?
@@ -102,15 +110,21 @@ module KnapsackPro
           logger.debug(response_body)
         end
 
+        if server_error?
+          raise ServerError.new(response_body)
+        end
+
         response_body
-      rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT, Errno::EPIPE, EOFError, SocketError, Net::OpenTimeout, Net::ReadTimeout => e
+      rescue ServerError, Errno::ECONNREFUSED, Errno::ETIMEDOUT, Errno::EPIPE, EOFError, SocketError, Net::OpenTimeout, Net::ReadTimeout => e
         logger.warn(e.inspect)
         retries += 1
-        if retries < 3
+        if retries < MAX_RETRY
           wait = retries * REQUEST_RETRY_TIMEBOX
           logger.warn("Wait #{wait}s and retry request to Knapsack Pro API.")
-          sleep wait
+          Kernel.sleep(wait)
           retry
+        else
+          response_body
         end
       end
     end

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '1.5.0'
+  VERSION = '1.6.0'
 end

data/spec/knapsack_pro/client/connection_spec.rb

@@ -68,27 +68,6 @@ describe KnapsackPro::Client::Connection do
         end
       end
 
-      context 'when body response is json and API response code is 500' do
-        let(:body) { '{"error": "Internal Server Error"}' }
-        let(:code) { '500' } # it must be string code
-
-        before do
-          expect(KnapsackPro).to receive(:logger).exactly(3).and_return(logger)
-          expect(logger).to receive(:debug).with('API request UUID: fake-uuid')
-          expect(logger).to receive(:debug).with('API response:')
-        end
-
-        it do
-          parsed_response = { 'error' => 'Internal Server Error' }
-
-          expect(logger).to receive(:error).with(parsed_response)
-
-          expect(subject).to eq(parsed_response)
-          expect(connection.success?).to be false
-          expect(connection.errors?).to be true
-        end
-      end
-
       context 'when body response is json with build_distribution_id' do
         let(:body) { '{"build_distribution_id": "seed-uuid"}' }
         let(:code) { '200' } # it must be string code
@@ -130,6 +109,61 @@ describe KnapsackPro::Client::Connection do
         end
       end
     end
+
+    context 'when retry request for http method POST' do
+      before do
+        http = instance_double(Net::HTTP)
+
+        expect(Net::HTTP).to receive(:new).exactly(3).with('api.knapsackpro.test', 3000).and_return(http)
+
+        expect(http).to receive(:use_ssl=).exactly(3).with(false)
+        expect(http).to receive(:open_timeout=).exactly(3).with(15)
+        expect(http).to receive(:read_timeout=).exactly(3).with(15)
+
+        header = { 'X-Request-Id' => 'fake-uuid' }
+        http_response = instance_double(Net::HTTPOK, body: body, header: header, code: code)
+        expect(http).to receive(:post).exactly(3).with(
+          endpoint_path,
+          "{\"fake\":\"hash\",\"test_suite_token\":\"3fa64859337f6e56409d49f865d13fd7\"}",
+          {
+            'Content-Type' => 'application/json',
+            'Accept' => 'application/json',
+            'KNAPSACK-PRO-CLIENT-NAME' => 'knapsack_pro-ruby',
+            'KNAPSACK-PRO-CLIENT-VERSION' => KnapsackPro::VERSION,
+          }
+        ).and_return(http_response)
+      end
+
+      context 'when body response is json and API response code is 500' do
+        let(:body) { '{"error": "Internal Server Error"}' }
+        let(:code) { '500' } # it must be string code
+
+        before do
+          expect(KnapsackPro).to receive(:logger).at_least(1).and_return(logger)
+          expect(logger).to receive(:debug).exactly(3).with('API request UUID: fake-uuid')
+          expect(logger).to receive(:debug).exactly(3).with('API response:')
+        end
+
+        it do
+          parsed_response = { 'error' => 'Internal Server Error' }
+
+          expect(logger).to receive(:error).exactly(3).with(parsed_response)
+
+          server_error = described_class::ServerError.new(parsed_response)
+          expect(logger).to receive(:warn).exactly(3).with(server_error.inspect)
+
+          expect(logger).to receive(:warn).with("Wait 2s and retry request to Knapsack Pro API.")
+          expect(logger).to receive(:warn).with("Wait 4s and retry request to Knapsack Pro API.")
+          expect(Kernel).to receive(:sleep).with(2)
+          expect(Kernel).to receive(:sleep).with(4)
+
+          expect(subject).to eq(parsed_response)
+
+          expect(connection.success?).to be false
+          expect(connection.errors?).to be true
+        end
+      end
+    end
   end
 
   describe '#success?' do
@@ -220,4 +254,37 @@ describe KnapsackPro::Client::Connection do
       end
     end
   end
+
+  describe '#server_error?' do
+    subject { connection.server_error? }
+
+    before do
+      http_response = double(code: code)
+      allow(connection).to receive(:http_response).and_return(http_response)
+    end
+
+    context 'when response code is 200' do
+      let(:code) { '200' } # it must be string code
+
+      it { should be false }
+    end
+
+    context 'when response code is 300' do
+      let(:code) { '300' } # it must be string code
+
+      it { should be false }
+    end
+
+    context 'when response code is 400' do
+      let(:code) { '400' } # it must be string code
+
+      it { should be false }
+    end
+
+    context 'when response code is 500' do
+      let(:code) { '500' } # it must be string code
+
+      it { should be true }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2019-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake