namespace Drupal\FunctionalJavascriptTests\Ajax;
-use Drupal\FunctionalJavascriptTests\JavascriptTestBase;
+use Drupal\FunctionalJavascriptTests\WebDriverTestBase;
/**
* Tests AJAX responses.
*
* @group Ajax
*/
-class AjaxTest extends JavascriptTestBase {
+class AjaxTest extends WebDriverTestBase {
/**
* {@inheritdoc}
$this->assertNotContains($fake_library, $libraries);
}
+ /**
+ * Tests that various AJAX responses with DOM elements are correctly inserted.
+ *
+ * After inserting DOM elements, Drupal JavaScript behaviors should be
+ * reattached and all top-level elements of type Node.ELEMENT_NODE need to be
+ * part of the context.
+ */
+ public function testInsertAjaxResponse() {
+ $render_single_root = [
+ 'pre-wrapped-div' => '<div class="pre-wrapped">pre-wrapped<script> var test;</script></div>',
+ 'pre-wrapped-span' => '<span class="pre-wrapped">pre-wrapped<script> var test;</script></span>',
+ 'pre-wrapped-whitespace' => ' <div class="pre-wrapped-whitespace">pre-wrapped-whitespace</div>' . "\n",
+ 'not-wrapped' => 'not-wrapped',
+ 'comment-string-not-wrapped' => '<!-- COMMENT -->comment-string-not-wrapped',
+ 'comment-not-wrapped' => '<!-- COMMENT --><div class="comment-not-wrapped">comment-not-wrapped</div>',
+ '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>',
+ 'empty' => '',
+ ];
+ $render_multiple_root_unwrapper = [
+ 'mixed' => ' foo <!-- COMMENT --> foo bar<div class="a class"><p>some string</p></div> additional not wrapped strings, <!-- ANOTHER COMMENT --> <p>final string</p>',
+ 'top-level-only' => '<div>element #1</div><div>element #2</div>',
+ 'top-level-only-pre-whitespace' => ' <div>element #1</div><div>element #2</div> ',
+ 'top-level-only-middle-whitespace-span' => '<span>element #1</span> <span>element #2</span>',
+ 'top-level-only-middle-whitespace-div' => '<div>element #1</div> <div>element #2</div>',
+ ];
+
+ // This is temporary behavior for BC reason.
+ $render_multiple_root_wrapper = [];
+ foreach ($render_multiple_root_unwrapper as $key => $render) {
+ $render_multiple_root_wrapper["$key--effect"] = '<div>' . $render . '</div>';
+ }
+
+ $expected_renders = array_merge(
+ $render_single_root,
+ $render_multiple_root_wrapper,
+ $render_multiple_root_unwrapper
+ );
+
+ // Checking default process of wrapping Ajax content.
+ foreach ($expected_renders as $render_type => $expected) {
+ $this->assertInsert($render_type, $expected);
+ }
+
+ // Checking custom ajaxWrapperMultipleRootElements wrapping.
+ $custom_wrapper_multiple_root = <<<JS
+ (function($, Drupal){
+ Drupal.theme.ajaxWrapperMultipleRootElements = function (elements) {
+ return $('<div class="my-favorite-div"></div>').append(elements);
+ };
+ }(jQuery, Drupal));
+JS;
+ $expected = '<div class="my-favorite-div"><span>element #1</span> <span>element #2</span></div>';
+ $this->assertInsert('top-level-only-middle-whitespace-span--effect', $expected, $custom_wrapper_multiple_root);
+
+ // Checking custom ajaxWrapperNewContent wrapping.
+ $custom_wrapper_new_content = <<<JS
+ (function($, Drupal){
+ Drupal.theme.ajaxWrapperNewContent = function (elements) {
+ return $('<div class="div-wrapper-forever"></div>').append(elements);
+ };
+ }(jQuery, Drupal));
+JS;
+ $expected = '<div class="div-wrapper-forever"></div>';
+ $this->assertInsert('empty', $expected, $custom_wrapper_new_content);
+ }
+
+ /**
+ * Assert insert.
+ *
+ * @param string $render_type
+ * Render type.
+ * @param string $expected
+ * Expected result.
+ * @param string $script
+ * Script for additional theming.
+ */
+ public function assertInsert($render_type, $expected, $script = '') {
+ // Check insert to block element.
+ $this->drupalGet('ajax-test/insert-block-wrapper');
+ $this->getSession()->executeScript($script);
+ $this->clickLink("Link html $render_type");
+ $this->assertWaitPageContains('<div class="ajax-target-wrapper"><div id="ajax-target">' . $expected . '</div></div>');
+
+ $this->drupalGet('ajax-test/insert-block-wrapper');
+ $this->getSession()->executeScript($script);
+ $this->clickLink("Link replaceWith $render_type");
+ $this->assertWaitPageContains('<div class="ajax-target-wrapper">' . $expected . '</div>');
+
+ // Check insert to inline element.
+ $this->drupalGet('ajax-test/insert-inline-wrapper');
+ $this->getSession()->executeScript($script);
+ $this->clickLink("Link html $render_type");
+ $this->assertWaitPageContains('<div class="ajax-target-wrapper"><span id="ajax-target-inline">' . $expected . '</span></div>');
+
+ $this->drupalGet('ajax-test/insert-inline-wrapper');
+ $this->getSession()->executeScript($script);
+ $this->clickLink("Link replaceWith $render_type");
+ $this->assertWaitPageContains('<div class="ajax-target-wrapper">' . $expected . '</div>');
+ }
+
+ /**
+ * Asserts that page contains an expected value after waiting.
+ *
+ * @param string $expected
+ * A needle text.
+ */
+ protected function assertWaitPageContains($expected) {
+ $page = $this->getSession()->getPage();
+ $this->assertTrue($page->waitFor(10, function () use ($page, $expected) {
+ // Clear content from empty styles and "processed" classes after effect.
+ $content = str_replace([' class="processed"', ' processed', ' style=""'], '', $page->getContent());
+ return stripos($content, $expected) !== FALSE;
+ }), "Page contains expected value: $expected");
+ }
+
}