楽観的ロックを使ったRuby on Railsアプリケーションを作って動きを確かめる

昔からある機能です。 Rails 0.9.3からの機能あったようです*1。よくわかっていないので、説明してみます。

Railsガイドの説明

Railsガイドでは次のように説明されています。

楽観的ロックでは、複数のユーザーが同じレコードを同時編集することを許し、データの衝突が最小限であることを仮定しています。この方法では、レコードがオープンされてから変更されたことがあるかどうかをチェックします。そのような変更が行われ、かつ更新が無視された場合、ActiveRecord::StaleObjectError例外が発生します。

いまいちユースケースがピンと来ません。

使い方

Railsガイド中では次のような短いサンプルがあります。

c1 = Customer.find(1)
c2 = Customer.find(1)

c1.first_name = "Sandra"
c1.save

c2.first_name = "Michael"
c2.save # ActiveRecord::StaleObjectErrorが発生

これだとRuby on Railsアプリケーションの中でどう使えば良いのかよくわかりません。画面からの編集リクエストとc1とc2の関係が想像できません。

用途

GitHubのWikiが楽観的ロックを使っていそうな動作だったような、おぼろげな記憶があります。確かめてみると、現在は次のようにフラッシュメッセージがPushされます。

f:id:ledsun:20220412014550p:plain — Gihub Wikiを編集中に保存された時にはフラッシュメッセージが表示されます。

記憶の中のイメージでは、Saveボタンを押したときに保存失敗していました。

想像するに、ユースケースは、ある程度長文を保持するモデルで編集内容を上書きされたくない時のようです。便利にするなら、マージするなり衝突したDiffを表示するなりしたいところです。そこまで凝った実装をしないで、最低限、別のユーザーからの変更があったことをユーザーに伝えるための機能です。

楽観的ロックを使ったRuby on Railsアプリケーションを作る

なんとなく用途がイメージできたので、実際にアプリケーションを作ってみます。長文を保持するので、記事モデルを一つ持つRuby on Railsアプリケーションを作ります。

楽観的ロックはlock_version カラムさえあれば動作します。 scaffold するときに lock_version カラムも指定しておきます。

bundle exec rails new -MCAJT --skip-active-job --skip-active-storage . 
bin/rails g scaffold Article title:string content:text lock_version:integer
bin/rails db:prepare

railsをインストールしていなければbundel initして出来たGemfileの中のコメントを外してbundleしてください。