Active Job 기초

$ bin/rails generate job guests_cleanup
invoke  test_unit
create    test/jobs/guests_cleanup_job_test.rb
create  app/jobs/guests_cleanup_job.rb

$ bin/rails generate job guests_cleanup --queue urgent

class GuestsCleanupJob < ApplicationJob
  queue_as :default

  def perform(*guests)
    # 나중에 실행할 작업
  end
end

$ bin/rails generate job process_payment --parent=payment_job

class ProcessPaymentJob < PaymentJob
  queue_as :default

  def perform(*args)
    # 나중에 수행할 작업
  end
end

# 큐잉 시스템이 사용 가능해지는 즉시 실행될 job을
# 큐에 추가합니다.
GuestsCleanupJob.perform_later guest

# 내일 정오에 실행될 job을 enqueue 합니다.
GuestsCleanupJob.set(wait_until: Date.tomorrow.noon).perform_later(guest)

# 1주일 후에 수행될 Job을 enqueue 합니다.
GuestsCleanupJob.set(wait: 1.week).perform_later(guest)

# `perform_now`와 `perform_later`는 내부적으로 `perform`을 호출하므로 
# 정의된 만큼의 인수를 전달할 수 있습니다.  
GuestsCleanupJob.perform_later(guest1, guest2, filter: "some_filter")

# config/application.rb
module YourApp
  class Application < Rails::Application
    # adapter의 gem이 Gemfile에 있는지 확인하고 
    # adapter의 특정 설치 및 배포 지침을 
    # 따르도록 하세요.
    config.active_job.queue_adapter = :sidekiq
  end
end

class GuestsCleanupJob < ApplicationJob
  self.queue_adapter = :resque
  # ...
end

# 이제 `config.active_job.queue_adapter`에 설정된 내용을 재정의하여
# `resque`를 backend queue adapter로 사용하게 됩니다.

class GuestsCleanupJob < ApplicationJob
  queue_as :low_priority
  # ...
end

# config/application.rb
module YourApp
  class Application < Rails::Application
    # 큐 이름 앞에 Rails 환경을 접두사로 추가합니다
    config.active_job.queue_name_prefix = Rails.env
  end
end

# app/jobs/guests_cleanup_job.rb  
class GuestsCleanupJob < ApplicationJob
  queue_as :low_priority
  # ...
end

# 이제 job은 production 환경에서는 production_low_priority queue에서,
# staging 환경에서는 staging_low_priority queue에서 실행됩니다

class GuestsCleanupJob < ApplicationJob
  queue_as :low_priority
  self.queue_name_prefix = nil
  # ...
end

# 이제 job의 queue 이름에 prefix가 붙지 않습니다. 
# `config.active_job.queue_name_prefix`에 설정된 값을 override합니다.

# config/application.rb
module YourApp
  class Application < Rails::Application
    # Queue 이름 앞에 Rails environment를 붙입니다
    config.active_job.queue_name_prefix = Rails.env
    # Queue 이름과 delimiter 사이에 "." 구분자를 설정합니다 
    config.active_job.queue_name_delimiter = "."
  end
end

# app/jobs/guests_cleanup_job.rb
class GuestsCleanupJob < ApplicationJob
  queue_as :low_priority
  # ...
end

# 이제 당신의 job은 production 환경에서는 production.low_priority queue에서,
# staging 환경에서는 staging.low_priority queue에서 실행될 것입니다

class ProcessVideoJob < ApplicationJob
  queue_as do 
    video = self.arguments.first
    if video.owner.premium?
      :premium_videojobs  # premium 사용자의 경우
    else
      :videojobs         # 일반 사용자의 경우
    end
  end

  def perform(video)
    # 비디오 처리 작업 수행
  end
end

ProcessVideoJob.perform_later(Video.last)

MyJob.set(queue: :another_queue).perform_later(record)

class GuestsCleanupJob < ApplicationJob
  queue_with_priority 10
  # ...
end

class ProcessVideoJob < ApplicationJob
  queue_with_priority do
    video = self.arguments.first
    if video.owner.premium?
      0
    else
      10
    end
  end

  def perform(video)
    # 비디오 처리 
  end
end

ProcessVideoJob.perform_later(Video.last)

MyJob.set(priority: 50).perform_later(record)

