knapsack_pro 8.3.2 → 8.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 479679af72441adcef212263c4a92e92760fc3bb82779616c47504d0a137a69c
-  data.tar.gz: 6376bcc3c00f50efa3633a1d015b23bb7a6fd3d8a3188d6912327e5f79c1ae27
+  metadata.gz: 17dceae7090394f68959e5b8bdef4c0640ce4027b28efe41fb8f3d612b5f0348
+  data.tar.gz: 5828288a2160348d9acce467e17d16da00e8f794aa39e70d0d0b5fecc0b9188c
 SHA512:
-  metadata.gz: 7dc0407f4c64d578cac17f64f71d93ac123e8ee7a96eeca2637e7e131449c35318bed7b6636d9e722528f36059a4cb5a8748b18e7737aaa8e92ba8212c82f83e
-  data.tar.gz: b3c505870912614006845bbf65b488ca1fe201f0a22e0dc449d5b2f7651603eceea5693fa7db5eff68bc7cd5bc89dde673eb21097a4cb341473b5b06bbcacaf5
+  metadata.gz: abf9abe76b5e0841d95c09230cd88289e6c197a26dad27cd2a9c7f2fe97310c9d1fbe1ddb77134676c604daa7a28bd8d6c405598262f9623a9110c5b7ce15751
+  data.tar.gz: 7c9a0f978b8f01b2e5ad888535ddfbaf006b20da5a5853edc454dd82044f1608b2ce9d21acd25a00c77146bbad7e0954d76f5fc2ae541970cdfd9feaee0bc45e

data/.circleci/config.yml

@@ -65,7 +65,6 @@ jobs:
       - run: bundle update rspec
       - run: bundle exec rspec --version
       - run: bundle exec rspec spec
-      - run: bundle exec ruby spec/knapsack_pro/formatters/time_tracker_specs.rb
 
   integration-rspec:
     parallelism: 1

data/.github/pull_request_template.md

@@ -1,23 +1,11 @@
-# Story
-
-TODO: link to the internal story
-
-## Related
-
-TODO: links to related PRs or issues
-
 # Description
 
 TODO
 
-# Changes
-
-TODO: changes introduced by this PR
-
-# Checklist reminder
+# Checks
 
-- [ ] You added the changes to the `UNRELEASED` section of the `CHANGELOG.md`, including the needed bump (ie, patch, minor, major)
-- [ ] You follow the architecture outlined below for RSpec in Queue Mode, which is a work in progress (feel free to propose changes):
+- [ ] I added the changes to the `UNRELEASED` section of the `CHANGELOG.md`, including the needed bump (i.e., patch, minor, major)
+- [ ] I followed the architecture outlined below for RSpec in Queue Mode:
   - Pure: `lib/knapsack_pro/pure/queue/rspec_pure.rb` contains pure functions that are unit tested.
-  - Extension: `lib/knapsack_pro/extensions/rspec_extension.rb` encapsulates calls to RSpec internals and is integration and e2e tested.
-  - Runner: `lib/knapsack_pro/runners/queue/rspec_runner.rb` invokes the pure code and the extension to produce side effects, which are integration and e2e tested.
+  - Extension: `lib/knapsack_pro/extensions/rspec_extension.rb` encapsulates calls to RSpec internals and is integration and E2E tested.
+  - Runner: `lib/knapsack_pro/runners/queue/rspec_runner.rb` invokes the pure code and the extension to produce side effects, which are integration and E2E tested.

data/.gitignore

@@ -36,5 +36,4 @@ Gemfile.lock
 .rvmrc
 
 # dynamically generated specs
-spec/knapsack_pro/formatters/tmp_time_tracker*_spec.rb
 spec_integration/

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ### UNRELEASED (patch)
 
