knapsack_pro 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 171049202c4a6b8c4fb1a3d637dcb8d3aac83d8d6d2505c01535116df8437622
-  data.tar.gz: ecf5ed5065c0c73d7bfc4ad2b9cc6f77148fed7f62c60fcac4bb946d5cc93e8b
+  metadata.gz: ba65a6353675fce4c06920c5dca6b7dcc90aee4a978db714f28bf9305f5208e3
+  data.tar.gz: 345aa8cf66464faeeb05cc3adcd2fcf904862aa02ea3f6a0109ca83f37c7c332
 SHA512:
-  metadata.gz: f930e4ea77b06784219c1e6013ce10429637dbcd566c1f05378aa57a698d815240f75c0779340804e240c3647a4c3a05a9815a67431771ff1b776e25a9bfeb2b
-  data.tar.gz: 73fc1741cf0b880a169dc2f36755b5d01914ad9238b60f873e85324778bb1520af1e34007c7b0d73e4c841440be8bdd8544f5ee97a0cd3340dc6b86171fe4303
+  metadata.gz: c12d293d3ac2ca00f33e5802f4c6cf0c8f9ef08dd76d5217892efcb14a8bc090b6f5a118514c79a7066baf8449c3b2406e7b6d4a867b4b479a9bda841d057dbf
+  data.tar.gz: 757a63fd917a7fc685659fe6d64d01b19800fa3cc81b4f66d7e9fd08ed9631b28c727544577bae13faae3e54c3b1b3fb3624b2d69e6b74287887c3cb1fb95c44

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 3.6.0
+
+* Add an attempt to read from the cache for Regular Mode API
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/182
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v3.5.0...v3.6.0
+
 ### 3.5.0
 
 * Add the `KnapsackPro::Hooks::Queue.before_subset_queue` hook in Queue Mode

data/lib/knapsack_pro/allocator.rb

@@ -9,8 +9,18 @@ module KnapsackPro
     end
 
     def test_file_paths
-      connection = KnapsackPro::Client::Connection.new(build_action)
+      action = build_action(cache_read_attempt: true)
+      connection = KnapsackPro::Client::Connection.new(action)
       response = connection.call
+
+      # when a cache miss because the test suite split was not cached yet
+      if connection.success? && connection.api_code == KnapsackPro::Client::API::V1::BuildDistributions::TEST_SUITE_SPLIT_CACHE_MISS_CODE
+        # make an attempt to initalize a new test suite split on the API side
+        action = build_action(cache_read_attempt: false)
+        connection = KnapsackPro::Client::Connection.new(action)
+        response = connection.call
+      end
+
       if connection.success?
         raise ArgumentError.new(response) if connection.errors?
         prepare_test_files(response)
@@ -47,13 +57,19 @@ module KnapsackPro
       KnapsackPro::Crypto::BranchEncryptor.call(repository_adapter.branch)
     end
 
-    def build_action
+    def build_action(cache_read_attempt:)
+      test_files =
+        unless cache_read_attempt
+          encrypted_test_files
+        end
+
       KnapsackPro::Client::API::V1::BuildDistributions.subset(
+        cache_read_attempt: cache_read_attempt,
         commit_hash: repository_adapter.commit_hash,
         branch: encrypted_branch,
         node_total: ci_node_total,
         node_index: ci_node_index,
-        test_files: encrypted_test_files,
+        test_files: test_files,
       )
     end
 

data/lib/knapsack_pro/client/api/v1/build_distributions.rb

@@ -3,19 +3,30 @@ module KnapsackPro
     module API
       module V1
         class BuildDistributions < Base
+          TEST_SUITE_SPLIT_CACHE_MISS_CODE = 'TEST_SUITE_SPLIT_CACHE_MISS'
+
           class << self
             def subset(args)
+              request_hash = {
+                :fixed_test_suite_split => KnapsackPro::Config::Env.fixed_test_suite_split,
+                :cache_read_attempt => args.fetch(:cache_read_attempt),
+                :commit_hash => args.fetch(:commit_hash),
+                :branch => args.fetch(:branch),
+                :node_total => args.fetch(:node_total),
+                :node_index => args.fetch(:node_index),
+                :ci_build_id => KnapsackPro::Config::Env.ci_node_build_id,
+              }
+
+              unless request_hash[:cache_read_attempt]
+                request_hash.merge!({
+                  :test_files => args.fetch(:test_files)
+                })
+              end
+
               action_class.new(
                 endpoint_path: '/v1/build_distributions/subset',
                 http_method: :post,
-                request_hash: {
-                  :fixed_test_suite_split => KnapsackPro::Config::Env.fixed_test_suite_split,
-                  :commit_hash => args.fetch(:commit_hash),
-                  :branch => args.fetch(:branch),
-                  :node_total => args.fetch(:node_total),
-                  :node_index => args.fetch(:node_index),
-                  :test_files => args.fetch(:test_files)
-                }
+                request_hash: request_hash
               )
             end
 

