Skip to content

[StaticWebAssets] Generate Link elements based on StaticWebAssets manifest properties #47915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Apr 3, 2025
Merged

[StaticWebAssets] Generate Link elements based on StaticWebAssets manifest properties #47915

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
e1b1f8f
Rewrite placeholder in HTML
maraf Mar 26, 2025
c1fe239
Use only value
maraf Mar 27, 2025
1c88391
Fix link element generation
maraf Mar 27, 2025
3c17f31
Ordered DependsOn properties to allow to hook in
maraf Mar 27, 2025
4a88cef
Add test on VanillaWasm app
maraf Mar 27, 2025
9b4817d
Optional filter by group
maraf Apr 1, 2025
a797228
More StringBuilder
maraf Apr 1, 2025
946576b
Tests for regexes
maraf Apr 1, 2025
e834aff
Feedback
maraf Apr 2, 2025
9929660
One more test case
maraf Apr 2, 2025
c9edacb
Rename
maraf Apr 2, 2025
e58f4a2
Rename 2
maraf Apr 2, 2025
52bbe4e
Consider order to be a number
maraf Apr 2, 2025
b16bc00
Fix
maraf Apr 2, 2025
d391f9c
Rename 3
maraf Apr 2, 2025
e456ef2
Update test to include preload group
maraf Apr 2, 2025
6fe643c
Workaround before runtime knows about the rename
maraf Apr 2, 2025
ad70433
Fix to allow multiple whitespaces between attributes. More tests
maraf Apr 3, 2025
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
96 changes: 48 additions & 48 deletions ...Sdk.StaticWebAssets.HtmlImportMap.targets → ...icWebAssets.HtmlAssetPlaceholders.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
***********************************************************************************************
Microsoft.NET.Sdk.StaticWebAssets.HtmlImportMap.targets
Microsoft.NET.Sdk.StaticWebAssets.OverrideHtmlAssetPlaceholders.targets

WARNING: DO NOT MODIFY this file unless you are knowledgeable about MSBuild and have
created a backup copy. Incorrect changes to this file will make it
Expand All @@ -12,74 +12,74 @@ Copyright (c) .NET Foundation. All rights reserved.

<Project ToolsVersion="14.0">

<UsingTask TaskName="Microsoft.AspNetCore.StaticWebAssets.Tasks.WriteImportMapToHtml" AssemblyFile="$(StaticWebAssetsSdkBuildTasksAssembly)" />
<UsingTask TaskName="Microsoft.AspNetCore.StaticWebAssets.Tasks.OverrideHtmlAssetPlaceholders" AssemblyFile="$(StaticWebAssetsSdkBuildTasksAssembly)" />

<PropertyGroup>

<!--
ResolveBuildRelatedStaticWebAssets
ResolveHtmlImportMapBuildStaticWebAssets
GenerateHtmlImportMapBuildStaticWebAssets
ResolveHtmlImportMapBuildConfiguration
ResolveHtmlAssetPlaceholdersBuildStaticWebAssets
GenerateHtmlAssetPlaceholdersBuildStaticWebAssets
ResolveHtmlAssetPlaceholdersBuildConfiguration
-->
<ResolveBuildRelatedStaticWebAssetsDependsOn>
$(ResolveBuildRelatedStaticWebAssetsDependsOn);
ResolveHtmlImportMapBuildStaticWebAssets;
ResolveHtmlAssetPlaceholdersBuildStaticWebAssets;
</ResolveBuildRelatedStaticWebAssetsDependsOn>
<ResolveCompressedFilesDependsOn>
$(ResolveCompressedFilesDependsOn);
ResolveHtmlImportMapBuildStaticWebAssets
ResolveHtmlAssetPlaceholdersBuildStaticWebAssets
</ResolveCompressedFilesDependsOn>
<ResolveBuildServiceWorkerStaticWebAssetsDependsOn>
$(ResolveBuildServiceWorkerStaticWebAssetsDependsOn);
ResolveHtmlImportMapBuildStaticWebAssets
ResolveHtmlAssetPlaceholdersBuildStaticWebAssets
</ResolveBuildServiceWorkerStaticWebAssetsDependsOn>
<ResolveHtmlImportMapBuildStaticWebAssetsDependsOn>
GenerateHtmlImportMapBuildStaticWebAssets;
$(ResolveHtmlImportMapBuildStaticWebAssetsDependsOn)
</ResolveHtmlImportMapBuildStaticWebAssetsDependsOn>
<GenerateHtmlImportMapBuildStaticWebAssetsDependsOn>
ResolveHtmlImportMapBuildConfiguration;
$(GenerateHtmlImportMapBuildStaticWebAssetsDependsOn)
</GenerateHtmlImportMapBuildStaticWebAssetsDependsOn>
<ResolveHtmlAssetPlaceholdersBuildStaticWebAssetsDependsOn>
$(ResolveHtmlAssetPlaceholdersBuildStaticWebAssetsDependsOn);
GenerateHtmlAssetPlaceholdersBuildStaticWebAssets
</ResolveHtmlAssetPlaceholdersBuildStaticWebAssetsDependsOn>
<GenerateHtmlAssetPlaceholdersBuildStaticWebAssetsDependsOn>
$(GenerateHtmlAssetPlaceholdersBuildStaticWebAssetsDependsOn);
ResolveHtmlAssetPlaceholdersBuildConfiguration
</GenerateHtmlAssetPlaceholdersBuildStaticWebAssetsDependsOn>

