Report better error when `Microsoft.Net.Sdk.Compilers.Toolset` package is not downloaded #42216

jjonescz · 2024-07-17T12:24:13Z

Related to #41791 and https://devdiv.visualstudio.com/DevDiv/_workitems/edit/2136930.

…e is not downloaded

baronfel · 2024-07-17T14:23:03Z

src/Tasks/Common/Resources/Strings.resx

@@ -952,5 +952,9 @@ You may need to build the project on another operating system or architecture, o
    <value>NETSDK1215: Targeting .NET Standard prior to 2.0 is no longer recommended. See {0} for more details.</value>
    <comment>{StrBegin="NETSDK1215: "}</comment>
  </data>
-  <!-- The latest message added is TargetFrameworkIsNotRecommended. Please update this value with each PR to catch parallel PRs both adding a new message -->
+  <data name="MicrosoftNetSdkCompilersToolsetNotFound" xml:space="preserve">
+    <value>NETSDK1216: Package Microsoft.Net.Sdk.Compilers.Toolset is not downloaded. Either run NuGet package restore or set property 'BuildWithNetFrameworkHostedCompiler' to 'false' to force use of the compiler bundled with MSBuild.</value>


I want to change the wording of this a bit but am having trouble getting it just right. The current message says what is wrong (the package wasn't downloaded) and how to fix it (restore or toggle the flag), but it doesn't say why the problem is a problem. I want something like

NETSDK1216: Package Microsoft.Net.Sdk.Compilers.Toolset is was not downloaded but was inferred to be required based on the current build environment. Either run NuGet package restore or set property 'BuildWithNetFrameworkHostedCompiler' to 'false' to force use of the compiler bundled with MSBuild.

But that's not much better :-/

property 'BuildWithNetFrameworkHostedCompiler' to 'false' to force use of the compiler bundled with MSBuild

I'm concerned about this recommendation. Once this error is hit the product is essentially in a broken state (cannot find vital components of the product). Flipping in this property is essentially silencing that signal that something is wrong. It then leads customers into the bad behaviors we saw before.

Once this error is hit the product is essentially in a broken state (cannot find vital components of the product)

I'm not sure that's correct, you can simply be using some internal company feed instead of the public nuget.org. In normal console apps etc that used to be completely fine. Or build in VS/MSBuild after restoring via dotnet CLI.

Flipping in this property is essentially silencing that signal that something is wrong. It then leads customers into the bad behaviors we saw before.

Sure but don't we want to tell customers how to suppress this error so they can unblock themselves - given the error is effectively a breaking change?

Perhaps something like:

NETSDK1216: Package Microsoft.Net.Sdk.Compilers.Toolset is not downloaded but it is needed because your MSBuild and SDK versions are mismatched. Ensure it is available in your NuGet feeds and then run NuGet package restore from Visual Studio or MSBuild.

Customers wanting a workaround can find it in the package's docs (#42212).

I've also tried to emphasize that you should restore via msbuild because dotnet restore wouldn't work.
Maybe dotnet restore /p:BuildWithNetFrameworkHostedCompiler=true would work and we can add that to the package docs.

dsplaisted · 2024-07-17T21:16:54Z

What are the ways that we expect that this error could be generated? Is it just when you run build while skipping restore? Understanding that may help write a better error message.

rainersigwald · 2024-07-17T21:18:40Z

What are the ways that we expect that this error could be generated? Is it just when you run build while skipping restore? Understanding that may help write a better error message.

Offline we figured out that it's "restore with dotnet restore or one of the things that do it implicitly, then load the project in VS and attempt to build without triggering restore first".

jjonescz · 2024-07-19T09:03:23Z

Offline we figured out that it's "restore with dotnet restore or one of the things that do it implicitly, then load the project in VS and attempt to build without triggering restore first".

Actually, that would work - Visual Studio runs its own restore on start. But if you for example removed the package after VS did its restore, then VS would not detect the package is missing and proceed to build, now falling back to the mismatched compiler version because the UsingTask was made conditional (#42238).

There are some other scenarios where this error could be useful like dotnet restore && msbuild -t:Build I guess.

jjonescz · 2024-07-19T09:05:59Z

src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.targets

+  <Target Name="_CheckMicrosoftNetSdkCompilersToolsetPackageExists" Condition="'$(_NeedToDownloadMicrosoftNetSdkCompilersToolsetPackage)' == 'true'" BeforeTargets="CoreCompile">
+    <!-- If users did not run restore or it failed to download the Microsoft.Net.Sdk.Compilers.Toolset package
+         (but they proceeded to build, e.g., in Visual Studio), display an error with suggestions how to fix the problem. -->
+    <NETSdkError ResourceName="MicrosoftNetSdkCompilersToolsetNotFound"


This could also be just a warning since technically the build will fall back to the compiler bundled with MSBuild - I don't know if that's a scenario we want to error or warn about. I chose error because that can be always relaxed without breaking users unlike the other way around.

I chose error because that can be always relaxed without breaking users unlike the other way around.

I endorse this philosophy.

Although I worry about breaking users, perhaps a warning would be better (it could be suppressed). @jaredpar also mentioned this should be a warning right?

baronfel · 2024-07-23T16:49:45Z

src/Tasks/Common/Resources/Strings.resx

@@ -952,5 +952,9 @@ You may need to build the project on another operating system or architecture, o
    <value>NETSDK1215: Targeting .NET Standard prior to 2.0 is no longer recommended. See {0} for more details.</value>
    <comment>{StrBegin="NETSDK1215: "}</comment>
  </data>
-  <!-- The latest message added is TargetFrameworkIsNotRecommended. Please update this value with each PR to catch parallel PRs both adding a new message -->
+  <data name="MicrosoftNetSdkCompilersToolsetNotFound" xml:space="preserve">
+    <value>NETSDK1216: Package Microsoft.Net.Sdk.Compilers.Toolset is not downloaded but it is needed because your MSBuild and SDK versions are mismatched. Ensure the package is available in your NuGet source feeds and then run NuGet package restore from Visual Studio or MSBuild.</value>


Do we know the version available at this point? It would be more helpful to tell the user "you need version X of package Y" than just "you need package Y".

Suggested change

<value>NETSDK1216: Package Microsoft.Net.Sdk.Compilers.Toolset is not downloaded but it is needed because your MSBuild and SDK versions are mismatched. Ensure the package is available in your NuGet source feeds and then run NuGet package restore from Visual Studio or MSBuild.</value>

<value>NETSDK1216: Package Microsoft.Net.Sdk.Compilers.Toolset is not downloaded but it is needed because your MSBuild and SDK versions are mismatched. Ensure version {0} of the package is available in your NuGet source feeds and then run NuGet package restore from Visual Studio or MSBuild.</value>

Note that this will require updating the callsite with formatting arguments.

baronfel · 2024-07-23T16:50:24Z

src/Tasks/Common/Resources/Strings.resx

-  <!-- The latest message added is TargetFrameworkIsNotRecommended. Please update this value with each PR to catch parallel PRs both adding a new message -->
+  <data name="MicrosoftNetSdkCompilersToolsetNotFound" xml:space="preserve">
+    <value>NETSDK1216: Package Microsoft.Net.Sdk.Compilers.Toolset is not downloaded but it is needed because your MSBuild and SDK versions are mismatched. Ensure the package is available in your NuGet source feeds and then run NuGet package restore from Visual Studio or MSBuild.</value>
+    <comment>{StrBegin="NETSDK1216: "}{Locked="Microsoft.Net.Sdk.Compilers.Toolset"}</comment>


Suggested change

<comment>{StrBegin="NETSDK1216: "}{Locked="Microsoft.Net.Sdk.Compilers.Toolset"}</comment>

<comment>{StrBegin="NETSDK1216: "}{Locked="Microsoft.Net.Sdk.Compilers.Toolset"} {0} is a NuGet package version and should not be translated. </comment>

jjonescz · 2024-07-24T11:13:58Z

/backport to release/9.0.1xx-preview7

github-actions · 2024-07-24T11:14:10Z

Started backporting to release/9.0.1xx-preview7: https://github.com/dotnet/sdk/actions/runs/10075584748

github-actions · 2024-07-24T11:14:29Z

@jjonescz an error occurred while backporting to release/9.0.1xx-preview7, please check the run log for details!

Error: @jjonescz is not a repo collaborator, backporting is not allowed. If you're a collaborator please make sure your dotnet team membership visibility is set to Public on https://github.com/orgs/dotnet/people?query=jjonescz

Report better error when Microsoft.Net.Sdk.Compilers.Toolset packag…

99c165c

…e is not downloaded

ghost added Area-Infrastructure untriaged Request triage from a team member labels Jul 17, 2024

build-analysis bot mentioned this pull request Jul 17, 2024

msbuild crashes with "MSB0001: Internal MSBuild Error: must be valid" dotnet/dnceng#3304

Open

3 tasks

jjonescz marked this pull request as ready for review July 17, 2024 14:12

jjonescz requested review from dsplaisted, marcpopMSFT, rainersigwald, jaredpar and baronfel July 17, 2024 14:12

baronfel reviewed Jul 17, 2024

View reviewed changes

jjonescz mentioned this pull request Jul 18, 2024

Avoid UsingTask when the target does not exist #42238

Merged

Improve wording

d7edd8d

jjonescz commented Jul 19, 2024

View reviewed changes

jaredpar approved these changes Jul 23, 2024

View reviewed changes

marcpopMSFT approved these changes Jul 23, 2024

View reviewed changes

baronfel approved these changes Jul 23, 2024

View reviewed changes

Add package version to the error message

c8800d4

This was referenced Jul 23, 2024

Microsoft.NET.Build.Containers.IntegrationTests are pulling from Docker Hub #42026

Open

Roslyn analyzer throws error AD0001 NullReferenceException dotnet/dnceng#3305

Open

jjonescz merged commit 2a0c0f0 into dotnet:main Jul 24, 2024
37 checks passed

jjonescz deleted the tearing-error branch July 24, 2024 08:03

jjonescz mentioned this pull request Jul 24, 2024

[Preview 7] Report better error when Microsoft.Net.Sdk.Compilers.Toolset package is not downloaded #42338

Merged

mthalman mentioned this pull request Aug 13, 2024

.NET Source-Build 9.0.100-preview.7.24407.1 August 2024 Updates #42699

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Report better error when `Microsoft.Net.Sdk.Compilers.Toolset` package is not downloaded #42216

Report better error when `Microsoft.Net.Sdk.Compilers.Toolset` package is not downloaded #42216

jjonescz commented Jul 17, 2024

baronfel Jul 17, 2024

jaredpar Jul 17, 2024

jjonescz Jul 18, 2024 •

edited

Loading

jjonescz Jul 18, 2024

dsplaisted commented Jul 17, 2024

rainersigwald commented Jul 17, 2024

jjonescz commented Jul 19, 2024 •

edited

Loading

jjonescz Jul 19, 2024 •

edited

Loading

rainersigwald Jul 19, 2024

jjonescz Jul 22, 2024

baronfel Jul 23, 2024

baronfel Jul 23, 2024

jjonescz commented Jul 24, 2024

github-actions bot commented Jul 24, 2024

github-actions bot commented Jul 24, 2024

	<value>NETSDK1216: Package Microsoft.Net.Sdk.Compilers.Toolset is not downloaded but it is needed because your MSBuild and SDK versions are mismatched. Ensure the package is available in your NuGet source feeds and then run NuGet package restore from Visual Studio or MSBuild.</value>
	<value>NETSDK1216: Package Microsoft.Net.Sdk.Compilers.Toolset is not downloaded but it is needed because your MSBuild and SDK versions are mismatched. Ensure version {0} of the package is available in your NuGet source feeds and then run NuGet package restore from Visual Studio or MSBuild.</value>

	<comment>{StrBegin="NETSDK1216: "}{Locked="Microsoft.Net.Sdk.Compilers.Toolset"}</comment>
	<comment>{StrBegin="NETSDK1216: "}{Locked="Microsoft.Net.Sdk.Compilers.Toolset"} {0} is a NuGet package version and should not be translated. </comment>

Report better error when Microsoft.Net.Sdk.Compilers.Toolset package is not downloaded #42216

Report better error when Microsoft.Net.Sdk.Compilers.Toolset package is not downloaded #42216

Conversation

jjonescz commented Jul 17, 2024

baronfel Jul 17, 2024

Choose a reason for hiding this comment

jaredpar Jul 17, 2024

Choose a reason for hiding this comment

jjonescz Jul 18, 2024 • edited Loading

Choose a reason for hiding this comment

jjonescz Jul 18, 2024

Choose a reason for hiding this comment

dsplaisted commented Jul 17, 2024

rainersigwald commented Jul 17, 2024

jjonescz commented Jul 19, 2024 • edited Loading

jjonescz Jul 19, 2024 • edited Loading

Choose a reason for hiding this comment

rainersigwald Jul 19, 2024

Choose a reason for hiding this comment

jjonescz Jul 22, 2024

Choose a reason for hiding this comment

baronfel Jul 23, 2024

Choose a reason for hiding this comment

baronfel Jul 23, 2024

Choose a reason for hiding this comment

jjonescz commented Jul 24, 2024

github-actions bot commented Jul 24, 2024

github-actions bot commented Jul 24, 2024

Report better error when `Microsoft.Net.Sdk.Compilers.Toolset` package is not downloaded #42216

Report better error when `Microsoft.Net.Sdk.Compilers.Toolset` package is not downloaded #42216

jjonescz Jul 18, 2024 •

edited

Loading

jjonescz commented Jul 19, 2024 •

edited

Loading

jjonescz Jul 19, 2024 •

edited

Loading