Fix RID regression by adding a task that calculates the best matching RID for platform #5695

joperezr · 2024-09-12T21:23:34Z

Description

In Aspire, we have always just cross-compiled our Dashbarod and DCP packages for a limited set of RIDs (win-x64, win-x86, win-arm64, linux-x64, linux-arm64, osx-x64, and osx-arm64). When running on platforms that had special RIDs that we weren't cross-compiling for (for example, rhel.8) then we were relying on the SDK's logic to automatically pick the best closest Dashboard and DCP pack for that RID.

However, in Aspire 8.2.0 we removed Dashboard and DCP from the workload and instead just added some sdk targets that were adding these references on the fly, but we were not doing this special matching logic the the SDK used to do and instead we were simply trying to use the current RID, which caused a regression in all of those platforms that have special RIDs which we don't cross-compile for.

In this PR, we are copying the logic that the SDK does for doing that matching, and we are calling it inside of our targets in order to ensure that we are going to get a valid package reference, which will fix the regression in those systems. This has been manually validated in RedHat 8, which was the original report for this regression. This fix, will get backported into release/8.2 branch, and serviced in 8.2.1.

Fixes #5486
Fixes #5674

cc: @DamianEdwards @radical @eerhardt @danegsta @dsplaisted

Checklist

Is this feature complete?
- Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
- No
Did you add public API?
- Yes
  - If yes, did you have an API Review for it?
    - Yes
    - No
  - Did you add <remarks /> and <code /> elements on your triple slash comments?
    - Yes
    - No
- No
Does the change make any security assumptions or guarantees?
- Yes
  - If yes, have you done a threat model and had a security review?
    - Yes
    - No
- No
Does the change require an update in our Aspire docs?
- Yes
  - Link to aspire-docs issue:
- No

Microsoft Reviewers: Open in CodeFlow

… RID for each platform.

dsplaisted · 2024-09-13T02:20:09Z

Looking at the dependencies this adds, I think it would be better to put the FindBestRidForPlatform task or something similar in the .NET SDK. You have to worry about having the right versions of the dependencies that will load in Visual Studio, including the right dependencies with your task, etc. This is kind of a pain to manage over time, so I'd recommend taking advantage of the fact that the .NET SDK already has to deal with that rather than dealing with these dependencies yourself.

I understand a reason not to do this is that you want this to run on the .NET 8 SDK which wouldn't have the new task. I would consider adding the task in .NET 9 and using it from the SDK if running on the .NET 9 SDK. Then when you move to requiring the .NET 9 SDK, you can drop the extra dependencies and the copy of the SDKs code for handling the RID graph. #Resolved

eng/BuildTask.targets

src/Aspire.Hosting.Sdk/Aspire.Hosting.Sdk.csproj

src/Aspire.Hosting.Sdk/FindBestRidForPlatform.cs

src/Aspire.Hosting.Sdk/Aspire.Hosting.Sdk.csproj

src/Aspire.Hosting.Sdk/SDK/Sdk.in.targets

src/Aspire.Hosting.Sdk/NuGetUtils.cs

src/Aspire.Hosting.Sdk/FindBestRidForPlatform.cs

joperezr · 2024-09-16T20:48:27Z

Thanks for the review folks. After chatting with @dsplaisted more on this offline, we agreed that in order to not have to deal with the task of making sure dependencies used by the task match the ones built-in on the SDK/Visual Studio the best approach should be to run out-of-proc. I will push some more changes here that will essentially move from an msbuild task to a cli tool instead which is invoked by our targets. The long-term goal for 10.0 will be to move this logic into dotnet/sdk instead. #Resolved

eerhardt · 2024-09-17T20:48:32Z

src/Aspire.Hosting.Sdk/Aspire.RuntimeIdentifier.Tool/Aspire.RuntimeIdentifier.Tool.csproj

@@ -0,0 +1,16 @@
+<Project Sdk="Microsoft.NET.Sdk">


Nesting .csprojs under folders that already contain a .csproj is typically not a good idea.

Agreed, though in this case the parent project is a NoTargets SDK project meaning it doesn't compile anything, and the child project doesn't have any targets that could be packed by the parent by accident either. Main reason why I made it a child project, is that the parent is the one that packs this. I could change it of course, but this "feels" better. There is also precedent in dotnet/runtime where source generator projects are nested under the package that packs them.

For example: https://github.com/dotnet/runtime/tree/main/src/libraries/System.Text.Json/gen

in dotnet/runtime, it is the src project that packs them, which is a sibling, not in a parent directory.

Oh -- fair enough. I don't feel strongly about this but I can change it if you want me to.

eng/dashboardpack/Sdk.in.targets

eng/dcppack/Aspire.Hosting.Orchestration.in.targets

src/Aspire.Hosting.Sdk/Aspire.RuntimeIdentifier.Tool/Program.cs

eerhardt · 2024-09-19T13:41:58Z

src/Aspire.Hosting.Sdk/Aspire.RuntimeIdentifier.Tool/Program.cs

+        return rootCommand.Parse(args).Invoke();
+    }
+
+    private static string[]? ParseSupportedRidsArgument(ArgumentResult result)


I'm surprised we need to write custom code for this.

I followed precedent that has been done on other tools: https://github.com/dotnet/sdk/blob/f007eb76461e4fff93c54e3ea2af67ad4eefeb32/src/Compatibility/ApiCompat/Microsoft.DotNet.ApiCompat.Tool/Program.cs#L362-L371