<!--
ResolvePublishRelatedStaticWebAssets
ResolveHtmlImportMapPublishStaticWebAssets
GenerateHtmlImportMapPublishStaticWebAssets
ResolveHtmlImportMapPublishConfiguration
ResolveHtmlAssetPlaceholdersPublishStaticWebAssets
GenerateHtmlAssetPlaceholdersPublishStaticWebAssets
ResolveHtmlAssetPlaceholdersPublishConfiguration
-->
<ResolvePublishRelatedStaticWebAssetsDependsOn>
$(ResolvePublishRelatedStaticWebAssetsDependsOn);
ResolveHtmlImportMapPublishStaticWebAssets
ResolveHtmlAssetPlaceholdersPublishStaticWebAssets
</ResolvePublishRelatedStaticWebAssetsDependsOn>
<ResolvePublishCompressedStaticWebAssetsDependsOn>
$(ResolvePublishCompressedStaticWebAssetsDependsOn);
ResolveHtmlImportMapPublishStaticWebAssets
ResolveHtmlAssetPlaceholdersPublishStaticWebAssets
</ResolvePublishCompressedStaticWebAssetsDependsOn>
<ResolvePublishServiceWorkerStaticWebAssetsDependsOn>
$(ResolvePublishServiceWorkerStaticWebAssetsDependsOn);
ResolveHtmlImportMapPublishStaticWebAssets
ResolveHtmlAssetPlaceholdersPublishStaticWebAssets
</ResolvePublishServiceWorkerStaticWebAssetsDependsOn>
<ResolveHtmlImportMapPublishStaticWebAssetsDependsOn>
GenerateHtmlImportMapPublishStaticWebAssets;
$(ResolveHtmlImportMapPublishStaticWebAssetsDependsOn)
</ResolveHtmlImportMapPublishStaticWebAssetsDependsOn>
<GenerateHtmlImportMapPublishStaticWebAssetsDependsOn>
ResolveHtmlImportMapPublishConfiguration;
$(GenerateHtmlImportMapPublishStaticWebAssetsDependsOn)
</GenerateHtmlImportMapPublishStaticWebAssetsDependsOn>
<ResolveHtmlAssetPlaceholdersPublishStaticWebAssetsDependsOn>
$(ResolveHtmlAssetPlaceholdersPublishStaticWebAssetsDependsOn);
GenerateHtmlAssetPlaceholdersPublishStaticWebAssets
</ResolveHtmlAssetPlaceholdersPublishStaticWebAssetsDependsOn>
<GenerateHtmlAssetPlaceholdersPublishStaticWebAssetsDependsOn>
$(GenerateHtmlAssetPlaceholdersPublishStaticWebAssetsDependsOn);
ResolveHtmlAssetPlaceholdersPublishConfiguration
</GenerateHtmlAssetPlaceholdersPublishStaticWebAssetsDependsOn>

