Skip to content

[wasm] Prepare for new boot config schema #49373

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 5 commits into from
Jun 13, 2025
Merged

[wasm] Prepare for new boot config schema #49373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6bb73c5
Switch between boot config schemas
maraf Jun 12, 2025
8035d0a
Switch between boot config schemas
maraf Jun 12, 2025
7f6c162
[ToRevert] Transform back and forth
maraf Jun 12, 2025
ab9d64f
Revert "[ToRevert] Transform back and forth"
maraf Jun 13, 2025
f6f1642
Merge branch 'main' into WasmNewBootSchema
maraf Jun 13, 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
234 changes: 231 additions & 3 deletions test/Microsoft.NET.Sdk.BlazorWebAssembly.Tests/BootJsonData.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
using System.Collections.Generic;
using System.Runtime.Serialization;
using System.Text.Json;
using System.Text.Json.Serialization;
using ResourceHashesByNameDictionary = System.Collections.Generic.Dictionary<string, string>;

// For test purposes only. Actual build time implementation lives in runtime repository with WasmSDK
Expand Down Expand Up @@ -41,7 +42,11 @@ public string entryAssembly
/// and values are SHA-256 hashes formatted in prefixed base-64 style (e.g., 'sha256-abcdefg...')
/// as used for subresource integrity checking.
/// </summary>
public ResourcesData resources { get; set; } = new ResourcesData();
[JsonIgnore]
public ResourcesData resources => (ResourcesData)resourcesRaw;

[JsonPropertyName("resources")]
public object resourcesRaw { get; set; }

/// <summary>
/// Gets a value that determines whether to enable caching of the <see cref="resources"/>
Expand Down Expand Up @@ -148,6 +153,9 @@ public class ResourcesData
[DataMember(EmitDefaultValue = false)]
public ResourceHashesByNameDictionary jsModuleWorker { get; set; }

[DataMember(EmitDefaultValue = false)]
public ResourceHashesByNameDictionary jsModuleDiagnostics { get; set; }

[DataMember(EmitDefaultValue = false)]
public ResourceHashesByNameDictionary jsModuleNative { get; set; }

Expand All @@ -158,16 +166,21 @@ public class ResourcesData
public ResourceHashesByNameDictionary wasmNative { get; set; }

[DataMember(EmitDefaultValue = false)]
public ResourceHashesByNameDictionary jsSymbols { get; set; }
public ResourceHashesByNameDictionary wasmSymbols { get; set; }

[DataMember(EmitDefaultValue = false)]
public ResourceHashesByNameDictionary icu { get; set; }

public ResourceHashesByNameDictionary coreAssembly { get; set; } = new ResourceHashesByNameDictionary();

/// <summary>
/// "assembly" (.dll) resources
/// </summary>
public ResourceHashesByNameDictionary assembly { get; set; } = new ResourceHashesByNameDictionary();

[DataMember(EmitDefaultValue = false)]
public ResourceHashesByNameDictionary corePdb { get; set; }

/// <summary>
/// "debug" (.pdb) resources
/// </summary>
Expand Down Expand Up @@ -212,13 +225,144 @@ public class ResourcesData
[DataMember(EmitDefaultValue = false)]
public Dictionary<string, AdditionalAsset> runtimeAssets { get; set; }

[DataMember(EmitDefaultValue = false)]
public Dictionary<string, ResourceHashesByNameDictionary> coreVfs { get; set; }

[DataMember(EmitDefaultValue = false)]
public Dictionary<string, ResourceHashesByNameDictionary> vfs { get; set; }

[DataMember(EmitDefaultValue = false)]
public List<string> remoteSources { get; set; }
}

