【Rails】Herokuで月一回のバッチ処理ができるのか

みなさんこんにちは！tekute-kuです。

今回はHerokuで月一回のバッチ処理を行う方法を紹介していきたいと思います！

記事を書いた目的
タスクの定義
Herokuのアドオンをインストール
Schedulerの設定
まとめ

記事を書いた目的

定期のバッチ処理を設定し開発環境では実行できたものの（whenever gemを使用）、本番環境であるHerokuでは使用できなかったのでHeroku上でのバッチ処理の方法を調べてみました。

Heroku上でバッチ処理をしたいけどやり方がわからない場合の参考になれば幸いです。

タスクの定義

HerokuではHeroku Suchedulerを使ってバッチ処理をしていきますので、Schedulerで実行したいタスク定義します。

rails g task タスク名

このコマンドでタスクを記載するファイルを作成します。

今回、私の場合はメールを月一回定期配信したいのでタスク名は「mail_every_month」としました。

rails g task mail_every_month

実行結果

Running via Spring preloader in process 46812
      create  lib/tasks/mail_every_month.rake

これで　lib/tasks　に　mail_every_month.rake　というrakeファイルが作成されました。

このrakeファイルの中にタスクを書き込んでいきますが最初はまだ以下のとおりのことしか記載されていません。

lib/tasks/mail_every_month.rake

namespace :mail_every_month do
end

ここにタスクを書き込みます。

私の場合はcustomers全員にメールを配信したいのでCustomerMailerを呼び出しています。

#名前空間
namespace :mail_every_month do
  # タスクの説明
  desc "customersに一ヶ月に１回メールを配信する"
  # タスクの名前
  task remind_mail: :environment do
    customers = Customers.all
    customers.each do |customer|
      CustomerMailer.remind_mail(customer).deliver
    end
  end
end

これでタスクに反映されたかどうかをコマンドで確認します。

bundle exec rake -T

ちなみにこちらは以下のコマンドでも問題ありません。

bundle exec rails -T

Rails5以降はRakeコマンドはrailsコマンドに統合されたのでどちらでも構いません。

実行結果

rake about                              # List versions of all Rails frameworks and the environment
rake active_storage:install             # Copy over the migration needed to the application
.
.
.
rake mail_every_month:remind_mail       # customersに一ヶ月に１回メールを配信する
.
.
.
rake yarn:install                       # Install all JavaScript dependencies as specified via Yarn

ここで先ほど設定したタスクが表示されていればOKです。

Herokuのアドオンをインストール

HerokuのSuchedulerを使うにはアドオンをインストールしなければいけません。

以下のコマンドによりアドオンをインストールします。

heroku addons:add scheduler:standard

実行結果

›   Warning: heroku update available from 7.59.4 to 7.64.0.
Creating scheduler:standard on ⬢ auto-sending-system... free
To manage scheduled jobs run:
heroku addons:open scheduler
Created scheduler-tapered-41040
Use heroku addons:docs scheduler to view documentation

これでSchedulerのアドオンがインストールされました。