</PropertyGroup>

<!-- Build -->

<Target Name="ResolveHtmlImportMapBuildConfiguration">
<Target Name="ResolveHtmlAssetPlaceholdersBuildConfiguration">
<PropertyGroup>
<_BuildImportMapHtmlPath>$([MSBuild]::NormalizeDirectory($(_StaticWebAssetsIntermediateOutputPath), 'importmaphtml', 'build'))</_BuildImportMapHtmlPath>
<_BuildHtmlAssetPlaceholdersPath>$([MSBuild]::NormalizeDirectory($(_StaticWebAssetsIntermediateOutputPath), 'htmlassetplaceholders', 'build'))</_BuildHtmlAssetPlaceholdersPath>
</PropertyGroup>

<MakeDir Directories="$(_BuildImportMapHtmlPath)"/>
<MakeDir Directories="$(_BuildHtmlAssetPlaceholdersPath)"/>

<ItemGroup>
<_HtmlStaticWebAssets Include="@(StaticWebAsset)" Condition="'%(AssetKind)' != 'Publish' and '%(Extension)' == '.html'" />
Expand All @@ -95,25 +95,25 @@ Copyright (c) .NET Foundation. All rights reserved.
</FilterStaticWebAssetEndpoints>
</Target>

<Target Name="GenerateHtmlImportMapBuildStaticWebAssets" DependsOnTargets="$(GenerateHtmlImportMapBuildStaticWebAssetsDependsOn)">
<WriteImportMapToHtml
<Target Name="GenerateHtmlAssetPlaceholdersBuildStaticWebAssets" DependsOnTargets="$(GenerateHtmlAssetPlaceholdersBuildStaticWebAssetsDependsOn)">
<OverrideHtmlAssetPlaceholders
Assets="@(_EsModuleCandidate)"
Endpoints="@(_EsModuleCandidateEndpoints)"
IncludeOnlyHardFingerprintedModules="false"
HtmlFiles="@(_HtmlStaticWebAssets)"
OutputPath="$(_BuildImportMapHtmlPath)">
OutputPath="$(_BuildHtmlAssetPlaceholdersPath)">
<Output TaskParameter="HtmlCandidates" ItemName="_HtmlCandidates" />
<Output TaskParameter="HtmlFilesToRemove" ItemName="_HtmlFilesToRemove" />
<Output TaskParameter="FileWrites" ItemName="FileWrites" />
</WriteImportMapToHtml>
</OverrideHtmlAssetPlaceholders>
</Target>

<Target Name="ResolveHtmlImportMapBuildStaticWebAssets" DependsOnTargets="$(ResolveHtmlImportMapBuildStaticWebAssetsDependsOn)">
<Target Name="ResolveHtmlAssetPlaceholdersBuildStaticWebAssets" DependsOnTargets="$(ResolveHtmlAssetPlaceholdersBuildStaticWebAssetsDependsOn)">
<ItemGroup>
<_HtmlCandidatesNoMetadata
Include="@(_HtmlCandidates)"
RemoveMetadata="SourceType;AssetKind;Integrity;Fingerprint" />
<_HtmlCandidatesNoMetadata ContentRoot="$(_BuildImportMapHtmlPath)" />
<_HtmlCandidatesNoMetadata ContentRoot="$(_BuildHtmlAssetPlaceholdersPath)" />
</ItemGroup>
<DefineStaticWebAssets CandidateAssets="@(_HtmlCandidatesNoMetadata)"
SourceType="Computed"
Expand Down Expand Up @@ -145,12 +145,12 @@ Copyright (c) .NET Foundation. All rights reserved.

<!-- Publish -->

