🤖

[Sidekiq+Redis]非同期的にメール送信する

2023/09/09に公開

Rails

Sidekiqとは？

ActiveJob（ジョブ）によって作られた一つ一つのタスクが登録されているRedis（キュー）を、非同期的にバックグラウンドで実行していくキューアダプター

# 実行順
Rails（ジョブ） → Redis（キュー） → Sidekiq（キューアダプター）

使い時は？

リアルタイム性を伴わない処理や、重たい処理に使われることが多い

該当する処理の具体例👇

メールの送信
画像の処理
データを集計してCSVに落とす

実装目標

以前作成した記事では、Action Mailerで同期的にメール送信を行っています。
今回は、非同期的にメール送信されるよう実装していきます。

実装

SidekiqとRedisの導入

非同期処理に必要なgemをbundle install

# Gemfile
gem 'redis'
gem 'redis-namespace'
gem 'sidekiq', '~> 6.4'

設定

キューアダプターをSidekiqに設定

# config/application.rb
class Application < Rails::Application    
  config.active_job.queue_adapter = :sidekiq # 追加
end

SidekiqとRedisの接続設定

config/initializers/sidekiq.rbを作成し、以下のように記載

# config/initializers/sidekiq.rb
Sidekiq.configure_server do |config|
  config.redis = { url: 'redis://redis:6379', namespace: 'sidekiq' }
end

Sidekiq.configure_client do |config|
  config.redis = { url: 'redis://redis:6379', namespace: 'sidekiq' }
end

Sidekiqのオプション設定

config/sidekiq.ymlを作成し、以下のように記載

# config/sidekiq.yml
:verbose: false
:pidfile: ./tmp/pids/sidekiq.pid
:logfile: ./log/sidekiq.log
:concurrency: 33
:queues:
  - default

メール送信機能を非同期処理化

コントローラーを編集

以上記事のUsersコントローラーで使用している
deliver_nowメソッドをdeliver_laterメソッドに修正し、非同期でメール送信するようにします

# users_controller.rb
def create
  @user = User.new(user_params)

  respond_to do |format|
    if @user.save
      # deliver_nowをdeliver_laterに変更
      UserMailer.with(email: @user.email, name: @user.name).welcome.deliver_later
      
      # 省略
    end
  end
end

ログ確認

メール送信された際、開発サーバーのコンソールログに、以下のようなログがあると実装完了🎉

# メールがキューに追加されることを示すログ
Enqueued ActionMailer::MailDeliveryJob (Job ID: xxxxx) to Sidekiq(mailers) with arguments: ...

# Sidekiqがキューからジョブを取り出して実行する
[ActiveJob] [ActionMailer::MailDeliveryJob] [Job ID] Performing ActionMailer::MailDeliveryJob from Sidekiq(mailers) with arguments: ..