data/lib/knapsack_pro/queue_allocator.rb

@@ -62,7 +62,6 @@ module KnapsackPro
     end
 
     def build_action(can_initialize_queue, attempt_connect_to_queue:)
-      # read test files from disk only when needed because it can be slow operation
       test_files =
         if can_initialize_queue && !attempt_connect_to_queue
           encrypted_test_files

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '3.5.0'
+  VERSION = '3.6.0'
 end

data/spec/fixtures/vcr_cassettes/api/v1/build_distributions/subset/invalid_test_suite_token.yml

@@ -5,12 +5,18 @@ http_interactions:
     uri: http://api.knapsackpro.test:3000/v1/build_distributions/subset
     body:
       encoding: UTF-8
-      string: '{"commit_hash":"abcdefg","branch":"master","node_total":"2","node_index":"1","test_files":[{"path":"a_spec.rb"},{"path":"b_spec.rb"}],"test_suite_token":"fake"}'
+      string: '{"fixed_test_suite_split":true,"cache_read_attempt":true,"commit_hash":"abcdefg","branch":"master","node_total":"2","node_index":"1","ci_build_id":"missing-build-id"}'
     headers:
       Content-Type:
       - application/json
       Accept:
       - application/json
+      Knapsack-Pro-Client-Name:
+      - knapsack_pro-ruby
+      Knapsack-Pro-Client-Version:
+      - 3.5.0
+      Knapsack-Pro-Test-Suite-Token:
+      - fake
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       User-Agent:
@@ -18,33 +24,36 @@ http_interactions:
   response:
     status:
       code: 403
-      message: 'Forbidden '
+      message: Forbidden
     headers:
       X-Frame-Options:
       - SAMEORIGIN
       X-Xss-Protection:
-      - 1; mode=block
+      - '0'
       X-Content-Type-Options:
       - nosniff
+      X-Download-Options:
+      - noopen
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
       Content-Type:
       - application/json; charset=utf-8
       Cache-Control:
       - no-cache
       X-Request-Id:
-      - 6d40fe71-7fad-449a-812f-9773429777ce
+      - a5ffe97f-4558-426b-9475-166eb89ab7cb
       X-Runtime:
-      - '0.054890'
-      Server:
-      - WEBrick/1.3.1 (Ruby/2.2.2/2015-04-13)
-      Date:
-      - Fri, 31 Jul 2015 16:09:00 GMT
-      Content-Length:
-      - '39'
-      Connection:
-      - Keep-Alive
+      - '0.231483'
+      Server-Timing:
+      - sql.active_record;dur=24.31, start_processing.action_controller;dur=0.00,
+        instantiation.active_record;dur=0.02, halted_callback.action_controller;dur=0.00,
+        process_action.action_controller;dur=15.10
+      Transfer-Encoding:
+      - chunked
     body:
       encoding: UTF-8
       string: '{"errors":["invalid test suite token"]}'
-    http_version: 
-  recorded_at: Fri, 31 Jul 2015 16:09:00 GMT
-recorded_with: VCR 2.9.3
+  recorded_at: Thu, 08 Dec 2022 23:27:10 GMT
+recorded_with: VCR 6.1.0

data/spec/fixtures/vcr_cassettes/api/v1/build_distributions/subset/success.yml

@@ -5,12 +5,18 @@ http_interactions:
     uri: http://api.knapsackpro.test:3000/v1/build_distributions/subset
     body:
       encoding: UTF-8
-      string: '{"commit_hash":"abcdefg","branch":"master","node_total":"2","node_index":"1","test_files":[{"path":"a_spec.rb"},{"path":"b_spec.rb"}],"test_suite_token":"3fa64859337f6e56409d49f865d13fd7"}'
+      string: '{"fixed_test_suite_split":true,"cache_read_attempt":true,"commit_hash":"abcdefg","branch":"master","node_total":"2","node_index":"1","ci_build_id":"missing-build-id"}'
     headers:
       Content-Type:
       - application/json
       Accept:
       - application/json
+      Knapsack-Pro-Client-Name:
+      - knapsack_pro-ruby
+      Knapsack-Pro-Client-Version:
+      - 3.5.0
+      Knapsack-Pro-Test-Suite-Token:
+      - 3fa64859337f6e56409d49f865d13fd7
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       User-Agent:
@@ -18,35 +24,38 @@ http_interactions:
   response:
     status:
       code: 200
