feat: use rspec retry to deflake ci

This is a bandaid fix that does not address the root cause.

Author: elasticspoon

Gemfile

@@ -98,6 +98,7 @@ end
 group :test do
   gem "brakeman" # security inspection
   gem "capybara"
+  gem "rspec-retry" # for retrying flaky tests
   gem "capybara-screenshot"
   gem "database_cleaner-active_record"
   gem "docx"

Gemfile.lock

@@ -472,6 +472,8 @@ GEM
       rspec-expectations (~> 3.13)
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
+    rspec-retry (0.6.2)
+      rspec-core (> 3.3)
     rspec-support (3.13.2)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
@@ -695,6 +697,7 @@ DEPENDENCIES
   request_store
   rexml
   rspec-rails
+  rspec-retry
   rspec_junit_formatter
   rswag-api
   rswag-specs

spec/support/rspec_retry.rb

@@ -0,0 +1,16 @@
+# spec/spec_helper.rb
+require 'rspec/retry'
+
+RSpec.configure do |config|
+  # show retry status in spec process
+  config.verbose_retry = true
+  # show exception that triggers a retry if verbose_retry is set to true
+  config.display_try_failure_messages = true
+
+  if ENV['CI'] == 'true'
+    # run retry only on features
+    config.around :each, :js do |ex|
+      ex.run_with_retry retry: 3
+    end
+  end
+end