Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/Symfony/Component/AssetMapper/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
CHANGELOG
=========

7.4
---

* Add support for loading JSON using import statements

7.3
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ protected function configure(): void
{
$this
->addArgument('name', InputArgument::OPTIONAL, 'An asset name (or a path) to search for (e.g. "app")')
->addOption('ext', null, InputOption::VALUE_REQUIRED, 'Filter assets by extension (e.g. "css")', null, ['js', 'css', 'png'])
->addOption('ext', null, InputOption::VALUE_REQUIRED, 'Filter assets by extension (e.g. "css")', null, ['js', 'css', 'json'])
->addOption('full', null, null, 'Whether to show the full paths')
->addOption('vendor', null, InputOption::VALUE_NEGATABLE, 'Only show assets from vendor packages')
->setHelp(<<<'EOT'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public function getEntries(): ImportMapEntries
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)));
}

$type = isset($data['type']) ? ImportMapType::tryFrom($data['type']) : ImportMapType::JS;
$type = ImportMapType::tryFrom($data['type'] ?? 'js') ?? ImportMapType::JS;
$isEntrypoint = $data['entrypoint'] ?? false;

if (isset($data['path'])) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ public function requirePackages(array $packagesToRequire, ImportMapEntries $impo

$newEntry = ImportMapEntry::createLocal(
$requireOptions->importName,
self::getImportMapTypeFromFilename($requireOptions->path),
ImportMapType::tryFrom(pathinfo($path, \PATHINFO_EXTENSION)) ?? ImportMapType::JS,
$path,
$requireOptions->entrypoint,
);
Expand Down Expand Up @@ -200,11 +200,6 @@ private function cleanupPackageFiles(ImportMapEntry $entry): void
}
}

private static function getImportMapTypeFromFilename(string $path): ImportMapType
{
return str_ends_with($path, '.css') ? ImportMapType::CSS : ImportMapType::JS;
}

/**
* Finds the MappedAsset allowing for a "logical path", relative or absolute filesystem path.
*/
Expand Down
39 changes: 26 additions & 13 deletions src/Symfony/Component/AssetMapper/ImportMap/ImportMapRenderer.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ class ImportMapRenderer
private const DEFAULT_ES_MODULE_SHIMS_POLYFILL_URL = 'https://ga.jspm.io/npm:es-module-shims@1.10.0/dist/es-module-shims.js';
private const DEFAULT_ES_MODULE_SHIMS_POLYFILL_INTEGRITY = 'sha384-ie1x72Xck445i0j4SlNJ5W5iGeL3Dpa0zD48MZopgWsjNB/lt60SuG1iduZGNnJn';

private const LOADER_JSON = "export default (async()=>await(await fetch('%s')).json())()";
private const LOADER_CSS = "document.head.appendChild(Object.assign(document.createElement('link'),{rel:'stylesheet',href:'%s'}))";

