Issue #3467860 by googletorp, catch, smustgrave, alexpott, swentel: Ensure... (4c3bada2) · Commits · project / drupal

core/core.libraries.yml

+1 −2

Original line number	Diff line number	Diff line
		@@ -819,8 +819,7 @@ drupal.touchevents-test:
		drupal.vertical-tabs:
		version: VERSION
		js:
		# Load before core/drupal.collapse.
		misc/vertical-tabs.js: { weight: -1 }
		misc/vertical-tabs.js: {}
		css:
		component:
		misc/vertical-tabs.css: {}

core/lib/Drupal/Core/Asset/AssetResolver.php

+65 −30

Original line number	Diff line number	Diff line
		@@ -91,31 +91,77 @@ public function __construct(LibraryDiscoveryInterface $library_discovery, Librar
		* $assets = new AttachedAssets();
		* $assets->setLibraries(['core/a', 'core/b', 'core/c']);
		* $assets->setAlreadyLoadedLibraries(['core/c']);
		* $resolver->getLibrariesToLoad($assets) === ['core/a', 'core/b', 'core/d']
		* $resolver->getLibrariesToLoad($assets, 'js') === ['core/a', 'core/b', 'core/d']
		* @endcode
		*
		* The attached assets tend to be in the order that libraries were attached
		* during a request. To minimize the number of unique aggregated asset URLs
		* and files, we normalize the list by filtering out libraries that don't
		* include the asset type being built as well as ensuring a reliable order of
		* the libraries based on their dependencies.
		*
		* @param \Drupal\Core\Asset\AttachedAssetsInterface $assets
		* The assets attached to the current response.
		* @param string\|null $asset_type
		* The asset type to load.
		*
		* @return string[]
		* A list of libraries and their dependencies, in the order they should be
		* loaded, excluding any libraries that have already been loaded.
		*/
		protected function getLibrariesToLoad(AttachedAssetsInterface $assets) {
		// The order of libraries passed in via assets can differ, so to reduce
		// variation, first normalize the requested libraries to the minimal
		// representative set before then expanding the list to include all
		// dependencies.
		protected function getLibrariesToLoad(AttachedAssetsInterface $assets, ?string $asset_type = NULL) {
		// @see Drupal\FunctionalTests\Core\Asset\AssetOptimizationTestUmami
		// @todo https://www.drupal.org/project/drupal/issues/1945262
		$libraries = $assets->getLibraries();
		if ($libraries) {
		$libraries = $this->libraryDependencyResolver->getMinimalRepresentativeSubset($libraries);
		}
		return array_diff(
		$this->libraryDependencyResolver->getLibrariesWithDependencies($libraries),
		$libraries_to_load = array_diff(
		$this->libraryDependencyResolver->getLibrariesWithDependencies($assets->getLibraries()),
		$this->libraryDependencyResolver->getLibrariesWithDependencies($assets->getAlreadyLoadedLibraries())
		);
		if ($asset_type) {
		$libraries_to_load = $this->filterLibrariesByType($libraries_to_load, $asset_type);
		}

		// We now have a complete list of libraries requested. However, this list
		// could be in any order depending on when libraries were attached during
		// the page request, which can result in different file contents and URLs
		// even for an otherwise identical set of libraries. To ensure that any
		// particular set of libraries results in the same aggregate URL, sort the
		// libraries, then generate the minimum representative set again.
		sort($libraries_to_load);
		$minimum_libraries = $this->libraryDependencyResolver->getMinimalRepresentativeSubset($libraries_to_load);
		$libraries_to_load = array_diff(
		$this->libraryDependencyResolver->getLibrariesWithDependencies($minimum_libraries),
		$this->libraryDependencyResolver->getLibrariesWithDependencies($assets->getAlreadyLoadedLibraries())
		);

		// Now remove any libraries without the relevant asset type again, since
		// they have been brought back in via dependencies.
		if ($asset_type) {
		$libraries_to_load = $this->filterLibrariesByType($libraries_to_load, $asset_type);
		}

		return $libraries_to_load;
		}

		/**
		* Filter libraries that don't contain an asset type.
		*
		* @param array $libraries
		* An array of library definitions.
		* @param string $asset_type
		* The type of asset, either 'js' or 'css'.
		*
		* @return array
		* The filtered libraries array.
		*/
		protected function filterLibrariesByType(array $libraries, string $asset_type): array {
		foreach ($libraries as $key => $library) {
		[$extension, $name] = explode('/', $library, 2);
		$definition = $this->libraryDiscovery->getLibraryByName($extension, $name);
		if (empty($definition[$asset_type])) {
		unset($libraries[$key]);
		}
		}
		return $libraries;
		}

		/**
		@@ -125,15 +171,9 @@ public function getCssAssets(AttachedAssetsInterface $assets, $optimize, ?Langua
		if (!$assets->getLibraries()) {
		return [];
		}
		$libraries_to_load = $this->getLibrariesToLoad($assets);
		foreach ($libraries_to_load as $key => $library) {
		[$extension, $name] = explode('/', $library, 2);
		$definition = $this->libraryDiscovery->getLibraryByName($extension, $name);
		if (empty($definition['css'])) {
		unset($libraries_to_load[$key]);
		}
		}
		$libraries_to_load = array_values($libraries_to_load);
		// Get the complete list of libraries to load including dependencies.
		$libraries_to_load = $this->getLibrariesToLoad($assets, 'css');

		if (!$libraries_to_load) {
		return [];
		}
		@@ -157,7 +197,7 @@ public function getCssAssets(AttachedAssetsInterface $assets, $optimize, ?Langua
		'preprocess' => TRUE,
		];

		foreach ($libraries_to_load as $key => $library) {
		foreach ($libraries_to_load as $library) {
		[$extension, $name] = explode('/', $library, 2);
		$definition = $this->libraryDiscovery->getLibraryByName($extension, $name);
		foreach ($definition['css'] as $options) {
		@@ -211,7 +251,7 @@ public function getCssAssets(AttachedAssetsInterface $assets, $optimize, ?Langua
		protected function getJsSettingsAssets(AttachedAssetsInterface $assets) {
		$settings = [];

		foreach ($this->getLibrariesToLoad($assets) as $library) {
		foreach ($this->getLibrariesToLoad($assets, 'js') as $library) {
		[$extension, $name] = explode('/', $library, 2);
		$definition = $this->libraryDiscovery->getLibraryByName($extension, $name);
		if (isset($definition['drupalSettings'])) {
		@@ -233,24 +273,19 @@ public function getJsAssets(AttachedAssetsInterface $assets, $optimize, ?Languag
		$language = $this->languageManager->getCurrentLanguage();
		}
		$theme_info = $this->themeManager->getActiveTheme();
		$libraries_to_load = $this->getLibrariesToLoad($assets);

		// Get the complete list of libraries to load including dependencies.
		$libraries_to_load = $this->getLibrariesToLoad($assets, 'js');

		// Collect all libraries that contain JS assets and are in the header.
		// Also remove any libraries with no JavaScript from the libraries to
		// load.
		$header_js_libraries = [];
		foreach ($libraries_to_load as $key => $library) {
		[$extension, $name] = explode('/', $library, 2);
		$definition = $this->libraryDiscovery->getLibraryByName($extension, $name);
		if (empty($definition['js'])) {
		unset($libraries_to_load[$key]);
		continue;
		}
		if (!empty($definition['header'])) {
		$header_js_libraries[] = $library;
		}
		}
		$libraries_to_load = array_values($libraries_to_load);

		// If all the libraries to load contained only CSS, there is nothing further
		// to do here, so return early.

core/modules/ckeditor5/ckeditor5.libraries.yml

+1 −0

Original line number	Diff line number	Diff line
		@@ -99,6 +99,7 @@ internal.drupal.ckeditor5.filter.admin:
		- core/once
		- core/drupal.ajax
		- core/drupalSettings
		- core/drupal.vertical-tabs

		internal.drupal.ckeditor5.table:
		css:

core/tests/Drupal/Tests/Core/Asset/AssetResolverTest.php

+83 −39

Original line number	Diff line number	Diff line
		@@ -8,6 +8,8 @@
		use Drupal\Core\Asset\AssetResolver;
		use Drupal\Core\Asset\AttachedAssets;
		use Drupal\Core\Asset\AttachedAssetsInterface;
		use Drupal\Core\Asset\JsCollectionGrouper;
		use Drupal\Core\Asset\LibraryDependencyResolver;
		use Drupal\Core\Cache\MemoryBackend;
		use Drupal\Core\Language\LanguageInterface;
		use Drupal\Tests\UnitTestCase;
		@@ -90,8 +92,13 @@ protected function setUp(): void {
		$this->libraryDiscovery = $this->getMockBuilder('Drupal\Core\Asset\LibraryDiscovery')
		->disableOriginalConstructor()
		->getMock();
		$this->libraryDiscovery->expects($this->any())
		->method('getLibraryByName')
		->willReturnCallback(function ($extension, $name) {
		return $this->libraries[$extension . '/' . $name];
		});
		$this->libraries = [
		'drupal' => [
		'core/drupal' => [
		'version' => '1.0.0',
		'css' => [],
		'js' =>
		@@ -100,7 +107,7 @@ protected function setUp(): void {
		],
		'license' => '',
		],
		'jquery' => [
		'core/jquery' => [
		'version' => '1.0.0',
		'css' => [],
		'js' =>
		@@ -109,7 +116,7 @@ protected function setUp(): void {
		],
		'license' => '',
		],
		'llama' => [
		'llama/css' => [
		'version' => '1.0.0',
		'css' =>
		[
		@@ -118,7 +125,7 @@ protected function setUp(): void {
		'js' => [],
		'license' => '',
		],
		'piggy' => [
		'piggy/css' => [
		'version' => '1.0.0',
		'css' =>
		[
		@@ -127,14 +134,32 @@ protected function setUp(): void {
		'js' => [],
		'license' => '',
		],
		'core/ckeditor5' => [
		'remote' => 'https://github.com/ckeditor/ckeditor5',
		'version' => '1.0.0',
		'license' => '',
		'js' => [
		'assets/vendor/ckeditor5/ckeditor5-dll/ckeditor5-dll.js' => [
		'data' => 'assets/vendor/ckeditor5/ckeditor5-dll/ckeditor5-dll.js',
		'preprocess' => FALSE,
		'minified' => TRUE,
		],
		],
		],
		'piggy/ckeditor' => [
		'version' => '1.0.0',
		'css' =>
		[
		'core/misc/ckeditor.css' => ['data' => 'core/misc/ckeditor.css'],
		],
		'js' => [],
		'license' => '',
		'dependencies' => [
		'core/ckeditor5',
		],
		],
		];
		$this->libraryDependencyResolver = $this->createMock('\Drupal\Core\Asset\LibraryDependencyResolverInterface');
		$this->libraryDependencyResolver->expects($this->any())
		->method('getLibrariesWithDependencies')
		->willReturnArgument(0);
		$this->libraryDependencyResolver->expects($this->any())
		->method('getMinimalRepresentativeSubset')
		->willReturnArgument(0);
		$this->libraryDependencyResolver = new LibraryDependencyResolver($this->libraryDiscovery);
		$this->moduleHandler = $this->createMock('\Drupal\Core\Extension\ModuleHandlerInterface');
		$this->themeManager = $this->createMock('\Drupal\Core\Theme\ThemeManagerInterface');
		$active_theme = $this->getMockBuilder('\Drupal\Core\Theme\ActiveTheme')
		@@ -169,22 +194,17 @@ protected function setUp(): void {
		* @dataProvider providerAttachedCssAssets
		*/
		public function testGetCssAssets(AttachedAssetsInterface $assets_a, AttachedAssetsInterface $assets_b, $expected_css_cache_item_count): void {
		$map = [
		['core', 'drupal', $this->libraries['drupal']],
		['core', 'jquery', $this->libraries['jquery']],
		['llama', 'css', $this->libraries['llama']],
		['piggy', 'css', $this->libraries['piggy']],
		];
		$this->libraryDiscovery->method('getLibraryByName')
		->willReturnMap($map);

		$this->libraryDiscovery->expects($this->any())
		->method('getLibraryByName')
		->willReturnCallback(function ($extension, $name) {
		return $this->libraries[$extension . '/' . $name];
		});
		$this->assetResolver->getCssAssets($assets_a, FALSE, $this->english);
		$this->assetResolver->getCssAssets($assets_b, FALSE, $this->english);
		$this->assertCount($expected_css_cache_item_count, $this->cache->getAllCids());
		}

		public static function providerAttachedCssAssets() {
		$time = time();
		return [
		'one js only library and one css only library' => [
		(new AttachedAssets())->setAlreadyLoadedLibraries([])->setLibraries(['core/drupal']),
		@@ -204,13 +224,11 @@ public static function providerAttachedCssAssets() {
		* @dataProvider providerAttachedJsAssets
		*/
		public function testGetJsAssets(AttachedAssetsInterface $assets_a, AttachedAssetsInterface $assets_b, $expected_js_cache_item_count, $expected_multilingual_js_cache_item_count): void {
		$map = [
		['core', 'drupal', $this->libraries['drupal']],
		['core', 'jquery', $this->libraries['jquery']],
		];
		$this->libraryDiscovery->method('getLibraryByName')
		->willReturnMap($map);

		$this->libraryDiscovery->expects($this->any())
		->method('getLibraryByName')
		->willReturnCallback(function ($extension, $name) {
		return $this->libraries[$extension . '/' . $name];
		});
		$this->assetResolver->getJsAssets($assets_a, FALSE, $this->english);
		$this->assetResolver->getJsAssets($assets_b, FALSE, $this->english);
		$this->assertCount($expected_js_cache_item_count, $this->cache->getAllCids());
		@@ -238,6 +256,32 @@ public static function providerAttachedJsAssets() {
		];
		}

		/**
		* Test that order of scripts are correct.
		*/
		public function testJsAssetsOrder(): void {
		$time = time();
		$assets_a = (new AttachedAssets())
		->setAlreadyLoadedLibraries([])
		->setLibraries(['core/drupal', 'core/ckeditor5', 'core/jquery', 'piggy/ckeditor'])
		->setSettings(['currentTime' => $time]);
		$assets_b = (new AttachedAssets())
		->setAlreadyLoadedLibraries([])
		->setLibraries(['piggy/ckeditor', 'core/drupal', 'core/ckeditor5', 'core/jquery'])
		->setSettings(['currentTime' => $time]);
		$js_assets_a = $this->assetResolver->getJsAssets($assets_a, FALSE, $this->english);
		$js_assets_b = $this->assetResolver->getJsAssets($assets_b, FALSE, $this->english);

		$grouper = new JsCollectionGrouper();

		$group_a = $grouper->group($js_assets_a[1]);
		$group_b = $grouper->group($js_assets_b[1]);

		foreach ($group_a as $key => $value) {
		$this->assertSame($value['items'], $group_b[$key]['items']);
		}
		}

		}

		if (!defined('CSS_AGGREGATE_DEFAULT')) {