Merge branch 'sh-always-retry-read-build-logs' into 'master'

Always attempt retry of job trace read when file is missing

See merge request gitlab-org/gitlab!40516

changelogs/unreleased/sh-always-retry-read-build-logs.yml

+---
+title: Always attempt retry of job trace read when file is missing
+merge_request: 40516
+author:
+type: fixed

lib/gitlab/ci/trace.rb

@@ -79,9 +79,7 @@ module Gitlab
         job.trace_chunks.any? || current_path.present? || old_trace.present?
       end
 
-      def read(&block)
-        should_retry = true if lock_taken?(lock_key)
-
+      def read(should_retry: true, &block)
         read_stream(&block)
       rescue Errno::ENOENT
         raise unless should_retry
@@ -195,13 +193,10 @@ module Gitlab
       end
 
       def in_write_lock(&blk)
+        lock_key = "trace:write:lock:#{job.id}"
         in_lock(lock_key, ttl: LOCK_TTL, retries: LOCK_RETRIES, sleep_sec: LOCK_SLEEP, &blk)
       end
 
-      def lock_key
-        "trace:write:lock:#{job.id}"
-      end
-
       def archive_stream!(stream)
         clone_file!(stream, JobArtifactUploader.workhorse_upload_path) do |clone_path|
           create_build_trace!(job, clone_path)

lib/gitlab/exclusive_lease_helpers.rb

@@ -39,10 +39,5 @@ module Gitlab
     ensure
       lease&.cancel
     end
-
-    def lock_taken?(key)
-      lease = Gitlab::ExclusiveLease.new(key, timeout: 0)
-      lease.exists?
-    end
   end
 end

spec/lib/gitlab/ci/trace_spec.rb

@@ -23,26 +23,14 @@ RSpec.describe Gitlab::Ci::Trace, :clean_gitlab_redis_shared_state do
       artifact1.file.migrate!(ObjectStorage::Store::REMOTE)
     end
 
-    context 'when write lock is not present' do
-      it 'raises an exception' do
-        expect { artifact2.job.trace.raw }.to raise_error(Errno::ENOENT)
-      end
-    end
+    it 'reloads the trace after is it migrated' do
+      stub_const('Gitlab::HttpIO::BUFFER_SIZE', test_data.length)
 
-    context 'when write lock is present', :clean_gitlab_redis_shared_state do
-      before do
-        Gitlab::ExclusiveLease.new("trace:write:lock:#{job.id}", timeout: 10.seconds).try_obtain
+      expect_next_instance_of(Gitlab::HttpIO) do |http_io|
+        expect(http_io).to receive(:get_chunk).and_return(test_data, "")
       end
 
-      it 'reloads the trace after is it migrated' do
-        stub_const('Gitlab::HttpIO::BUFFER_SIZE', test_data.length)
-
-        expect_next_instance_of(Gitlab::HttpIO) do |http_io|
-          expect(http_io).to receive(:get_chunk).and_return(test_data, "")
-        end
-
-        expect(artifact2.job.trace.raw).to eq(test_data)
-      end
+      expect(artifact2.job.trace.raw).to eq(test_data)
     end
   end
 

spec/lib/gitlab/exclusive_lease_helpers_spec.rb

@@ -111,14 +111,4 @@ RSpec.describe Gitlab::ExclusiveLeaseHelpers, :clean_gitlab_redis_shared_state d
       end
     end
   end
-
-  describe '#lock_taken?' do
-    it 'returns true when lock has been taken' do
-      expect(class_instance.lock_taken?(unique_key)).to be false
-
-      class_instance.in_lock(unique_key) do
-        expect(class_instance.lock_taken?(unique_key)).to be true
-      end
-    end
-  end
 end