[AssetMapper] Moving the polyfill into importmap.php for convenience

weaverryan · weaverryan · commit 9e7e935f7141 · 2023-10-03T11:31:38.000-04:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -924,8 +924,8 @@ private function addAssetMapperSection(ArrayNodeDefinition $rootNode, callable $
                             ->defaultValue('%kernel.project_dir%/importmap.php')
                         ->end()
                         ->scalarNode('importmap_polyfill')
-                            ->info('URL of the ES Module Polyfill to use, false to disable. Defaults to using a CDN URL.')
-                            ->defaultValue(null)
+                            ->info('The importmap name that will be used to load the polyfill. Set to false to disable.')
+                            ->defaultValue('es-module-shims')
                         ->end()
                         ->arrayNode('importmap_script_attributes')
                             ->info('Key-value pair of attributes to add to script tags output for the importmap.')
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1378,7 +1378,7 @@ private function registerAssetMapperConfiguration(array $config, ContainerBuilde
 
         $container
             ->getDefinition('asset_mapper.importmap.renderer')
-            ->replaceArgument(3, $config['importmap_polyfill'] ?? ImportMapManager::POLYFILL_URL)
+            ->replaceArgument(3, $config['importmap_polyfill'])
             ->replaceArgument(4, $config['importmap_script_attributes'])
         ;
     }
diff --git a/src/Symfony/Component/AssetMapper/ImportMap/ImportMapManager.php b/src/Symfony/Component/AssetMapper/ImportMap/ImportMapManager.php
@@ -24,7 +24,6 @@
  */
 class ImportMapManager
 {
-    public const POLYFILL_URL = 'https://ga.jspm.io/npm:es-module-shims@1.7.2/dist/es-module-shims.js';
     public const IMPORT_MAP_CACHE_FILENAME = 'importmap.json';
     public const ENTRYPOINT_CACHE_FILENAME_PATTERN = 'entrypoint.%s.json';
 
diff --git a/src/Symfony/Component/AssetMapper/ImportMap/ImportMapRenderer.php b/src/Symfony/Component/AssetMapper/ImportMap/ImportMapRenderer.php
@@ -25,7 +25,7 @@ public function __construct(
         private readonly ImportMapManager $importMapManager,
         private readonly ?Packages $assetPackages = null,
         private readonly string $charset = 'UTF-8',
-        private readonly string|false $polyfillUrl = ImportMapManager::POLYFILL_URL,
+        private readonly string|false $polyfillImportName = false,
         private readonly array $scriptAttributes = [],
     ) {
     }
@@ -38,6 +38,7 @@ public function render(string|array $entryPoint, array $attributes = []): string
         $importMap = [];
         $modulePreloads = [];
         $cssLinks = [];
+        $polyFillPath = null;
         foreach ($importMapData as $importName => $data) {
             $path = $data['path'];
 
@@ -46,6 +47,12 @@ public function render(string|array $entryPoint, array $attributes = []): string
                 $path = $this->assetPackages->getUrl(ltrim($path, '/'));
             }
 
+            // if this represents the polyfill, hide it from the import map
+            if ($importName === $this->polyfillImportName) {
+                $polyFillPath = $path;
+                continue;
+            }
+
             $preload = $data['preload'] ?? false;
             if ('css' !== $data['type']) {
                 $importMap[$importName] = $path;
@@ -76,8 +83,12 @@ public function render(string|array $entryPoint, array $attributes = []): string
             </script>
             HTML;
 
-        if ($this->polyfillUrl) {
-            $url = $this->escapeAttributeValue($this->polyfillUrl);
+        if (false !== $this->polyfillImportName && null === $polyFillPath) {
+            throw new \InvalidArgumentException(sprintf('The JavaScript module polyfill was not found in your import map. Either disable the polyfill or run "php bin/console importmap:require %s" to install it.', $this->polyfillImportName));
+        }
+
+        if ($polyFillPath) {
+            $url = $this->escapeAttributeValue($polyFillPath);
 
             $output .= <<<HTML
 

Original file line number	Diff line number	Diff line change
`@@ -1378,7 +1378,7 @@ private function registerAssetMapperConfiguration(array $config, ContainerBuilde`
`1378`	`1378`
`1379`	`1379`	`$container`
`1380`	`1380`	`->getDefinition('asset_mapper.importmap.renderer')`
`1381`		`- ->replaceArgument(3, $config['importmap_polyfill'] ?? ImportMapManager::POLYFILL_URL)`
	`1381`	`+ ->replaceArgument(3, $config['importmap_polyfill'])`
`1382`	`1382`	`->replaceArgument(4, $config['importmap_script_attributes'])`
`1383`	`1383`	`;`
`1384`	`1384`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,6 @@`
`24`	`24`	`*/`
`25`	`25`	`class ImportMapManager`
`26`	`26`	`{`
`27`		`- public const POLYFILL_URL = 'https://ga.jspm.io/npm:es-module-shims@1.7.2/dist/es-module-shims.js';`
`28`	`27`	`public const IMPORT_MAP_CACHE_FILENAME = 'importmap.json';`
`29`	`28`	`public const ENTRYPOINT_CACHE_FILENAME_PATTERN = 'entrypoint.%s.json';`
`30`	`29`