マイグレーションファイルから Model を直接触るのはやめて欲しい

1 min read

何が起こったのか

開発環境で新たにDBを作成。

お約束通り、

$ rails db:create
$ rails db:migrate

大量のマイグレーションファイルを一気に migrate しようとしたその時、事件は起こった。

PG undefined column hogehoge ...

的な感じで、スッと通らない🧐
嫌な予感がする。

なになに。。。。

マイグレーションファイルから直接 Model にアクセスしていたんです。

migartion_file
...

Hoge.delete_all

...

みたいな感じでモデルに対して直接操作を行う処理が書かれていた😓

そのマイグレーションファイルは過去のものであり、その当時はそのモデルがあったのだろうが、今現在のソースコードには存在しない。
当然、 そんなモデルは無いよ と怒られたりする。

こんな感じで直接 Model に対して処理を行っているマイグレーションファイルが散見された。
結果 migrate を通すのにものすごく苦労し、過去のマイグレーションファイルにも手を入れなくてはいけなくなった。

マイグレーションファイルってそういうものなのでしょうか?
いいえ、違うはずです。

どうすれば良いのか

マイグレーションファイルは、後々どんな人が開発に入ってきてもしっかり rails db:migrate が通るように積み上げていきましょう。

ファイル数が増えるのは仕方ありません。大事なのはしっかり通るかどうかです。
おそらく当時の開発者もモデルに対して処理を書いているのは分かっていたはずで、データメンテナンスがしたかったのだと思います。

既存データのメンテナンスはマイグレーションファイルでやらないで、rake task を作成するとか他にもやり方があったはずです。

自戒も込めて、マイグレーションファイルに関して気をつけるべきことを書いておきます

  • マイグレーションファイルを追加した時には、 rails db:migrate:redo を習慣づけて redo が通ることを確認する
  • 古いマイグレーションファイルを後から書き換えない(見栄えは悪いが単純に積み上げていくのがベストプラクティス)
  • データメンテナンスはマイグレーションファイルの中で行わない(rake task を作ったり rails console から手動やったり他の方法がある)

Model は単なる ruby のクラスに過ぎません。
それは今後名前が変わるかもしれませんし、データの持ち方も変わるかもしれません。

マイグレーションファイルの中からモデルを直接触るのはやめましょう😭


どなたかの役に立てば幸いです。