Skip to content
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

Permit specifying to use workload versions in global.json #47421

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Permit specifying to use workload versions in global.json #47421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c5b7a46
Permit specifying to use workload versions in global.json
Forgind Mar 10, 2025
31a8d89
Update SdkDirectoryWorkloadManifestProvider.GlobalJsonReader.cs
Forgind Mar 11, 2025
7308af6
Little refactor
Forgind Mar 12, 2025
4675ad4
Update src/Cli/dotnet/commands/dotnet-workload/update/WorkloadUpdateC…
Forgind Mar 12, 2025
87dde0f
Test!
Forgind Mar 12, 2025
1155738
Merge branch 'globaljsonworkloadsets' of https://github.com/forgind/s…
Forgind Mar 12, 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
106 changes: 53 additions & 53 deletions src/Cli/dotnet/commands/InstallingWorkloadCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ internal abstract class InstallingWorkloadCommand : WorkloadCommandBase
protected readonly IWorkloadManifestUpdater _workloadManifestUpdaterFromConstructor;
protected IInstaller _workloadInstaller;
protected IWorkloadManifestUpdater _workloadManifestUpdater;
protected bool? _shouldUseWorkloadSets;
private WorkloadHistoryState _workloadHistoryRecord;

protected bool UseRollback => !string.IsNullOrWhiteSpace(_fromRollbackDefinition);
Expand Down Expand Up @@ -85,7 +86,8 @@ public InstallingWorkloadCommand(
IInstaller workloadInstaller,
INuGetPackageDownloader nugetPackageDownloader,
IWorkloadManifestUpdater workloadManifestUpdater,
string tempDirPath)
string tempDirPath,
bool? shouldUseWorkloadSetsFromGlobalJson = null)
: base(parseResult, reporter: reporter, tempDirPath: tempDirPath, nugetPackageDownloader: nugetPackageDownloader)
{
_arguments = parseResult.GetArguments();
Expand Down Expand Up @@ -131,7 +133,8 @@ public InstallingWorkloadCommand(
_workloadManifestUpdaterFromConstructor = workloadManifestUpdater;

_globalJsonPath = SdkDirectoryWorkloadManifestProvider.GetGlobalJsonPath(Environment.CurrentDirectory);
_workloadSetVersionFromGlobalJson = SdkDirectoryWorkloadManifestProvider.GlobalJsonReader.GetWorkloadVersionFromGlobalJson(_globalJsonPath);
_workloadSetVersionFromGlobalJson = SdkDirectoryWorkloadManifestProvider.GlobalJsonReader.GetWorkloadVersionFromGlobalJson(_globalJsonPath, out _shouldUseWorkloadSets);
_shouldUseWorkloadSets = shouldUseWorkloadSetsFromGlobalJson ?? _shouldUseWorkloadSets;

if (SpecifiedWorkloadSetVersionInGlobalJson && (SpecifiedWorkloadSetVersionOnCommandLine || UseRollback || FromHistory))
{
Expand All @@ -149,6 +152,15 @@ public InstallingWorkloadCommand(
InstallingWorkloadCommandParser.WorkloadSetVersionOption.Name,
WorkloadUpdateCommandParser.FromHistoryOption.Name), isUserError: true);
}
else if (_shouldUseWorkloadSets == true && (UseRollback || (FromHistory && _WorkloadHistoryRecord.WorkloadSetVersion is null)))
{
// TODO: This and the next should be fixed
throw new GracefulException(Update.LocalizableStrings.SpecifiedWorkloadVersionAndSpecificNonWorkloadVersion, isUserError: true);
}
else if (_shouldUseWorkloadSets == false && (SpecifiedWorkloadSetVersionInGlobalJson || SpecifiedWorkloadSetVersionOnCommandLine || (FromHistory && _WorkloadHistoryRecord.WorkloadSetVersion is not null)))
{
throw new GracefulException(Update.LocalizableStrings.SpecifiedNoWorkloadVersionAndSpecificWorkloadVersion, isUserError: true);
}

// At this point, at most one of SpecifiedWorkloadSetVersionOnCommandLine, UseRollback, FromHistory, and SpecifiedWorkloadSetVersionInGlobalJson is true
}
Expand All @@ -160,23 +172,19 @@ protected static Dictionary<string, string> GetInstallStateContents(IEnumerable<

InstallStateContents GetCurrentInstallState()
{
return GetCurrentInstallState(_sdkFeatureBand, _workloadRootDir);
}

static InstallStateContents GetCurrentInstallState(SdkFeatureBand sdkFeatureBand, string dotnetDir)
{
string path = Path.Combine(WorkloadInstallType.GetInstallStateFolder(sdkFeatureBand, dotnetDir), "default.json");
string path = Path.Combine(WorkloadInstallType.GetInstallStateFolder(_sdkFeatureBand, _workloadRootDir), "default.json");
return InstallStateContents.FromPath(path);
}

public static bool ShouldUseWorkloadSetMode(SdkFeatureBand sdkFeatureBand, string dotnetDir)
{
return GetCurrentInstallState(sdkFeatureBand, dotnetDir).ShouldUseWorkloadSets();
return WorkloadManifestUpdater.ShouldUseWorkloadSetMode(sdkFeatureBand, dotnetDir);
}

protected void UpdateWorkloadManifests(WorkloadHistoryRecorder recorder, ITransactionContext context, DirectoryPath? offlineCache)
{
var updateToLatestWorkloadSet = ShouldUseWorkloadSetMode(_sdkFeatureBand, _workloadRootDir) && !SpecifiedWorkloadSetVersionInGlobalJson;
var shouldUseWorkloadSetsPerInstallState = ShouldUseWorkloadSetMode(_sdkFeatureBand, _workloadRootDir);
var updateToLatestWorkloadSet = _shouldUseWorkloadSets ?? shouldUseWorkloadSetsPerInstallState && !SpecifiedWorkloadSetVersionInGlobalJson;
if (FromHistory && !string.IsNullOrWhiteSpace(_WorkloadHistoryRecord.WorkloadSetVersion))
{
// This is essentially the same as updating to a specific workload set version, and we're now past the error check,
Expand All @@ -191,6 +199,12 @@ protected void UpdateWorkloadManifests(WorkloadHistoryRecorder recorder, ITransa
updateToLatestWorkloadSet = false;
}

string resolvedWorkloadSetVersion = _workloadSetVersionFromGlobalJson;
if (SpecifiedWorkloadSetVersionInGlobalJson && recorder is not null)
{
recorder.HistoryRecord.GlobalJsonVersion = _workloadSetVersionFromGlobalJson;
}

if (SpecifiedWorkloadSetVersionOnCommandLine)
{
updateToLatestWorkloadSet = false;
Expand All @@ -203,45 +217,37 @@ protected void UpdateWorkloadManifests(WorkloadHistoryRecorder recorder, ITransa
_workloadInstaller.UpdateInstallMode(_sdkFeatureBand, true);
}

if (SpecifiedWorkloadSetVersionInGlobalJson && recorder is not null)
{
recorder.HistoryRecord.GlobalJsonVersion = _workloadSetVersionFromGlobalJson;
}
}

string resolvedWorkloadSetVersion = null;

if (_workloadSetVersionFromCommandLine?.Any(v => v.Contains('@')) == true)
{
var versions = WorkloadSearchVersionsCommand.FindBestWorkloadSetsFromComponents(
_sdkFeatureBand,
_workloadInstaller is not NetSdkMsiInstallerClient ? _workloadInstaller : null,
_sdkFeatureBand.IsPrerelease,
PackageDownloader,
_workloadSetVersionFromCommandLine,
_workloadResolver,
numberOfWorkloadSetsToTake: 1);

if (versions is null)
if (_workloadSetVersionFromCommandLine.Any(v => v.Contains('@')))
{
return;
}
else if (!versions.Any())
{
Reporter.WriteLine(Update.LocalizableStrings.NoWorkloadUpdateFound);
return;
var versions = WorkloadSearchVersionsCommand.FindBestWorkloadSetsFromComponents(
_sdkFeatureBand,
_workloadInstaller is not NetSdkMsiInstallerClient ? _workloadInstaller : null,
_sdkFeatureBand.IsPrerelease,
PackageDownloader,
_workloadSetVersionFromCommandLine,
_workloadResolver,
numberOfWorkloadSetsToTake: 1);

if (versions is null)
{
return;
}
else if (!versions.Any())
{
Reporter.WriteLine(Update.LocalizableStrings.NoWorkloadUpdateFound);
return;
}
else
{
resolvedWorkloadSetVersion = versions.Single();
}
}
else
{
resolvedWorkloadSetVersion = versions.Single();
resolvedWorkloadSetVersion = _workloadSetVersionFromCommandLine.Single();
}
}
else if (SpecifiedWorkloadSetVersionOnCommandLine)
{
resolvedWorkloadSetVersion = _workloadSetVersionFromCommandLine.Single();
}

resolvedWorkloadSetVersion = _workloadSetVersionFromGlobalJson ?? resolvedWorkloadSetVersion;
if (string.IsNullOrWhiteSpace(resolvedWorkloadSetVersion) && !UseRollback && !FromHistory)
{
_workloadManifestUpdater.UpdateAdvertisingManifestsAsync(_includePreviews, updateToLatestWorkloadSet, offlineCache).Wait();
Expand Down Expand Up @@ -269,17 +275,11 @@ protected void UpdateWorkloadManifests(WorkloadHistoryRecorder recorder, ITransa
return;
}

IEnumerable<ManifestVersionUpdate> manifestsToUpdate;
if (resolvedWorkloadSetVersion != null)
{
manifestsToUpdate = InstallWorkloadSet(context, resolvedWorkloadSetVersion);
}
else
{
manifestsToUpdate = UseRollback ? _workloadManifestUpdater.CalculateManifestRollbacks(_fromRollbackDefinition, recorder) :
FromHistory ? _workloadManifestUpdater.CalculateManifestUpdatesFromHistory(_WorkloadHistoryRecord) :
_workloadManifestUpdater.CalculateManifestUpdates().Select(m => m.ManifestUpdate);
}
IEnumerable<ManifestVersionUpdate> manifestsToUpdate =
resolvedWorkloadSetVersion != null ? InstallWorkloadSet(context, resolvedWorkloadSetVersion) :
UseRollback ? _workloadManifestUpdater.CalculateManifestRollbacks(_fromRollbackDefinition, recorder) :
FromHistory ? _workloadManifestUpdater.CalculateManifestUpdatesFromHistory(_WorkloadHistoryRecord) :
_workloadManifestUpdater.CalculateManifestUpdates().Select(m => m.ManifestUpdate);

InstallStateContents oldInstallState = GetCurrentInstallState();

Expand Down
2 changes: 1 addition & 1 deletion src/Cli/dotnet/commands/dotnet-workload/GlobalJsonWorkloadSetFile.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ string GetWorkloadVersionFromGlobalJson(string globalJsonPath)
{
try
{
return SdkDirectoryWorkloadManifestProvider.GlobalJsonReader.GetWorkloadVersionFromGlobalJson(globalJsonPath);
return SdkDirectoryWorkloadManifestProvider.GlobalJsonReader.GetWorkloadVersionFromGlobalJson(globalJsonPath, out _);
}
catch (SdkDirectoryWorkloadManifestProvider.JsonFormatException)
{
Expand Down
6 changes: 5 additions & 1 deletion src/Cli/dotnet/commands/dotnet-workload/config/WorkloadConfigCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,11 @@ public override int Execute()
}
else if (string.IsNullOrEmpty(_updateMode))
{
if (InstallingWorkloadCommand.ShouldUseWorkloadSetMode(_sdkFeatureBand, _dotnetPath))
string globalJsonPath = SdkDirectoryWorkloadManifestProvider.GetGlobalJsonPath(Environment.CurrentDirectory);
var globalJsonVersion = SdkDirectoryWorkloadManifestProvider.GlobalJsonReader.GetWorkloadVersionFromGlobalJson(globalJsonPath, out bool? shouldUseWorkloadSets);
shouldUseWorkloadSets = shouldUseWorkloadSets == null ? string.IsNullOrWhiteSpace(globalJsonVersion) ? null : true : shouldUseWorkloadSets;

if (shouldUseWorkloadSets ?? InstallingWorkloadCommand.ShouldUseWorkloadSetMode(_sdkFeatureBand, _dotnetPath))
{
Reporter.WriteLine(WorkloadConfigCommandParser.UpdateMode_WorkloadSet);
}
Expand Down
3 changes: 2 additions & 1 deletion src/Cli/dotnet/commands/dotnet-workload/list/WorkloadListCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ public override int Execute()
Reporter.WriteLine();
var shouldPrintTable = versionInfo.IsInstalled;
var shouldShowWorkloadSetVersion = versionInfo.GlobalJsonPath is not null ||
InstallStateContents.FromPath(Path.Combine(WorkloadInstallType.GetInstallStateFolder(_workloadListHelper._currentSdkFeatureBand, _workloadListHelper.UserLocalPath), "default.json")).ShouldUseWorkloadSets();
versionInfo.GlobalJsonSpecifiesWorkloadSets == true ||
WorkloadManifestUpdater.ShouldUseWorkloadSetMode(_workloadListHelper._currentSdkFeatureBand, _workloadListHelper.UserLocalPath);

if (shouldShowWorkloadSetVersion)
{
Expand Down
6 changes: 6 additions & 0 deletions src/Cli/dotnet/commands/dotnet-workload/update/LocalizableStrings.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,4 +180,10 @@
<data name="WorkloadVersionRequestedNotFound" xml:space="preserve">
<value>Workload version {0} not found.</value>
</data>
<data name="SpecifiedWorkloadVersionAndSpecificNonWorkloadVersion" xml:space="preserve">
<value>'useWorkloadVersions' specified to use a workload version. This option is not compatible with updating from a rollback file or from history using a set of manifests.</value>
</data>
<data name="SpecifiedNoWorkloadVersionAndSpecificWorkloadVersion" xml:space="preserve">
<value>'useWorkloadVersions' specified to not use a workload version. This is not compatible with updating or installing with a specified workload version from the command line, global.json, or from a history record with a workload version.</value>
</data>
</root>
8 changes: 5 additions & 3 deletions src/Cli/dotnet/commands/dotnet-workload/update/WorkloadUpdateCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,11 @@ public WorkloadUpdateCommand(
IWorkloadManifestUpdater workloadManifestUpdater = null,
string tempDirPath = null,
bool isRestoring = false,
WorkloadHistoryRecorder recorder = null)
WorkloadHistoryRecorder recorder = null,
bool? shouldUseWorkloadSetsFromGlobalJson = null)
: base(parseResult, reporter: reporter, workloadResolverFactory: workloadResolverFactory, workloadInstaller: workloadInstaller,
nugetPackageDownloader: nugetPackageDownloader, workloadManifestUpdater: workloadManifestUpdater,
tempDirPath: tempDirPath)
tempDirPath: tempDirPath, shouldUseWorkloadSetsFromGlobalJson: shouldUseWorkloadSetsFromGlobalJson)

{

Expand Down Expand Up @@ -97,9 +98,10 @@ public override int Execute()
}
else if (_adManifestOnlyOption)
{
bool? shouldUseWorkloadSetsPerGlobalJson = _shouldUseWorkloadSets ?? (SpecifiedWorkloadSetVersionInGlobalJson ? true : null);
_workloadManifestUpdater.UpdateAdvertisingManifestsAsync(
_includePreviews,
ShouldUseWorkloadSetMode(_sdkFeatureBand, _workloadRootDir),
shouldUseWorkloadSetsPerGlobalJson ?? ShouldUseWorkloadSetMode(_sdkFeatureBand, _workloadRootDir),
string.IsNullOrWhiteSpace(_fromCacheOption) ?
null :
new DirectoryPath(_fromCacheOption))
Expand Down
10 changes: 10 additions & 0 deletions src/Cli/dotnet/commands/dotnet-workload/update/xlf/LocalizableStrings.cs.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions src/Cli/dotnet/commands/dotnet-workload/update/xlf/LocalizableStrings.de.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions src/Cli/dotnet/commands/dotnet-workload/update/xlf/LocalizableStrings.es.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading