LibraryDiscoveryIntegrationTest.php

<?php

declare (strict_types=1);
namespace Drupal\KernelTests\Core\Asset;

use Drupal\Core\Asset\Exception\InvalidLibrariesExtendSpecificationException;
use Drupal\Core\Asset\Exception\InvalidLibrariesOverrideSpecificationException;
use Drupal\KernelTests\KernelTestBase;

/**
 * Tests the library discovery and library discovery parser.
 *
 * @group Render
 */
class LibraryDiscoveryIntegrationTest extends KernelTestBase {
    
    /**
     * The library discovery service.
     *
     * @var \Drupal\Core\Asset\LibraryDiscoveryInterface
     */
    protected $libraryDiscovery;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'theme_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->container
            ->get('theme_installer')
            ->install([
            'test_theme',
            'starterkit_theme',
        ]);
        $this->libraryDiscovery = $this->container
            ->get('library.discovery');
    }
    
    /**
     * Tests that hook_library_info is invoked and the cache is cleared.
     */
    public function testHookLibraryInfoByTheme() : void {
        // Activate test_theme and verify that the library 'kitten' is added using
        // hook_library_info_alter().
        $this->activateTheme('test_theme');
        $this->assertNotEmpty($this->libraryDiscovery
            ->getLibraryByName('test_theme', 'kitten'));
        // Now make starterkit_theme the active theme and assert that library is not
        // added.
        $this->activateTheme('starterkit_theme');
        $this->assertFalse($this->libraryDiscovery
            ->getLibraryByName('test_theme', 'kitten'));
    }
    
    /**
     * Tests that libraries-override are applied to library definitions.
     */
    public function testLibrariesOverride() : void {
        // Assert some starterkit_theme libraries that will be overridden or
        // removed.
        $this->activateTheme('starterkit_theme');
        $this->assertAssetInLibrary('core/themes/starterkit_theme/css/components/button.css', 'starterkit_theme', 'base', 'css');
        $this->assertAssetInLibrary('core/themes/starterkit_theme/css/components/container-inline.css', 'starterkit_theme', 'base', 'css');
        $this->assertAssetInLibrary('core/themes/starterkit_theme/css/components/details.css', 'starterkit_theme', 'base', 'css');
        $this->assertAssetInLibrary('core/themes/starterkit_theme/css/components/dialog.css', 'starterkit_theme', 'dialog', 'css');
        // Confirmatory assert on core library to be removed.
        $this->assertNotEmpty($this->libraryDiscovery
            ->getLibraryByName('core', 'drupal.progress'), 'Confirmatory test on "core/drupal.progress"');
        // Activate test theme that defines libraries overrides.
        $this->activateTheme('test_theme');
        // Assert that entire library was correctly overridden.
        $this->assertEquals($this->libraryDiscovery
            ->getLibraryByName('core', 'drupal.collapse'), $this->libraryDiscovery
            ->getLibraryByName('test_theme', 'collapse'), 'Entire library correctly overridden.');
        // Assert that starterkit_theme library assets were correctly overridden or
        // removed.
        $this->assertNoAssetInLibrary('core/themes/starterkit_theme/css/components/button.css', 'starterkit_theme', 'base', 'css');
        $this->assertNoAssetInLibrary('core/themes/starterkit_theme/css/components/container-inline.css', 'starterkit_theme', 'base', 'css');
        $this->assertNoAssetInLibrary('core/themes/starterkit_theme/css/components/details.css', 'starterkit_theme', 'base', 'css');
        $this->assertNoAssetInLibrary('core/themes/starterkit_theme/css/components/dialog.css', 'starterkit_theme', 'dialog', 'css');
        $this->assertAssetInLibrary('core/modules/system/tests/themes/test_theme/css/my-button.css', 'starterkit_theme', 'base', 'css');
        $this->assertAssetInLibrary('themes/my_theme/css/my-container-inline.css', 'starterkit_theme', 'base', 'css');
        $this->assertAssetInLibrary('themes/my_theme/css/my-details.css', 'starterkit_theme', 'base', 'css');
        // Assert that entire library was correctly removed.
        $this->assertFalse($this->libraryDiscovery
            ->getLibraryByName('core', 'drupal.progress'), 'Entire library correctly removed.');
        // Assert that overridden library asset still retains attributes.
        $library = $this->libraryDiscovery
            ->getLibraryByName('core', 'drupal.batch');
        $this->assertSame('core/modules/system/tests/themes/test_theme/js/collapse.js', $library['js'][0]['data']);
        $this->assertFalse($library['js'][0]['cache']);
    }
    
    /**
     * Tests libraries-override on drupalSettings.
     */
    public function testLibrariesOverrideDrupalSettings() : void {
        // Activate test theme that attempts to override drupalSettings.
        $this->activateTheme('test_theme_libraries_override_with_drupal_settings');
        // Assert that drupalSettings cannot be overridden and throws an exception.
        try {
            $this->libraryDiscovery
                ->getLibraryByName('core', 'drupal.ajax');
            $this->fail('Throw Exception when trying to override drupalSettings');
        } catch (InvalidLibrariesOverrideSpecificationException $e) {
            $expected_message = 'drupalSettings may not be overridden in libraries-override. Trying to override core/drupal.ajax/drupalSettings. Use hook_library_info_alter() instead.';
            $this->assertEquals($expected_message, $e->getMessage(), 'Throw Exception when trying to override drupalSettings');
        }
    }
    
    /**
     * Tests libraries-override on malformed assets.
     */
    public function testLibrariesOverrideMalformedAsset() : void {
        // Activate test theme that overrides with a malformed asset.
        $this->activateTheme('test_theme_libraries_override_with_invalid_asset');
        // Assert that improperly formed asset "specs" throw an exception.
        try {
            $this->libraryDiscovery
                ->getLibraryByName('core', 'drupal.dialog');
            $this->fail('Throw Exception when specifying invalid override');
        } catch (InvalidLibrariesOverrideSpecificationException $e) {
            $expected_message = 'Library asset core/drupal.dialog/css is not correctly specified. It should be in the form "extension/library_name/sub_key/path/to/asset.js".';
            $this->assertEquals($expected_message, $e->getMessage(), 'Throw Exception when specifying invalid override');
        }
    }
    
    /**
     * Tests libraries overrides with multiple parent themes.
     */
    public function testLibrariesOverridesMultiple() : void {
        
        /** @var \Drupal\Core\Extension\ThemeInstallerInterface $theme_installer */
        $theme_installer = $this->container
            ->get('theme_installer');
        $theme_installer->install([
            'test_basetheme',
        ]);
        $theme_installer->install([
            'test_subtheme',
        ]);
        $theme_installer->install([
            'test_subsubtheme',
        ]);
        
        /** @var \Drupal\Core\Theme\ThemeInitializationInterface $theme_initializer */
        $theme_initializer = $this->container
            ->get('theme.initialization');
        $active_theme = $theme_initializer->initTheme('test_subsubtheme');
        $libraries_override = $active_theme->getLibrariesOverride();
        $expected_order = [
            'core/modules/system/tests/themes/test_basetheme',
            'core/modules/system/tests/themes/test_subtheme',
            'core/modules/system/tests/themes/test_subsubtheme',
        ];
        $this->assertEquals($expected_order, array_keys($libraries_override));
    }
    
    /**
     * Tests library assets with other ways for specifying paths.
     */
    public function testLibrariesOverrideOtherAssetLibraryNames() : void {
        // Activate a test theme that defines libraries overrides on other types of
        // assets.
        $this->activateTheme('test_theme');
        // Assert Drupal-relative paths.
        $this->assertAssetInLibrary('themes/my_theme/css/dropbutton.css', 'core', 'drupal.dropbutton', 'css');
        // Assert stream wrapper paths.
        $this->assertAssetInLibrary('public://my_css/vertical-tabs.css', 'core', 'drupal.vertical-tabs', 'css');
        // Assert a protocol-relative URI.
        $this->assertAssetInLibrary('//my-server/my_theme/js/overridden.js', 'core', 'drupal.displace', 'js');
        // Assert an absolute URI.
        $this->assertAssetInLibrary('http://example.com/my_theme/js/announce.js', 'core', 'drupal.announce', 'js');
    }
    
    /**
     * Tests that base theme libraries-override still apply in sub themes.
     */
    public function testBaseThemeLibrariesOverrideInSubTheme() : void {
        // Activate a test theme that has subthemes.
        $this->activateTheme('test_subtheme');
        // Assert that libraries-override specified in the base theme still applies
        // in the sub theme.
        $this->assertNoAssetInLibrary('core/misc/dialog/dialog.js', 'core', 'drupal.dialog', 'js');
        $this->assertAssetInLibrary('core/modules/system/tests/themes/test_basetheme/js/loadjs.min.js', 'core', 'loadjs', 'js');
    }
    
    /**
     * Tests libraries-extend.
     */
    public function testLibrariesExtend() : void {
        // Simulate starterkit_theme defining the test-navigation library.
        // @see theme_test_library_info_alter()
        $this->container
            ->get('state')
            ->set('theme_test_library_info_alter starterkit_theme', [
            'test-navigation' => [
                'css' => [
                    'component' => [
                        'css/components/test-navigation.css' => [],
                    ],
                ],
            ],
        ]);
        // Activate starterkit_theme and verify the libraries are not extended.
        $this->activateTheme('starterkit_theme');
        $this->assertNoAssetInLibrary('core/modules/system/tests/themes/test_theme_libraries_extend/css/extend_1.css', 'starterkit_theme', 'test-navigation', 'css');
        $this->assertNoAssetInLibrary('core/modules/system/tests/themes/test_theme_libraries_extend/js/extend_1.js', 'starterkit_theme', 'test-navigation', 'js');
        $this->assertNoAssetInLibrary('core/modules/system/tests/themes/test_theme_libraries_extend/css/extend_2.css', 'starterkit_theme', 'test-navigation', 'css');
        // Activate the theme that extends the test-navigation library in
        // starterkit_theme.
        $this->activateTheme('test_theme_libraries_extend');
        $this->assertAssetInLibrary('core/modules/system/tests/themes/test_theme_libraries_extend/css/extend_1.css', 'starterkit_theme', 'test-navigation', 'css');
        $this->assertAssetInLibrary('core/modules/system/tests/themes/test_theme_libraries_extend/js/extend_1.js', 'starterkit_theme', 'test-navigation', 'js');
        $this->assertAssetInLibrary('core/modules/system/tests/themes/test_theme_libraries_extend/css/extend_2.css', 'starterkit_theme', 'test-navigation', 'css');
        // Activate a sub theme and confirm that it inherits the library assets
        // extended in the base theme as well as its own.
        $this->assertNoAssetInLibrary('core/modules/system/tests/themes/test_basetheme/css/base-libraries-extend.css', 'starterkit_theme', 'base', 'css');
        $this->assertNoAssetInLibrary('core/modules/system/tests/themes/test_subtheme/css/sub-libraries-extend.css', 'starterkit_theme', 'base', 'css');
        $this->activateTheme('test_subtheme');
        $this->assertAssetInLibrary('core/modules/system/tests/themes/test_basetheme/css/base-libraries-extend.css', 'starterkit_theme', 'base', 'css');
        $this->assertAssetInLibrary('core/modules/system/tests/themes/test_subtheme/css/sub-libraries-extend.css', 'starterkit_theme', 'base', 'css');
        // Activate test theme that extends with a non-existent library. An
        // exception should be thrown.
        $this->activateTheme('test_theme_libraries_extend');
        try {
            $this->libraryDiscovery
                ->getLibraryByName('core', 'drupal.dialog');
            $this->fail('Throw Exception when specifying non-existent libraries-extend.');
        } catch (InvalidLibrariesExtendSpecificationException $e) {
            $expected_message = 'The specified library "test_theme_libraries_extend/non_existent_library" does not exist.';
            $this->assertEquals($expected_message, $e->getMessage(), 'Throw Exception when specifying non-existent libraries-extend.');
        }
        // Also, test non-string libraries-extend. An exception should be thrown.
        $this->container
            ->get('theme_installer')
            ->install([
            'test_theme',
        ]);
        try {
            $this->libraryDiscovery
                ->getLibraryByName('test_theme', 'collapse');
            $this->fail('Throw Exception when specifying non-string libraries-extend.');
        } catch (InvalidLibrariesExtendSpecificationException $e) {
            $expected_message = 'The libraries-extend specification for each library must be a list of strings.';
            $this->assertEquals($expected_message, $e->getMessage(), 'Throw Exception when specifying non-string libraries-extend.');
        }
    }
    
    /**
     * Test library deprecation support.
     *
     * @group legacy
     */
    public function testDeprecatedLibrary() : void {
        $this->expectDeprecation('Targeting theme_test/moved_from css/foo.css from test_theme_with_deprecated_libraries library_overrides is deprecated in drupal:X.0.0 and will be removed in drupal:Y.0.0. Target theme_test/moved_to css/base-remove.css instead. See https://example.com');
        $this->expectDeprecation('Targeting theme_test/moved_from js/bar.js from test_theme_with_deprecated_libraries library_overrides is deprecated in drupal:X.0.0 and will be removed in drupal:Y.0.0. Target theme_test/moved_to js/foo.js instead. See https://example.com');
        $this->expectDeprecation('Theme "theme_test" is overriding a deprecated library. The "theme_test/deprecated_library" asset library is deprecated in drupal:X.0.0 and is removed from drupal:Y.0.0. Use another library instead. See https://www.example.com');
        $this->expectDeprecation('Theme "theme_test" is extending a deprecated library. The "theme_test/another_deprecated_library" asset library is deprecated in drupal:X.0.0 and is removed from drupal:Y.0.0. Use another library instead. See https://www.example.com');
        $this->expectDeprecation('The "theme_test/deprecated_library" asset library is deprecated in drupal:X.0.0 and is removed from drupal:Y.0.0. Use another library instead. See https://www.example.com');
        $this->expectDeprecation('The "theme_test/another_deprecated_library" asset library is deprecated in drupal:X.0.0 and is removed from drupal:Y.0.0. Use another library instead. See https://www.example.com');
        $this->activateTheme('test_theme_with_deprecated_libraries');
        $this->libraryDiscovery
            ->getLibraryByName('theme_test', 'moved_to');
        $this->libraryDiscovery
            ->getLibraryByName('theme_test', 'deprecated_library');
        $this->libraryDiscovery
            ->getLibraryByName('theme_test', 'another_deprecated_library');
    }
    
    /**
     * Activates a specified theme.
     *
     * Installs the theme if not already installed and makes it the active theme.
     *
     * @param string $theme_name
     *   The name of the theme to be activated.
     */
    protected function activateTheme($theme_name) {
        $this->container
            ->get('theme_installer')
            ->install([
            $theme_name,
        ]);
        
        /** @var \Drupal\Core\Theme\ThemeInitializationInterface $theme_initializer */
        $theme_initializer = $this->container
            ->get('theme.initialization');
        
        /** @var \Drupal\Core\Theme\ThemeManagerInterface $theme_manager */
        $theme_manager = $this->container
            ->get('theme.manager');
        $theme_manager->setActiveTheme($theme_initializer->getActiveThemeByName($theme_name));
        $this->libraryDiscovery
            ->clearCachedDefinitions();
        $this->assertSame($theme_name, $theme_manager->getActiveTheme()
            ->getName());
    }
    
    /**
     * Asserts that the specified asset is in the given library.
     *
     * @param string $asset
     *   The asset file with the path for the file.
     * @param string $extension
     *   The extension in which the $library is defined.
     * @param string $library_name
     *   Name of the library.
     * @param string $sub_key
     *   The library sub key where the given asset is defined.
     * @param string $message
     *   (optional) A message to display with the assertion.
     *
     * @internal
     */
    protected function assertAssetInLibrary(string $asset, string $extension, string $library_name, string $sub_key, ?string $message = NULL) : void {
        if (!isset($message)) {
            $message = sprintf('Asset %s found in library "%s/%s"', $asset, $extension, $library_name);
        }
        $library = $this->libraryDiscovery
            ->getLibraryByName($extension, $library_name);
        foreach ($library[$sub_key] as $definition) {
            if ($asset == $definition['data']) {
                return;
            }
        }
        $this->fail($message);
    }
    
    /**
     * Asserts that the specified asset is not in the given library.
     *
     * @param string $asset
     *   The asset file with the path for the file.
     * @param string $extension
     *   The extension in which the $library_name is defined.
     * @param string $library_name
     *   Name of the library.
     * @param string $sub_key
     *   The library sub key where the given asset is defined.
     * @param string $message
     *   (optional) A message to display with the assertion.
     *
     * @internal
     */
    protected function assertNoAssetInLibrary(string $asset, string $extension, string $library_name, string $sub_key, ?string $message = NULL) : void {
        if (!isset($message)) {
            $message = sprintf('Asset %s not found in library "%s/%s"', $asset, $extension, $library_name);
        }
        $library = $this->libraryDiscovery
            ->getLibraryByName($extension, $library_name);
        foreach ($library[$sub_key] as $definition) {
            if ($asset == $definition['data']) {
                $this->fail($message);
            }
        }
    }

}