View source
<?php
namespace Drupal\FunctionalTests\Libraries;
use Drupal\Tests\BrowserTestBase;
class JqueryUiLibraryAssetsTest extends BrowserTestBase {
protected $defaultTheme = 'stark';
protected static $modules = [
'jqueryui_library_assets_test',
];
protected $libraryDiscovery;
protected $weightGroupedAssets = [];
protected $coreLibrariesWithJqueryUiAssets = [];
protected function setUp() : void {
parent::setUp();
$this->libraryDiscovery = $this->container
->get('library.discovery');
$core_libraries = $this->libraryDiscovery
->getLibrariesByExtension('core');
$libraries_to_check = [
'drupal.autocomplete',
'drupal.dialog',
];
$this->coreLibrariesWithJqueryUiAssets = array_filter($core_libraries, function ($key) use ($libraries_to_check) {
return in_array($key, $libraries_to_check);
}, ARRAY_FILTER_USE_KEY);
foreach ($this->coreLibrariesWithJqueryUiAssets as $library) {
foreach ([
'js',
'css',
] as $type) {
foreach ($library[$type] as $asset) {
$file = $asset['data'];
if (strpos($file, 'jquery.ui') === FALSE) {
continue;
}
$weight = $asset['weight'];
$this->weightGroupedAssets["{$weight}"][] = $file;
}
}
}
$this->weightGroupedAssets = array_map(function ($item) {
return array_unique($item);
}, $this->weightGroupedAssets);
ksort($this->weightGroupedAssets);
}
public function testProperlySetWeights() {
$assets = [];
foreach ($this->weightGroupedAssets as $asset_array) {
foreach ($asset_array as $asset) {
$this
->assertNotContains($asset, $assets);
$assets[] = $asset;
}
}
$necessary_loading_order = [
[
'core/assets/vendor/jquery.ui/ui/version-min.js',
],
[
'core/assets/vendor/jquery.ui/ui/data-min.js',
'core/assets/vendor/jquery.ui/ui/disable-selection-min.js',
'core/assets/vendor/jquery.ui/ui/focusable-min.js',
'core/assets/vendor/jquery.ui/ui/form-min.js',
'core/assets/vendor/jquery.ui/ui/ie-min.js',
'core/assets/vendor/jquery.ui/ui/jquery-patch-min.js',
'core/assets/vendor/jquery.ui/ui/keycode-min.js',
'core/assets/vendor/jquery.ui/ui/plugin-min.js',
'core/assets/vendor/jquery.ui/ui/safe-active-element-min.js',
'core/assets/vendor/jquery.ui/ui/safe-blur-min.js',
'core/assets/vendor/jquery.ui/ui/scroll-parent-min.js',
'core/assets/vendor/jquery.ui/ui/unique-id-min.js',
'core/assets/vendor/jquery.ui/ui/widget-min.js',
'core/assets/vendor/jquery.ui/themes/base/core.css',
],
[
'core/assets/vendor/jquery.ui/ui/widgets/autocomplete-min.js',
'core/assets/vendor/jquery.ui/ui/labels-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/menu-min.js',
'core/assets/vendor/jquery.ui/themes/base/autocomplete.css',
'core/assets/vendor/jquery.ui/themes/base/menu.css',
'core/assets/vendor/jquery.ui/ui/widgets/controlgroup-min.js',
'core/assets/vendor/jquery.ui/ui/form-reset-mixin-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/mouse-min.js',
'core/assets/vendor/jquery.ui/themes/base/controlgroup.css',
],
[
'core/assets/vendor/jquery.ui/ui/widgets/checkboxradio-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/draggable-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/resizable-min.js',
'core/assets/vendor/jquery.ui/themes/base/checkboxradio.css',
'core/assets/vendor/jquery.ui/themes/base/resizable.css',
],
[
'core/assets/vendor/jquery.ui/ui/widgets/button-min.js',
'core/assets/vendor/jquery.ui/themes/base/button.css',
],
[
'core/assets/vendor/jquery.ui/ui/widgets/dialog-min.js',
'core/assets/vendor/jquery.ui/themes/base/dialog.css',
],
[
'core/assets/vendor/jquery.ui/themes/base/theme.css',
],
];
$configured_weights = array_keys($this->weightGroupedAssets);
foreach ($necessary_loading_order as $stage => $assets) {
$assets_loaded_in_stage = $this->weightGroupedAssets[$configured_weights[$stage]];
foreach ($assets as $asset) {
$this
->assertContains($asset, $assets_loaded_in_stage);
}
}
}
public function testSameAssetSameWeight() {
$asset_weights = [];
$libraries_to_check = $this->coreLibrariesWithJqueryUiAssets;
foreach ($libraries_to_check as $library) {
foreach ([
'js',
'css',
] as $type) {
foreach ($library[$type] as $asset) {
$file = $asset['data'];
if (strpos($file, 'jquery.ui') !== FALSE) {
if (!isset($asset_weights[$file])) {
$asset_weights[$file] = $asset['weight'];
}
else {
$this
->assertEquals($asset_weights[$file], $asset['weight']);
}
}
}
}
}
}
protected function trimFilePath($path) {
$base_path_position = strpos($path, base_path());
if ($base_path_position !== FALSE) {
$path = substr_replace($path, '', $base_path_position, strlen(base_path()));
}
$query_pos = strpos($path, '?');
return $query_pos !== FALSE ? substr($path, 0, $query_pos) : $path;
}
public function testLibraryAssetLoadingOrder($library) {
$this
->drupalGet("jqueryui_library_assets_test/{$library}");
$this
->assertSession()
->statusCodeEquals(200);
$libraries = strpos($library, '|') !== FALSE ? explode('|', $library) : [
$library,
];
$files_to_check = [];
foreach ($libraries as $library_name) {
foreach ([
'css',
'js',
] as $type) {
$assets = $this->coreLibrariesWithJqueryUiAssets[$library_name][$type];
foreach ($assets as $asset) {
if (strpos($asset['data'], 'jquery.ui') !== FALSE) {
$files_to_check[$asset['data']] = TRUE;
}
}
}
}
$this
->assertNotEmpty($files_to_check);
$css = $this
->getSession()
->getPage()
->findAll('css', 'link[href*="jquery.ui"]');
$css_weight = -100;
foreach ($css as $item) {
$file = $this
->trimFilePath($item
->getAttribute('href'));
$found = FALSE;
foreach ($this->weightGroupedAssets as $key => $array) {
if (in_array($file, $array)) {
$found = TRUE;
$this
->assertGreaterThanOrEqual($css_weight, $key, "The file {$file} not loading in the expected order based on its weight value.");
$css_weight = $key;
unset($files_to_check[$file]);
}
}
$this
->assertTrue($found, "A jQuery UI file: {$file} was loaded by the page, but is not taken into account by the test.");
}
$this
->assertGreaterThan(-100, $css_weight);
$js_weight = -100;
$js = $this
->getSession()
->getPage()
->findAll('css', 'script[src*="jquery.ui"]');
foreach ($js as $item) {
$file = $this
->trimFilePath($item
->getAttribute('src'));
$found = FALSE;
foreach ($this->weightGroupedAssets as $key => $array) {
if (in_array($file, $array)) {
$found = TRUE;
$this
->assertGreaterThanOrEqual($js_weight, $key, "The file {$file} not loading in the expected order based on its weight value.");
$js_weight = $key;
unset($files_to_check[$file]);
}
}
$this
->assertTrue($found, "A jQuery UI file: {$file} was loaded by the page, but is not taken into account by the test.");
}
$this
->assertGreaterThan(-100, $js_weight);
$this
->assertEmpty($files_to_check);
}
public function testAssetLoadingUnchanged($library, array $expected_css, array $expected_js) {
$this
->drupalGet("jqueryui_library_assets_test/{$library}");
$this
->assertSession()
->statusCodeEquals(200);
$css = $this
->getSession()
->getPage()
->findAll('css', 'link[href*="jquery.ui"]');
$css_loaded_by_page = [];
foreach ($css as $item) {
$file = $this
->trimFilePath($item
->getAttribute('href'));
$css_loaded_by_page[] = $file;
}
$this
->assertEmpty(array_diff($css_loaded_by_page, $expected_css));
$js = $this
->getSession()
->getPage()
->findAll('css', 'script[src*="jquery.ui"]');
$js_loaded_by_page = [];
foreach ($js as $item) {
$file = $this
->trimFilePath($item
->getAttribute('src'));
$js_loaded_by_page[] = $file;
}
$this
->assertEmpty(array_diff($js_loaded_by_page, $expected_js));
}
public function providerTestAssetLoading() {
return [
'drupal.autocomplete' => [
'library' => 'drupal.autocomplete',
'expected_css' => [
'core/assets/vendor/jquery.ui/themes/base/core.css',
'core/assets/vendor/jquery.ui/themes/base/menu.css',
'core/assets/vendor/jquery.ui/themes/base/autocomplete.css',
'core/assets/vendor/jquery.ui/themes/base/theme.css',
],
'expected_js' => [
'core/assets/vendor/jquery.ui/ui/data-min.js',
'core/assets/vendor/jquery.ui/ui/disable-selection-min.js',
'core/assets/vendor/jquery.ui/ui/form-min.js',
'core/assets/vendor/jquery.ui/ui/labels-min.js',
'core/assets/vendor/jquery.ui/ui/jquery-patch-min.js',
'core/assets/vendor/jquery.ui/ui/scroll-parent-min.js',
'core/assets/vendor/jquery.ui/ui/unique-id-min.js',
'core/assets/vendor/jquery.ui/ui/version-min.js',
'core/assets/vendor/jquery.ui/ui/focusable-min.js',
'core/assets/vendor/jquery.ui/ui/ie-min.js',
'core/assets/vendor/jquery.ui/ui/keycode-min.js',
'core/assets/vendor/jquery.ui/ui/plugin-min.js',
'core/assets/vendor/jquery.ui/ui/safe-active-element-min.js',
'core/assets/vendor/jquery.ui/ui/safe-blur-min.js',
'core/assets/vendor/jquery.ui/ui/widget-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/menu-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/autocomplete-min.js',
],
],
'drupal.dialog' => [
'library' => 'drupal.dialog',
'expected_css' => [
'core/assets/vendor/jquery.ui/themes/base/core.css',
'core/assets/vendor/jquery.ui/themes/base/resizable.css',
'core/assets/vendor/jquery.ui/themes/base/checkboxradio.css',
'core/assets/vendor/jquery.ui/themes/base/controlgroup.css',
'core/assets/vendor/jquery.ui/themes/base/button.css',
'core/assets/vendor/jquery.ui/themes/base/dialog.css',
'core/assets/vendor/jquery.ui/themes/base/theme.css',
],
'expected_js' => [
'core/assets/vendor/jquery.ui/ui/data-min.js',
'core/assets/vendor/jquery.ui/ui/disable-selection-min.js',
'core/assets/vendor/jquery.ui/ui/form-min.js',
'core/assets/vendor/jquery.ui/ui/labels-min.js',
'core/assets/vendor/jquery.ui/ui/jquery-patch-min.js',
'core/assets/vendor/jquery.ui/ui/scroll-parent-min.js',
'core/assets/vendor/jquery.ui/ui/unique-id-min.js',
'core/assets/vendor/jquery.ui/ui/version-min.js',
'core/assets/vendor/jquery.ui/ui/focusable-min.js',
'core/assets/vendor/jquery.ui/ui/keycode-min.js',
'core/assets/vendor/jquery.ui/ui/plugin-min.js',
'core/assets/vendor/jquery.ui/ui/safe-active-element-min.js',
'core/assets/vendor/jquery.ui/ui/safe-blur-min.js',
'core/assets/vendor/jquery.ui/ui/widget-min.js',
'core/assets/vendor/jquery.ui/ui/ie-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/mouse-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/draggable-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/resizable-min.js',
'core/assets/vendor/jquery.ui/ui/form-reset-mixin-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/checkboxradio-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/controlgroup-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/button-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/dialog-min.js',
],
],
'drupal.autocomplete|drupal.dialog' => [
'library' => 'drupal.autocomplete|drupal.dialog',
'expected_css' => [
'core/assets/vendor/jquery.ui/themes/base/core.css',
'core/assets/vendor/jquery.ui/themes/base/menu.css',
'core/assets/vendor/jquery.ui/themes/base/autocomplete.css',
'core/assets/vendor/jquery.ui/themes/base/resizable.css',
'core/assets/vendor/jquery.ui/themes/base/checkboxradio.css',
'core/assets/vendor/jquery.ui/themes/base/controlgroup.css',
'core/assets/vendor/jquery.ui/themes/base/button.css',
'core/assets/vendor/jquery.ui/themes/base/dialog.css',
'core/assets/vendor/jquery.ui/themes/base/theme.css',
],
'expected_js' => [
'core/assets/vendor/jquery.ui/ui/data-min.js',
'core/assets/vendor/jquery.ui/ui/disable-selection-min.js',
'core/assets/vendor/jquery.ui/ui/form-min.js',
'core/assets/vendor/jquery.ui/ui/labels-min.js',
'core/assets/vendor/jquery.ui/ui/jquery-patch-min.js',
'core/assets/vendor/jquery.ui/ui/scroll-parent-min.js',
'core/assets/vendor/jquery.ui/ui/unique-id-min.js',
'core/assets/vendor/jquery.ui/ui/version-min.js',
'core/assets/vendor/jquery.ui/ui/focusable-min.js',
'core/assets/vendor/jquery.ui/ui/keycode-min.js',
'core/assets/vendor/jquery.ui/ui/plugin-min.js',
'core/assets/vendor/jquery.ui/ui/safe-active-element-min.js',
'core/assets/vendor/jquery.ui/ui/safe-blur-min.js',
'core/assets/vendor/jquery.ui/ui/widget-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/menu-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/autocomplete-min.js',
'core/assets/vendor/jquery.ui/ui/ie-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/mouse-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/draggable-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/resizable-min.js',
'core/assets/vendor/jquery.ui/ui/form-reset-mixin-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/checkboxradio-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/controlgroup-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/button-min.js',
'core/assets/vendor/jquery.ui/ui/widgets/dialog-min.js',
],
],
];
}
}