function BlockFilterTest::testBlockFilter

Tests block filter.

File

core/modules/layout_builder/tests/src/FunctionalJavascript/BlockFilterTest.php, line 56

Class

BlockFilterTest

Tests the JavaScript functionality of the block add filter.

Namespace

Code

public function testBlockFilter() : void {
  $assert_session = $this->assertSession();
  $session = $this->getSession();
  $page = $session->getPage();
  // Open the block listing.
  $this->drupalGet('node/1/layout');
  $assert_session->linkExists('Add block');
  $this->clickLink('Add block');
  $assert_session->assertWaitOnAjaxRequest();
  // Get all blocks, for assertions later.
  $blocks = $page->findAll('css', '.js-layout-builder-categories li');
  $categories = $page->findAll('css', '.js-layout-builder-category');
  $filter = $assert_session->elementExists('css', '.js-layout-builder-filter');
  // Set announce to ensure it is not cleared.
  $init_message = 'init message';
  $session->evaluateScript("Drupal.announce('{$init_message}')");
  // Test block filter does not take effect for 1 character.
  $filter->setValue('a');
  $this->assertAnnounceContains($init_message);
  $visible_rows = $this->filterVisibleElements($blocks);
  $this->assertSameSize($blocks, $visible_rows);
  // Get the Content Fields category, which will be closed before filtering.
  $contentFieldsCategory = $page->find('named', [
    'content',
    'Content fields',
  ]);
  // Link that belongs to the Content Fields category, to verify collapse.
  $promoteToFrontPageLink = $page->find('named', [
    'content',
    'Promoted to front page',
  ]);
  // Test that front page link is visible until Content Fields collapsed.
  $this->assertTrue($promoteToFrontPageLink->isVisible());
  $contentFieldsCategory->click();
  $this->assertFalse($promoteToFrontPageLink->isVisible());
  // Test block filter reduces the number of visible rows.
  $filter->setValue('ad');
  $fewer_blocks_message = ' blocks are available in the modified list';
  $this->assertAnnounceContains($fewer_blocks_message);
  $visible_rows = $this->filterVisibleElements($blocks);
  $this->assertCount(3, $visible_rows);
  $visible_categories = $this->filterVisibleElements($categories);
  $this->assertCount(3, $visible_categories);
  // Test Drupal.announce() message when multiple matches are present.
  $expected_message = count($visible_rows) . $fewer_blocks_message;
  $this->assertAnnounceContains($expected_message);
  // Test 3 letter search.
  $filter->setValue('adm');
  $visible_rows = $this->filterVisibleElements($blocks);
  $this->assertCount(2, $visible_rows);
  $visible_categories = $this->filterVisibleElements($categories);
  $this->assertCount(2, $visible_categories);
  // Retest that blocks appear when reducing letters.
  $filter->setValue('ad');
  $visible_rows = $this->filterVisibleElements($blocks);
  $this->assertCount(3, $visible_rows);
  $visible_categories = $this->filterVisibleElements($categories);
  $this->assertCount(3, $visible_categories);
  // Test blocks reappear after being filtered by repeating search for "a"
  $filter->setValue('a');
  $this->assertAnnounceContains('All available blocks are listed.');
  // Test Drupal.announce() message when only one match is present.
  $filter->setValue('Powered by');
  $this->assertAnnounceContains(' block is available');
  $visible_rows = $this->filterVisibleElements($blocks);
  $this->assertCount(1, $visible_rows);
  $visible_categories = $this->filterVisibleElements($categories);
  $this->assertCount(1, $visible_categories);
  $this->assertAnnounceContains('1 block is available in the modified list.');
  // Test Drupal.announce() message when no matches are present.
  $filter->setValue('Pan-Galactic Gargle Blaster');
  $visible_rows = $this->filterVisibleElements($blocks);
  $this->assertCount(0, $visible_rows);
  $visible_categories = $this->filterVisibleElements($categories);
  $this->assertCount(0, $visible_categories);
  $announce_element = $page->find('css', '#drupal-live-announce');
  $page->waitFor(2, function () use ($announce_element) {
    return str_starts_with($announce_element->getText(), '0 blocks are available');
  });
  // Test Drupal.announce() message when all blocks are listed.
  $filter->setValue('');
  $this->assertAnnounceContains('All available blocks are listed.');
  // Confirm the Content Fields category remains collapsed after filtering.
  $this->assertFalse($promoteToFrontPageLink->isVisible());
}