【Rails】Capybaraのfill_inメソッドを実行すると「既存レコードの内容+指定した内容」がセットされる事象の原因と対処【RSpec】

2022年2月5日 11:17

はじめに

RSpec + Capybaraを使用して、Railsアプリの統合テストを実装しています。とあるモデルの編集画面において、入力フォームの内容を書き換えた上で送信し、レコードが更新されることを確認します。

入力フォームの内容を書き換えるにはCapybaraのfill_inメソッドを使います。

fill_in 'ラベル', with: '書き換える内容'

今回は編集画面のため、画面にアクセスした時点で既存レコードの内容がセットされています。fill_inメソッドが実行されると、既存レコードの内容は削除され、withで指定した内容に書き換えられます。

しかし、条件は不明ですが、指定した内容で書き換えられるのではなく、既存レコードの内容+指定した内容がセットされるという事象に遭遇しました。

今回は、fill_inメソッドを実行すると既存レコードの内容+指定した内容がセットされる事象の原因と対処について記載します。

  • Capybara 3.33.0
  • Selenium-WebDriver 3.142.7

既存レコードの内容+指定した内容がセットされる

事象

事象が発生したコードは以下のようになります。

_form.html.erb

<%= form.label, :field_1, 'フィールド1' %>
<%= form.text_field :field_1%>

<%= form.label, :field_2, 'フィールド2' %>
<%= form.text_field :field_2%>

feature_spec.rb

fill_in 'フィールド1', with: 'updated_field_1'
fill_in 'フィールド2', with: 'updated_field_2'

特筆すべきこともない、いたってシンプルでオーソドックスなコードかと思います。編集画面のため、画面にアクセスした時点でフィールド1およびフィールド2には既存レコードの内容がセットされており、それをfill_inメソッドで書き換えようとしたのですが、フィールド2は想定通り指定した内容で書き換えられましたが、なぜかフィールド1だけ既存レコードの内容+指定した内容がセットされてしまいました。

対象フィールド fill_in実行前 fill_in実行後
フィールド1 (既存レコードの内容) (既存レコードの内容)updated_field_1
フィールド2 (既存レコードの内容) updated_field_2

原因

おそらく、Capybaraのバグではないかと思います。以下のIssueで言及されています(Capybaraのリポジトリではないですが)。以下のIssueにおいて、NGMarmaduke氏が原因と思われる該当コードを特定しています。

対処

上記のIssueに書いてありますが、fill_inメソッドにfill_options: { clear: :backspace }オプションを追加することで、指定した内容で書き換えられるようになります。その他、直前で空文字をセットするとか、バックスペースキーを入力するとかいくつか対処法があるようですが、一行で書ける方法がエレガントでいいと思います。

feature_spec.rb

# オプション指定
fill_in 'フィールド1', with: 'updated_field_1', fill_options: { clear: :backspace }

# 直前で空文字をセット
fill_in 'フィールド1', with: ''
fill_in 'フィールド1', with: 'updated_field_1'

# 直前でバックスペースキーを入力
find('フィールド1').send_keys :backspace
fill_in 'フィールド1', with: 'updated_field_1'

まとめ

今回は、fill_inメソッドを実行すると既存レコードの内容+指定した内容がセットされる事象において、その原因と対処法について記載しました。

本事象については2016年2月にIssueで言及されているにもかかわらず、未だにCapybaraで対処されていない(たぶん)ことを鑑みると、バグではないのかもしれません。ただ、私の環境では事象が発生する条件がわからなかったので、事象が発生した場合は本記事の通り対処する必要があります。

本記事の内容を参考にしていただければと思います。

関連記事

【Rails】Railsアップグレードまとめ
# はじめに Ruby on Railsに限らず、何らかのフレームワークを使ってWebシステムを構築している場合、フレームワークのアップグレード作業は避けて通れません。 一般的にフレームワークはバージョン毎にEOL (End of Life [...]
2022年10月1日 14:32
【Rails】ユーザー登録時に行うメールアドレス認証機能の実装方法
# はじめに ユーザー登録/解除やログイン/ログアウトといった認証機能の導入に「devise」というGemを使っている人は多いと思います。「devise」では以下のように記述するだけで、ユーザー登録時に確認メールを送付しメールアドレス認証を行う機 [...]
2022年9月24日 14:24
【Rails】モデルに列挙型(enum)を定義し、使いこなす方法
# はじめに Railsはモデルでカラム名と同名の列挙型(enum)を定義することで、カラムと列挙型の変数を紐付けることができます。カラムと列挙型の変数を紐付けると、カラムに対して様々な便利な使い方ができるようになります。 本記事では、モデ [...]
2022年9月3日 10:29
【Rails】RailsでCORSとPreflight requestの設定を行う方法
# はじめに RailsアプリをAPIサーバーとして構築するには、CORS (Cross-Origin Resource Sharing)と Preflight requestの設定を行う必要があります。APIサーバーは外部からの要求に対して処理 [...]
2022年8月27日 10:44
【Ruby】Bundlerを使ってRubyGemsを作成/公開する方法
# はじめに Bundlerを使ってRubyGemsを作成および公開する方法について説明します。Bundlerを使わずにRubyGemsを作成/公開する方法については以下の記事を参照してください。 <iframe class="hatena [...]
2022年7月12日 23:18
【Ruby】RubyGemsを作成/公開する方法
# はじめに RubyGemsを作成および公開する方法について説明します。Bundlerを使ってRubyGemsを作成する方法については以下の記事を参照してください。 <iframe class="hatenablogcard" style [...]
2022年7月11日 21:52
【Rails】M1チップ搭載MacでRuby on Railsの開発環境構築
# はじめに M1チップ搭載MacにRuby on Railsの開発環境を構築する手順を記載します。 - MacBook Air (M1, 2020) - macOS Monterey 12.3.1 # Homebrew ## [...]
2022年5月5日 11:56
【Rails】Rakeタスクの基本情報と作成・実行方法
# はじめに Railsには標準でRakeというGemが同梱されています。RakeはRubyで実装されたMake(UNIX系のOSで使用できるコマンド)のようなビルド作業を自動化するツールです。Ruby Make、略してRakeというわけですね。 [...]
2022年3月7日 22:12