Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\FunctionalJavascriptTests\Ajax;
Chris@0: 
Chris@17: use Drupal\FunctionalJavascriptTests\WebDriverTestBase;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests AJAX responses.
Chris@0:  *
Chris@0:  * @group Ajax
Chris@0:  */
Chris@17: class AjaxTest extends WebDriverTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static $modules = ['ajax_test'];
Chris@0: 
Chris@0:   public function testAjaxWithAdminRoute() {
Chris@0:     \Drupal::service('theme_installer')->install(['stable', 'seven']);
Chris@0:     $theme_config = \Drupal::configFactory()->getEditable('system.theme');
Chris@0:     $theme_config->set('admin', 'seven');
Chris@0:     $theme_config->set('default', 'stable');
Chris@0:     $theme_config->save();
Chris@0: 
Chris@0:     $account = $this->drupalCreateUser(['view the administration theme']);
Chris@0:     $this->drupalLogin($account);
Chris@0: 
Chris@0:     // First visit the site directly via the URL. This should render it in the
Chris@0:     // admin theme.
Chris@0:     $this->drupalGet('admin/ajax-test/theme');
Chris@0:     $assert = $this->assertSession();
Chris@0:     $assert->pageTextContains('Current theme: seven');
Chris@0: 
Chris@0:     // Now click the modal, which should also use the admin theme.
Chris@0:     $this->drupalGet('ajax-test/dialog');
Chris@0:     $assert->pageTextNotContains('Current theme: stable');
Chris@0:     $this->clickLink('Link 8 (ajax)');
Chris@0:     $assert->assertWaitOnAjaxRequest();
Chris@0: 
Chris@0:     $assert->pageTextContains('Current theme: stable');
Chris@0:     $assert->pageTextNotContains('Current theme: seven');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Test that AJAX loaded libraries are not retained between requests.
Chris@0:    *
Chris@0:    * @see https://www.drupal.org/node/2647916
Chris@0:    */
Chris@0:   public function testDrupalSettingsCachingRegression() {
Chris@0:     $this->drupalGet('ajax-test/dialog');
Chris@0:     $assert = $this->assertSession();
Chris@0:     $session = $this->getSession();
Chris@0: 
Chris@0:     // Insert a fake library into the already loaded library settings.
Chris@0:     $fake_library = 'fakeLibrary/fakeLibrary';
Chris@0:     $session->evaluateScript("drupalSettings.ajaxPageState.libraries = drupalSettings.ajaxPageState.libraries + ',$fake_library';");
Chris@0: 
Chris@0:     $libraries = $session->evaluateScript('drupalSettings.ajaxPageState.libraries');
Chris@0:     // Test that the fake library is set.
Chris@0:     $this->assertContains($fake_library, $libraries);
Chris@0: 
Chris@0:     // Click on the AJAX link.
Chris@0:     $this->clickLink('Link 8 (ajax)');
Chris@0:     $assert->assertWaitOnAjaxRequest();
Chris@0: 
Chris@0:     // Test that the fake library is still set after the AJAX call.
Chris@0:     $libraries = $session->evaluateScript('drupalSettings.ajaxPageState.libraries');
Chris@0:     $this->assertContains($fake_library, $libraries);
Chris@0: 
Chris@0:     // Reload the page, this should reset the loaded libraries and remove the
Chris@0:     // fake library.
Chris@0:     $this->drupalGet('ajax-test/dialog');
Chris@0:     $libraries = $session->evaluateScript('drupalSettings.ajaxPageState.libraries');
Chris@0:     $this->assertNotContains($fake_library, $libraries);
Chris@0: 
Chris@0:     // Click on the AJAX link again, and the libraries should still not contain
Chris@0:     // the fake library.
Chris@0:     $this->clickLink('Link 8 (ajax)');
Chris@0:     $assert->assertWaitOnAjaxRequest();
Chris@0:     $libraries = $session->evaluateScript('drupalSettings.ajaxPageState.libraries');
Chris@0:     $this->assertNotContains($fake_library, $libraries);
Chris@0:   }
Chris@0: 
Chris@17:   /**
Chris@17:    * Tests that various AJAX responses with DOM elements are correctly inserted.
Chris@17:    *
Chris@17:    * After inserting DOM elements, Drupal JavaScript behaviors should be
Chris@17:    * reattached and all top-level elements of type Node.ELEMENT_NODE need to be
Chris@17:    * part of the context.
Chris@17:    */
Chris@17:   public function testInsertAjaxResponse() {
Chris@17:     $render_single_root = [
Chris@17:       'pre-wrapped-div' => '<div class="pre-wrapped">pre-wrapped<script> var test;</script></div>',
Chris@17:       'pre-wrapped-span' => '<span class="pre-wrapped">pre-wrapped<script> var test;</script></span>',
Chris@17:       'pre-wrapped-whitespace' => ' <div class="pre-wrapped-whitespace">pre-wrapped-whitespace</div>' . "\n",
Chris@17:       'not-wrapped' => 'not-wrapped',
Chris@17:       'comment-string-not-wrapped' => '<!-- COMMENT -->comment-string-not-wrapped',
Chris@17:       'comment-not-wrapped' => '<!-- COMMENT --><div class="comment-not-wrapped">comment-not-wrapped</div>',
Chris@17:       'svg' => '<svg xmlns="http://www.w3.org/2000/svg" width="10" height="10"><rect x="0" y="0" height="10" width="10" fill="green"/></svg>',
Chris@17:       'empty' => '',
Chris@17:     ];
Chris@17:     $render_multiple_root_unwrapper = [
Chris@17:       'mixed' => ' foo <!-- COMMENT -->  foo bar<div class="a class"><p>some string</p></div> additional not wrapped strings, <!-- ANOTHER COMMENT --> <p>final string</p>',
Chris@17:       'top-level-only' => '<div>element #1</div><div>element #2</div>',
Chris@17:       'top-level-only-pre-whitespace' => ' <div>element #1</div><div>element #2</div> ',
Chris@17:       'top-level-only-middle-whitespace-span' => '<span>element #1</span> <span>element #2</span>',
Chris@17:       'top-level-only-middle-whitespace-div' => '<div>element #1</div> <div>element #2</div>',
Chris@17:     ];
Chris@17: 
Chris@17:     // This is temporary behavior for BC reason.
Chris@17:     $render_multiple_root_wrapper = [];
Chris@17:     foreach ($render_multiple_root_unwrapper as $key => $render) {
Chris@17:       $render_multiple_root_wrapper["$key--effect"] = '<div>' . $render . '</div>';
Chris@17:     }
Chris@17: 
Chris@17:     $expected_renders = array_merge(
Chris@17:       $render_single_root,
Chris@17:       $render_multiple_root_wrapper,
Chris@17:       $render_multiple_root_unwrapper
Chris@17:     );
Chris@17: 
Chris@17:     // Checking default process of wrapping Ajax content.
Chris@17:     foreach ($expected_renders as $render_type => $expected) {
Chris@17:       $this->assertInsert($render_type, $expected);
Chris@17:     }
Chris@17: 
Chris@17:     // Checking custom ajaxWrapperMultipleRootElements wrapping.
Chris@17:     $custom_wrapper_multiple_root = <<<JS
Chris@17:     (function($, Drupal){
Chris@17:       Drupal.theme.ajaxWrapperMultipleRootElements = function (elements) {
Chris@17:         return $('<div class="my-favorite-div"></div>').append(elements);
Chris@17:       };
Chris@17:     }(jQuery, Drupal));
Chris@17: JS;
Chris@17:     $expected = '<div class="my-favorite-div"><span>element #1</span> <span>element #2</span></div>';
Chris@17:     $this->assertInsert('top-level-only-middle-whitespace-span--effect', $expected, $custom_wrapper_multiple_root);
Chris@17: 
Chris@17:     // Checking custom ajaxWrapperNewContent wrapping.
Chris@17:     $custom_wrapper_new_content = <<<JS
Chris@17:     (function($, Drupal){
Chris@17:       Drupal.theme.ajaxWrapperNewContent = function (elements) {
Chris@17:         return $('<div class="div-wrapper-forever"></div>').append(elements);
Chris@17:       };
Chris@17:     }(jQuery, Drupal));
Chris@17: JS;
Chris@17:     $expected = '<div class="div-wrapper-forever"></div>';
Chris@17:     $this->assertInsert('empty', $expected, $custom_wrapper_new_content);
Chris@17:   }
Chris@17: 
Chris@17:   /**
Chris@17:    * Assert insert.
Chris@17:    *
Chris@17:    * @param string $render_type
Chris@17:    *   Render type.
Chris@17:    * @param string $expected
Chris@17:    *   Expected result.
Chris@17:    * @param string $script
Chris@17:    *   Script for additional theming.
Chris@17:    */
Chris@17:   public function assertInsert($render_type, $expected, $script = '') {
Chris@17:     // Check insert to block element.
Chris@17:     $this->drupalGet('ajax-test/insert-block-wrapper');
Chris@17:     $this->getSession()->executeScript($script);
Chris@17:     $this->clickLink("Link html $render_type");
Chris@17:     $this->assertWaitPageContains('<div class="ajax-target-wrapper"><div id="ajax-target">' . $expected . '</div></div>');
Chris@17: 
Chris@17:     $this->drupalGet('ajax-test/insert-block-wrapper');
Chris@17:     $this->getSession()->executeScript($script);
Chris@17:     $this->clickLink("Link replaceWith $render_type");
Chris@17:     $this->assertWaitPageContains('<div class="ajax-target-wrapper">' . $expected . '</div>');
Chris@17: 
Chris@17:     // Check insert to inline element.
Chris@17:     $this->drupalGet('ajax-test/insert-inline-wrapper');
Chris@17:     $this->getSession()->executeScript($script);
Chris@17:     $this->clickLink("Link html $render_type");
Chris@17:     $this->assertWaitPageContains('<div class="ajax-target-wrapper"><span id="ajax-target-inline">' . $expected . '</span></div>');
Chris@17: 
Chris@17:     $this->drupalGet('ajax-test/insert-inline-wrapper');
Chris@17:     $this->getSession()->executeScript($script);
Chris@17:     $this->clickLink("Link replaceWith $render_type");
Chris@17:     $this->assertWaitPageContains('<div class="ajax-target-wrapper">' . $expected . '</div>');
Chris@17:   }
Chris@17: 
Chris@17:   /**
Chris@17:    * Asserts that page contains an expected value after waiting.
Chris@17:    *
Chris@17:    * @param string $expected
Chris@17:    *   A needle text.
Chris@17:    */
Chris@17:   protected function assertWaitPageContains($expected) {
Chris@17:     $page = $this->getSession()->getPage();
Chris@17:     $this->assertTrue($page->waitFor(10, function () use ($page, $expected) {
Chris@17:       // Clear content from empty styles and "processed" classes after effect.
Chris@17:       $content = str_replace([' class="processed"', ' processed', ' style=""'], '', $page->getContent());
Chris@17:       return stripos($content, $expected) !== FALSE;
Chris@17:     }), "Page contains expected value: $expected");
Chris@17:   }
Chris@17: 
Chris@0: }