【Rails】paranoia gemの論理削除における、関連オブジェクト削除の流れを追ってみた
論理削除を簡単に実装してくれる、paranoiaというgemがあります。
- paranoiaを使って、あるモデルのオブジェクトを論理削除できるようにしたとき
親モデル has_many :子モデル, dependent: :destroyのとき
上記の状況の際、親の削除に紐づく子の削除が物理/論理のどちらになるかは、以下のとおりです。
この動きはREADMEでも解説されていますが、実際に内部でどのように実装されているのかをソースコードを追って確認してみた、というのが今回の記事になります。
やってみる
Postモデルを作成。
paranoiaを使って、Postモデルのオブジェクトを論理削除できるようにしてみます。gemのREADMEに従って、Gemfileにparanoiaを追加してbundle installしてから、以下を行います。
- postsテーブルに
deleted_atカラムを追加するマイグレーションファイルを追加- このカラムに削除日が入っていれば削除されているものとして扱う
- Postモデルに
acts_as_paranoidを追加
class AddDeletedAtToPosts < ActiveRecord::Migration[8.0] def change add_column :posts, :deleted_at, :datetime add_index :posts, :deleted_at end end
class Post < ApplicationRecord acts_as_paranoid # 追加 end
これで論理削除ができるようになります。
post = Post.create(...)で適当にPostを作成- この段階で
Post.allすると、先ほどのPostを取得できる
- この段階で
post.destroyする- この段階で
Post.allすると、先ほどのPostを取得できない Post.with_deletedというスコープを使うと、先ほどのPostを取得できる
- この段階で
post.destroy実行後のSQLを見ると、実際に行っているのはdeleted_atカラムに時刻を入れて更新していることであるのがわかります。
paranoia-test(dev)> post = Post.create(title: 'テスト')
TRANSACTION (0.1ms) BEGIN immediate TRANSACTION /*application='ParanoiaTest'*/
Post Create (2.6ms) INSERT INTO "posts" ("title", "created_at", "updated_at", "deleted_at") VALUES ('テスト', '2025-03-02 05:35:08.350535', '2025-03-02 05:35:08.350535', NULL) RETURNING "id" /*application='ParanoiaTest'*/
TRANSACTION (3.0ms) COMMIT TRANSACTION /*application='ParanoiaTest'*/
=>
#<Post:0x00007f7aad9923c8
...
paranoia-test(dev)> Post.all
Post Load (0.1ms) SELECT "posts".* FROM "posts" WHERE "posts"."deleted_at" IS NULL /* loading for pp */ LIMIT 11 /*application='ParanoiaTest'*/
=>
[#<Post:0x00007f7aae22e4c8
id: 1,
title: "テスト",
created_at: "2025-03-02 05:35:08.350535000 +0000",
updated_at: "2025-03-02 05:35:08.350535000 +0000",
deleted_at: nil>]
paranoia-test(dev)> post.destroy
TRANSACTION (0.1ms) BEGIN immediate TRANSACTION /*application='ParanoiaTest'*/
Comment Load (0.2ms) SELECT "comments".* FROM "comments" WHERE "comments"."post_id" = 1 /*application='ParanoiaTest'*/
Post Update (0.2ms) UPDATE "posts" SET "deleted_at" = '2025-03-02 05:35:17.146309', "updated_at" = '2025-03-02 05:35:17.146316' WHERE "posts"."id" = 1 /*application='ParanoiaTest'*/
TRANSACTION (0.2ms) COMMIT TRANSACTION /*application='ParanoiaTest'*/
=>
#<Post:0x00007f7aad9923c8
id: 1,
title: "テスト",
created_at: "2025-03-02 05:35:08.350535000 +0000",
updated_at: "2025-03-02 05:35:17.146316000 +0000",
deleted_at: "2025-03-02 05:35:17.146309000 +0000">
paranoia-test(dev)> Post.all
Post Load (0.1ms) SELECT "posts".* FROM "posts" WHERE "posts"."deleted_at" IS NULL /* loading for pp */ LIMIT 11 /*application='ParanoiaTest'*/
=> []
paranoia-test(dev)> Post.with_deleted
Post Load (0.1ms) SELECT "posts".* FROM "posts" /* loading for pp */ LIMIT 11 /*application='ParanoiaTest'*/
=>
[#<Post:0x00007f7aae12f8d8
id: 1,
title: "テスト",
created_at: "2025-03-02 05:35:08.350535000 +0000",
updated_at: "2025-03-02 05:35:17.146316000 +0000",
deleted_at: "2025-03-02 05:35:17.146309000 +0000">]
関連オブジェクトの削除について
ここでCommentモデルを追加して、Postがhas_many :comments, dependent: :destroyである状態を考えます。
親のPostオブジェクトが、紐づく子のCommentオブジェクトを持っているとき、親を論理削除したときの子の削除の動きは以下のようになっています。
- Commentモデルで
acts_as_paranoidによる論理削除の設定をしていないとき- 子のCommentオブジェクトは物理削除される(DBから消える)
- Commentモデルで
acts_as_paranoidによる論理削除の設定をしているとき- 子のCommentオブジェクトは論理削除される(
deleted_atが更新されて、DBには残る)
- 子のCommentオブジェクトは論理削除される(
1.の状況で親のPostオブジェクトをdestroy(CommentはSQLでDELETEされている)
paranoia-test(dev)> post.destroy TRANSACTION (0.1ms) BEGIN immediate TRANSACTION /*application='ParanoiaTest'*/ Comment Load (0.1ms) SELECT "comments".* FROM "comments" WHERE "comments"."post_id" = 1 /*application='ParanoiaTest'*/ Comment Destroy (0.1ms) DELETE FROM "comments" WHERE "comments"."id" = 1 /*application='ParanoiaTest'*/ Post Update (0.1ms) UPDATE "posts" SET "deleted_at" = '2025-03-02 05:07:22.781654', "updated_at" = '2025-03-02 05:07:22.781670' WHERE "posts"."id" = 1 /*application='ParanoiaTest'*/ TRANSACTION (3.2ms) COMMIT TRANSACTION /*application='ParanoiaTest'*/ => #<Post:0x00007f54f06b4c60 id: 1, title: "テスト", created_at: "2025-03-02 04:59:59.611098000 +0000", updated_at: "2025-03-02 05:07:22.781670000 +0000", deleted_at: "2025-03-02 05:07:22.781654000 +0000">
2.の状況で親のPostオブジェクトをdestroy(CommentはSQLでUPDATEされている)
paranoia-test(dev)> post.destroy TRANSACTION (0.3ms) BEGIN immediate TRANSACTION /*application='ParanoiaTest'*/ Comment Load (0.7ms) SELECT "comments".* FROM "comments" WHERE "comments"."deleted_at" IS NULL AND "comments"."post_id" = 2 /*application='ParanoiaTest'*/ Comment Update (0.1ms) UPDATE "comments" SET "deleted_at" = '2025-03-02 05:13:16.316338', "updated_at" = '2025-03-02 05:13:16.316397' WHERE "comments"."id" = 2 /*application='ParanoiaTest'*/ Post Update (0.0ms) UPDATE "posts" SET "deleted_at" = '2025-03-02 05:13:16.322941', "updated_at" = '2025-03-02 05:13:16.322947' WHERE "posts"."id" = 2 /*application='ParanoiaTest'*/ TRANSACTION (0.1ms) COMMIT TRANSACTION /*application='ParanoiaTest'*/ => #<Post:0x00007f1f6e37a2a0 id: 2, title: "aa", created_at: "2025-03-02 05:09:28.200792000 +0000", updated_at: "2025-03-02 05:13:16.322947000 +0000", deleted_at: "2025-03-02 05:13:16.322941000 +0000">
このことはREADMEのこの部分でも解説されています。
なぜこんな動きになるのか
paranoiaのdestroyメソッドはActiveRecordのdestroyメソッドをオーバライドしているacts_as_paranoidをモデルで呼ぶと、1の設定が有効になるdependent: :destroyは「親が削除されたときに、子に対してdestroyメソッドを呼ぶ」ための設定- 親が削除されたとき、子の
destroyの動きが論理 / 物理削除のどちらになるかは、子がacts_as_parainoidを呼んでいるかどうかで決まる
1については、gemのソースコードの以下の部分でわかります。
module Paranoia # 中略 def paranoia_destroy with_transaction_returning_status do result = run_callbacks(:destroy) do @_disable_counter_cache = paranoia_destroyed? result = paranoia_delete next result unless result && ActiveRecord::VERSION::STRING >= '4.2' each_counter_cached_associations do |association| foreign_key = association.reflection.foreign_key.to_sym next if destroyed_by_association && destroyed_by_association.foreign_key.to_sym == foreign_key next unless send(association.reflection.name) association.decrement_counters end @_trigger_destroy_callback = true @_disable_counter_cache = false result end raise ActiveRecord::Rollback, "Not destroyed" unless paranoia_destroyed? result end || false end alias_method :destroy, :paranoia_destroy
カウンタキャッシュを取り扱うためにごにょごにょやってますが(ここはふわっとしか読んでいません😓)、alias_methodでモデルオブジェクトにdestroyが呼ばれたときに、このparanoia_destroyが実行されるようになっています。
※ ちなみに、実際にdeleted_atの更新を行うのは、このメソッド内部で呼ばれているparanoia_deleteになっています。
2については、acts_as_paranoidメソッドの定義部分でわかります。このメソッドを実行するとParanoiaモジュールをモデルクラスにincludeする(他にも1でされているようなエイリアス設定などを行う)ことで、1で定義されたメソッドがdestroyで呼ばれるようになるわけです。
ActiveSupport.on_load(:active_record) do class ActiveRecord::Base def self.acts_as_paranoid(options={}) # 中略 include Paranoia
3についてはRailsガイドで解説されています。子も含めて論理削除したい場合は、子側でもacts_as_paranoidを呼ぶのを忘れないようにする必要がある、ということですね。
要は、親も子も呼んでいるのはdestroyメソッドですが、挙動が異なるのは「paranoiaが適用されているモデルのdestroyメソッドだけが、Paranoiaモジュールの読み込みによってオーバライドされていたから」という点がポイントだったわけです。
注意: paranoiaは公式からも非推奨と言われている
ここまでparanoiaのことを見てきましたが、公式のREADMEに下のようにあるように、このgemは新規のプロジェクトには非推奨とされています。
paranoia has some surprising behaviour (like overriding ActiveRecord's delete and destroy) and is not recommended for new projects. See discard's README for more details.
まさにここまで見てきたとおり、destroyなどActiveRecordのメソッドをオーバーライドしていることで予期しない挙動を招く可能性があるという注意喚起ですね。またここで紹介されているdiscardというgemでは、discardという独自メソッドで論理削除を行うようになっており(既存メソッドはオーバーライドしない)、これが大きな違いです。
こちらのgemの中身も読んでみましたが、paranoiaよりもシンプルな実装で、自分のような初学者でも全体を読み通すのがそこまで難しくありません。gemの実装を読む練習としても良いサンプルだと思いました。機会があれば、別の記事で取り上げたいと思っています。
(そもそも論理削除自体がアンチパターンである、という議論もあるということも認識はしていますが、ここについて語るための知見はまだありません😓)
おまけ
記事を書きながら聴いていた曲は、BLACK SABBATHの『Paranoid』でした。かっこいい~。