public class AssetsData
{
/// <summary>
/// Gets a hash of all resources
/// </summary>
public string hash { get; set; }

[DataMember(EmitDefaultValue = false)]
public List<JsAsset> jsModuleWorker { get; set; }

[DataMember(EmitDefaultValue = false)]
public List<JsAsset> jsModuleDiagnostics { get; set; }

[DataMember(EmitDefaultValue = false)]
public List<JsAsset> jsModuleNative { get; set; }

[DataMember(EmitDefaultValue = false)]
public List<JsAsset> jsModuleRuntime { get; set; }

[DataMember(EmitDefaultValue = false)]
public List<WasmAsset> wasmNative { get; set; }

[DataMember(EmitDefaultValue = false)]
public List<SymbolsAsset> wasmSymbols { get; set; }

[DataMember(EmitDefaultValue = false)]
public List<GeneralAsset> icu { get; set; }

/// <summary>
/// "assembly" (.dll) resources needed to start MonoVM
/// </summary>
public List<GeneralAsset> coreAssembly { get; set; } = new();

/// <summary>
/// "assembly" (.dll) resources
/// </summary>
public List<GeneralAsset> assembly { get; set; } = new();

/// <summary>
/// "debug" (.pdb) resources needed to start MonoVM
/// </summary>
[DataMember(EmitDefaultValue = false)]
public List<GeneralAsset> corePdb { get; set; }

/// <summary>
/// "debug" (.pdb) resources
/// </summary>
[DataMember(EmitDefaultValue = false)]
public List<GeneralAsset> pdb { get; set; }

/// <summary>
/// localization (.satellite resx) resources
/// </summary>
[DataMember(EmitDefaultValue = false)]
public Dictionary<string, List<GeneralAsset>> satelliteResources { get; set; }

/// <summary>
/// Assembly (.dll) resources that are loaded lazily during runtime
/// </summary>
[DataMember(EmitDefaultValue = false)]
public List<GeneralAsset> lazyAssembly { get; set; }

/// <summary>
/// JavaScript module initializers that Blazor will be in charge of loading.
/// Used in .NET < 8
/// </summary>
[DataMember(EmitDefaultValue = false)]
public List<JsAsset> libraryInitializers { get; set; }

[DataMember(EmitDefaultValue = false)]
public List<JsAsset> modulesAfterConfigLoaded { get; set; }

[DataMember(EmitDefaultValue = false)]
public List<JsAsset> modulesAfterRuntimeReady { get; set; }

/// <summary>
/// Extensions created by users customizing the initialization process. The format of the file(s)
/// is up to the user.
/// </summary>
[DataMember(EmitDefaultValue = false)]
public Dictionary<string, ResourceHashesByNameDictionary> extensions { get; set; }

[DataMember(EmitDefaultValue = false)]
public List<VfsAsset> coreVfs { get; set; }

[DataMember(EmitDefaultValue = false)]
public List<VfsAsset> vfs { get; set; }
}

[DataContract]
public class JsAsset
{
public string name { get; set; }
public string moduleExports { get; set; }
}

[DataContract]
public class SymbolsAsset
{
public string name { get; set; }
}

[DataContract]
public class WasmAsset
{
public string name { get; set; }
public string integrity { get; set; }
public string resolvedUrl { get; set; }
}

[DataContract]
public class GeneralAsset
{
public string virtualPath { get; set; }
public string name { get; set; }
public string integrity { get; set; }
public string resolvedUrl { get; set; }
}

[DataContract]
public class VfsAsset
{
public string virtualPath { get; set; }
public string name { get; set; }
public string integrity { get; set; }
public string resolvedUrl { get; set; }
}