-      message: 'OK '
+      message: OK
     headers:
       X-Frame-Options:
       - SAMEORIGIN
       X-Xss-Protection:
-      - 1; mode=block
+      - '0'
       X-Content-Type-Options:
       - nosniff
+      X-Download-Options:
+      - noopen
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
       Content-Type:
       - application/json; charset=utf-8
       Etag:
-      - W/"bba747f5e635a765e120718b7876d174"
+      - W/"1f643e3528e8ff45d9d2d67ab7e32be1"
       Cache-Control:
       - max-age=0, private, must-revalidate
       X-Request-Id:
-      - 190e26fb-676b-4b85-9737-8a90d0cce310
+      - 9b378323-c960-4868-894e-5ae0cdab8840
       X-Runtime:
-      - '0.639590'
-      Server:
-      - WEBrick/1.3.1 (Ruby/2.2.3/2015-08-18)
-      Date:
-      - Tue, 28 Jun 2016 20:40:35 GMT
-      Content-Length:
-      - '137'
-      Connection:
-      - Keep-Alive
+      - '0.273775'
+      Server-Timing:
+      - sql.active_record;dur=55.90, start_processing.action_controller;dur=0.00,
+        unpermitted_parameters.action_controller;dur=0.01, instantiation.active_record;dur=10.69,
+        process_action.action_controller;dur=92.24
+      Transfer-Encoding:
+      - chunked
     body:
       encoding: UTF-8
-      string: '{"build_distribution_id":"1f905f45-c203-40f1-9891-d9a91dd11245","node_index":1,"test_files":[{"path":"b_spec.rb","time_execution":null}]}'
-    http_version: 
-  recorded_at: Tue, 28 Jun 2016 20:40:35 GMT
-recorded_with: VCR 2.9.3
+      string: '{"code":"TEST_SUITE_SPLIT_CACHE_MISS"}'
+  recorded_at: Thu, 08 Dec 2022 23:27:07 GMT
+recorded_with: VCR 6.1.0

data/spec/integration/api/build_distributions_subset_spec.rb