<Target Name="ResolveHtmlImportMapPublishConfiguration">
<Target Name="ResolveHtmlAssetPlaceholdersPublishConfiguration">
<PropertyGroup>
<_PublishImportMapHtmlPath>$([MSBuild]::NormalizeDirectory($(_StaticWebAssetsIntermediateOutputPath), 'importmaphtml', 'publish'))</_PublishImportMapHtmlPath>
<_PublishHtmlAssetPlaceholdersPath>$([MSBuild]::NormalizeDirectory($(_StaticWebAssetsIntermediateOutputPath), 'htmlassetplaceholders', 'publish'))</_PublishHtmlAssetPlaceholdersPath>
</PropertyGroup>

<MakeDir Directories="$(_PublishImportMapHtmlPath)"/>
<MakeDir Directories="$(_PublishHtmlAssetPlaceholdersPath)"/>

<ItemGroup>
<_EsModuleCandidateForPublish Include="@(StaticWebAsset)" Condition="'%(AssetKind)' != 'Build'" />
Expand All @@ -165,25 +165,25 @@ Copyright (c) .NET Foundation. All rights reserved.
</FilterStaticWebAssetEndpoints>
</Target>

<Target Name="GenerateHtmlImportMapPublishStaticWebAssets" DependsOnTargets="$(GenerateHtmlImportMapPublishStaticWebAssetsDependsOn)">
<WriteImportMapToHtml
<Target Name="GenerateHtmlAssetPlaceholdersPublishStaticWebAssets" DependsOnTargets="$(GenerateHtmlAssetPlaceholdersPublishStaticWebAssetsDependsOn)">
<OverrideHtmlAssetPlaceholders
Assets="@(_EsModuleCandidateForPublish)"
Endpoints="@(_EsModuleCandidateForPublishEndpoints)"
IncludeOnlyHardFingerprintedModules="true"
HtmlFiles="@(_HtmlStaticWebAssets)"
OutputPath="$(_PublishImportMapHtmlPath)">
OutputPath="$(_PublishHtmlAssetPlaceholdersPath)">
<Output TaskParameter="HtmlCandidates" ItemName="_HtmlPublishCandidates" />
<Output TaskParameter="HtmlFilesToRemove" ItemName="_HtmlPublishFilesToRemove" />
<Output TaskParameter="FileWrites" ItemName="FileWrites" />
</WriteImportMapToHtml>
</OverrideHtmlAssetPlaceholders>
</Target>

<Target Name="ResolveHtmlImportMapPublishStaticWebAssets" DependsOnTargets="$(ResolveHtmlImportMapPublishStaticWebAssetsDependsOn)">
<Target Name="ResolveHtmlAssetPlaceholdersPublishStaticWebAssets" DependsOnTargets="$(ResolveHtmlAssetPlaceholdersPublishStaticWebAssetsDependsOn)">
<ItemGroup>
<_HtmlPublishCandidatesNoMetadata
Include="@(_HtmlPublishCandidates)"
RemoveMetadata="SourceType;AssetKind;Integrity;Fingerprint" />
<_HtmlPublishCandidatesNoMetadata ContentRoot="$(_PublishImportMapHtmlPath)" />
<_HtmlPublishCandidatesNoMetadata ContentRoot="$(_PublishHtmlAssetPlaceholdersPath)" />
</ItemGroup>
<DefineStaticWebAssets CandidateAssets="@(_HtmlPublishCandidatesNoMetadata)"
SourceType="Computed"
Expand Down
2 changes: 1 addition & 1 deletion src/StaticWebAssetsSdk/Targets/Microsoft.NET.Sdk.StaticWebAssets.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -741,6 +741,6 @@ Copyright (c) .NET Foundation. All rights reserved.

<Import Project="Microsoft.NET.Sdk.StaticWebAssets.ServiceWorker.targets" Condition="'$(ServiceWorkerAssetsManifest)' != ''" />

<Import Project="Microsoft.NET.Sdk.StaticWebAssets.HtmlImportMap.targets" Condition="'$(WriteImportMapToHtml)' == 'true'" />
<Import Project="Microsoft.NET.Sdk.StaticWebAssets.HtmlAssetPlaceholders.targets" Condition="'$(OverrideHtmlAssetPlaceholders)' == 'true'" />

