[browser] Support WasmFilesToIncludeInFileSystem in WasmSdk #120970
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Collections.Specialized; | ||
| using System.IO; | ||
| using System.Linq; | ||
| using System.Threading.Tasks; | ||
| using Xunit; | ||
| using Xunit.Abstractions; | ||
|
|
||
| #nullable enable | ||
|
|
||
| namespace Wasm.Build.Tests; | ||
|
|
||
| public class FilesToIncludeInFileSystemTests : WasmTemplateTestsBase | ||
| { | ||
| public FilesToIncludeInFileSystemTests(ITestOutputHelper output, SharedBuildPerTestClassFixture buildContext) | ||
| : base(output, buildContext) | ||
| { | ||
| } | ||
|
|
||
| public static IEnumerable<object?[]> LoadFilesToVfsData() | ||
| { | ||
| if (!EnvironmentVariables.UseJavascriptBundler) | ||
| yield return new object?[] { false }; | ||
|
|
||
| yield return new object?[] { true }; | ||
| } | ||
|
|
||
| [Theory, TestCategory("bundler-friendly")] | ||
| [MemberData(nameof(LoadFilesToVfsData))] | ||
| public async Task LoadFilesToVfs(bool publish) | ||
| { | ||
| Configuration config = Configuration.Debug; | ||
| ProjectInfo info = CopyTestAsset(config, aot: false, TestAsset.WasmBasicTestApp, "FilesToIncludeInFileSystemTest"); | ||
|
|
||
| if (publish) | ||
| PublishProject(info, config, new PublishOptions()); | ||
| else | ||
| BuildProject(info, config, new BuildOptions()); | ||
|
|
||
| BrowserRunOptions runOptions = new( | ||
| config, | ||
| TestScenario: "FilesToIncludeInFileSystemTest" | ||
| ); | ||
| RunResult result = publish | ||
| ? await RunForPublishWithWebServer(runOptions) | ||
| : await RunForBuildWithDotnetRun(runOptions); | ||
|
|
||
| Assert.Contains(result.TestOutput, m => m.Contains("'/myfiles/Vfs1.txt' exists 'True' with content 'Vfs1.txt'")); | ||
| Assert.Contains(result.TestOutput, m => m.Contains("'/myfiles/Vfs2.txt' exists 'True' with content 'Vfs2.txt'")); | ||
| Assert.Contains(result.TestOutput, m => m.Contains("'/subdir/subsubdir/Vfs3.txt' exists 'True' with content 'Vfs3.txt'")); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System; | ||
| using System.IO; | ||
| using System.Text.Json; | ||
| using System.Runtime.InteropServices.JavaScript; | ||
|
|
||
| public partial class FilesToIncludeInFileSystemTest | ||
| { | ||
| [JSExport] | ||
| public static void Run() | ||
| { | ||
| // Check file presence in VFS based on application environment | ||
| PrintFileExistence("/myfiles/Vfs1.txt"); | ||
| PrintFileExistence("/myfiles/Vfs2.txt"); | ||
| PrintFileExistence("/subdir/subsubdir/Vfs3.txt"); | ||
| } | ||
|
|
||
| // Synchronize with FilesToIncludeInFileSystemTests | ||
| private static void PrintFileExistence(string path) => TestOutput.WriteLine($"'{path}' exists '{File.Exists(path)}' with content '{File.ReadAllText(path)}'"); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Vfs1.txt |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Vfs2.txt |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Vfs3.txt |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -321,14 +321,14 @@ public string TransformResourcesToAssets(BootJsonData config, bool bundlerFriend | |||||
| var asset = new VfsAsset() | ||||||
| { | ||||||
| virtualPath = a.Key, | ||||||
| name = $"../{a.Value.Keys.First()}", | ||||||
maraf marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| integrity = a.Value.Values.First() | ||||||
| }; | ||||||
|
|
||||||
| if (bundlerFriendly) | ||||||
| { | ||||||
| string escaped = EscapeName(string.Concat(asset.name)); | ||||||
| imports.Add($"import {escaped} from \"./{asset.name}\";"); | ||||||
|
There was a problem hiding this comment. Removing the
Suggested change
|
||||||
| asset.resolvedUrl = EncodeJavascriptVariableInJson(escaped); | ||||||
| } | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -214,7 +214,8 @@ private void WriteBootConfig(string entryAssemblyName) | |||||
| var assetTraitName = resource.GetMetadata("AssetTraitName"); | ||||||
| var assetTraitValue = resource.GetMetadata("AssetTraitValue"); | ||||||
| var resourceName = Path.GetFileName(resource.GetMetadata("OriginalItemSpec")); | ||||||
| var resourceEndpoint = endpointByAsset[resource.ItemSpec].ItemSpec; | ||||||
| var resourceRoute = Path.GetFileName(resourceEndpoint); | ||||||
|
|
||||||
| if (TryGetLazyLoadedAssembly(lazyLoadAssembliesWithoutExtension, resourceName, out var lazyLoad)) | ||||||
| { | ||||||
|
|
@@ -354,6 +355,16 @@ private void WriteBootConfig(string entryAssemblyName) | |||||
| AddResourceToList(resource, resourceList, targetPath); | ||||||
| continue; | ||||||
| } | ||||||
| else if (string.Equals("WasmResource", assetTraitName, StringComparison.OrdinalIgnoreCase) && assetTraitValue.StartsWith("vfs:", StringComparison.OrdinalIgnoreCase)) | ||||||
| { | ||||||
| Log.LogMessage(MessageImportance.Low, "Candidate '{0}' is defined as VFS resource '{1}'.", resource.ItemSpec, assetTraitValue); | ||||||
|
|
||||||
| var targetPath = assetTraitValue.Substring("vfs:".Length); | ||||||
|
There was a problem hiding this comment. Use string slice operator
Suggested change
|
||||||
|
|
||||||
| resourceData.vfs ??= []; | ||||||
| resourceData.vfs[targetPath] = []; | ||||||
| AddResourceToList(resource, resourceData.vfs[targetPath], resourceEndpoint); | ||||||
| } | ||||||
| else | ||||||
| { | ||||||
| Log.LogMessage(MessageImportance.Low, "Skipping resource '{0}' since it doesn't belong to a defined category.", resource.ItemSpec); | ||||||
|
|
@@ -418,7 +429,6 @@ private void WriteBootConfig(string entryAssemblyName) | |||||
| } | ||||||
| } | ||||||
|
|
||||||
| if (EnvVariables != null && EnvVariables.Length > 0) | ||||||
| { | ||||||
| result.environmentVariables = new Dictionary<string, string>(); | ||||||
|
|
@@ -428,6 +438,7 @@ private void WriteBootConfig(string entryAssemblyName) | |||||
| result.environmentVariables[name] = env.GetMetadata("Value"); | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| if (Extensions != null && Extensions.Length > 0) | ||||||
| { | ||||||
| result.extensions = new Dictionary<string, Dictionary<string, object>>(); | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The TargetPath should be prefixed with '/' to ensure it's an absolute path in the VFS. According to the PR description, files should be loaded to paths like '/file.txt' and '/subdir/file.txt', but this sets TargetPath to 'file.txt' or 'subdir/file.txt' without the leading slash.