@@ -6,6 +6,7 @@ describe 'Request API /v1/build_distributions/subset' do
 
   let(:action) do
     KnapsackPro::Client::API::V1::BuildDistributions.subset(
+      cache_read_attempt: true,
       commit_hash: 'abcdefg',
       branch: 'master',
       node_total: '2',

data/spec/knapsack_pro/allocator_spec.rb

@@ -17,66 +17,11 @@ describe KnapsackPro::Allocator do
 
   describe '#test_file_paths' do
     let(:response) { double }
+    let(:api_code) { nil }
 
     subject { allocator.test_file_paths }
 
-    before do
-      encrypted_test_files = double
-      expect(KnapsackPro::Crypto::Encryptor).to receive(:call).with(fast_and_slow_test_files_to_run).and_return(encrypted_test_files)
-
-      encrypted_branch = double
-      expect(KnapsackPro::Crypto::BranchEncryptor).to receive(:call).with(repository_adapter.branch).and_return(encrypted_branch)
-
-      action = double
-      expect(KnapsackPro::Client::API::V1::BuildDistributions).to receive(:subset).with({
-        commit_hash: repository_adapter.commit_hash,
-        branch: encrypted_branch,
-        node_total: ci_node_total,
-        node_index: ci_node_index,
-        test_files: encrypted_test_files,
-      }).and_return(action)
-
-      connection = instance_double(KnapsackPro::Client::Connection,
-                                   call: response,
-                                   success?: success?,
-                                   errors?: errors?)
-      expect(KnapsackPro::Client::Connection).to receive(:new).with(action).and_return(connection)
-    end
-
-    context 'when successful request to API' do
-      let(:success?) { true }
-
-      context 'when response has errors' do
-        let(:errors?) { true }
-
-        it do
-          expect { subject }.to raise_error(ArgumentError)
-        end
-      end
-
-      context 'when response has no errors' do
-        let(:errors?) { false }
-        let(:response) do
-          {
-            'test_files' => [
-              { 'path' => 'a_spec.rb' },
-              { 'path' => 'b_spec.rb' },
-            ]
-          }
-        end
-
-        before do
-          expect(KnapsackPro::Crypto::Decryptor).to receive(:call).with(fast_and_slow_test_files_to_run, response['test_files']).and_call_original
-        end
-
-        it { should eq ['a_spec.rb', 'b_spec.rb'] }
-      end
-    end
-
-    context 'when not successful request to API' do
-      let(:success?) { false }
-      let(:errors?) { false }
-
+    shared_examples_for 'when connection to API failed (fallback mode)' do
       context 'when fallback mode is disabled' do
         before do
           expect(KnapsackPro::Config::Env).to receive(:fallback_mode_enabled?).and_return(false)
@@ -126,5 +71,143 @@ describe KnapsackPro::Allocator do
         it { should eq ['c_spec.rb', 'd_spec.rb'] }
       end
     end
+
+    before do
+      encrypted_branch = double
+      expect(KnapsackPro::Crypto::BranchEncryptor).to receive(:call).with(repository_adapter.branch).and_return(encrypted_branch)
+
+      action = double
+      expect(KnapsackPro::Client::API::V1::BuildDistributions).to receive(:subset).with({
+        cache_read_attempt: true,
+        commit_hash: repository_adapter.commit_hash,
+        branch: encrypted_branch,
+        node_total: ci_node_total,
+        node_index: ci_node_index,
+        test_files: nil, # when `cache_read_attempt=true`, then expect `test_files` is `nil` to make the request fast due to a small payload
+      }).and_return(action)
+
+      connection = instance_double(KnapsackPro::Client::Connection,
+                                   call: response,
+                                   success?: success?,
+                                   errors?: errors?,
+                                   api_code: api_code)
+      expect(KnapsackPro::Client::Connection).to receive(:new).with(action).and_return(connection)
+    end
+
+    context 'when successful request to API' do
+      let(:success?) { true }
+
+      context 'when response has errors' do
+        let(:errors?) { true }
+
+        it do
+          expect { subject }.to raise_error(ArgumentError)
+        end
+      end
+
+      context 'when response has no errors' do
+        let(:errors?) { false }
+
+        context 'when the response returns test files (successful attempt to read from the cache - the cached test suite split exists on the API side)' do
+          let(:response) do
+            {
+              'test_files' => [
+                { 'path' => 'a_spec.rb' },
+                { 'path' => 'b_spec.rb' },
+              ]
+            }
+          end
+
+          before do
+            expect(KnapsackPro::Crypto::Decryptor).to receive(:call).with(fast_and_slow_test_files_to_run, response['test_files']).and_call_original
+          end
+
+          it { should eq ['a_spec.rb', 'b_spec.rb'] }
+        end
+
+        context 'when the response has the API code=TEST_SUITE_SPLIT_CACHE_MISS' do
+          let(:response) do
+            { 'code' => 'TEST_SUITE_SPLIT_CACHE_MISS' }
+          end
+          let(:api_code) { 'TEST_SUITE_SPLIT_CACHE_MISS' }
+
+          before do
+            encrypted_branch = double
+            expect(KnapsackPro::Crypto::BranchEncryptor).to receive(:call).with(repository_adapter.branch).and_return(encrypted_branch)
+
+            encrypted_test_files = double
+            expect(KnapsackPro::Crypto::Encryptor).to receive(:call).with(fast_and_slow_test_files_to_run).and_return(encrypted_test_files)
+
+            # 2nd request is not an attempt to read from the cache.
+            # Try to initalize a new test suite split by sending a list of test files from the disk.
+            action = double
+            expect(KnapsackPro::Client::API::V1::BuildDistributions).to receive(:subset).with({
+              cache_read_attempt: false,
+              commit_hash: repository_adapter.commit_hash,
+              branch: encrypted_branch,
+              node_total: ci_node_total,
+              node_index: ci_node_index,
+              test_files: encrypted_test_files,
+            }).and_return(action)
+
+            connection = instance_double(KnapsackPro::Client::Connection,
+                                         call: response2,
+                                         success?: response2_success?,
+                                         errors?: response2_errors?,
+                                         api_code: nil)
+            expect(KnapsackPro::Client::Connection).to receive(:new).with(action).and_return(connection)
+          end
+
+          context 'when successful 2nd request to API' do
+            let(:response2_success?) { true }
+
+            context 'when 2nd response has errors' do
+              let(:response2_errors?) { true }
+              let(:response2) { nil }
+
+              it do
+                expect { subject }.to raise_error(ArgumentError)
+              end
+            end
+
+            context 'when 2nd response has no errors' do
+              let(:response2_errors?) { false }
+
+              context 'when 2nd response returns test files' do
+                let(:response2) do
+                  {
+                    'test_files' => [
+                      { 'path' => 'a_spec.rb' },
+                      { 'path' => 'b_spec.rb' },
+                    ]
+                  }
+                end
+
+                before do
+                  expect(KnapsackPro::Crypto::Decryptor).to receive(:call).with(fast_and_slow_test_files_to_run, response2['test_files']).and_call_original
+                end
+
+                it { should eq ['a_spec.rb', 'b_spec.rb'] }
+              end
+            end
+          end
+
+          context 'when not successful 2nd request to API' do
+            let(:response2_success?) { false }
+            let(:response2_errors?) { false }
+            let(:response2) { nil }
+
+            it_behaves_like 'when connection to API failed (fallback mode)'
+          end
+        end
+      end
+    end
+
+    context 'when not successful request to API' do
+      let(:success?) { false }
+      let(:errors?) { false }
+
+      it_behaves_like 'when connection to API failed (fallback mode)'
+    end
   end
 end

data/spec/knapsack_pro/client/api/v1/build_distributions_spec.rb

@@ -5,10 +5,12 @@ describe KnapsackPro::Client::API::V1::BuildDistributions do
     let(:branch) { double }
     let(:node_total) { double }
     let(:node_index) { double }
+    let(:ci_build_id) { double }
     let(:test_files) { double }
 
     subject do
       described_class.subset(
+        cache_read_attempt: cache_read_attempt,
         commit_hash: commit_hash,
         branch: branch,
         node_total: node_total,
@@ -19,23 +21,52 @@ describe KnapsackPro::Client::API::V1::BuildDistributions do
 
     before do
       expect(KnapsackPro::Config::Env).to receive(:fixed_test_suite_split).and_return(fixed_test_suite_split)
+      expect(KnapsackPro::Config::Env).to receive(:ci_node_build_id).and_return(ci_build_id)
     end
 
-    it do
-      action = double
-      expect(KnapsackPro::Client::API::Action).to receive(:new).with({
-        endpoint_path: '/v1/build_distributions/subset',
-        http_method: :post,
-        request_hash: {
-          fixed_test_suite_split: fixed_test_suite_split,
-          commit_hash: commit_hash,
-          branch: branch,
-          node_total: node_total,
-          node_index: node_index,
-          test_files: test_files
-        }
-      }).and_return(action)
-      expect(subject).to eq action
+    context 'when cache_read_attempt=true' do
+      let(:cache_read_attempt) { true }
+
+      it 'does not send test_files among other params' do
+        action = double
+        expect(KnapsackPro::Client::API::Action).to receive(:new).with({
+          endpoint_path: '/v1/build_distributions/subset',
+          http_method: :post,
+          request_hash: {
+            fixed_test_suite_split: fixed_test_suite_split,
+            cache_read_attempt: cache_read_attempt,
+            commit_hash: commit_hash,
+            branch: branch,
+            node_total: node_total,
+            node_index: node_index,
+            ci_build_id: ci_build_id,
+          }
+        }).and_return(action)
+        expect(subject).to eq action
+      end
+    end
+
+    context 'when cache_read_attempt=false' do
+      let(:cache_read_attempt) { false }
+
+      it 'sends test_files among other params' do
+        action = double
+        expect(KnapsackPro::Client::API::Action).to receive(:new).with({
+          endpoint_path: '/v1/build_distributions/subset',
+          http_method: :post,
+          request_hash: {
+            fixed_test_suite_split: fixed_test_suite_split,
+            cache_read_attempt: cache_read_attempt,
+            commit_hash: commit_hash,
+            branch: branch,
+            node_total: node_total,
+            node_index: node_index,
+            ci_build_id: ci_build_id,
+            test_files: test_files
+          }
+        }).and_return(action)
+        expect(subject).to eq action
+      end
     end
   end
 

data/spec/knapsack_pro/queue_allocator_spec.rb

@@ -147,10 +147,7 @@ describe KnapsackPro::QueueAllocator do
             it { should eq ['a_spec.rb', 'b_spec.rb'] }
           end
 
-          context 'when response has code=ATTEMPT_CONNECT_TO_QUEUE_FAILED' do
-            let(:response) do
-              { 'code' => 'ATTEMPT_CONNECT_TO_QUEUE_FAILED' }
-            end
+          context 'when the response has the API code=ATTEMPT_CONNECT_TO_QUEUE_FAILED' do
             let(:api_code) { 'ATTEMPT_CONNECT_TO_QUEUE_FAILED' }
 
             before do
@@ -197,7 +194,7 @@ describe KnapsackPro::QueueAllocator do
               context 'when 2nd response has no errors' do
                 let(:response2_errors?) { false }
 
-                context 'when 2nd response returns test files (successful attempt to connect to queue already existing on the API side)' do
+                context 'when 2nd response returns test files (successfully initialized a new queue or connected to an existing queue on the API side)' do
                   let(:response2) do
                     {
                       'test_files' => [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2022-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake