AttachedAssetsTest.php

<?php

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

use Drupal\Component\Serialization\Json;
use Drupal\Core\Asset\AttachedAssets;
use Drupal\KernelTests\KernelTestBase;

/**
 * Tests #attached assets: attached asset libraries and JavaScript settings.
 *
 * I.e. tests:
 *
 * @code
 * $build['#attached']['library'] = …
 * $build['#attached']['drupalSettings'] = …
 * @endcode
 *
 * @group Common
 * @group Asset
 */
class AttachedAssetsTest extends KernelTestBase {
    
    /**
     * The asset resolver service.
     *
     * @var \Drupal\Core\Asset\AssetResolverInterface
     */
    protected $assetResolver;
    
    /**
     * The renderer service.
     *
     * @var \Drupal\Core\Render\RendererInterface
     */
    protected $renderer;
    
    /**
     * The file URL generator.
     *
     * @var \Drupal\Core\File\FileUrlGeneratorInterface
     */
    protected $fileUrlGenerator;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'language',
        'common_test',
        'system',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->assetResolver = $this->container
            ->get('asset.resolver');
        $this->renderer = $this->container
            ->get('renderer');
        $this->fileUrlGenerator = $this->container
            ->get('file_url_generator');
    }
    
    /**
     * Tests that default CSS and JavaScript is empty.
     */
    public function testDefault() : void {
        $assets = new AttachedAssets();
        $this->assertEquals([], $this->assetResolver
            ->getCssAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage()), 'Default CSS is empty.');
        [
            $js_assets_header,
            $js_assets_footer,
        ] = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage());
        $this->assertEquals([], $js_assets_header, 'Default header JavaScript is empty.');
        $this->assertEquals([], $js_assets_footer, 'Default footer JavaScript is empty.');
    }
    
    /**
     * Tests non-existing libraries.
     */
    public function testLibraryUnknown() : void {
        $build['#attached']['library'][] = 'core/unknown';
        $assets = AttachedAssets::createFromRenderArray($build);
        $this->assertSame([], $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[0], 'Unknown library was not added to the page.');
    }
    
    /**
     * Tests adding a CSS and a JavaScript file.
     */
    public function testAddFiles() : void {
        $build['#attached']['library'][] = 'common_test/files';
        $assets = AttachedAssets::createFromRenderArray($build);
        $css = $this->assetResolver
            ->getCssAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage());
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $this->assertArrayHasKey('core/modules/system/tests/modules/common_test/bar.css', $css);
        $this->assertArrayHasKey('core/modules/system/tests/modules/common_test/foo.js', $js);
        $css_render_array = \Drupal::service('asset.css.collection_renderer')->render($css);
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_css = (string) $this->renderer
            ->renderInIsolation($css_render_array);
        $rendered_js = (string) $this->renderer
            ->renderInIsolation($js_render_array);
        $query_string = $this->container
            ->get('asset.query_string')
            ->get();
        $this->assertStringContainsString('<link rel="stylesheet" media="all" href="' . $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/bar.css') . '?' . $query_string . '" />', $rendered_css, 'Rendering an external CSS file.');
        $this->assertStringContainsString('<script src="' . $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/foo.js') . '?' . $query_string . '"></script>', $rendered_js, 'Rendering an external JavaScript file.');
    }
    
    /**
     * Tests adding JavaScript settings.
     */
    public function testAddJsSettings() : void {
        // Add a file in order to test default settings.
        $build['#attached']['library'][] = 'core/drupalSettings';
        $assets = AttachedAssets::createFromRenderArray($build);
        $this->assertEquals([], $assets->getSettings(), 'JavaScript settings on $assets are empty.');
        $javascript = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $this->assertArrayHasKey('currentPath', $javascript['drupalSettings']['data']['path']);
        $this->assertArrayHasKey('currentPath', $assets->getSettings()['path']);
        $assets->setSettings([
            'drupal' => 'rocks',
            'dries' => 280342800,
        ]);
        $javascript = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $this->assertEquals(280342800, $javascript['drupalSettings']['data']['dries'], 'JavaScript setting is set correctly.');
        $this->assertEquals('rocks', $javascript['drupalSettings']['data']['drupal'], 'The other JavaScript setting is set correctly.');
    }
    
    /**
     * Tests adding external CSS and JavaScript files.
     */
    public function testAddExternalFiles() : void {
        $build['#attached']['library'][] = 'common_test/external';
        $assets = AttachedAssets::createFromRenderArray($build);
        $css = $this->assetResolver
            ->getCssAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage());
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $this->assertArrayHasKey('http://example.com/stylesheet.css', $css);
        $this->assertArrayHasKey('http://example.com/script.js', $js);
        $css_render_array = \Drupal::service('asset.css.collection_renderer')->render($css);
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_css = (string) $this->renderer
            ->renderInIsolation($css_render_array);
        $rendered_js = (string) $this->renderer
            ->renderInIsolation($js_render_array);
        $this->assertStringContainsString('<link rel="stylesheet" media="all" href="http://example.com/stylesheet.css" />', $rendered_css, 'Rendering an external CSS file.');
        $this->assertStringContainsString('<script src="http://example.com/script.js"></script>', $rendered_js, 'Rendering an external JavaScript file.');
    }
    
    /**
     * Tests adding JavaScript files with additional attributes.
     */
    public function testAttributes() : void {
        $build['#attached']['library'][] = 'common_test/js-attributes';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = (string) $this->renderer
            ->renderInIsolation($js_render_array);
        $expected_1 = '<script src="http://example.com/deferred-external.js" foo="bar" defer></script>';
        $expected_2 = '<script src="' . $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/deferred-internal.js') . '?v=1" defer bar="foo"></script>';
        $this->assertStringContainsString($expected_1, $rendered_js, 'Rendered external JavaScript with correct defer and random attributes.');
        $this->assertStringContainsString($expected_2, $rendered_js, 'Rendered internal JavaScript with correct defer and random attributes.');
    }
    
    /**
     * Tests that attributes are maintained when JS aggregation is enabled.
     */
    public function testAggregatedAttributes() : void {
        $build['#attached']['library'][] = 'common_test/js-attributes';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, TRUE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = (string) $this->renderer
            ->renderInIsolation($js_render_array);
        $expected_1 = '<script src="http://example.com/deferred-external.js" foo="bar" defer></script>';
        $expected_2 = '<script src="' . $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/deferred-internal.js') . '?v=1" defer bar="foo"></script>';
        $this->assertStringContainsString($expected_1, $rendered_js, 'Rendered external JavaScript with correct defer and random attributes.');
        $this->assertStringContainsString($expected_2, $rendered_js, 'Rendered internal JavaScript with correct defer and random attributes.');
    }
    
    /**
     * Integration test for CSS/JS aggregation.
     */
    public function testAggregation() : void {
        $build['#attached']['library'][] = 'core/drupal.timezone';
        $build['#attached']['library'][] = 'core/drupal.vertical-tabs';
        $assets = AttachedAssets::createFromRenderArray($build);
        $this->assertCount(1, $this->assetResolver
            ->getCssAssets($assets, TRUE, \Drupal::languageManager()->getCurrentLanguage()), 'There is a sole aggregated CSS asset.');
        [
            $header_js,
            $footer_js,
        ] = $this->assetResolver
            ->getJsAssets($assets, TRUE, \Drupal::languageManager()->getCurrentLanguage());
        $this->assertEquals([], \Drupal::service('asset.js.collection_renderer')->render($header_js), 'There are 0 JavaScript assets in the header.');
        $rendered_footer_js = \Drupal::service('asset.js.collection_renderer')->render($footer_js);
        $this->assertCount(2, $rendered_footer_js, 'There are 2 JavaScript assets in the footer.');
        $this->assertEquals('drupal-settings-json', $rendered_footer_js[0]['#attributes']['data-drupal-selector'], 'The first of the two JavaScript assets in the footer has drupal settings.');
        $this->assertStringStartsWith(base_path(), $rendered_footer_js[1]['#attributes']['src'], 'The second of the two JavaScript assets in the footer has the sole aggregated JavaScript asset.');
    }
    
    /**
     * Tests JavaScript settings.
     */
    public function testSettings() : void {
        $build = [];
        $build['#attached']['library'][] = 'core/drupalSettings';
        // Nonsensical value to verify if it's possible to override path settings.
        $build['#attached']['drupalSettings']['path']['pathPrefix'] = 'does_not_exist';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        // Cast to string since this returns a \Drupal\Core\Render\Markup object.
        $rendered_js = (string) $this->renderer
            ->renderInIsolation($js_render_array);
        // Parse the generated drupalSettings <script> back to a PHP representation.
        $startToken = '{';
        $endToken = '}';
        $start = strpos($rendered_js, $startToken);
        $end = strrpos($rendered_js, $endToken);
        // Convert to a string, as $renderer_js is a \Drupal\Core\Render\Markup
        // object.
        $json = mb_substr($rendered_js, $start, $end - $start + 1);
        $parsed_settings = Json::decode($json);
        // Test whether the settings for core/drupalSettings are available.
        $this->assertTrue(isset($parsed_settings['path']['baseUrl']), 'drupalSettings.path.baseUrl is present.');
        $this->assertSame('does_not_exist', $parsed_settings['path']['pathPrefix'], 'drupalSettings.path.pathPrefix is present and has the correct (overridden) value.');
        $this->assertSame('', $parsed_settings['path']['currentPath'], 'drupalSettings.path.currentPath is present and has the correct value.');
        $this->assertFalse($parsed_settings['path']['currentPathIsAdmin'], 'drupalSettings.path.currentPathIsAdmin is present and has the correct value.');
        $this->assertFalse($parsed_settings['path']['isFront'], 'drupalSettings.path.isFront is present and has the correct value.');
        $this->assertSame('en', $parsed_settings['path']['currentLanguage'], 'drupalSettings.path.currentLanguage is present and has the correct value.');
        // Tests whether altering JavaScript settings via hook_js_settings_alter()
        // is working as expected.
        // @see common_test_js_settings_alter()
        $this->assertSame('☃', $parsed_settings['pluralDelimiter']);
        $this->assertSame('bar', $parsed_settings['foo']);
    }
    
    /**
     * Tests JS assets depending on the 'core/<head>' virtual library.
     */
    public function testHeaderHTML() : void {
        $build['#attached']['library'][] = 'common_test/js-header';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[0];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = (string) $this->renderer
            ->renderInIsolation($js_render_array);
        $query_string = $this->container
            ->get('asset.query_string')
            ->get();
        $this->assertStringContainsString('<script src="' . $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/header.js') . '?' . $query_string . '"></script>', $rendered_js, 'The JS asset in common_test/js-header appears in the header.');
        $this->assertStringContainsString('<script src="' . $this->fileUrlGenerator
            ->generateString('core/misc/drupal.js'), $rendered_js, 'The JS asset of the direct dependency (core/drupal) of common_test/js-header appears in the header.');
        $this->assertStringContainsString('<script src="' . $this->fileUrlGenerator
            ->generateString('core/misc/drupalSettingsLoader.js'), $rendered_js, 'The JS asset of the indirect dependency (core/drupalSettings) of common_test/js-header appears in the header.');
    }
    
    /**
     * Tests that for assets with cache = FALSE, Drupal sets preprocess = FALSE.
     */
    public function testNoCache() : void {
        $build['#attached']['library'][] = 'common_test/no-cache';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $this->assertFalse($js['core/modules/system/tests/modules/common_test/nocache.js']['preprocess'], 'Setting cache to FALSE sets preprocess to FALSE when adding JavaScript.');
    }
    
    /**
     * Tests JavaScript versioning.
     */
    public function testVersionQueryString() : void {
        $build['#attached']['library'][] = 'core/once';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = (string) $this->renderer
            ->renderInIsolation($js_render_array);
        $this->assertStringContainsString('core/assets/vendor/once/once.min.js?v=1.0.1', $rendered_js, 'JavaScript version identifiers correctly appended to URLs');
    }
    
    /**
     * Tests JavaScript and CSS asset ordering.
     */
    public function testRenderOrder() : void {
        $build['#attached']['library'][] = 'common_test/order';
        $assets = AttachedAssets::createFromRenderArray($build);
        // Construct the expected result from the regex.
        $expected_order_js = [
            "-8_1",
            "-8_2",
            "-8_3",
            "-8_4",
            // The external script.
"-5_1",
            "-3_1",
            "-3_2",
            "0_1",
            "0_2",
            "0_3",
        ];
        // Retrieve the rendered JavaScript and test against the regex.
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = (string) $this->renderer
            ->renderInIsolation($js_render_array);
        $matches = [];
        if (preg_match_all('/weight_([-0-9]+_[0-9]+)/', $rendered_js, $matches)) {
            $result = $matches[1];
        }
        else {
            $result = [];
        }
        $this->assertSame($expected_order_js, $result, 'JavaScript is added in the expected weight order.');
        // Construct the expected result from the regex.
        $expected_order_css = [
            // Base.
'base_weight_-101_1',
            'base_weight_-8_1',
            'layout_weight_-101_1',
            'base_weight_0_1',
            'base_weight_0_2',
            // Layout.
'layout_weight_-8_1',
            'component_weight_-101_1',
            'layout_weight_0_1',
            'layout_weight_0_2',
            // Component.
'component_weight_-8_1',
            'state_weight_-101_1',
            'component_weight_0_1',
            'component_weight_0_2',
            // State.
'state_weight_-8_1',
            'theme_weight_-101_1',
            'state_weight_0_1',
            'state_weight_0_2',
            // Theme.
'theme_weight_-8_1',
            'theme_weight_0_1',
            'theme_weight_0_2',
        ];
        // Retrieve the rendered CSS and test against the regex.
        $css = $this->assetResolver
            ->getCssAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage());
        $css_render_array = \Drupal::service('asset.css.collection_renderer')->render($css);
        $rendered_css = (string) $this->renderer
            ->renderInIsolation($css_render_array);
        $matches = [];
        if (preg_match_all('/([a-z]+)_weight_([-0-9]+_[0-9]+)/', $rendered_css, $matches)) {
            $result = $matches[0];
        }
        else {
            $result = [];
        }
        $this->assertSame($expected_order_css, $result, 'CSS is added in the expected weight order.');
    }
    
    /**
     * Tests rendering the JavaScript with a file's weight above jQuery's.
     */
    public function testRenderDifferentWeight() : void {
        // If a library contains assets A and B, and A is listed first, then B can
        // still make itself appear first by defining a lower weight.
        $build['#attached']['library'][] = 'core/jquery';
        $build['#attached']['library'][] = 'common_test/weight';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = (string) $this->renderer
            ->renderInIsolation($js_render_array);
        // Verify that lighter CSS assets are rendered first.
        $this->assertLessThan(strpos($rendered_js, 'first.js'), strpos($rendered_js, 'lighter.css'));
        // Verify that lighter JavaScript assets are rendered first.
        $this->assertLessThan(strpos($rendered_js, 'first.js'), strpos($rendered_js, 'lighter.js'));
        // Verify that a JavaScript file is rendered before jQuery.
        $this->assertLessThan(strpos($rendered_js, 'core/assets/vendor/jquery/jquery.min.js'), strpos($rendered_js, 'before-jquery.js'));
    }
    
    /**
     * Tests altering a JavaScript's weight via hook_js_alter().
     *
     * @see common_test_js_alter()
     */
    public function testAlter() : void {
        // Add both tableselect.js and alter.js.
        $build['#attached']['library'][] = 'core/drupal.tableselect';
        $build['#attached']['library'][] = 'common_test/hook_js_alter';
        $assets = AttachedAssets::createFromRenderArray($build);
        // Render the JavaScript, testing if alter.js was altered to be before
        // tableselect.js. See common_test_js_alter() to see where this alteration
        // takes place.
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = (string) $this->renderer
            ->renderInIsolation($js_render_array);
        // Verify that JavaScript weight is correctly altered by the alter hook.
        $this->assertLessThan(strpos($rendered_js, 'core/misc/tableselect.js'), strpos($rendered_js, 'alter.js'));
    }
    
    /**
     * Adds a JavaScript library to the page and alters it.
     *
     * @see common_test_library_info_alter()
     */
    public function testLibraryAlter() : void {
        // Verify that common_test altered the title of loadjs.
        
        /** @var \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery */
        $library_discovery = \Drupal::service('library.discovery');
        $library = $library_discovery->getLibraryByName('core', 'loadjs');
        $this->assertEquals('0.0', $library['version'], 'Registered libraries were altered.');
        // common_test_library_info_alter() also added a dependency on jQuery Form.
        $build['#attached']['library'][] = 'core/loadjs';
        $assets = AttachedAssets::createFromRenderArray($build);
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = (string) $this->renderer
            ->renderInIsolation($js_render_array);
        $this->assertStringContainsString('core/misc/jquery.form.js', (string) $rendered_js, 'Altered library dependencies are added to the page.');
    }
    
    /**
     * Dynamically defines an asset library and alters it.
     */
    public function testDynamicLibrary() : void {
        
        /** @var \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery */
        $library_discovery = \Drupal::service('library.discovery');
        // Retrieve a dynamic library definition.
        // @see common_test_library_info_build()
        \Drupal::state()->set('common_test.library_info_build_test', TRUE);
        $library_discovery->clearCachedDefinitions();
        $dynamic_library = $library_discovery->getLibraryByName('common_test', 'dynamic_library');
        $this->assertIsArray($dynamic_library);
        $this->assertArrayHasKey('version', $dynamic_library);
        $this->assertSame('1.0', $dynamic_library['version']);
        // Make sure the dynamic library definition could be altered.
        // @see common_test_library_info_alter()
        $this->assertArrayHasKey('dependencies', $dynamic_library);
        $this->assertSame([
            'core/jquery',
        ], $dynamic_library['dependencies']);
    }
    
    /**
     * Tests that multiple modules can implement libraries with the same name.
     *
     * @see common_test.library.yml
     */
    public function testLibraryNameConflicts() : void {
        
        /** @var \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery */
        $library_discovery = \Drupal::service('library.discovery');
        $loadjs = $library_discovery->getLibraryByName('common_test', 'loadjs');
        $this->assertEquals('0.1', $loadjs['version'], 'Alternative libraries can be added to the page.');
    }
    
    /**
     * Tests JavaScript files that have query strings attached get added right.
     */
    public function testAddJsFileWithQueryString() : void {
        $build['#attached']['library'][] = 'common_test/querystring';
        $assets = AttachedAssets::createFromRenderArray($build);
        $css = $this->assetResolver
            ->getCssAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage());
        $js = $this->assetResolver
            ->getJsAssets($assets, FALSE, \Drupal::languageManager()->getCurrentLanguage())[1];
        $this->assertArrayHasKey('core/modules/system/tests/modules/common_test/querystring.css?arg1=value1&arg2=value2', $css);
        $this->assertArrayHasKey('core/modules/system/tests/modules/common_test/querystring.js?arg1=value1&arg2=value2', $js);
        $css_render_array = \Drupal::service('asset.css.collection_renderer')->render($css);
        $rendered_css = (string) $this->renderer
            ->renderInIsolation($css_render_array);
        $js_render_array = \Drupal::service('asset.js.collection_renderer')->render($js);
        $rendered_js = (string) $this->renderer
            ->renderInIsolation($js_render_array);
        $query_string = $this->container
            ->get('asset.query_string')
            ->get();
        $this->assertStringContainsString('<link rel="stylesheet" media="all" href="' . str_replace('&', '&amp;', $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/querystring.css?arg1=value1&arg2=value2')) . '&amp;' . $query_string . '" />', $rendered_css, 'CSS file with query string gets version query string correctly appended..');
        $this->assertStringContainsString('<script src="' . str_replace('&', '&amp;', $this->fileUrlGenerator
            ->generateString('core/modules/system/tests/modules/common_test/querystring.js?arg1=value1&arg2=value2')) . '&amp;' . $query_string . '"></script>', $rendered_js, 'JavaScript file with query string gets version query string correctly appended.');
    }

}