src/Aspire.Hosting.Sdk/Aspire.RuntimeIdentifier.Tool/Program.cs

src/Aspire.Hosting.Sdk/Aspire.RuntimeIdentifier.Tool/Aspire.RuntimeIdentifier.Tool.csproj

joperezr · 2024-09-19T20:54:25Z

/backport to release/8.2

github-actions · 2024-09-19T20:54:37Z

Started backporting to release/8.2: https://github.com/dotnet/aspire/actions/runs/10948758588

github-actions · 2024-09-19T20:54:41Z

@joperezr backporting to release/8.2 failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch

Applying: Fix RID regression by adding a task that calculates the best matching RID for each platform.
.git/rebase-apply/patch:94: trailing whitespace.
    <!-- Don't go higher than binding redirects entries in the toolset MSBuild.exe.config file. --> 
.git/rebase-apply/patch:104: trailing whitespace.
  
.git/rebase-apply/patch:111: trailing whitespace.
  
.git/rebase-apply/patch:116: trailing whitespace.
  
.git/rebase-apply/patch:127: trailing whitespace.
  
warning: squelched 8 whitespace errors
warning: 13 lines add whitespace errors.
Using index info to reconstruct a base tree...
M	Aspire.sln
M	Directory.Build.targets
M	Directory.Packages.props
Falling back to patching base and 3-way merge...
Auto-merging Directory.Packages.props
Auto-merging Directory.Build.targets
CONFLICT (content): Merge conflict in Directory.Build.targets
Auto-merging Aspire.sln
CONFLICT (content): Merge conflict in Aspire.sln
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 Fix RID regression by adding a task that calculates the best matching RID for each platform.
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

github-actions · 2024-09-19T20:54:41Z

@joperezr an error occurred while backporting to release/8.2, please check the run log for details!

Error: git am failed, most likely due to a merge conflict.

eerhardt

LGTM. Thanks!

Fix RID regression by adding a task that calculates the best matching…

9e681e0

… RID for each platform.

dotnet-issue-labeler bot added the area-components label Sep 12, 2024

joperezr requested review from radical, dsplaisted, DamianEdwards, eerhardt and danegsta September 12, 2024 21:24

joperezr mentioned this pull request Sep 12, 2024

Property CliPath: the path to the dcp executable used for Aaspire orchestration is required; Property DashboardPath: The path to the Aspire Dashboard binaries is missing #5674

Open

1 task

This comment was marked as resolved.

Sign in to view

Merge branch main into FixRegression

d940f57

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

Some tests timing out on helix #5247

Open

radical reviewed Sep 13, 2024

View reviewed changes

eng/BuildTask.targets Outdated Show resolved Hide resolved

radical reviewed Sep 13, 2024

View reviewed changes

eng/BuildTask.targets Outdated Show resolved Hide resolved

eerhardt reviewed Sep 16, 2024

View reviewed changes

joperezr added 2 commits September 17, 2024 13:41

Use out-of-proc instead of MSBuild task

1660c17

Merge branch origin/main into FixRegression

c60996e

eerhardt reviewed Sep 17, 2024

View reviewed changes

joperezr added 2 commits September 17, 2024 14:24

Do not show the output of running the tool as 'High' importance

a6d2cac

PR Feedback

5306455

eerhardt reviewed Sep 19, 2024

View reviewed changes

PR Feedback

3c4949f

dotnet deleted a comment from github-actions bot Sep 19, 2024

eerhardt approved these changes Sep 19, 2024

View reviewed changes

Fix package authoring

0eb36cf

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

The Operation will be canceled. The next steps may not contain expected logs. dotnet/dnceng#3008

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix RID regression by adding a task that calculates the best matching RID for platform #5695

Fix RID regression by adding a task that calculates the best matching RID for platform #5695

joperezr commented Sep 12, 2024 •

edited

Loading

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

dsplaisted commented Sep 13, 2024 •

edited by joperezr

Loading

joperezr commented Sep 16, 2024 •

edited

Loading

eerhardt Sep 17, 2024

joperezr Sep 17, 2024

joperezr Sep 17, 2024

eerhardt Sep 17, 2024

joperezr Sep 17, 2024

eerhardt Sep 19, 2024

joperezr Sep 19, 2024

joperezr commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

eerhardt left a comment

Fix RID regression by adding a task that calculates the best matching RID for platform #5695

Are you sure you want to change the base?

Fix RID regression by adding a task that calculates the best matching RID for platform #5695

Conversation

joperezr commented Sep 12, 2024 • edited Loading

Description

Checklist

Microsoft Reviewers: Open in CodeFlow

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

dsplaisted commented Sep 13, 2024 • edited by joperezr Loading

joperezr commented Sep 16, 2024 • edited Loading

eerhardt Sep 17, 2024

Choose a reason for hiding this comment

joperezr Sep 17, 2024

Choose a reason for hiding this comment

joperezr Sep 17, 2024

Choose a reason for hiding this comment

eerhardt Sep 17, 2024

Choose a reason for hiding this comment

joperezr Sep 17, 2024

Choose a reason for hiding this comment

eerhardt Sep 19, 2024

Choose a reason for hiding this comment

joperezr Sep 19, 2024

Choose a reason for hiding this comment

joperezr commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

eerhardt left a comment

Choose a reason for hiding this comment

joperezr commented Sep 12, 2024 •

edited

Loading

dsplaisted commented Sep 13, 2024 •

edited by joperezr

Loading

joperezr commented Sep 16, 2024 •

edited

Loading