</Project>
119 changes: 96 additions & 23 deletions ...ebAssetsSdk/Tasks/WriteImportMapToHtml.cs → ...dk/Tasks/OverrideHtmlAssetPlaceholders.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Text.RegularExpressions;
using Microsoft.AspNetCore.StaticWebAssets.Tasks.Utils;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;
using System.Text.Encodings.Web;
using System.Text.Json.Serialization;
using System.Text.Json;
using Microsoft.AspNetCore.StaticWebAssets.Tasks.Utils;
using System.Text.RegularExpressions;

namespace Microsoft.AspNetCore.StaticWebAssets.Tasks;

public partial class WriteImportMapToHtml : Task
public partial class OverrideHtmlAssetPlaceholders : Task
{
[Required]
public ITaskItem[] Assets { get; set; } = [];
Expand All @@ -37,14 +37,11 @@ public partial class WriteImportMapToHtml : Task
[Output]
public string[] FileWrites { get; set; } = [];

// "([^"]+)(#\[\.{fingerprint}\])([^"]+)"
// 1.group = file name
// 2.group = fingerprint placeholder
// 3.group = file extension
// wrapped in quotes
private static readonly Regex _assetsRegex = new Regex(@"""([^""]+)(#\[\.{fingerprint}\])([^""]+)""");
internal static readonly Regex _assetsRegex = new Regex(@"""(?<fileName>[^""]+)#\[\.{fingerprint}\](?<fileExtension>[^""]+)""");

internal static readonly Regex _importMapRegex = new Regex(@"<script\s+type=""importmap""\s*>\s*</script>");

private static readonly Regex _importMapRegex = new Regex(@"<script\s+type=""importmap""\s*>\s*</script>");
internal static readonly Regex _preloadRegex = new Regex(@"<link\s+rel=""preload""(\sid=""(?<group>[^""]+)"")?\s*[/]?>");

public override bool Execute()
{
Expand Down Expand Up @@ -75,10 +72,17 @@ public override bool Execute()
return $"<script type=\"importmap\">{JsonSerializer.Serialize(importMap, ImportMapSerializerContext.CustomEncoder.Options)}</script>";
});

// Generate import map
outputContent = _preloadRegex.Replace(outputContent, e =>
{
Log.LogMessage("Writing preload links to '{0}'", item.ItemSpec);
return GeneratePreloadLinks(resources, e.Groups["group"]?.Value);
});

