gitlab-foss/lib/gitlab/ci/pipeline/chain/helpers.rb

# frozen_string_literal: true

module Gitlab
  module Ci
    module Pipeline
      module Chain
        module Helpers
          def error(message, failure_reason: nil)
            sanitized_message = sanitize_message(message)
            pipeline.add_error_message(sanitized_message)

            drop_pipeline!(failure_reason)

            # TODO: consider not to rely on AR errors directly as they can be
            # polluted with other unrelated errors (e.g. state machine)
            # https://gitlab.com/gitlab-org/gitlab/-/issues/220823
            pipeline.errors.add(:base, sanitized_message)

            pipeline.errors.full_messages
          end

          def warning(message)
            pipeline.add_warning_message(sanitize_message(message))
          end

          private

          def sanitize_message(message)
            ActionController::Base.helpers.sanitize(message, tags: [])
          end

          def drop_pipeline!(failure_reason)
            if pipeline.readonly?
              # Only set the status and reason without tracking failures
              pipeline.set_failed(failure_reason)
            elsif Enums::Ci::Pipeline.persistable_failure_reason?(failure_reason) && command.save_incompleted
              # Project iid must be called outside a transaction, so we ensure it is set here
              # otherwise it may be set within the state transition transaction of the drop! call
              # which it will lock the InternalId row for the whole transaction
              pipeline.ensure_project_iid!

              pipeline.drop!(failure_reason)
            else
              command.increment_pipeline_failure_reason_counter(failure_reason)

              pipeline.set_failed(failure_reason)
            end
          end
        end
      end
    end
  end
end