Skip to content

Commit

Permalink
Merge pull request #17641 from opf/fix/fix-flaky-test-and-introduce-a…
Browse files Browse the repository at this point in the history
…-wait-size-animation-helper

Fix flaky test
  • Loading branch information
cbliard authored Jan 17, 2025
2 parents bd628bc + 5b70edf commit 72a6367
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 1 deletion.
53 changes: 53 additions & 0 deletions spec/support/capybara/wait_helpers.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# frozen_string_literal: true

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# See COPYRIGHT and LICENSE files for more details.
#++

module WaitHelpers
# Wait for an element to stop being resized on the page
#
# Useful to wait for a primer dialog to finish opening, as they have an
# opening animation.
#
# @param selector [String] CSS selector for the element to wait for
# @param wait [Integer] Optional maximum time to wait in seconds, defaults to
# Capybara's default wait time
def wait_for_size_animation_completion(selector, wait: Capybara.default_max_wait_time)
element = page.find(selector, wait:)
page.document.synchronize do
initial_position = page.evaluate_script("arguments[0].getBoundingClientRect()", element)
sleep 0.1 # Small delay to allow for animation
final_position = page.evaluate_script("arguments[0].getBoundingClientRect()", element)
raise Capybara::ExpectationNotMet, "Animation not finished" unless initial_position == final_position
end
end
end

RSpec.configure do |config|
config.include WaitHelpers, type: :feature
end
2 changes: 2 additions & 0 deletions spec/support/pages/page.rb
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@

require_relative "../toasts/expectations"
require_relative "../flash/expectations"
require_relative "../capybara/wait_helpers"

module Pages
class Page
Expand All @@ -38,6 +39,7 @@ class Page
include OpenProject::StaticRouting::UrlHelpers
include Toasts::Expectations
include Flash::Expectations
include WaitHelpers

def current_page?
URI.parse(current_url).path == path
Expand Down
2 changes: 1 addition & 1 deletion spec/support/pages/projects/show.rb
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ def open_edit_dialog_for_section(section)
end
end

expect(page).to have_css("[data-test-selector='async-dialog-content']", wait: 5)
wait_for_size_animation_completion("[data-test-selector='async-dialog-content']")
end

def open_edit_dialog_for_life_cycles
Expand Down

0 comments on commit 72a6367

Please sign in to comment.