AttachedAssetsTest.php 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481
  1. <?php
  2. namespace Drupal\KernelTests\Core\Asset;
  3. use Drupal\Component\Serialization\Json;
  4. use Drupal\Component\Utility\Unicode;
  5. use Drupal\Core\Asset\AttachedAssets;
  6. use Drupal\KernelTests\KernelTestBase;
  7. /**
  8. * Tests #attached assets: attached asset libraries and JavaScript settings.
  9. *
  10. * i.e. tests:
  11. *
  12. * @code
  13. * $build['#attached']['library'] = …
  14. * $build['#attached']['drupalSettings'] = …
  15. * @endcode
  16. *
  17. * @group Common
  18. * @group Asset
  19. */
  20. class AttachedAssetsTest extends KernelTestBase {
  21. /**
  22. * The asset resolver service.
  23. *
  24. * @var \Drupal\Core\Asset\AssetResolverInterface
  25. */
  26. protected $assetResolver;
  27. /**
  28. * The renderer service.
  29. *
  30. * @var \Drupal\Core\Render\RendererInterface
  31. */
  32. protected $renderer;
  33. /**
  34. * {@inheritdoc}
  35. */
  36. public static $modules = ['language', 'simpletest', 'common_test', 'system'];
  37. /**
  38. * {@inheritdoc}
  39. */
  40. protected function setUp() {
  41. parent::setUp();
  42. $this->container->get('router.builder')->rebuild();
  43. $this->assetResolver = $this->container->get('asset.resolver');
  44. $this->renderer = $this->container->get('renderer');
  45. }
  46. /**
  47. * Tests that default CSS and JavaScript is empty.
  48. */
  49. public function testDefault() {
  50. $assets = new AttachedAssets();
  51. $this->assertEqual([], $this->assetResolver->getCssAssets($assets, FALSE), 'Default CSS is empty.');
  52. list($js_assets_header, $js_assets_footer) = $this->assetResolver->getJsAssets($assets, FALSE);
  53. $this->assertEqual([], $js_assets_header, 'Default header JavaScript is empty.');
  54. $this->assertEqual([], $js_assets_footer, 'Default footer JavaScript is empty.');
  55. }
  56. /**
  57. * Tests non-existing libraries.
  58. */
  59. public function testLibraryUnknown() {
  60. $build['#attached']['library'][] = 'core/unknown';
  61. $assets = AttachedAssets::createFromRenderArray($build);
  62. $this->assertSame([], $this->assetResolver->getJsAssets($assets, FALSE)[0], 'Unknown library was not added to the page.');
  63. }
  64. /**
  65. * Tests adding a CSS and a JavaScript file.
  66. */
  67. public function testAddFiles() {
  68. $build['#attached']['library'][] = 'common_test/files';
  69. $assets = AttachedAssets::createFromRenderArray($build);
  70. $css = $this->assetResolver->getCssAssets($assets, FALSE);
  71. $js = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  72. $this->assertTrue(array_key_exists('core/modules/system/tests/modules/common_test/bar.css', $css), 'CSS files are correctly added.');
  73. $this->assertTrue(array_key_exists('core/modules/system/tests/modules/common_test/foo.js', $js), 'JavaScript files are correctly added.');
  74. $css_render_array = \Drupal::service('asset.css.collection_renderer')->render($css);
  75. $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
  76. $rendered_css = $this->renderer->renderPlain($css_render_array);
  77. $rendered_js = $this->renderer->renderPlain($js_render_array);
  78. $query_string = $this->container->get('state')->get('system.css_js_query_string') ?: '0';
  79. $this->assertNotIdentical(strpos($rendered_css, '<link rel="stylesheet" href="' . file_url_transform_relative(file_create_url('core/modules/system/tests/modules/common_test/bar.css')) . '?' . $query_string . '" media="all" />'), FALSE, 'Rendering an external CSS file.');
  80. $this->assertNotIdentical(strpos($rendered_js, '<script src="' . file_url_transform_relative(file_create_url('core/modules/system/tests/modules/common_test/foo.js')) . '?' . $query_string . '"></script>'), FALSE, 'Rendering an external JavaScript file.');
  81. }
  82. /**
  83. * Tests adding JavaScript settings.
  84. */
  85. public function testAddJsSettings() {
  86. // Add a file in order to test default settings.
  87. $build['#attached']['library'][] = 'core/drupalSettings';
  88. $assets = AttachedAssets::createFromRenderArray($build);
  89. $this->assertEqual([], $assets->getSettings(), 'JavaScript settings on $assets are empty.');
  90. $javascript = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  91. $this->assertTrue(array_key_exists('currentPath', $javascript['drupalSettings']['data']['path']), 'The current path JavaScript setting is set correctly.');
  92. $this->assertTrue(array_key_exists('currentPath', $assets->getSettings()['path']), 'JavaScript settings on $assets are resolved after retrieving JavaScript assets, and are equal to the returned JavaScript settings.');
  93. $assets->setSettings(['drupal' => 'rocks', 'dries' => 280342800]);
  94. $javascript = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  95. $this->assertEqual(280342800, $javascript['drupalSettings']['data']['dries'], 'JavaScript setting is set correctly.');
  96. $this->assertEqual('rocks', $javascript['drupalSettings']['data']['drupal'], 'The other JavaScript setting is set correctly.');
  97. }
  98. /**
  99. * Tests adding external CSS and JavaScript files.
  100. */
  101. public function testAddExternalFiles() {
  102. $build['#attached']['library'][] = 'common_test/external';
  103. $assets = AttachedAssets::createFromRenderArray($build);
  104. $css = $this->assetResolver->getCssAssets($assets, FALSE);
  105. $js = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  106. $this->assertTrue(array_key_exists('http://example.com/stylesheet.css', $css), 'External CSS files are correctly added.');
  107. $this->assertTrue(array_key_exists('http://example.com/script.js', $js), 'External JavaScript files are correctly added.');
  108. $css_render_array = \Drupal::service('asset.css.collection_renderer')->render($css);
  109. $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
  110. $rendered_css = $this->renderer->renderPlain($css_render_array);
  111. $rendered_js = $this->renderer->renderPlain($js_render_array);
  112. $this->assertNotIdentical(strpos($rendered_css, '<link rel="stylesheet" href="http://example.com/stylesheet.css" media="all" />'), FALSE, 'Rendering an external CSS file.');
  113. $this->assertNotIdentical(strpos($rendered_js, '<script src="http://example.com/script.js"></script>'), FALSE, 'Rendering an external JavaScript file.');
  114. }
  115. /**
  116. * Tests adding JavaScript files with additional attributes.
  117. */
  118. public function testAttributes() {
  119. $build['#attached']['library'][] = 'common_test/js-attributes';
  120. $assets = AttachedAssets::createFromRenderArray($build);
  121. $js = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  122. $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
  123. $rendered_js = $this->renderer->renderPlain($js_render_array);
  124. $expected_1 = '<script src="http://example.com/deferred-external.js" foo="bar" defer></script>';
  125. $expected_2 = '<script src="' . file_url_transform_relative(file_create_url('core/modules/system/tests/modules/common_test/deferred-internal.js')) . '?v=1" defer bar="foo"></script>';
  126. $this->assertNotIdentical(strpos($rendered_js, $expected_1), FALSE, 'Rendered external JavaScript with correct defer and random attributes.');
  127. $this->assertNotIdentical(strpos($rendered_js, $expected_2), FALSE, 'Rendered internal JavaScript with correct defer and random attributes.');
  128. }
  129. /**
  130. * Tests that attributes are maintained when JS aggregation is enabled.
  131. */
  132. public function testAggregatedAttributes() {
  133. $build['#attached']['library'][] = 'common_test/js-attributes';
  134. $assets = AttachedAssets::createFromRenderArray($build);
  135. $js = $this->assetResolver->getJsAssets($assets, TRUE)[1];
  136. $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
  137. $rendered_js = $this->renderer->renderPlain($js_render_array);
  138. $expected_1 = '<script src="http://example.com/deferred-external.js" foo="bar" defer></script>';
  139. $expected_2 = '<script src="' . file_url_transform_relative(file_create_url('core/modules/system/tests/modules/common_test/deferred-internal.js')) . '?v=1" defer bar="foo"></script>';
  140. $this->assertNotIdentical(strpos($rendered_js, $expected_1), FALSE, 'Rendered external JavaScript with correct defer and random attributes.');
  141. $this->assertNotIdentical(strpos($rendered_js, $expected_2), FALSE, 'Rendered internal JavaScript with correct defer and random attributes.');
  142. }
  143. /**
  144. * Integration test for CSS/JS aggregation.
  145. */
  146. public function testAggregation() {
  147. $build['#attached']['library'][] = 'core/drupal.timezone';
  148. $build['#attached']['library'][] = 'core/drupal.vertical-tabs';
  149. $assets = AttachedAssets::createFromRenderArray($build);
  150. $this->assertEqual(1, count($this->assetResolver->getCssAssets($assets, TRUE)), 'There is a sole aggregated CSS asset.');
  151. list($header_js, $footer_js) = $this->assetResolver->getJsAssets($assets, TRUE);
  152. $this->assertEqual([], \Drupal::service('asset.js.collection_renderer')->render($header_js), 'There are 0 JavaScript assets in the header.');
  153. $rendered_footer_js = \Drupal::service('asset.js.collection_renderer')->render($footer_js);
  154. $this->assertEqual(2, count($rendered_footer_js), 'There are 2 JavaScript assets in the footer.');
  155. $this->assertEqual('drupal-settings-json', $rendered_footer_js[0]['#attributes']['data-drupal-selector'], 'The first of the two JavaScript assets in the footer has drupal settings.');
  156. $this->assertEqual(0, strpos($rendered_footer_js[1]['#attributes']['src'], base_path()), 'The second of the two JavaScript assets in the footer has the sole aggregated JavaScript asset.');
  157. }
  158. /**
  159. * Tests JavaScript settings.
  160. */
  161. public function testSettings() {
  162. $build = [];
  163. $build['#attached']['library'][] = 'core/drupalSettings';
  164. // Nonsensical value to verify if it's possible to override path settings.
  165. $build['#attached']['drupalSettings']['path']['pathPrefix'] = 'yarhar';
  166. $assets = AttachedAssets::createFromRenderArray($build);
  167. $js = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  168. $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
  169. // Cast to string since this returns a \Drupal\Core\Render\Markup object.
  170. $rendered_js = (string) $this->renderer->renderPlain($js_render_array);
  171. // Parse the generated drupalSettings <script> back to a PHP representation.
  172. $startToken = '{';
  173. $endToken = '}';
  174. $start = strpos($rendered_js, $startToken);
  175. $end = strrpos($rendered_js, $endToken);
  176. // Convert to a string, as $renderer_js is a \Drupal\Core\Render\Markup
  177. // object.
  178. $json = Unicode::substr($rendered_js, $start, $end - $start + 1);
  179. $parsed_settings = Json::decode($json);
  180. // Test whether the settings for core/drupalSettings are available.
  181. $this->assertTrue(isset($parsed_settings['path']['baseUrl']), 'drupalSettings.path.baseUrl is present.');
  182. $this->assertIdentical($parsed_settings['path']['pathPrefix'], 'yarhar', 'drupalSettings.path.pathPrefix is present and has the correct (overridden) value.');
  183. $this->assertIdentical($parsed_settings['path']['currentPath'], '', 'drupalSettings.path.currentPath is present and has the correct value.');
  184. $this->assertIdentical($parsed_settings['path']['currentPathIsAdmin'], FALSE, 'drupalSettings.path.currentPathIsAdmin is present and has the correct value.');
  185. $this->assertIdentical($parsed_settings['path']['isFront'], FALSE, 'drupalSettings.path.isFront is present and has the correct value.');
  186. $this->assertIdentical($parsed_settings['path']['currentLanguage'], 'en', 'drupalSettings.path.currentLanguage is present and has the correct value.');
  187. // Tests whether altering JavaScript settings via hook_js_settings_alter()
  188. // is working as expected.
  189. // @see common_test_js_settings_alter()
  190. $this->assertIdentical($parsed_settings['pluralDelimiter'], '☃');
  191. $this->assertIdentical($parsed_settings['foo'], 'bar');
  192. }
  193. /**
  194. * Tests JS assets depending on the 'core/<head>' virtual library.
  195. */
  196. public function testHeaderHTML() {
  197. $build['#attached']['library'][] = 'common_test/js-header';
  198. $assets = AttachedAssets::createFromRenderArray($build);
  199. $js = $this->assetResolver->getJsAssets($assets, FALSE)[0];
  200. $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
  201. $rendered_js = $this->renderer->renderPlain($js_render_array);
  202. $query_string = $this->container->get('state')->get('system.css_js_query_string') ?: '0';
  203. $this->assertNotIdentical(strpos($rendered_js, '<script src="' . file_url_transform_relative(file_create_url('core/modules/system/tests/modules/common_test/header.js')) . '?' . $query_string . '"></script>'), FALSE, 'The JS asset in common_test/js-header appears in the header.');
  204. $this->assertNotIdentical(strpos($rendered_js, '<script src="' . file_url_transform_relative(file_create_url('core/misc/drupal.js'))), FALSE, 'The JS asset of the direct dependency (core/drupal) of common_test/js-header appears in the header.');
  205. $this->assertNotIdentical(strpos($rendered_js, '<script src="' . file_url_transform_relative(file_create_url('core/assets/vendor/domready/ready.min.js'))), FALSE, 'The JS asset of the indirect dependency (core/domready) of common_test/js-header appears in the header.');
  206. }
  207. /**
  208. * Tests that for assets with cache = FALSE, Drupal sets preprocess = FALSE.
  209. */
  210. public function testNoCache() {
  211. $build['#attached']['library'][] = 'common_test/no-cache';
  212. $assets = AttachedAssets::createFromRenderArray($build);
  213. $js = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  214. $this->assertFalse($js['core/modules/system/tests/modules/common_test/nocache.js']['preprocess'], 'Setting cache to FALSE sets preprocess to FALSE when adding JavaScript.');
  215. }
  216. /**
  217. * Tests adding JavaScript within conditional comments.
  218. *
  219. * @see \Drupal\Core\Render\Element\HtmlTag::preRenderConditionalComments()
  220. */
  221. public function testBrowserConditionalComments() {
  222. $default_query_string = $this->container->get('state')->get('system.css_js_query_string') ?: '0';
  223. $build['#attached']['library'][] = 'common_test/browsers';
  224. $assets = AttachedAssets::createFromRenderArray($build);
  225. $js = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  226. $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
  227. $rendered_js = $this->renderer->renderPlain($js_render_array);
  228. $expected_1 = "<!--[if lte IE 8]>\n" . '<script src="' . file_url_transform_relative(file_create_url('core/modules/system/tests/modules/common_test/old-ie.js')) . '?' . $default_query_string . '"></script>' . "\n<![endif]-->";
  229. $expected_2 = "<!--[if !IE]><!-->\n" . '<script src="' . file_url_transform_relative(file_create_url('core/modules/system/tests/modules/common_test/no-ie.js')) . '?' . $default_query_string . '"></script>' . "\n<!--<![endif]-->";
  230. $this->assertNotIdentical(strpos($rendered_js, $expected_1), FALSE, 'Rendered JavaScript within downlevel-hidden conditional comments.');
  231. $this->assertNotIdentical(strpos($rendered_js, $expected_2), FALSE, 'Rendered JavaScript within downlevel-revealed conditional comments.');
  232. }
  233. /**
  234. * Tests JavaScript versioning.
  235. */
  236. public function testVersionQueryString() {
  237. $build['#attached']['library'][] = 'core/backbone';
  238. $build['#attached']['library'][] = 'core/domready';
  239. $assets = AttachedAssets::createFromRenderArray($build);
  240. $js = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  241. $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
  242. $rendered_js = $this->renderer->renderPlain($js_render_array);
  243. $this->assertTrue(strpos($rendered_js, 'core/assets/vendor/backbone/backbone-min.js?v=1.2.3') > 0 && strpos($rendered_js, 'core/assets/vendor/domready/ready.min.js?v=1.0.8') > 0, 'JavaScript version identifiers correctly appended to URLs');
  244. }
  245. /**
  246. * Tests JavaScript and CSS asset ordering.
  247. */
  248. public function testRenderOrder() {
  249. $build['#attached']['library'][] = 'common_test/order';
  250. $assets = AttachedAssets::createFromRenderArray($build);
  251. // Construct the expected result from the regex.
  252. $expected_order_js = [
  253. "-8_1",
  254. "-8_2",
  255. "-8_3",
  256. "-8_4",
  257. // The external script.
  258. "-5_1",
  259. "-3_1",
  260. "-3_2",
  261. "0_1",
  262. "0_2",
  263. "0_3",
  264. ];
  265. // Retrieve the rendered JavaScript and test against the regex.
  266. $js = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  267. $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
  268. $rendered_js = $this->renderer->renderPlain($js_render_array);
  269. $matches = [];
  270. if (preg_match_all('/weight_([-0-9]+_[0-9]+)/', $rendered_js, $matches)) {
  271. $result = $matches[1];
  272. }
  273. else {
  274. $result = [];
  275. }
  276. $this->assertIdentical($result, $expected_order_js, 'JavaScript is added in the expected weight order.');
  277. // Construct the expected result from the regex.
  278. $expected_order_css = [
  279. // Base.
  280. 'base_weight_-101_1',
  281. 'base_weight_-8_1',
  282. 'layout_weight_-101_1',
  283. 'base_weight_0_1',
  284. 'base_weight_0_2',
  285. // Layout.
  286. 'layout_weight_-8_1',
  287. 'component_weight_-101_1',
  288. 'layout_weight_0_1',
  289. 'layout_weight_0_2',
  290. // Component.
  291. 'component_weight_-8_1',
  292. 'state_weight_-101_1',
  293. 'component_weight_0_1',
  294. 'component_weight_0_2',
  295. // State.
  296. 'state_weight_-8_1',
  297. 'theme_weight_-101_1',
  298. 'state_weight_0_1',
  299. 'state_weight_0_2',
  300. // Theme.
  301. 'theme_weight_-8_1',
  302. 'theme_weight_0_1',
  303. 'theme_weight_0_2',
  304. ];
  305. // Retrieve the rendered CSS and test against the regex.
  306. $css = $this->assetResolver->getCssAssets($assets, FALSE);
  307. $css_render_array = \Drupal::service('asset.css.collection_renderer')->render($css);
  308. $rendered_css = $this->renderer->renderPlain($css_render_array);
  309. $matches = [];
  310. if (preg_match_all('/([a-z]+)_weight_([-0-9]+_[0-9]+)/', $rendered_css, $matches)) {
  311. $result = $matches[0];
  312. }
  313. else {
  314. $result = [];
  315. }
  316. $this->assertIdentical($result, $expected_order_css, 'CSS is added in the expected weight order.');
  317. }
  318. /**
  319. * Tests rendering the JavaScript with a file's weight above jQuery's.
  320. */
  321. public function testRenderDifferentWeight() {
  322. // If a library contains assets A and B, and A is listed first, then B can
  323. // still make itself appear first by defining a lower weight.
  324. $build['#attached']['library'][] = 'core/jquery';
  325. $build['#attached']['library'][] = 'common_test/weight';
  326. $assets = AttachedAssets::createFromRenderArray($build);
  327. $js = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  328. $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
  329. $rendered_js = $this->renderer->renderPlain($js_render_array);
  330. $this->assertTrue(strpos($rendered_js, 'lighter.css') < strpos($rendered_js, 'first.js'), 'Lighter CSS assets are rendered first.');
  331. $this->assertTrue(strpos($rendered_js, 'lighter.js') < strpos($rendered_js, 'first.js'), 'Lighter JavaScript assets are rendered first.');
  332. $this->assertTrue(strpos($rendered_js, 'before-jquery.js') < strpos($rendered_js, 'core/assets/vendor/jquery/jquery.min.js'), 'Rendering a JavaScript file above jQuery.');
  333. }
  334. /**
  335. * Tests altering a JavaScript's weight via hook_js_alter().
  336. *
  337. * @see simpletest_js_alter()
  338. */
  339. public function testAlter() {
  340. // Add both tableselect.js and simpletest.js.
  341. $build['#attached']['library'][] = 'core/drupal.tableselect';
  342. $build['#attached']['library'][] = 'simpletest/drupal.simpletest';
  343. $assets = AttachedAssets::createFromRenderArray($build);
  344. // Render the JavaScript, testing if simpletest.js was altered to be before
  345. // tableselect.js. See simpletest_js_alter() to see where this alteration
  346. // takes place.
  347. $js = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  348. $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
  349. $rendered_js = $this->renderer->renderPlain($js_render_array);
  350. $this->assertTrue(strpos($rendered_js, 'simpletest.js') < strpos($rendered_js, 'core/misc/tableselect.js'), 'Altering JavaScript weight through the alter hook.');
  351. }
  352. /**
  353. * Adds a JavaScript library to the page and alters it.
  354. *
  355. * @see common_test_library_info_alter()
  356. */
  357. public function testLibraryAlter() {
  358. // Verify that common_test altered the title of Farbtastic.
  359. /** @var \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery */
  360. $library_discovery = \Drupal::service('library.discovery');
  361. $library = $library_discovery->getLibraryByName('core', 'jquery.farbtastic');
  362. $this->assertEqual($library['version'], '0.0', 'Registered libraries were altered.');
  363. // common_test_library_info_alter() also added a dependency on jQuery Form.
  364. $build['#attached']['library'][] = 'core/jquery.farbtastic';
  365. $assets = AttachedAssets::createFromRenderArray($build);
  366. $js = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  367. $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
  368. $rendered_js = $this->renderer->renderPlain($js_render_array);
  369. $this->assertTrue(strpos($rendered_js, 'core/assets/vendor/jquery-form/jquery.form.min.js'), 'Altered library dependencies are added to the page.');
  370. }
  371. /**
  372. * Dynamically defines an asset library and alters it.
  373. */
  374. public function testDynamicLibrary() {
  375. /** @var \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery */
  376. $library_discovery = \Drupal::service('library.discovery');
  377. // Retrieve a dynamic library definition.
  378. // @see common_test_library_info_build()
  379. \Drupal::state()->set('common_test.library_info_build_test', TRUE);
  380. $library_discovery->clearCachedDefinitions();
  381. $dynamic_library = $library_discovery->getLibraryByName('common_test', 'dynamic_library');
  382. $this->assertTrue(is_array($dynamic_library));
  383. if ($this->assertTrue(isset($dynamic_library['version']))) {
  384. $this->assertSame('1.0', $dynamic_library['version']);
  385. }
  386. // Make sure the dynamic library definition could be altered.
  387. // @see common_test_library_info_alter()
  388. if ($this->assertTrue(isset($dynamic_library['dependencies']))) {
  389. $this->assertSame(['core/jquery'], $dynamic_library['dependencies']);
  390. }
  391. }
  392. /**
  393. * Tests that multiple modules can implement libraries with the same name.
  394. *
  395. * @see common_test.library.yml
  396. */
  397. public function testLibraryNameConflicts() {
  398. /** @var \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery */
  399. $library_discovery = \Drupal::service('library.discovery');
  400. $farbtastic = $library_discovery->getLibraryByName('common_test', 'jquery.farbtastic');
  401. $this->assertEqual($farbtastic['version'], '0.1', 'Alternative libraries can be added to the page.');
  402. }
  403. /**
  404. * Tests JavaScript files that have querystrings attached get added right.
  405. */
  406. public function testAddJsFileWithQueryString() {
  407. $build['#attached']['library'][] = 'common_test/querystring';
  408. $assets = AttachedAssets::createFromRenderArray($build);
  409. $css = $this->assetResolver->getCssAssets($assets, FALSE);
  410. $js = $this->assetResolver->getJsAssets($assets, FALSE)[1];
  411. $this->assertTrue(array_key_exists('core/modules/system/tests/modules/common_test/querystring.css?arg1=value1&arg2=value2', $css), 'CSS file with query string is correctly added.');
  412. $this->assertTrue(array_key_exists('core/modules/system/tests/modules/common_test/querystring.js?arg1=value1&arg2=value2', $js), 'JavaScript file with query string is correctly added.');
  413. $css_render_array = \Drupal::service('asset.css.collection_renderer')->render($css);
  414. $rendered_css = $this->renderer->renderPlain($css_render_array);
  415. $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
  416. $rendered_js = $this->renderer->renderPlain($js_render_array);
  417. $query_string = $this->container->get('state')->get('system.css_js_query_string') ?: '0';
  418. $this->assertNotIdentical(strpos($rendered_css, '<link rel="stylesheet" href="' . str_replace('&', '&amp;', file_url_transform_relative(file_create_url('core/modules/system/tests/modules/common_test/querystring.css?arg1=value1&arg2=value2'))) . '&amp;' . $query_string . '" media="all" />'), FALSE, 'CSS file with query string gets version query string correctly appended..');
  419. $this->assertNotIdentical(strpos($rendered_js, '<script src="' . str_replace('&', '&amp;', file_url_transform_relative(file_create_url('core/modules/system/tests/modules/common_test/querystring.js?arg1=value1&arg2=value2'))) . '&amp;' . $query_string . '"></script>'), FALSE, 'JavaScript file with query string gets version query string correctly appended.');
  420. }
  421. }