Provide helper test method to wait for an element to be removed from the page

I know https://www.drupal.org/u/marcoscano had the same usecase on the weekend. I'm not sure right now what he ended up with.

This will be similar to \Drupal\FunctionalJavascriptTests\JSWebAssert::waitForElement but course there is no point in returning the element which should not be there.

Haha, yeah that's certainly a true statement.

Then maybe there is a sense to make a universal JTB::waitFor() method like c/p from Behat\Mink\Element\Element::waitFor(). But this can be done later of course. RTBC++

Do you want to open up a follow up for that?

1. +++ b/core/modules/system/tests/src/FunctionalJavascript/OffCanvasTestBase.php
   @@ -149,4 +134,21 @@ public function themeDataProvider() {
   +  protected function waitForNoElement($selector, $timeout = 10000) {
   +    $this->assertSession()->assertNoElementAfterWait('css', $selector, $timeout);
   +  }
   

   We need a @trigger_error('some mesage', E_USER_DEPRECATED) to inform other tests that this is going away.

2. +++ b/core/tests/Drupal/FunctionalJavascriptTests/JSWebAssert.php
   @@ -367,4 +367,37 @@ function t(r, lx, ly) {
   +    if ($node) {
   +      throw new ElementHtmlException($message, $this->session->getDriver(), $node);
   +    }
   

   I think the if ($node) { is unnecessary. Less conditions makes things less complicated.

3. +++ b/core/tests/Drupal/FunctionalJavascriptTests/Tests/JSWebAssertTest.php
   @@ -29,6 +30,22 @@ public function testJsWebAssert() {
   +    $assert_session->elementExists('css', '[data-drupal-selector="edit-test-assert-no-element-after-wait-pass"]');
   +    $page->findButton('Test assertNoElementAfterWait: pass')->press();
   +    $assert_session->assertNoElementAfterWait('css', '[data-drupal-selector="edit-test-assert-no-element-after-wait-pass"]', 1000);
   +
   +    $assert_session->elementExists('css', '[data-drupal-selector="edit-test-assert-no-element-after-wait-fail"]');
   +    $page->findButton('Test assertNoElementAfterWait: fail')->press();
   +    try {
   +      $assert_session->assertNoElementAfterWait('css', '[data-drupal-selector="edit-test-assert-no-element-after-wait-fail"]', 500, 'Element exists on page after too short wait.');
   +      $this->fail('Element not exists on page after too short wait.');
   +    }
   +    catch (ElementHtmlException $e) {
   +      $this->assertSame('Element exists on page after too short wait.', $e->getMessage());
   +    }
   +
   +    $assert_session->assertNoElementAfterWait('css', '[data-drupal-selector="edit-test-assert-no-element-after-wait-fail"]', 2500, 'Element remove after another wait.ss');
   

   Nice tests!

Reroll + a few coding standards fixes

+++ b/core/tests/Drupal/FunctionalJavascriptTests/JSWebAssert.php
@@ -367,4 +367,37 @@ function t(r, lx, ly) {
+  public function assertNoElementAfterWait($selector_type, $selector, $timeout = 10000, $message = 'Element exists on the page.') {
+
+    $start = microtime(TRUE);

There's an extra blank line here, but that is fixable on commit.

Otherwise, I think this looks fine. Good to go.

Took care of the 10 remaining @todos

Thank you @bnjmnm. All feedback has been addressed, back to RTBC.

+++ b/core/modules/layout_builder/tests/src/FunctionalJavascript/MoveBlockFormTest.php
@@ -90,7 +90,6 @@ protected function setUp() {
-    $this->waitForNoElement('#drupal-off-canvas');

The fail might be related to the removal of this line. It seems that removing this might cause a random fail.

Thanks @lendude, looks like that line was inadvertently removed instead of replaced with the new method. Glad you & the tests caught that!

The new test failure is most likely due to css transitions changing the location of the element the test is attempting to access. There's a test module in Layout Builder that disables css transitions that will likely fix the issue (and would add right now if I was on the machine with my dev environment)

Added the test module that disables CSS transitions to MoveBlockFormTest. Hoping that addresses the unexpected test failure.

Interdiffs look clean and right. Bot is happy green. RTBC.

Thanks!
-Derek

For some reason this hasn;t been set back to needs work for the re-roll.

Reroll

Patch applies well to 8.8.x

#38.1

Is there a reason we are not replacing this with a call to assertNoElementAfterWait()?

. After discovering that assertNoElementAfterWait would not work due to the element still being present (just hidden), I also realized the hide() transition is now instantaneous, so the wait is no longer neccessary. It had been added in an earlier iteration of the toggle issue when hide/show were animated

Items 2-5 of #38 are also addressed in this patch.

--- a/core/tests/Drupal/FunctionalJavascriptTests/JSWebAssert.php
+++ b/core/tests/Drupal/FunctionalJavascriptTests/JSWebAssert.php
@@ -387,4 +387,35 @@ function t(r, lx, ly) {
     return $this->session->evaluateScript($full_javascript_visibility_test);
   }
 
+  /**
+   * Asserts that no matching element exists on the page after a wait.
+   *
+   * @param string $selector_type
+   *   The element selector type (CSS, XPath).

The element selector type is case-sensitive. CSS and XPath should be lowercase.

See #3041900: The element selector type "CSS, XPath" in JSWebAssert should be lowercase.

https://www.drupal.org/pift-ci-job/1295717
https://www.drupal.org/pift-ci-job/1295054
https://www.drupal.org/pift-ci-job/1295043
https://www.drupal.org/pift-ci-job/1295846
https://www.drupal.org/pift-ci-job/1295036
https://www.drupal.org/pift-ci-job/1295033

Needs reroll after fixed:
#2901792: Disable all animations in Javascript testing

#3056536: LayoutBuilderDisableInteractionsTest randomly fails

The assertNoElementAfterWait has been changed in core/modules/layout_builder/tests/src/FunctionalJavascript/LayoutBuilderDisableInteractionsTest.php.

This is no longer critical.

Rerolled and fixed fail.

Can't find anything to add to this, all feedback had been addressed again, so back to RTBC

Committed 9a11de6 and pushed to 8.8.x. Thanks!
Committed 6ad73cb and pushed to 8.7.x. Thanks!

Didn't quite merge to 8.7.x correctly so had to commit a quick follow-up afterwards... Add block vs Add Block - fun https://www.drupal.org/commitlog/commit/2/6ad73cb21868ac8fba291aef6de5a6...