Changing preload -> render_as_link_tag for CSS

weaverryan · weaverryan · commit ba79d06f5017 · 2023-09-17T20:14:26.000-04:00
diff --git a/src/Symfony/Component/AssetMapper/ImportMap/ImportMapConfigReader.php b/src/Symfony/Component/AssetMapper/ImportMap/ImportMapConfigReader.php
@@ -38,7 +38,7 @@ public function getEntries(): ImportMapEntries
 
         $entries = new ImportMapEntries();
         foreach ($importMapConfig ?? [] as $importName => $data) {
-            $validKeys = ['path', 'url', 'downloaded_to', 'type', 'preload', 'entrypoint'];
+            $validKeys = ['path', 'url', 'downloaded_to', 'type', 'preload', 'entrypoint', 'render_link_tag'];
             if ($invalidKeys = array_diff(array_keys($data), $validKeys)) {
                 throw new \InvalidArgumentException(sprintf('The following keys are not valid for the importmap entry "%s": "%s". Valid keys are: "%s".', $importName, implode('", "', $invalidKeys), implode('", "', $validKeys)));
             }
@@ -47,15 +47,33 @@ public function getEntries(): ImportMapEntries
             $isEntry = $data['entrypoint'] ?? false;
 
             if ($isEntry && ImportMapType::JS !== $type) {
-                throw new RuntimeException('The "entrypoint" option can only be used with the "js" type.');
+                throw new RuntimeException(sprintf('The "entrypoint" option can only be used with the "js" type. Found in importmap.php for key "%s"', $importName));
+            }
+
+            $preload = null;
+            // render_link_tag is an alias for preload for CSS type
+            if (isset($data['render_link_tag'])) {
+                if (ImportMapType::CSS !== $type) {
+                    throw new RuntimeException(sprintf('The "render_link_tag" option can only be used with the "css" type. Found in importmap.php for key "%s"', $importName));
+                }
+
+                $preload = $data['render_link_tag'];
+            }
+
+            if (isset($data['preload'])) {
+                if (ImportMapType::JS !== $type) {
+                    throw new RuntimeException(sprintf('The "preload" option can only be used with the "js" type. Found in importmap.php for key "%s"', $importName));
+                }
+
+                $preload = $data['preload'];
             }
 
             $entries->add(new ImportMapEntry(
                 $importName,
                 path: $data['path'] ?? $data['downloaded_to'] ?? null,
                 url: $data['url'] ?? null,
                 isDownloaded: isset($data['downloaded_to']),
-                preload: $data['preload'] ?? null,
+                preload: $preload,
                 type: $type,
                 isEntrypoint: $isEntry,
             ));
@@ -79,7 +97,8 @@ public function writeEntries(ImportMapEntries $entries): void
                 $config['url'] = $entry->url;
             }
             if ($entry->preload !== null) {
-                $config['preload'] = $entry->preload;
+                $key = ImportMapType::CSS === $entry->type ? 'render_link_tag' : 'preload';
+                $config[$key] = $entry->preload;
             }
             if (ImportMapType::JS !== $entry->type) {
                 $config['type'] = $entry->type->value;
@@ -100,9 +119,10 @@ public function writeEntries(ImportMapEntries $entries): void
          * - "path" is a path inside the asset mapper system. Use the
          *     "debug:asset-map" command to see the full list of paths.
          *
-         * - "preload"
-         *     For JavaScript: adds a modulepreload link to help the browser download it earlier.
-         *     For CSS: adds a <link rel="stylesheet"> tag for the CSS.
+         * - "entrypoint" (JavaScript only) set to true for any module that will
+         *     be used as an the "entrypoint" (and passed to the importmap() Twig function).
+         *
+         * - "render_link_tag" (CSS only) set to true to render the CSS as a <link> tag.
          *
          * The "importmap:require" command can be used to add new entries to this file.
          *
diff --git a/src/Symfony/Component/AssetMapper/Tests/Command/AssetsMapperCompileCommandTest.php b/src/Symfony/Component/AssetMapper/Tests/Command/AssetsMapperCompileCommandTest.php
@@ -89,7 +89,7 @@ public function testAssetsAreCompiled()
             '/assets/file4.js', // imported by (preload: true) file5
             'file2', // in importmap (preload: null)
             '/assets/file1.css', // imported by (preload: null) file2.js
-            'file3.css', // in importmap, (preload: true)
+            'file3.css', // in importmap, (render_link_tag: true)
             // imported by file3.css: CSS imported by CSS does not need to be in the importmap
             // 'already-abcdefVWXYZ0123456789.digested.css',
         ], array_keys($actualImportMap));
diff --git a/src/Symfony/Component/AssetMapper/Tests/ImportMap/ImportMapConfigReaderTest.php b/src/Symfony/Component/AssetMapper/Tests/ImportMap/ImportMapConfigReaderTest.php
@@ -53,6 +53,11 @@ public function testGetEntriesAndWriteEntries()
         'path' => 'styles/app.css',
         'type' => 'css',
     ],
+    'type_css_render_link_tag' => [
+        'path' => 'styles/app.css',
+        'render_link_tag' => true,
+        'type' => 'css',
+    ],
     'entry_point' => [
         'path' => 'entry.js',
         'entrypoint' => true,
@@ -66,7 +71,7 @@ public function testGetEntriesAndWriteEntries()
         $this->assertInstanceOf(ImportMapEntries::class, $entries);
         /** @var ImportMapEntry[] $allEntries */
         $allEntries = iterator_to_array($entries);
-        $this->assertCount(7, $allEntries);
+        $this->assertCount(8, $allEntries);
 
         $remotePackageEntry = $allEntries[0];
         $this->assertSame('remote_package', $remotePackageEntry->importName);
@@ -94,7 +99,10 @@ public function testGetEntriesAndWriteEntries()
         $typeCssEntry = $allEntries[5];
         $this->assertSame('css', $typeCssEntry->type->value);
 
-        $entryPointEntry = $allEntries[6];
+        $typeCssRenderAsLinkTagEntry = $allEntries[6];
+        $this->assertTrue($typeCssRenderAsLinkTagEntry->preload);
+
+        $entryPointEntry = $allEntries[7];
         $this->assertTrue($entryPointEntry->isEntrypoint);
 
         // now save the original raw data from importmap.php and delete the file
diff --git a/src/Symfony/Component/AssetMapper/Tests/fixtures/importmap.php b/src/Symfony/Component/AssetMapper/Tests/fixtures/importmap.php
@@ -30,6 +30,6 @@
     'file3.css' => [
         'path' => 'file3.css',
         'type' => 'css',
-        'preload' => true,
+        'render_link_tag' => true,
     ],
 ];