class GuestsCleanupJob < ApplicationJob
  queue_as :default

  around_perform :around_cleanup

  def perform
    # 나중에 실행할 작업 
  end

  private
    def around_cleanup
      # perform 메서드 실행 전에 할 작업
      yield
      # perform 메서드 실행 후에 할 작업 
    end
end

class ApplicationJob < ActiveJob::Base
  before_enqueue { |job| $statsd.increment "#{job.class.name.underscore}.enqueue" }
  # job이 enqueue되기 전에 해당 job 클래스의 underscore된 이름으로 statsd 메트릭을 증가시킵니다
end

# `perform_all_later`에 전달할 job들을 생성합니다.
# `new`에 전달된 인자들은 `perform`으로 전달됩니다
guest_cleanup_jobs = Guest.all.map { |guest| GuestsCleanupJob.new(guest) }

# `GuestsCleanupJob`의 각 인스턴스에 대해 별도의 job을 큐에 넣습니다
ActiveJob.perform_all_later(guest_cleanup_jobs)

# job들을 일괄 큐잉하기 전에 `set` 메서드를 사용하여 옵션을 구성할 수도 있습니다.
guest_cleanup_jobs = Guest.all.map { |guest| GuestsCleanupJob.new(guest).set(wait: 1.day) }

ActiveJob.perform_all_later(guest_cleanup_jobs)

class ExportDataJob < ApplicationJob
  def perform(*args)
    # 데이터 내보내기
  end
end

class NotifyGuestsJob < ApplicationJob
  def perform(*guests)
    # 게스트 이메일 보내기  
  end
end

# Job 인스턴스 생성
cleanup_job = GuestsCleanupJob.new(guest) 
export_job = ExportDataJob.new(data)
notify_job = NotifyGuestsJob.new(guest)

# 여러 클래스의 job 인스턴스들을 한번에 대기열에 추가
ActiveJob.perform_all_later(cleanup_job, export_job, notify_job)

# 지금 바로 이메일을 보내려면 #deliver_now를 사용하세요
UserMailer.welcome(@user).deliver_now

# Active Job을 통해 이메일을 보내려면 #deliver_later를 사용하세요 
UserMailer.welcome(@user).deliver_later

I18n.locale = :eo

UserMailer.welcome(@user).deliver_later # 이메일이 에스페란토어로 현지화됩니다.

class TrashableCleanupJob < ApplicationJob
  def perform(trashable_class, trashable_id, depth)
    trashable = trashable_class.constantize.find(trashable_id)
    trashable.cleanup(depth) 
  end
end

class TrashableCleanupJob < ApplicationJob
  def perform(trashable, depth)
    trashable.cleanup(depth)
  end
end

# app/serializers/money_serializer.rb
class MoneySerializer < ActiveJob::Serializers::ObjectSerializer
  # 지원되는 객체 타입을 사용하여 객체를 더 단순한 형태로 변환합니다.
  # 권장되는 형태는 특정 키를 가진 Hash입니다. 키는 기본 타입만 사용할 수 있습니다.
  # custom serializer 타입을 hash에 추가하기 위해 `super`를 호출해야 합니다.
  def serialize(money)
    super(
      "amount" => money.amount,
      "currency" => money.currency
    )
  end

  # 직렬화된 값을 적절한 객체로 변환합니다.
  def deserialize(hash)
    Money.new(hash["amount"], hash["currency"])
  end

  private
    # 인자가 이 serializer로 직렬화되어야 하는지 확인합니다.
    def klass
      Money
    end
end

# config/initializers/custom_serializers.rb
Rails.application.config.active_job.custom_serializers << MoneySerializer

# config/application.rb 
module YourApp
  class Application < Rails::Application
    config.autoload_once_paths << "#{root}/app/serializers"
  end
end

class GuestsCleanupJob < ApplicationJob
  queue_as :default

  rescue_from(ActiveRecord::RecordNotFound) do |exception| 
    # 예외 발생 시 처리할 내용 
  end

  def perform
    # 나중에 실행할 내용
  end
end

class RemoteServiceJob < ApplicationJob
  retry_on CustomAppException # 기본값으로 3초 대기, 5번 시도

  discard_on ActiveJob::DeserializationError

  def perform(*args)
    # CustomAppException 또는 ActiveJob::DeserializationError를 발생시킬 수 있음
  end
end