Skip to content

[browser] Fix filtering compressed assets for pdb during publish #100016

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 2 commits into from
Mar 21, 2024
Merged

[browser] Fix filtering compressed assets for pdb during publish #100016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0012707
Filter out compressed assets when related asset is not used
maraf Mar 20, 2024
4a8583f
Add WBT
maraf Mar 20, 2024
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
26 changes: 25 additions & 1 deletion src/mono/wasm/Wasm.Build.Tests/Templates/WasmTemplateTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

namespace Wasm.Build.Tests
{
public class WasmTemplateTests : WasmTemplateTestBase
public class WasmTemplateTests : BlazorWasmTestBase
{
public WasmTemplateTests(ITestOutputHelper output, SharedBuildPerTestClassFixture buildContext)
: base(output, buildContext)
Expand Down Expand Up @@ -603,5 +603,29 @@ internal static void TestWasmStripILAfterAOTOutput(string objBuildDir, string fr
}
}
}

[Theory]
[InlineData(false)]
[InlineData(true)]
public void PublishPdb(bool copyOutputSymbolsToPublishDirectory)
{
string config = "Release";
string id = $"publishpdb_{copyOutputSymbolsToPublishDirectory.ToString().ToLower()}_{GetRandomId()}";
CreateWasmTemplateProject(id, "wasmbrowser");

(CommandResult result, _) = BlazorPublish(new BlazorBuildOptions(id, config), $"-p:CopyOutputSymbolsToPublishDirectory={copyOutputSymbolsToPublishDirectory.ToString().ToLower()}");
result.EnsureSuccessful();

string publishFrameworkPath = Path.GetFullPath(FindBlazorBinFrameworkDir(config, forPublish: true));
AssertFile(".pdb");
AssertFile(".pdb.gz");
AssertFile(".pdb.br");

void AssertFile(string suffix)
{
var fileName = $"{id}{suffix}";
Assert.True(copyOutputSymbolsToPublishDirectory == File.Exists(Path.Combine(publishFrameworkPath, fileName)), $"The {fileName} file {(copyOutputSymbolsToPublishDirectory ? "should" : "shouldn't")} exist in publish folder");
}
}
}
}
17 changes: 14 additions & 3 deletions src/tasks/Microsoft.NET.Sdk.WebAssembly.Pack.Tasks/ComputeWasmPublishAssets.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,7 @@ private List<ITaskItem> ProcessSymbolAssets(
{
var symbolStaticWebAssets = new List<ITaskItem>();
var updateMap = new Dictionary<string, ITaskItem>();
var existingToRemove = new Dictionary<string, ITaskItem>();

foreach (var kvp in symbolAssets)
{
Expand All @@ -339,9 +340,14 @@ private List<ITaskItem> ProcessSymbolAssets(
resolvedPublishFilesToRemove.Remove(existing.ItemSpec);
}
}
else
{
Log.LogMessage(MessageImportance.Low, "Marking '{0}' as removed for filtering compressed assets.", kvp.Key);
existingToRemove.Add(kvp.Key, kvp.Value);
}
}

var compressedFiles = ProcessCompressedAssets(compressedRepresentations, symbolAssets, updateMap);
var compressedFiles = ProcessCompressedAssets(compressedRepresentations, symbolAssets, updateMap, existingToRemove);

foreach (var file in compressedFiles)
{
Expand Down Expand Up @@ -460,7 +466,8 @@ private List<ITaskItem> ComputeUpdatedAssemblies(
private List<ITaskItem> ProcessCompressedAssets(
Dictionary<string, ITaskItem> compressedRepresentations,
Dictionary<string, ITaskItem> assetsToUpdate,
Dictionary<string, ITaskItem> updatedAssets)
Dictionary<string, ITaskItem> updatedAssets,
Dictionary<string, ITaskItem> existingToRemove = null)
{
var processed = new List<string>();
var runtimeAssetsToUpdate = new List<ITaskItem>();
Expand All @@ -470,7 +477,11 @@ private List<ITaskItem> ProcessCompressedAssets(
var relatedAsset = compressedAsset.GetMetadata("RelatedAsset");
if (assetsToUpdate.ContainsKey(relatedAsset))
{
if (!updatedAssets.ContainsKey(relatedAsset))
if (existingToRemove?.ContainsKey(relatedAsset) == true)
{
Log.LogMessage(MessageImportance.Low, "Removing compressed '{0}' because related '{1}' is not published.", compressedAsset.ItemSpec, relatedAsset);
}
else if (!updatedAssets.ContainsKey(relatedAsset))
{
Log.LogMessage(MessageImportance.Low, "Related assembly for '{0}' was not updated and the compressed asset can be reused.", relatedAsset);
var newCompressedAsset = new TaskItem(compressedAsset);
Expand Down