Add "not installed" and other messages for workloads #43472

dsplaisted · 2024-09-16T18:03:21Z

This PR is an update to #42683, I rebased the changes so I couldn't push to @Forgind's original branch.

Sample output when SDK is in workload set update mode but no workload set is installed:

C:\SdkTesting>dotnet workload --version
9.0.100-manifests.91e63147


C:\SdkTesting>dotnet workload --info
 Workload version: 9.0.100-manifests.91e63147
 Configured to use workload sets when installing new manifests.
 Workloads are configured to install and update using workload versions, but none were found. Run "dotnet workload restore" to install a workload version.

 [aspire]
   Installation Source: SDK 9.0.100-preview.6
   Manifest Version:    9.0.0-preview.4.24456.4/8.0.100
   Manifest Path:       C:\Program Files\dotnet\sdk-manifests\8.0.100\microsoft.net.sdk.aspire\9.0.0-preview.4.24456.4\WorkloadManifest.json
   Install Type:              Msi



C:\SdkTesting>dotnet --info
.NET SDK:
 Version:           9.0.100-preview.6.24328.19
 Commit:            b7dcdeb43c
 Workload version:  9.0.100-manifests.91e63147
 MSBuild version:   17.12.0-preview-24461-13+3b9f2e956

Runtime Environment:
 OS Name:     Windows
 OS Version:  10.0.22631
 OS Platform: Windows
 RID:         win-x64
 Base Path:   C:\Program Files\dotnet\sdk\9.0.100-preview.6.24328.19\

.NET workloads installed:
 [aspire]
   Installation Source: SDK 9.0.100-preview.6
   Manifest Version:    9.0.0-preview.4.24456.4/8.0.100
   Manifest Path:       C:\Program Files\dotnet\sdk-manifests\8.0.100\microsoft.net.sdk.aspire\9.0.0-preview.4.24456.4\WorkloadManifest.json
   Install Type:              Msi

Configured to use workload sets when installing new manifests.
Workloads are configured to install and update using workload versions, but none were found. Run "dotnet workload restore" to install a workload version.

Host:
  Version:      9.0.0-rc.2.24459.11
  Architecture: x64
  Commit:       static

.NET SDKs installed:
  9.0.100-preview.6.24328.19 [C:\Program Files\dotnet\sdk]

.NET runtimes installed:
  Microsoft.AspNetCore.App 9.0.0-preview.6.24328.4 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
  Microsoft.NETCore.App 9.0.0-preview.6.24327.7 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 9.0.0-rc.2.24459.11 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.WindowsDesktop.App 9.0.0-preview.6.24327.6 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

Other architectures found:
  None

Environment variables:
  Not set

global.json file:
  Not found

Learn more:
  https://aka.ms/dotnet/info

Download .NET:
  https://aka.ms/dotnet/download

Sample output when global.json specifies a workload set that isn't installed:

C:\SdkTesting\ConsoleApp>dotnet workload --version
9.0.100-preview.6.24352.3 (not installed)


C:\SdkTesting\ConsoleApp>dotnet workload --info
 Workload version: 9.0.100-preview.6.24352.3 (not installed)
 Configured to use loose manifests when installing new manifests.
 Workload version 9.0.100-preview.6.24352.3, which was specified in C:\SdkTesting\global.json, was not found. Run "dotnet workload restore" to install this workload version.

There are no installed workloads to display.


C:\SdkTesting\ConsoleApp>dotnet --info
.NET SDK:
 Version:           9.0.100-preview.6.24328.19
 Commit:            b7dcdeb43c
 Workload version:  9.0.100-preview.6.24352.3 (not installed)
 MSBuild version:   17.12.0-preview-24461-13+3b9f2e956

Runtime Environment:
 OS Name:     Windows
 OS Version:  10.0.22631
 OS Platform: Windows
 RID:         win-x64
 Base Path:   C:\Program Files\dotnet\sdk\9.0.100-preview.6.24328.19\

.NET workloads installed:
There are no installed workloads to display.
Configured to use loose manifests when installing new manifests.
Workload version 9.0.100-preview.6.24352.3, which was specified in C:\SdkTesting\global.json, was not found. Run "dotnet workload restore" to install this workload version.

Host:
  Version:      9.0.0-rc.2.24459.11
  Architecture: x64
  Commit:       static

.NET SDKs installed:
  9.0.100-preview.6.24328.19 [C:\Program Files\dotnet\sdk]

.NET runtimes installed:
  Microsoft.AspNetCore.App 9.0.0-preview.6.24328.4 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
  Microsoft.NETCore.App 9.0.0-preview.6.24327.7 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 9.0.0-rc.2.24459.11 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.WindowsDesktop.App 9.0.0-preview.6.24327.6 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

Other architectures found:
  None

Environment variables:
  Not set

global.json file:
  C:\SdkTesting\global.json

Learn more:
  https://aka.ms/dotnet/info

Download .NET:
  https://aka.ms/dotnet/download

Specifically when the user runs `dotnet workload --version` or `dotnet workload --info` after requesting a workload set via the global.json but it isn't installed, finding only the baseline manifest, or switching to WorkloadInstallType.WorkloadSets and not finding a workload set.

…dResolver.cs

…r.cs

(GC errors are reported as warnings to the console)

joeloff · 2024-09-16T18:20:59Z

