knapsack_pro 5.0.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee1c87eca84a9ac30345268d7d2e9ac71d09003098e5173f73c0a3afccfea7bf
-  data.tar.gz: 52d53bd9c42699151ec2ac5ed6d340cbcdd0b632b88f2da60fcae54db3984090
+  metadata.gz: 58063b1846ea84151755a05ad9f4cca8297246b78ff0c47d140576cb0d32e19c
+  data.tar.gz: bf36f5e4232ae62eb835dea8f6aeb0d767f5bef88e7aabf7fea2508c8017068a
 SHA512:
-  metadata.gz: 8afa9cc8410a16af780fcc854ebed0f50959eaa8c5cbdbe8fadb67e3822494ef2f18d56ee6158b1503d4db5be129a308e1e7794aab853685163b9888d70f18be
-  data.tar.gz: 4304ce7d54d20e43ed4576989f9700ef68f25a099671cb42a578f27ccb6fcc67dd1d2c7c0c546a96a0af9a570bc5b6c8c6c2d0742c6f1868f7a77557cd50d45f
+  metadata.gz: 756a63cd54c3e35e60cd09ba057c026d5ab279dab5bdd295bccfb49c6f235f68835e956171a19d9a8c5ca21db46de204e22867c879dae331fe482ffefe906189
+  data.tar.gz: 54e7d11084f8eab1ace9e225f0a1455dd9b391f33742cafa475b2ce144024f8509d7afcb0915f663784f0ead5407b7accee33d90acb19c44a6ab845c8507e0b5

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+### 5.1.1
+
+* Use `KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true` as default value in Queue Mode for GitLab CI
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/206
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v5.1.0...v5.1.1
+
+### 5.1.0
+
+* Mask user seats data instead of hashing it
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/202
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v5.0.0...v5.1.0
+
+
 ### 5.0.0
 
 * __(breaking change)__ Use `KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true` as default value in Queue Mode and use `false` for proper CI providers
@@ -10,6 +27,10 @@
 
     https://github.com/KnapsackPro/knapsack_pro-ruby/pull/201
 
+    __(breaking change)__ for Buildkite. You need to pass the `BUILDKITE` environment variable to Docker Compose.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/issues/204
+
 * Set `RAILS_ENV=test` / `RACK_ENV=test` in Queue Mode
 
     https://github.com/KnapsackPro/knapsack_pro-ruby/pull/199

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

@@ -15,7 +15,7 @@ module KnapsackPro
                 :node_total => args.fetch(:node_total),
                 :node_index => args.fetch(:node_index),
                 :ci_build_id => KnapsackPro::Config::Env.ci_node_build_id,
-                :user_seat => KnapsackPro::Config::Env.user_seat_hash,
+                :user_seat => KnapsackPro::Config::Env.masked_user_seat,
               }
 
               unless request_hash[:cache_read_attempt]

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

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

data/lib/knapsack_pro/config/ci/gitlab_ci.rb

@@ -43,7 +43,7 @@ module KnapsackPro
         end
 
         def fixed_queue_split
-          false
+          true
         end
       end
     end

data/lib/knapsack_pro/config/env.rb

@@ -64,9 +64,10 @@ module KnapsackPro
             ci_env_for(:user_seat)
         end
 
-        def user_seat_hash
+        def masked_user_seat
           return unless user_seat
-          Digest::SHA2.hexdigest(user_seat)
+
+          user_seat.gsub(/(?<=\w{2})[a-zA-Z]/, "*")
         end
 
         def test_file_pattern

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '5.0.0'
+  VERSION = '5.1.1'
 end

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

@@ -6,7 +6,7 @@ describe KnapsackPro::Client::API::V1::BuildDistributions do
     let(:node_total) { double }
     let(:node_index) { double }
     let(:ci_build_id) { double }
-    let(:user_seat_hash) { double }
+    let(:masked_user_seat) { double }
     let(:test_files) { double }
 
     subject do
@@ -23,7 +23,7 @@ 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)
-      expect(KnapsackPro::Config::Env).to receive(:user_seat_hash).and_return(user_seat_hash)
+      expect(KnapsackPro::Config::Env).to receive(:masked_user_seat).and_return(masked_user_seat)
     end
 
     context 'when cache_read_attempt=true' do
@@ -42,7 +42,7 @@ describe KnapsackPro::Client::API::V1::BuildDistributions do
             node_total: node_total,
             node_index: node_index,
             ci_build_id: ci_build_id,
