gitlab-org--gitlab-foss/app/workers/email_receiver_worker.rb

124 lines
3.8 KiB
Ruby

# frozen_string_literal: true
class EmailReceiverWorker # rubocop:disable Scalability/IdempotentWorker
include ApplicationWorker
data_consistency :always
sidekiq_options retry: 3
feature_category :team_planning
urgency :high
weight 2
# https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/1263
tags :needs_own_queue
attr_accessor :raw
def perform(raw)
return unless should_perform?
@raw = raw
execute_receiver
end
def should_perform?
Gitlab::IncomingEmail.enabled?
end
private
def execute_receiver
receiver.execute
log_success
rescue StandardError => e
log_error(e)
handle_failure(e)
end
def receiver
@receiver ||= Gitlab::Email::Receiver.new(raw)
end
def logger
Sidekiq.logger
end
def log_success
logger.info(build_message('Successfully processed message', receiver.mail_metadata))
end
def log_error(error)
payload =
case error
# Unparsable e-mails don't have metadata we can use
when Gitlab::Email::EmailUnparsableError, Gitlab::Email::EmptyEmailError
{}
else
mail_metadata
end
# We don't need the backtrace and more details if the e-mail couldn't be processed
if error.is_a?(Gitlab::Email::ProcessingError)
payload['exception.class'] = error.class.name
else
Gitlab::ExceptionLogFormatter.format!(error, payload)
Gitlab::ErrorTracking.track_exception(error)
end
logger.error(build_message('Error processing message', payload))
end
def build_message(message, params = {})
{
class: self.class.name,
Labkit::Correlation::CorrelationId::LOG_KEY => Labkit::Correlation::CorrelationId.current_id,
message: message
}.merge(params)
end
def mail_metadata
receiver.mail_metadata
rescue StandardError => e
# We should never get here as long as we check EmailUnparsableError, but
# let's be defensive in case we did something wrong.
Gitlab::ErrorTracking.track_exception(e)
{}
end
def handle_failure(error)
return unless raw.present?
can_retry = false
reason =
case error
when Gitlab::Email::UnknownIncomingEmail
s_("EmailError|We couldn't figure out what the email is for. Please create your issue or comment through the web interface.")
when Gitlab::Email::SentNotificationNotFoundError
s_("EmailError|We couldn't figure out what the email is in reply to. Please create your comment through the web interface.")
when Gitlab::Email::ProjectNotFound
s_("EmailError|We couldn't find the project. Please check if there's any typo.")
when Gitlab::Email::EmptyEmailError
can_retry = true
s_("EmailError|It appears that the email is blank. Make sure your reply is at the top of the email, we can't process inline replies.")
when Gitlab::Email::UserNotFoundError
s_("EmailError|We couldn't figure out what user corresponds to the email. Please create your comment through the web interface.")
when Gitlab::Email::UserBlockedError
s_("EmailError|Your account has been blocked. If you believe this is in error, contact a staff member.")
when Gitlab::Email::UserNotAuthorizedError
s_("EmailError|You are not allowed to perform this action. If you believe this is in error, contact a staff member.")
when Gitlab::Email::NoteableNotFoundError
s_("EmailError|The thread you are replying to no longer exists, perhaps it was deleted? If you believe this is in error, contact a staff member.")
when Gitlab::Email::InvalidAttachment
error.message
when Gitlab::Email::InvalidRecordError
can_retry = true
error.message
end
if reason
EmailRejectionMailer.rejection(reason, raw, can_retry).deliver_later
end
end
end