app/models/ci/build_trace_metadata.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

# frozen_string_literal: true

module Ci
  class BuildTraceMetadata < Ci::ApplicationRecord
    MAX_ATTEMPTS = 5
    self.table_name = 'ci_build_trace_metadata'
    self.primary_key = :build_id

    belongs_to :build, class_name: 'Ci::Build'
    belongs_to :trace_artifact, class_name: 'Ci::JobArtifact'

    validates :build, presence: true
    validates :archival_attempts, presence: true

    def self.find_or_upsert_for!(build_id)
      record = find_by(build_id: build_id)
      return record if record

      upsert({ build_id: build_id }, unique_by: :build_id)
      find_by!(build_id: build_id)
    end

    # The job is retried around 5 times during the 7 days retention period for
    # trace chunks as defined in `Ci::BuildTraceChunks::RedisBase::CHUNK_REDIS_TTL`
    def can_attempt_archival_now?
      return false unless archival_attempts_available?
      return true unless last_archival_attempt_at

      last_archival_attempt_at + backoff < Time.current
    end

    def archival_attempts_available?
      archival_attempts <= MAX_ATTEMPTS
    end

    def increment_archival_attempts!
      increment!(:archival_attempts, touch: :last_archival_attempt_at)
    end

    def track_archival!(trace_artifact_id)
      update!(trace_artifact_id: trace_artifact_id, archived_at: Time.current)
    end

    def archival_attempts_message
      if archival_attempts_available?
        'The job can not be archived right now.'
      else
        'The job is out of archival attempts.'
      end
    end

    private

    def backoff
      ::Gitlab::Ci::Trace::Backoff.new(archival_attempts).value_with_jitter
    end
  end
end