EditModeTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\contextual\FunctionalJavascript;

use Drupal\FunctionalJavascriptTests\WebDriverTestBase;

/**
 * Tests edit mode.
 *
 * @group contextual
 * @group #slow
 */
class EditModeTest extends WebDriverTestBase {
  
  /**
   * CSS selector for Drupal's announce element.
   */
  const ANNOUNCE_SELECTOR = '#drupal-live-announce';
  
  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'node',
    'block',
    'user',
    'system',
    'breakpoint',
    'toolbar',
    'contextual',
  ];
  
  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';
  
  /**
   * The administration theme name.
   *
   * @var string
   */
  protected $adminTheme = 'claro';
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    \Drupal::service('theme_installer')->install([
      $this->adminTheme,
    ]);
    \Drupal::configFactory()->getEditable('system.theme')
      ->set('admin', $this->adminTheme)
      ->save();
    $this->drupalLogin($this->createUser([
      'administer blocks',
      'access contextual links',
      'access toolbar',
      'view the administration theme',
    ]));
    $this->placeBlock('system_powered_by_block', [
      'id' => 'powered',
    ]);
  }
  
  /**
   * Tests enabling and disabling edit mode.
   */
  public function testEditModeEnableDisable() : void {
    $web_assert = $this->assertSession();
    $page = $this->getSession()
      ->getPage();
    // Get the page twice to ensure edit mode remains enabled after a new page
    // request.
    $this->drupalGet('user');
    $expected_restricted_tab_count = 1 + count($page->findAll('css', '[data-contextual-id]'));
    // After the page loaded we need to additionally wait until the settings
    // tray Ajax activity is done.
    $web_assert->assertWaitOnAjaxRequest();
    $unrestricted_tab_count = $this->getTabbableElementsCount();
    $this->assertGreaterThan($expected_restricted_tab_count, $unrestricted_tab_count);
    // Enable edit mode.
    // After the first page load the page will be in edit mode when loaded.
    $this->pressToolbarEditButton();
    $this->assertAnnounceEditMode();
    $this->assertSame($expected_restricted_tab_count, $this->getTabbableElementsCount());
    // Disable edit mode.
    $this->pressToolbarEditButton();
    $this->assertAnnounceLeaveEditMode();
    $this->assertSame($unrestricted_tab_count, $this->getTabbableElementsCount());
    // Enable edit mode again.
    $this->pressToolbarEditButton();
    // Finally assert that the 'edit mode enabled' announcement is still
    // correct after toggling the edit mode at least once.
    $this->assertAnnounceEditMode();
    $this->assertSame($expected_restricted_tab_count, $this->getTabbableElementsCount());
    // Test while Edit Mode is enabled it doesn't interfere with pages with
    // no contextual links.
    $this->drupalGet('admin/structure/block');
    $web_assert->elementContains('css', 'h1.page-title', 'Block layout');
    $this->assertEquals(0, count($page->findAll('css', '[data-contextual-id]')));
    $this->assertGreaterThan(0, $this->getTabbableElementsCount());
  }
  
  /**
   * Presses the toolbar edit mode.
   */
  protected function pressToolbarEditButton() : void {
    $edit_button = $this->getSession()
      ->getPage()
      ->find('css', '#toolbar-bar div.contextual-toolbar-tab button');
    $edit_button->press();
  }
  
  /**
   * Asserts that the correct message was announced when entering edit mode.
   *
   * @internal
   */
  protected function assertAnnounceEditMode() : void {
    $web_assert = $this->assertSession();
    // Wait for contextual trigger button.
    $web_assert->waitForElementVisible('css', '.contextual trigger');
    $web_assert->elementContains('css', static::ANNOUNCE_SELECTOR, 'Tabbing is constrained to a set of');
    $web_assert->elementNotContains('css', static::ANNOUNCE_SELECTOR, 'Tabbing is no longer constrained by the Contextual module.');
  }
  
  /**
   * Assert that the correct message was announced when leaving edit mode.
   *
   * @internal
   */
  protected function assertAnnounceLeaveEditMode() : void {
    $web_assert = $this->assertSession();
    $page = $this->getSession()
      ->getPage();
    // Wait till all the contextual links are hidden.
    $page->waitFor(1, function () use ($page) {
      return empty($page->find('css', '.contextual .trigger.visually-hidden'));
    });
    $web_assert->elementContains('css', static::ANNOUNCE_SELECTOR, 'Tabbing is no longer constrained by the Contextual module.');
    $web_assert->elementNotContains('css', static::ANNOUNCE_SELECTOR, 'Tabbing is constrained to a set of');
  }
  
  /**
   * Gets the number of elements that are tabbable.
   *
   * @return int
   *   The number of tabbable elements.
   */
  protected function getTabbableElementsCount() : int {
    // Mark all tabbable elements.
    $this->getSession()
      ->executeScript("jQuery(window.tabbable.tabbable(document.body)).attr('data-marked', '');");
    // Count all marked elements.
    $count = count($this->getSession()
      ->getPage()
      ->findAll('css', "[data-marked]"));
    // Remove set attributes.
    $this->getSession()
      ->executeScript("jQuery('[data-marked]').removeAttr('data-marked');");
    return $count;
  }

}