// Fingerprint all assets used in html
outputContent = _assetsRegex.Replace(outputContent, e =>
{
string assetPath = e.Groups[1].Value + e.Groups[3].Value;
string assetPath = e.Groups["fileName"].Value + e.Groups["fileExtension"].Value;
string fingerprintedAssetPath = GetFingerprintedAssetPath(urlMappings, assetPath);
Log.LogMessage("Replacing asset '{0}' with fingerprinted version '{1}'", assetPath, fingerprintedAssetPath);
return "\"" + fingerprintedAssetPath + "\"";
Expand All @@ -105,6 +109,48 @@ public override bool Execute()
return true;
}

private static string GeneratePreloadLinks(List<ResourceAsset> assets, string? group)
{
var links = new List<(string? Order, string Value)>();
foreach (var asset in assets)
{
if (asset.PreloadRel == null)
{
continue;
}

if (group != null && asset.PreloadGroup != group)
{
continue;
}

var link = new StringBuilder();
link.Append($"<link href=\"").Append(asset.Url).Append("\" rel=\"").Append(asset.PreloadRel).Append('"');
if (!string.IsNullOrEmpty(asset.PreloadAs))
{
link.Append(" as=\"").Append(asset.PreloadAs).Append('"');
}
if (!string.IsNullOrEmpty(asset.PreloadPriority))
{
link.Append(" fetchpriority=\"").Append(asset.PreloadPriority).Append('"');
}
if (!string.IsNullOrEmpty(asset.PreloadCrossorigin))
{
link.Append(" crossorigin=\"").Append(asset.PreloadCrossorigin).Append('"');
}
if (!string.IsNullOrEmpty(asset.Integrity))
{
link.Append(" integrity=\"").Append(asset.Integrity).Append('"');
}

link.Append(" />");
links.Add((asset.PreloadOrder, link.ToString()));
}

links.Sort((a, b) => string.Compare(a.Order, b.Order, StringComparison.InvariantCulture));
return String.Join(Environment.NewLine, links.Select(l => l.Value));
}

private string GetFingerprintedAssetPath(Dictionary<string, ResourceAsset> urlMappings, string assetPath)
{
if (urlMappings.TryGetValue(assetPath, out var asset) && (!IncludeOnlyHardFingerprintedModules || asset.IsHardFingerprinted))
Expand All @@ -125,33 +171,54 @@ internal List<ResourceAsset> CreateResourcesFromEndpoints(IEnumerable<StaticWebA
// subresource integrity to things like images, script tags, etc.
foreach (var endpoint in endpoints)
{
string? label = null;
string? integrity = null;

// If there's a selector this means that this is an alternative representation for a resource, so skip it.
if (endpoint.Selectors?.Length == 0)
{
var resourceAsset = new ResourceAsset(endpoint.Route);
for (var i = 0; i < endpoint.EndpointProperties?.Length; i++)
{
var property = endpoint.EndpointProperties[i];
if (property.Name.Equals("label", StringComparison.OrdinalIgnoreCase))
{
label = property.Value;
resourceAsset.Label = property.Value;
}
else if (property.Name.Equals("integrity", StringComparison.OrdinalIgnoreCase))
{
integrity = property.Value;
resourceAsset.Integrity = property.Value;
}
else if (property.Name.Equals("preloadgroup", StringComparison.OrdinalIgnoreCase))
{
resourceAsset.PreloadGroup = property.Value;
}
else if (property.Name.Equals("preloadrel", StringComparison.OrdinalIgnoreCase))
{
resourceAsset.PreloadRel = property.Value;
}
else if (property.Name.Equals("preloadas", StringComparison.OrdinalIgnoreCase))
{
resourceAsset.PreloadAs = property.Value;
}
else if (property.Name.Equals("preloadpriority", StringComparison.OrdinalIgnoreCase))
{
resourceAsset.PreloadPriority = property.Value;
}
else if (property.Name.Equals("preloadcrossorigin", StringComparison.OrdinalIgnoreCase))
{
resourceAsset.PreloadCrossorigin = property.Value;
}
else if (property.Name.Equals("preloadorder", StringComparison.OrdinalIgnoreCase))
{
resourceAsset.PreloadOrder = property.Value;
}
}

bool isHardFingerprinted = true;
var asset = Assets.FirstOrDefault(a => a.ItemSpec == endpoint.AssetFile);
if (asset != null)
{
isHardFingerprinted = asset.GetMetadata("RelativePath").Contains("#[.{fingerprint}]!");
resourceAsset.IsHardFingerprinted = asset.GetMetadata("RelativePath").Contains("#[.{fingerprint}]!");
}

resources.Add(new ResourceAsset(endpoint.Route, label, integrity, isHardFingerprinted));
resources.Add(resourceAsset);
}
}

Expand Down Expand Up @@ -207,12 +274,18 @@ private static Dictionary<string, ResourceAsset> GroupResourcesByLabel(List<Reso
}
}

internal sealed class ResourceAsset(string url, string? label, string? integrity, bool isHardFingerprinted)
internal sealed class ResourceAsset(string url)
{
public string Url { get; } = url;
public string? Label { get; set; } = label;
public string? Integrity { get; set; } = integrity;
public bool IsHardFingerprinted { get; set; } = isHardFingerprinted;
public string? Label { get; set; }
public string? Integrity { get; set; }
public string? PreloadGroup { get; set; }
public string? PreloadRel { get; set; }
public string? PreloadAs { get; set; }
public string? PreloadPriority { get; set; }
public string? PreloadCrossorigin { get; set; }
public string? PreloadOrder { get; set; }
public bool IsHardFingerprinted { get; set; } = true;
}

internal class ImportMap(Dictionary<string, string> imports, Dictionary<string, Dictionary<string, string>> scopes, Dictionary<string, string> integrity)
Expand Down
Loading
Loading