public function __construct(
private readonly ImportMapGenerator $importMapGenerator,
private readonly ?Packages $assetPackages = null,
Expand All @@ -48,7 +51,7 @@ public function render(string|array $entryPoint, array $attributes = []): string
$importMapData = $this->importMapGenerator->getImportMapData($entryPoint);
$importMap = [];
$modulePreloads = [];
$cssLinks = [];
$webLinks = [];
$polyfillPath = null;
foreach ($importMapData as $importName => $data) {
$path = $data['path'];
Expand All @@ -70,29 +73,34 @@ public function render(string|array $entryPoint, array $attributes = []): string
}

$preload = $data['preload'] ?? false;
if ('css' !== $data['type']) {
if ('json' === $data['type']) {
$importMap[$importName] = 'data:application/javascript,'.str_replace('%', '%25', \sprintf(self::LOADER_JSON, addslashes($path)));
if ($preload) {
$webLinks[$path] = 'fetch';
}
} elseif ('css' !== $data['type']) {
$importMap[$importName] = $path;
if ($preload) {
$modulePreloads[] = $path;
}
} elseif ($preload) {
$cssLinks[] = $path;
$webLinks[$path] = 'style';
// importmap entry is a noop
$importMap[$importName] = 'data:application/javascript,';
} else {
$importMap[$importName] = 'data:application/javascript,'.rawurlencode(\sprintf('document.head.appendChild(Object.assign(document.createElement("link"),{rel:"stylesheet",href:"%s"}))', addslashes($path)));
$importMap[$importName] = 'data:application/javascript,'.str_replace('%', '%25', \sprintf(self::LOADER_CSS, addslashes($path)));
}
}

$output = '';
foreach ($cssLinks as $url) {
$url = $this->escapeAttributeValue($url);

$output .= "\n<link rel=\"stylesheet\" href=\"$url\">";
foreach ($webLinks as $url => $as) {
if ('style' === $as) {
$output .= "\n<link rel=\"stylesheet\" href=\"{$this->escapeAttributeValue($url)}\">";
}
}

if (class_exists(AddLinkHeaderListener::class) && $request = $this->requestStack?->getCurrentRequest()) {
$this->addWebLinkPreloads($request, $cssLinks);
$this->addWebLinkPreloads($request, $webLinks);
}

$scriptAttributes = $attributes || $this->scriptAttributes ? ' '.$this->createAttributesString($attributes) : '';
Expand Down Expand Up @@ -186,12 +194,17 @@ private function createAttributesString(array $attributes, string $pattern = '%s
return $attributeString;
}

private function addWebLinkPreloads(Request $request, array $cssLinks): void
private function addWebLinkPreloads(Request $request, array $links): void
{
$cssPreloadLinks = array_map(fn ($url) => (new Link('preload', $url))->withAttribute('as', 'style'), $cssLinks);
foreach ($links as $url => $as) {
$links[$url] = (new Link('preload', $url))->withAttribute('as', $as);
if ('fetch' === $as) {
$links[$url] = $links[$url]->withAttribute('crossorigin', 'anonymous');
}
}

if (null === $linkProvider = $request->attributes->get('_links')) {
$request->attributes->set('_links', new GenericLinkProvider($cssPreloadLinks));
$request->attributes->set('_links', new GenericLinkProvider($links));

return;
}
Expand All @@ -200,7 +213,7 @@ private function addWebLinkPreloads(Request $request, array $cssLinks): void
return;
}

foreach ($cssPreloadLinks as $link) {
foreach ($links as $link) {
$linkProvider = $linkProvider->withLink($link);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ enum ImportMapType: string
{
case JS = 'js';
case CSS = 'css';
case JSON = 'json';
}
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ public function testBasicRender()
$this->assertStringContainsString('"app_css_preload": "data:application/javascript,', $html);
$this->assertStringContainsString('<link rel="stylesheet" href="/subdirectory/assets/styles/app-preload-d1g35t.css">', $html);
// non-preloaded CSS file
$this->assertStringContainsString('"app_css_no_preload": "data:application/javascript,document.head.appendChild%28Object.assign%28document.createElement%28%22link%22%29%2C%7Brel%3A%22stylesheet%22%2Chref%3A%22%2Fsubdirectory%2Fassets%2Fstyles%2Fapp-nopreload-d1g35t.css%22%7D', $html);
$this->assertStringContainsString('"app_css_no_preload": "data:application/javascript,document.head.appendChild(Object.assign(document.createElement(\'link\'),{rel:\'stylesheet\',href:\'/subdirectory/assets/styles/app-nopreload-d1g35t.css\'}))', $html);
$this->assertStringNotContainsString('<link rel="stylesheet" href="/subdirectory/assets/styles/app-nopreload-d1g35t.css">', $html);
// remote js
$this->assertStringContainsString('"remote_js": "https://cdn.example.com/assets/remote-d1g35t.js"', $html);
Expand Down
Loading