src/Cli/dotnet/commands/dotnet-workload/list/WorkloadListCommand.cs

                    else
                    {
-                        Reporter.WriteLine(string.Format(LocalizableStrings.WorkloadSetVersion, _workloadListHelper.WorkloadResolver.GetWorkloadVersion() ?? "unknown"));
+                        Reporter.WriteLine(string.Format(LocalizableStrings.WorkloadSetVersion, _workloadListHelper.WorkloadResolver.GetWorkloadVersion().Version ?? "unknown"));


Should "unknown" be localized?

It probably should have been at one time, but by now I think that Version should never be null, so the "unknown" string should never actually be used.

nagilson

It looks good to me, though I added a few nit questions.

nagilson · 2024-09-16T18:52:12Z

src/Resolvers/Microsoft.NET.Sdk.WorkloadManifestReader/Strings.resx

    <comment>{Locked="dotnet workload restore"}</comment>
  </data>
+  <data name="ShouldInstallAWorkloadSet" xml:space="preserve">
+    <value>Workloads are configured to install and update using workload versions, but none were found. Run "dotnet workload restore" to install a workload version.</value>


Would a string like this also suffice? Workload sets are enabled, but none are installed. Run "dotnet workload restore" to install a workload set version.\n

(Either way I would suggest adding a new line to separate out the workload info list.

I'm out of date enough to not know the differentiation between workload sets and workload versions. But after reading the issue and this message, for someone with less context, this provided more clarity, but I was also still a bit confused.

I thought we discussed moving that message to the bottom of the output from workload --info? Though perhaps I misremembered.

Workload sets are basically workload versions, but it was decided that calling them sets was confusing, so workload version is the customer-facing phrasing.

I see. But the toggle switch (maybe internal only) uses the workload-set terminology. dotnet workload config --update-mode workload-set 😭

Workload sets and workload versions are the same thing. I try to use "workload versions" as the user-facing term because it can be decently understood without learning a new concept, but that didn't really work with the config setting so they both show up.

I've added an extra blank line.

nagilson · 2024-09-16T18:52:52Z

test/dotnet-MsiInstallation.Tests/Framework/TestExtensions.cs

+    {
+        public static AndConstraint<CommandResultAssertions> PassWithoutWarning(this CommandResultAssertions assertions)
+        {
+            return assertions.Pass()


This is a good test to have! Thank you!

nagilson · 2024-09-16T18:58:48Z

src/Resolvers/Microsoft.NET.Sdk.WorkloadManifestReader/Strings.resx

    <value>Workload version {0}, which was specified in {1}, was not found. Run "dotnet workload restore" to install this workload version.</value>
    <comment>{Locked="dotnet workload restore"}</comment>
  </data>
+  <data name="ShouldInstallAWorkloadSet" xml:space="preserve">


Is there any chance this would break dependents on the workload --info output? It looks like there's already text that can be prepended to it, so probably not

I went over this with @baronfel and if I've correctly implemented what we talked about, he felt that these changes were not likely to cause much issue with people parsing the output.

nagilson

The new changes also lgtm. Thank you!

Forgind and others added 12 commits September 12, 2024 22:47

Update src/Resolvers/Microsoft.NET.Sdk.WorkloadManifestReader/Workloa…

31f771d

…dResolver.cs

Update src/Resolvers/Microsoft.NET.Sdk.WorkloadManifestReader/Workloa…

059e6ba

…dResolver.cs

Update src/Cli/dotnet/commands/dotnet-workload/WorkloadHistoryRecorde…

2246a9e

…r.cs

Fix nullable bug

bc5e8c0

Changes from triage

2575d75

Shorten message

7410158

Fix bad merges

4329877

Fix MSI installation elevation communication protocol

2bd0315

Check for GC errors in workload tests

214028b

(GC errors are reported as warnings to the console)

Make workload version / update mode output more consistent

5d5fa01

Add test coverage for workload set special cases

11239cf

ghost added Area-Workloads untriaged Request triage from a team member labels Sep 16, 2024

dsplaisted requested review from baronfel and a team September 16, 2024 18:03

joeloff reviewed Sep 16, 2024

View reviewed changes

nagilson approved these changes Sep 16, 2024

View reviewed changes

dsplaisted added 3 commits September 16, 2024 16:54

Fix handling installer shutdown in workload restore command

8634876

Fix workload restore with global.json-specified workload version

61a87e6

Code review feedback: add empty line

b7dcdeb

joeloff approved these changes Sep 16, 2024

View reviewed changes

nagilson approved these changes Sep 16, 2024

View reviewed changes

dsplaisted enabled auto-merge September 16, 2024 21:54

dsplaisted disabled auto-merge September 16, 2024 23:30

dsplaisted merged commit dfaa9c5 into dotnet:release/9.0.1xx Sep 16, 2024
28 of 31 checks passed

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

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

Closed

dsplaisted mentioned this pull request Sep 17, 2024

Send "workload set not installed" messages #42683

Closed

Forgind mentioned this pull request Mar 3, 2025

[NETSDKE2E]The workload version in ‘dotnet workload --version| --info“ should show the workload set version rather than the manifest version after set update mode to workload-set. #42527

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add "not installed" and other messages for workloads #43472

Add "not installed" and other messages for workloads #43472

Uh oh!

dsplaisted commented Sep 16, 2024 •

edited

Loading

Uh oh!

joeloff Sep 16, 2024

Uh oh!

dsplaisted Sep 16, 2024

Uh oh!

nagilson left a comment

Uh oh!

nagilson Sep 16, 2024

Uh oh!

Forgind Sep 16, 2024

Uh oh!

nagilson Sep 16, 2024

Uh oh!

dsplaisted Sep 16, 2024

Uh oh!

nagilson Sep 16, 2024

Uh oh!

nagilson Sep 16, 2024

Uh oh!

dsplaisted Sep 16, 2024

Uh oh!

nagilson left a comment

Uh oh!

Uh oh!

Uh oh!

Add "not installed" and other messages for workloads #43472

Add "not installed" and other messages for workloads #43472

Uh oh!

Conversation

dsplaisted commented Sep 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nagilson left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nagilson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dsplaisted commented Sep 16, 2024 •

edited

Loading