Introduce the wait_for helper for system tests and fix a flaky test

Signed-off-by: Rémy Coutable <remy@rymai.me>

ee/spec/features/projects/audit_events_spec.rb

@@ -80,11 +80,11 @@ describe 'Projects > Audit Events', :js do
         find('.ic-remove').click
       end
 
-      wait_for_all_requests
-
       visit project_audit_events_path(project)
 
-      expect(page).to have_content('Remove deploy key')
+      wait_for('Audit event background creation job is done', polling_interval: 0.5, reload: true) do
+        page.has_content?('Remove deploy key', wait: 0)
+      end
     end
   end
 

spec/spec_helper.rb

@@ -85,6 +85,7 @@ RSpec.configure do |config|
   config.include Devise::Test::IntegrationHelpers, type: :feature
   config.include LoginHelpers, type: :feature
   config.include SearchHelpers, type: :feature
+  config.include WaitHelpers, type: :feature
   config.include EmailHelpers, :mailer, type: :mailer
   config.include Warden::Test::Helpers, type: :request
   config.include Gitlab::Routing, type: :routing

spec/support/helpers/wait_for_requests.rb

@@ -50,20 +50,6 @@ module WaitForRequests
       finished_all_vue_resource_requests?
   end
 
-  # Waits until the passed block returns true
-  def wait_for(condition_name, max_wait_time: Capybara.default_max_wait_time, polling_interval: 0.01)
-    wait_until = Time.now + max_wait_time.seconds
-    loop do
-      break if yield
-
-      if Time.now > wait_until
-        raise "Condition not met: #{condition_name}"
-      else
-        sleep(polling_interval)
-      end
-    end
-  end
-
   def finished_all_vue_resource_requests?
     Capybara.page.evaluate_script('window.activeVueResources || 0').zero?
   end

spec/support/helpers/wait_helpers.rb

+module WaitHelpers
+  extend self
+
+  # Waits until the passed block returns true
+  def wait_for(condition_name, max_wait_time: Capybara.default_max_wait_time, polling_interval: 0.01, reload: false)
+    wait_until = Time.now + max_wait_time.seconds
+    loop do
+      result = yield
+      break if result
+
+      page.refresh if reload
+
+      if Time.now > wait_until
+        raise "Condition not met: #{condition_name}"
+      else
+        sleep(polling_interval)
+      end
+    end
+  end
+end