knapsack_pro 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee1c87eca84a9ac30345268d7d2e9ac71d09003098e5173f73c0a3afccfea7bf
-  data.tar.gz: 52d53bd9c42699151ec2ac5ed6d340cbcdd0b632b88f2da60fcae54db3984090
+  metadata.gz: d4e0c8f7bd4c8bf4c50885cdbcbecf34222a3d1ab46d3be52d937d940a0ba5c0
+  data.tar.gz: b8a68e22c872686d20fc6fac50ec3d02bad449768da522eb36ed86db5d331dfc
 SHA512:
-  metadata.gz: 8afa9cc8410a16af780fcc854ebed0f50959eaa8c5cbdbe8fadb67e3822494ef2f18d56ee6158b1503d4db5be129a308e1e7794aab853685163b9888d70f18be
-  data.tar.gz: 4304ce7d54d20e43ed4576989f9700ef68f25a099671cb42a578f27ccb6fcc67dd1d2c7c0c546a96a0af9a570bc5b6c8c6c2d0742c6f1868f7a77557cd50d45f
+  metadata.gz: 34d669379edb42f5a3e3eaf9075320bd1e2457ec48dfae86d94e2fa21eb4562d1fcc2db66ed49749ef78a641741d934e6d978bc9cc557d5985e49eb9bbed133d
+  data.tar.gz: bde90595bb3123c0c10b53d58de5b78637a2c30679f3ab5e37283735ce3a4f6bcbc19a39be7fcf691f6878f5be0018d16e3eb0bc8adc9f2d6f23827de72f0bb2

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+### 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

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/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.0'
 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 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - ArturT
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-07 00:00:00.000000000 Z
+date: 2023-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -389,7 +389,7 @@ metadata:
   documentation_uri: https://docs.knapsackpro.com/integration/
   homepage_uri: https://knapsackpro.com
   source_code_uri: https://github.com/KnapsackPro/knapsack_pro-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -404,8 +404,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Knapsack Pro splits tests across parallel CI nodes and ensures each parallel
   job finish work at a similar time.