【Rails】ActiveRecord::Base.transaction do ~ end にて気になること と エラー処理に関して (エラーメッセージ)

Question

https://teratail.com/questions/342357
「 Rails API 例外処理 create! or createなのか ベストプラクティスを知りたい 」 にてご回答いただけた内容に関しての質問になります。

質問内容

1,find_byでレコードを探したいときトランザクション内にて行うのかそれともトランザクション外部で行うのか。下記のコードではトランザクション外部で書いてみたコードになります。トランザクション内で行うのであればロジックは考えます...

2,DBを操作しないメールを送信するコードもトランザクション内であるので一個のトランザクション内に書くのか。

3,上記コードのエラーを示すレスポンスに関して、 result = { error: { message: e.message } } とerrorの中に二重構造にした理由を知りたいです。
これはフロント側で何か使うために2重の構造にしているのか、調べてもあまり出てこなく、気になっております。

# ご回答いただいた内容を参考に記述してみました。

Class XXXcontroller < Applicationcontroller

  def create
    user = User.find(params[:id]) # 質問1

    render json: status: 400, { message: "該当のユーザーはいません。"} if user.blank?


    begin 
      ActiveRecord::Base.transaction do
      user.create(...)!
      Form.update!(is_completed: true)
      Mailer.send_email # 質問２
    end

    render status: 200, json: { message: "会員登録に成功しました。メール送信を行いました。"}

   rescue => e

     result = {error: {message:  e.message }} # 質問3

     render status: 500, json: { result }
   end

 end
end

質問1は別のやり方でも書いてみました。(トランザクション外での実装)

rescue_fromでまとめて、RecordNotFoundが出た時点でメソッド化したものを呼び出すか。

   rescue_from ActiveRecord::RecordNotFound, with: :render_not_found_message

   user = User.find(params[:id])

   private

   def render_not_found_message  	
     render json: status: 400, { message: "該当のユーザーはいません。"}
   end

宜しくお願い致します。

Answer 1

find_byでレコードを探したいときトランザクション内にて行うのかそれともトランザクション外部で行うのか。

コードの中身次第です。純粋に1レコードしか取得しない状況でトランザクションが影響することは考えられませんが、サブテーブルが複雑に絡み合うような取得の場合はトランザクションで1時点の状態を確実に取得したほうが適当かもしれません。

DBを操作しないメールを送信するコードもトランザクション内であるので一個のトランザクション内に書くのか。

そもそも、メール送信処理をトランザクションに入れるべきではありません。メール送信のロールバックも不可能ですし、DB処理より長時間かかるメール処理の時間中もロックが続いてしまいます。デメリットしかありません。

Comments

[maisumakun]

RailsのActionMailerには、.deliver_laterのような遅延実行の仕掛けがあります。

アクション内からメールを生成するような場合はそれに任せるのがいいです。

[rzz]

理解が深まりました！ご回答ありがとうございます。
2番目のご回答に関してなのですが、
DBに保存ができても、メールが送れなければ保存はしたくないのでトランザクション外となると
メール送信の際エラーが発生した場合も含めたロジックはどのように記載すれば良いのでしょうか。

create! → 成功
update! → 成功

Mailer.send → メール送信失敗
の場合DBにデータが残ってしまうのが懸念点です。。

[rzz]

コメント見落としてました！すみません。メール送信はトランザクション外にして.deliver_laterにすれば良いということですね。

Answer 2

1,find_byでレコードを探したいときトランザクション内にて行うのかそれともトランザクション外部で行うのか。下記のコードではトランザクション外部で書いてみたコードになります。トランザクション内で行うのであればロジックは考えます...

トランザクションはテーブルの更新処理に対して成功 or 失敗を担保するための仕組みですので、
単なる検索でトランザクションが必要かどうかはケースバイケースになります。

2,DBを操作しないメールを送信するコードもトランザクション内であるので一個のトランザクション内に書くのか。

トランザクションはDBに関する話なので、メールを送るだけならトランザクションである必要はありません。
もちろんトランザクション内に書いても処理の順番が正しければ意図通りに動きます。

今回提示されているコードに関してはcreate!(), update!()の後にメール送信を書いているので、
成功した時しかメール送信処理に来ないため、保存に失敗したのにメールが飛ぶといった事はありません。
(ビックリマーク付きのメソッドを使っているため、保存に失敗したら例外が発生するため)

でも、明確にトランザクションとメール送信は分けたほうがコードとしては分かりやすいです。

3,上記コードのエラーを示すレスポンスに関して、 result = { error: { message: e.message } } とerrorの中に二重構造にした理由を知りたいです。 これはフロント側で何か使うために2重の構造にしているのか、調べてもあまり出てこなく、気になっております。

{
  error: {
    message: "エラー"
  }
}

というハッシュを返しているので、フロント側では例えば、dataという変数にレスポンスを受け取ったとしたらdata.error.messageとして使う事を想定しているだけです。

Comments

[rzz]

ご回答頂きありがとうございます！よく理解が出来ました。
最後に1つ、メール送信の際
トランザクション内に
create! update!して
トランザクション外にメール送信をする実装をすると
DBに保存が成功 + メール送信に失敗となった場合、やっぱりcreate! update!した保存を取り消すのは難しいですよね...？

[mingos]

そうですね。取り消せません。

特にトランザクション内でメール送信を書いたとしても、
ロールバックされる条件は例外の発生なので、メール送信に失敗した時に例外が発生しない場合は取り消せません。
確実にメール送信失敗時に例外が発生するのかどうかは自分も分かりません。