Build order issue with RCL static assets and TSC generated JS files in wwwroot

[MarkStega]

If you believe you have an issue that affects the security of the platform please do NOT create an issue and instead email your issue details to secure@microsoft.com. Your report may be eligible for our bug bounty but ONLY if it is reported through email.

Describe the bug

A build of a Razor Class Library that has static assets in wwwroot may or may not include a JS file that is generated from a Typescript source.

To Reproduce

Steps to reproduce the behavior:

1. Using this version of ASP.NET Core '3.0P7'
2. Create a RazorClassLib
3. Add the current Microsoft.Typescript.MSBuild nuget package to the project
4. Place a TS file in wwwroot
5. Build the library
6. There are 3 individuals with identical repositories (@chrissainty, @SQL-MisterMagoo, and @MarkStega). On two of the three environments the DLL does not contain the JS content. On the third it does. We have a work-around in place that adds an explicit embedded resource by name in the fashion of a BlazorLib project. The repository is found at https://github.com/Blazored/LocalStorage

Expected behavior

I expect the build to be consistent from one developer system to the next given the same version of VS, .NetCore, etc.

Screenshots

n/a.

Additional context

VS 16.3.0 Preview 1.0

C:\Solutions\TemporarySolutions\Typeahead>dotnet --info
.NET Core SDK (reflecting any global.json):
Version: 3.0.100-preview7-012821
Commit: 6348f1068a

Runtime Environment:
OS Name: Windows
OS Version: 10.0.18362
OS Platform: Windows
RID: win10-x64
Base Path: C:\Program Files\dotnet\sdk\3.0.100-preview7-012821\

Host (useful for support):
Version: 3.0.0-preview7-27912-14
Commit: 4da6ee6450

.NET Core SDKs installed:
2.1.701 [C:\Program Files\dotnet\sdk]
2.1.800 [C:\Program Files\dotnet\sdk]
2.1.801 [C:\Program Files\dotnet\sdk]
2.2.301 [C:\Program Files\dotnet\sdk]
2.2.400 [C:\Program Files\dotnet\sdk]
2.2.401 [C:\Program Files\dotnet\sdk]
3.0.100-preview7-012821 [C:\Program Files\dotnet\sdk]

.NET Core runtimes installed:
Microsoft.AspNetCore.All 2.1.12 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All]
Microsoft.AspNetCore.All 2.2.6 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All]
Microsoft.AspNetCore.App 2.1.12 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 2.2.6 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 3.0.0-preview7.19365.7 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.NETCore.App 2.1.12 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 2.2.6 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 3.0.0-preview7-27912-14 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.WindowsDesktop.App 3.0.0-preview7-27912-14 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

To install additional .NET Core runtimes or SDKs:
https://aka.ms/dotnet-download

C:\Solutions\TemporarySolutions\Typeahead>

[mkArtakMSFT]

Thanks for contacting us, @MarkStega .
This is quite interesting and unexpected. @javiercn can you please look into this? Thanks!

[javiercn]

@MarkStega Could you clarify something real quick?

Seems like you are referring to the old blazor support for static assets (which embedded them into the assembly) we are moving from that model to the new model where the static assets are just part of the package as content.

Which one are you using?

[MarkStega]

We are trying to use the new model without the ItemGroup with EmbeddedResources being called out (If you look at the repository the csproj for LocalStorage it has those, that is the workaround for the build issue). The problem occurs when that ItemGroup is removed and we are trying to build the dll as a 'new style' RCL with the embedding being done by the build triggered by resources in wwwroot.

[javiercn]

Ok, just to be clear.

We don't/won't be supporting embedded resources going forward. The content is just a file that we include in the package under staticwebassets and that we copy to the output folder of consuming apps during publish.

Apps need to manually reference the file in their HTML/Razor file through a script tag with src="_content/{libraryname}/{filepathunderwwwroot}.

Provided those things, it might be that the TS compilation happens after we compute the static web assets. You can add the following to your project to force typescript compilation to happen before we compute the static web assets.

  <PropertyGroup>
    <ResolveStaticWebAssetsInputsDependsOn>
      CompileTypeScript;
      $(ResolveStaticWebAssetsInputsDependsOn)
    </ResolveStaticWebAssetsInputsDependsOn>
  </PropertyGroup>

[javiercn]

I haven't seen this be an issue while packing the project, but I filed an issue for further improvements. My current recommendation is that you use the snippet above and avoid putting the ts file directly in the wwwroot and instead, set the ts output folder to wwwroot.

Closing this as there's no further action to be performed here.

#12727 for the mentioned improvements.

[MarkStega]

If I add the ResolveStaticWebAssetsInputsDependsOn with the current structure the JS gets included in the DLL (as does the TS file).

If I then move the TS file out of wwwroot and add this to the project file

  <PropertyGroup>
    <TypeScriptOutDir>wwwroot</TypeScriptOutDir>
  </PropertyGroup>

then the good news is that I indeed have the wwwroot directory created during the build and the JS file within. The bad news is that the ResolveStaticWebAssetsInputsDependsOn no longer works and the JS is not included in the DLL.

[javiercn]

That's likely because you need a target to declare the embedded file that happens after the typescript build.

[ghidello]

I have a blazorlib project and a blazor client-side project consuming it. In the blazorlib I

• removed the "old" EmbeddedResouces ItemGroups
• renamed the content folder to wwwroot
• created a msbuild target that calls webpack creating a js file in the wwwroot folder
• added the ResolveStaticWebAssetsInputsDependsOn calling the webpack target
• manually added the script tag to the index.html file

The application runs and the nupkg contains the staticwebassets folder with my js file.
The problem I'm having now is publishing the client-side project: the _content folder is missing. Is it intended to be added automatically or should I configure something?

[MarkStega]

That's likely because you need a target to declare the embedded file that happens after the typescript build.

But I thought that was the point of the 'ResolveStaticAssetsDependOn'? Are you saying I have to explicitly have another msbuild target?