karafka/karafka

View on GitHub
lib/karafka/active_job/consumer.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

module Karafka
  # Namespace for all the ActiveJob related things from within Karafka
  module ActiveJob
    # This is the consumer for ActiveJob that eats the messages enqueued with it one after another.
    # It marks the offset after each message, so we make sure, none of the jobs is executed twice
    class Consumer < ::Karafka::BaseConsumer
      # Executes the ActiveJob logic
      # @note ActiveJob does not support batches, so we just run one message after another
      def consume
        messages.each do |message|
          break if Karafka::App.stopping?

          consume_job(message)

          mark_as_consumed(message)
        end
      end

      private

      # Consumes a message with the job and runs needed instrumentation
      #
      # @param job_message [Karafka::Messages::Message] message with active job
      def consume_job(job_message)
        with_deserialized_job(job_message) do |job|
          tags.add(:job_class, job['job_class'])

          payload = { caller: self, job: job, message: job_message }

          # We publish both to make it consistent with `consumer.x` events
          Karafka.monitor.instrument('active_job.consume', payload)
          Karafka.monitor.instrument('active_job.consumed', payload) do
            ::ActiveJob::Base.execute(job)
          end
        end
      end

      # @param job_message [Karafka::Messages::Message] message with active job
      def with_deserialized_job(job_message)
        # We technically speaking could set this as deserializer and reference it from the
        # message instead of using the `#raw_payload`. This is not done on purpose to simplify
        # the ActiveJob setup here
        yield ::ActiveSupport::JSON.decode(job_message.raw_payload)
      end
    end
  end
end