public enum GlobalizationMode : int
{
// Note that the numeric values are serialized and used in JS code, so don't change them without also updating the JS code
Expand Down Expand Up @@ -261,10 +405,65 @@ public class BootJsonDataLoader
public static BootJsonData ParseBootData(string bootConfigPath)
{
string jsonContent = GetJsonContent(bootConfigPath);
BootJsonData config = JsonSerializer.Deserialize<BootJsonData>(jsonContent, new JsonSerializerOptions { PropertyNameCaseInsensitive = true });
var options = new JsonSerializerOptions { PropertyNameCaseInsensitive = true };
options.Converters.Add(new ResourcesConverter());
BootJsonData config = JsonSerializer.Deserialize<BootJsonData>(jsonContent, options);
if (config.resourcesRaw is AssetsData assets)
{
config.resourcesRaw = ConvertAssetsToResources(assets);
}

return config;
}

private static ResourcesData ConvertAssetsToResources(AssetsData assets)
{
static Dictionary<string, ResourceHashesByNameDictionary> ConvertSatelliteResources(Dictionary<string, List<GeneralAsset>> satelliteResources)
{
if (satelliteResources == null)
return null;

var result = new Dictionary<string, ResourceHashesByNameDictionary>();
foreach (var kvp in satelliteResources)
result[kvp.Key] = kvp.Value.ToDictionary(a => a.name, a => a.integrity);

return result;
}

static Dictionary<string, ResourceHashesByNameDictionary> ConvertVfsAssets(List<VfsAsset> vfsAssets)
{
return vfsAssets?.ToDictionary(a => a.virtualPath, a => new ResourceHashesByNameDictionary
{
{ a.name, a.integrity }
});
}

var resources = new ResourcesData
{
hash = assets.hash,
jsModuleWorker = assets.jsModuleWorker?.ToDictionary(a => a.name, a => (string)null),
jsModuleDiagnostics = assets.jsModuleDiagnostics?.ToDictionary(a => a.name, a => (string)null),
jsModuleNative = assets.jsModuleNative?.ToDictionary(a => a.name, a => (string)null),
jsModuleRuntime = assets.jsModuleRuntime?.ToDictionary(a => a.name, a => (string)null),
wasmNative = assets.wasmNative?.ToDictionary(a => a.name, a => a.integrity),
wasmSymbols = assets.wasmSymbols?.ToDictionary(a => a.name, a => (string)null),
icu = assets.icu?.ToDictionary(a => a.name, a => a.integrity),
coreAssembly = assets.coreAssembly?.ToDictionary(a => a.name, a => a.integrity),
assembly = assets.assembly?.ToDictionary(a => a.name, a => a.integrity),
corePdb = assets.corePdb?.ToDictionary(a => a.name, a => a.integrity),
pdb = assets.pdb?.ToDictionary(a => a.name, a => a.integrity),
satelliteResources = ConvertSatelliteResources(assets.satelliteResources),
lazyAssembly = assets.lazyAssembly?.ToDictionary(a => a.name, a => a.integrity),
libraryInitializers = assets.libraryInitializers?.ToDictionary(a => a.name, a => (string)null),
modulesAfterConfigLoaded = assets.modulesAfterConfigLoaded?.ToDictionary(a => a.name, a => (string)null),
modulesAfterRuntimeReady = assets.modulesAfterRuntimeReady?.ToDictionary(a => a.name, a => (string)null),
extensions = assets.extensions,
coreVfs = ConvertVfsAssets(assets.coreVfs),
vfs = ConvertVfsAssets(assets.vfs)
};
return resources;
}

public static string GetJsonContent(string bootConfigPath)
{
string startComment = "/*json-start*/";
Expand All @@ -284,3 +483,32 @@ public static string GetJsonContent(string bootConfigPath)
return moduleContent;
}
}

internal class ResourcesConverter : JsonConverter<object>
{
public override object Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
var nestedOptions = new JsonSerializerOptions(options);
nestedOptions.Converters.Remove(this);

if (reader.TokenType == JsonTokenType.StartObject)
{
try
{

return JsonSerializer.Deserialize<AssetsData>(ref reader, nestedOptions)!;
}
catch
{
return JsonSerializer.Deserialize<ResourcesData>(ref reader, nestedOptions)!;
}
}

return JsonSerializer.Deserialize<object>(ref reader, nestedOptions)!;
}

public override void Write(Utf8JsonWriter writer, object value, JsonSerializerOptions options)
{
JsonSerializer.Serialize(writer, value, value.GetType(), options);
}
}
13 changes: 5 additions & 8 deletions test/Microsoft.NET.Sdk.BlazorWebAssembly.Tests/WasmPublishIntegrationTestBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,12 @@ protected static void VerifyBootManifestHashes(TestAsset testAsset, string blazo
var bootManifestResolvedPath = Path.Combine(blazorPublishDirectory, "_framework", WasmBootConfigFileName);
var bootManifest = BootJsonDataLoader.ParseBootData(bootManifestResolvedPath);

VerifyBootManifestHashes(testAsset, blazorPublishDirectory, bootManifest.resources.coreAssembly);
VerifyBootManifestHashes(testAsset, blazorPublishDirectory, bootManifest.resources.assembly);
if (bootManifest.resources.corePdb != null)
{
VerifyBootManifestHashes(testAsset, blazorPublishDirectory, bootManifest.resources.corePdb);
}
if (bootManifest.resources.pdb != null)
{
VerifyBootManifestHashes(testAsset, blazorPublishDirectory, bootManifest.resources.pdb);
Expand All @@ -33,14 +38,6 @@ protected static void VerifyBootManifestHashes(TestAsset testAsset, string blazo
{
VerifyBootManifestHashes(testAsset, blazorPublishDirectory, bootManifest.resources.wasmNative);
}
if (bootManifest.resources.jsModuleNative != null)
{
VerifyBootManifestHashes(testAsset, blazorPublishDirectory, bootManifest.resources.jsModuleNative);
}
if (bootManifest.resources.jsModuleRuntime != null)
{
VerifyBootManifestHashes(testAsset, blazorPublishDirectory, bootManifest.resources.jsModuleRuntime);
}

if (bootManifest.resources.satelliteResources != null)
{
Expand Down
Loading