+### 8.4.0
+
+* Add a batch UUID to the V1 Queue API request payload to improve handling of retried requests
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/307
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v8.3.3...v8.4.0
+
+### 8.3.3
+
+* Replace `Hash#sum` with `Hash#reduce` to fix a rare bug in the RSpec time tracker for a specific project
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/305
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v8.3.2...v8.3.3
+
 ### 8.3.2
 
 * Fix infinite recursion when the logger enters a loop. [The issue](https://github.com/KnapsackPro/knapsack_pro-ruby/issues/269) occurs when `KNAPSACK_PRO_LOG_DIR=log` is set and a conflict arises between the values of environment variables from the CI provider and those configured by the user (e.g., `KNAPSACK_PRO_CI_NODE_INDEX`, `KNAPSACK_PRO_CI_NODE_TOTAL`).

data/README.md

@@ -67,7 +67,7 @@ bundle update knapsack_pro
 RSpec:
 
 ```bash
-bin/test
+bundle exec rspec
 ```
 
 Scripted tests can be found in the [Rails App With Knapsack Pro repository](https://github.com/KnapsackPro/rails-app-with-knapsack_pro/blob/master/bin/knapsack_pro_all.rb).

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

@@ -19,6 +19,7 @@ module KnapsackPro
                 :node_index => args.fetch(:node_index),
                 :node_build_id => KnapsackPro::Config::Env.ci_node_build_id,
                 :user_seat => KnapsackPro::Config::Env.masked_user_seat,
+                batch_uuid: args.fetch(:batch_uuid)
               }
 
               if request_hash[:can_initialize_queue] && !request_hash[:attempt_connect_to_queue]

data/lib/knapsack_pro/formatters/time_tracker.rb

@@ -109,12 +109,12 @@ module KnapsackPro
         group.each do |_, example|
           next if example[:time_execution] == 0.0
 
-          example[:time_execution] += time_all_by_group_id_path.sum do |group_id_path, time|
+          example[:time_execution] += time_all_by_group_id_path.reduce(0.0) do |sum, (group_id_path, time)|
             # :path is a file path (a_spec.rb), sum any before/after(:all) in the file
-            next time if group_id_path.start_with?(example[:path])
+            next sum + time if group_id_path.start_with?(example[:path])
             # :path is an id path (a_spec.rb[1:1]), sum any before/after(:all) above it
-            next time if example[:path].start_with?(group_id_path[0..-2])
-            0
+            next sum + time if example[:path].start_with?(group_id_path[0..-2])
+            sum
           end
         end
       end

data/lib/knapsack_pro/queue_allocator.rb

@@ -41,26 +41,26 @@ module KnapsackPro
       @fallback_mode = false
     end
 
-    def test_file_paths(can_initialize_queue, executed_test_files)
+    def test_file_paths(can_initialize_queue, executed_test_files, batch_uuid: SecureRandom.uuid)
       return [] if @fallback_mode
 
-      batch = pull_tests_from_queue(can_initialize_queue)
+      batch = pull_tests_from_queue(can_initialize_queue, batch_uuid)
 
       return switch_to_fallback_mode(executed_test_files: executed_test_files) if batch.connection_failed?
       return normalize_test_files(batch.test_files) if batch.queue_exists?
 
       test_files_result = test_suite.calculate_test_files
 
-      return try_initializing_queue(test_files_result.test_files) if test_files_result.quick?
+      return try_initializing_queue(test_files_result.test_files, batch_uuid) if test_files_result.quick?
 
       # The tests to run were found slowly. By that time, the queue could have already been initialized by another CI node.
       # Attempt to pull tests from the queue to avoid the attempt to initialize the queue unnecessarily (queue initialization is an expensive request with a big test files payload).
-      batch = pull_tests_from_queue(can_initialize_queue)
+      batch = pull_tests_from_queue(can_initialize_queue, batch_uuid)
 
       return switch_to_fallback_mode(executed_test_files: executed_test_files) if batch.connection_failed?
       return normalize_test_files(batch.test_files) if batch.queue_exists?
 
-      try_initializing_queue(test_files_result.test_files)
+      try_initializing_queue(test_files_result.test_files, batch_uuid)
     end
 
     private
@@ -80,7 +80,7 @@ module KnapsackPro
       KnapsackPro::TestFilePresenter.paths(decrypted_test_files)
     end
 
-    def build_action(can_initialize_queue:, attempt_connect_to_queue:, test_files: nil)
+    def build_action(can_initialize_queue:, attempt_connect_to_queue:, batch_uuid:, test_files: nil)
       if can_initialize_queue && !attempt_connect_to_queue
         raise 'Test files are required when initializing a new queue.' if test_files.nil?
         test_files = KnapsackPro::Crypto::Encryptor.call(test_files)
@@ -95,25 +95,26 @@ module KnapsackPro
         node_index: ci_node_index,
         node_build_id: ci_node_build_id,
         test_files: test_files,
+        batch_uuid: batch_uuid
       )
     end
 
-    def pull_tests_from_queue(can_initialize_queue)
-      action = build_action(can_initialize_queue: can_initialize_queue, attempt_connect_to_queue: can_initialize_queue)
+    def pull_tests_from_queue(can_initialize_queue, batch_uuid)
+      action = build_action(can_initialize_queue: can_initialize_queue, attempt_connect_to_queue: can_initialize_queue, batch_uuid: batch_uuid)
       connection = KnapsackPro::Client::Connection.new(action)
       response = connection.call
       Batch.new(connection, response)
     end
 
-    def initialize_queue(tests_to_run)
-      action = build_action(can_initialize_queue: true, attempt_connect_to_queue: false, test_files: tests_to_run)
+    def initialize_queue(tests_to_run, batch_uuid)
+      action = build_action(can_initialize_queue: true, attempt_connect_to_queue: false, batch_uuid: batch_uuid, test_files: tests_to_run)
       connection = KnapsackPro::Client::Connection.new(action)
       response = connection.call
       Batch.new(connection, response)
     end
 
-    def try_initializing_queue(tests)
-      result = initialize_queue(tests)
+    def try_initializing_queue(tests, batch_uuid)
+      result = initialize_queue(tests, batch_uuid)
 
       return switch_to_fallback_mode(executed_test_files: []) if result.connection_failed?
 

data/lib/knapsack_pro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KnapsackPro
-  VERSION = '8.3.2'
+  VERSION = '8.4.0'
 end

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

@@ -10,6 +10,7 @@ describe KnapsackPro::Client::API::V1::Queues do
     let(:masked_user_seat) { double }
     let(:can_initialize_queue) { [false, true].sample }
     let(:attempt_connect_to_queue) { [false, true].sample }
+    let(:batch_uuid) { SecureRandom.uuid }
 
     subject do
       described_class.queue(
@@ -19,7 +20,8 @@ describe KnapsackPro::Client::API::V1::Queues do
         branch: branch,
         node_total: node_total,
         node_index: node_index,
-        test_files: test_files
+        test_files: test_files,
+        batch_uuid: batch_uuid
       )
     end