-            user_seat: user_seat_hash,
+            user_seat: masked_user_seat,
           }
         }).and_return(action)
         expect(subject).to eq action
@@ -65,7 +65,7 @@ describe KnapsackPro::Client::API::V1::BuildDistributions do
             node_total: node_total,
             node_index: node_index,
             ci_build_id: ci_build_id,
-            user_seat: user_seat_hash,
+            user_seat: masked_user_seat,
             test_files: test_files
           }
         }).and_return(action)

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

@@ -7,7 +7,7 @@ describe KnapsackPro::Client::API::V1::Queues do
     let(:node_index) { double }
     let(:test_files) { double }
     let(:node_build_id) { double }
-    let(:user_seat_hash) { double }
+    let(:masked_user_seat) { double }
 
     subject do
       described_class.queue(
@@ -24,7 +24,7 @@ describe KnapsackPro::Client::API::V1::Queues do
     before do
       expect(KnapsackPro::Config::Env).to receive(:fixed_queue_split).and_return(fixed_queue_split)
       expect(KnapsackPro::Config::Env).to receive(:ci_node_build_id).and_return(node_build_id)
-      expect(KnapsackPro::Config::Env).to receive(:user_seat_hash).and_return(user_seat_hash)
+      expect(KnapsackPro::Config::Env).to receive(:masked_user_seat).and_return(masked_user_seat)
     end
 
     context 'when can_initialize_queue=true and attempt_connect_to_queue=true' do
@@ -45,7 +45,7 @@ describe KnapsackPro::Client::API::V1::Queues do
             node_total: node_total,
             node_index: node_index,
             node_build_id: node_build_id,
-            user_seat: user_seat_hash,
+            user_seat: masked_user_seat,
           }
         }).and_return(action)
         expect(subject).to eq action
@@ -70,7 +70,7 @@ describe KnapsackPro::Client::API::V1::Queues do
             node_total: node_total,
             node_index: node_index,
             node_build_id: node_build_id,
-            user_seat: user_seat_hash,
+            user_seat: masked_user_seat,
             test_files: test_files
           }
         }).and_return(action)
@@ -96,7 +96,7 @@ describe KnapsackPro::Client::API::V1::Queues do
             node_total: node_total,
             node_index: node_index,
             node_build_id: node_build_id,
-            user_seat: user_seat_hash,
+            user_seat: masked_user_seat,
           }
         }).and_return(action)
         expect(subject).to eq action

data/spec/knapsack_pro/config/env_spec.rb

@@ -207,22 +207,26 @@ describe KnapsackPro::Config::Env do
     end
   end
 
-  describe '.user_seat_hash' do
-    subject { described_class.user_seat_hash }
+  describe '.masked_seat_hash' do
+    subject { described_class.masked_user_seat }
 
     before do
       expect(described_class).to receive(:user_seat).at_least(1).and_return(user_seat)
     end
 
-    context 'when the user seat has a value' do
+    context 'when the user seat is a name' do
       let(:user_seat) { 'John Doe' }
 
-      it 'returns a SHA256 hash for the user seat' do
-        expect(subject).to eq '6cea57c2fb6cbc2a40411135005760f241fffc3e5e67ab99882726431037f908'
-      end
+      it { expect(subject).to eq 'Jo** Do*' }
+    end
+
+    context 'when the user seat is an e-mail' do
+      let(:user_seat) { 'john.doe@example.com' }
+
+      it { expect(subject).to eq 'jo**.do*@ex*****.co*' }
     end
 
-    context 'when the user seat has no value' do
+    context 'when the user seat is nil' do
       let(:user_seat) { nil }
 
       it { expect(subject).to be_nil }
@@ -724,7 +728,7 @@ describe KnapsackPro::Config::Env do
         ['Codefresh', { 'CF_BUILD_ID' => '123' }, false],
         ['Codeship', { 'CI_NAME' => 'codeship' }, true],
         ['GitHub Actions', { 'GITHUB_ACTIONS' => 'true' }, true],
-        ['GitLab CI', { 'GITLAB_CI' => 'true' }, false],
+        ['GitLab CI', { 'GITLAB_CI' => 'true' }, true],
         ['Heroku CI', { 'HEROKU_TEST_RUN_ID' => '123' }, false],
         ['Semaphore CI 1.0', { 'SEMAPHORE_BUILD_NUMBER' => '123' }, false],
         ['Semaphore CI 2.0', { 'SEMAPHORE' => 'true', 'SEMAPHORE_WORKFLOW_ID' => '123' }, false],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.1
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-07 00:00:00.000000000 Z
+date: 2023-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake