Use SdkAnalysisLevel in restorecommand http-errors #5925

Nigusu-Allehu · 2024-07-15T18:29:50Z

Bug

Description

while performing restore, avoid showing error based on the SDKAnalysisLevel value.
if it is greater than or equal to 9.0.100 > show error message.

Concerns

Should we parse SdkAnalysisLevel and UsingMicrosoftNetSdk for the following ?

PackageRestoreManager
- Used to restore during scenarios where there is no solution manager
NuGetPackageManager.cs
- install and update

PR Checklist

Meaningful title, helpful description and a linked NuGet/Home issue
Added tests
Link to an issue or pull request to update docs if this PR changes settings, environment variables, new feature, etc.

build/Shared/SdkAnalysisLevelMinimums.cs

nkolev92

Looks good.
Some minor feedback.

build/Shared/SdkAnalysisLevelMinimums.cs

src/NuGet.Core/NuGet.Commands/RestoreCommand/RestoreCommand.cs

test/NuGet.Core.FuncTests/NuGet.Commands.FuncTest/RestoreCommandTests.cs

src/NuGet.Core/NuGet.Commands/RestoreCommand/RestoreCommand.cs

build/Shared/SdkAnalysisLevelMinimums.cs

src/NuGet.Core/NuGet.Commands/RestoreCommand/RestoreCommand.cs

zivkan

I feel somewhat strongly about not using potentially valid DNS host names in tests. Otherwise I'd be happy to approve this.

I know there's too much in the coding guidelines document to remember everything, but is it worthwhile adding something in there, or create a new testing-guidelines.md, so that in the future we can just link to it (plus maybe someone will actually read it and remember when writing a test, leading to fewer PR iterations)

build/Shared/SdkAnalysisLevelMinimums.cs

zivkan · 2024-07-16T06:50:59Z

build/Shared/SdkAnalysisLevelMinimums.cs

+    /// </summary>
+    internal static class SdkAnalysisLevelMinimums
+    {
+        public const string HttpErrorSdkAnalysisLevelMinimumValue = "9.0.100";


Thinking ahead to a future where we have multiple features that are gating on the same SdkAnalysisLevel version, would it be better to have one SdkAnalysisLevelMinimums.v9_0_100 that they all use, or multiple feature-named properties with the same value?

The compiler will de-duplicate compile time constant strings, so that's not a concern.

I prefer having feature-based constants. It gives context to people reading the code.

The code where it's reference is context too 😁

src/NuGet.Core/NuGet.Commands/RestoreCommand/RestoreCommand.cs

test/NuGet.Core.FuncTests/NuGet.Commands.FuncTest/RestoreCommandTests.cs

zivkan · 2024-07-16T08:46:08Z

test/NuGet.Core.FuncTests/NuGet.Commands.FuncTest/RestoreCommandTests.cs

+            string httpSourceUrl = "http://api.source/index.json";
+            string httpsSourceUrl = "https://api.source/index.json";


I don't think the https feed plays any part in this test, right? If that's right, it makes the test longer, and takes me longer to read/verify the test because now I'm trying to figure out why this second source is relevant to the test.

It's just to make sure we are throwing errors despite having both http and https sources.

test/NuGet.Core.FuncTests/NuGet.Commands.FuncTest/RestoreCommandTests.cs

nkolev92

I like the separate API.

Maybe we keep it internal in NuGet.Commands until we have another use-case.

3 use-cases tends to be the sweet spot for designing a good API, and currently we just have 1. An idea would be something that combines feature flags alongside the SDK analysis level, but really all of this would be easier if we had more use-cases.

src/NuGet.Core/NuGet.Versioning/utility/SdkAnalysisLevelMinimums.cs

nkolev92 · 2024-07-16T19:17:53Z

test/NuGet.Core.FuncTests/NuGet.Commands.FuncTest/RestoreCommandTests.cs

        [Fact]
        public async Task Restore_WithHttpSourceAndAllowInsecureConnectionsTrue_Succeeds()
        {
            // Arrange
            using var pathContext = new SimpleTestPathContext();
            var packageA = new SimpleTestPackageContext("a", "1.0.0");
            await SimpleTestPackageUtility.CreateFolderFeedV3Async(pathContext.PackageSource, packageA);
-            string httpSourceUrl = "http://api.source/index.json";
-            string httpsSourceUrl = "https://api.source/index.json";
+            string httpSourceUrl = "http://unit.test/index.json";


Just fyi, you might see a lot of tests referring to contoso.

Here's some history: https://learn.microsoft.com/en-us/microsoft-365/enterprise/contoso-case-study?view=o365-worldwide.

src/NuGet.Core/NuGet.Versioning/utility/SdkAnalysisLevelMinimums.cs

src/NuGet.Core/NuGet.Commands/RestoreCommand/RestoreCommand.cs

jebriede · 2024-07-16T22:22:30Z

test/NuGet.Core.Tests/NuGet.Commands.Test/SdkAnalysisLevelMinimumsTests.cs

+        [Fact]
+        public void IsEnabled_WhenSdkAnalysisLevelIsNullAndUsingMicrosoftNetSdkIsFalse_ShouldReturnTrue()
+        {
+            var result = SdkAnalysisLevelMinimums.IsEnabled(null, false, new NuGetVersion("9.0.100"));
+            Assert.True(result);
+        }
+
+        [Fact]
+        public void IsEnabled_WhenSdkAnalysisLevelIsNullAndUsingMicrosoftNetSdkIsTrue_ShouldReturnFalse()
+        {
+            var result = SdkAnalysisLevelMinimums.IsEnabled(null, true, new NuGetVersion("9.0.100"));
+            Assert.False(result);
+        }
+
+        [Fact]
+        public void IsEnabled_WhenSdkAnalysisLevelIsLessThanMinSdkVersion_ShouldReturnFalse()
+        {
+            var result = SdkAnalysisLevelMinimums.IsEnabled(new NuGetVersion("8.0.900"), true, new NuGetVersion("9.0.100"));
+            Assert.False(result);
+        }
+
+        [Fact]
+        public void IsEnabled_WhenSdkAnalysisLevelIsEqualToMinSdkVersion_ShouldReturnTrue()
+        {
+            var result = SdkAnalysisLevelMinimums.IsEnabled(new NuGetVersion("9.0.100"), true, new NuGetVersion("9.0.100"));
+            Assert.True(result);
+        }
+
+        [Fact]
+        public void IsEnabled_WhenSdkAnalysisLevelIsGreaterThanMinSdkVersion_ShouldReturnTrue()
+        {
+            var result = SdkAnalysisLevelMinimums.IsEnabled(new NuGetVersion("9.0.101"), true, new NuGetVersion("9.0.100"));
+            Assert.True(result);
+        }


Nit: these could be combined into a data-driven test (using Theory) where you supply 4 parameters: the first three being the inputs, the fourth being the expectedValue (true or false).

zivkan · 2024-07-17T21:10:06Z

src/NuGet.Core/NuGet.Commands/RestoreCommand/RestoreCommand.cs

-                            await _logger.LogAsync(RestoreLogMessage.CreateError(NuGetLogCode.NU1302,
+                            var isErrorEnabled = SdkAnalysisLevelMinimums.IsEnabled(_request.Project.RestoreMetadata.SdkAnalysisLevel,
+                                _request.Project.RestoreMetadata.UsingMicrosoftNETSdk,
+                                SdkAnalysisLevelMinimums.HttpErrorSdkAnalysisLevelMinimumValue);


We can see here how "wordy" the property name is. The C# language doesn't let you (easily) use the property without also specifying the class name, and having "SdkAnalysisLevelMinimum" in both the class and property looks redundant when used.

But this is something easily changed later, since it's not a public API. Just something to keep in mind when writing new code.

use SdkAnalysisLevel in restorecommand

19fa1b2

Nigusu-Allehu requested a review from a team as a code owner July 15, 2024 18:29

Nigusu-Allehu marked this pull request as draft July 15, 2024 18:30

Nigusu-Allehu added the Priority:1 PRs that are high priority and should be reviewed quickly label Jul 15, 2024

nkolev92 reviewed Jul 15, 2024

View reviewed changes

build/Shared/SdkAnalysisLevelMinimums.cs Outdated Show resolved Hide resolved

Nigusu-Allehu self-assigned this Jul 15, 2024

Add tests and fix if logic

1c374b5

Nigusu-Allehu marked this pull request as ready for review July 15, 2024 21:41

nkolev92 reviewed Jul 15, 2024

View reviewed changes

src/NuGet.Core/NuGet.Commands/RestoreCommand/RestoreCommand.cs Show resolved Hide resolved

show warnings if <9.0.100

c9c0b24

kartheekp-ms reviewed Jul 16, 2024

View reviewed changes

build/Shared/SdkAnalysisLevelMinimums.cs Outdated Show resolved Hide resolved

kartheekp-ms reviewed Jul 16, 2024

View reviewed changes

src/NuGet.Core/NuGet.Commands/RestoreCommand/RestoreCommand.cs Outdated Show resolved Hide resolved

Nigusu-Allehu added 2 commits July 15, 2024 21:26

Simplify if statement

f0ae146

fix if logic

7ff21bc

zivkan reviewed Jul 16, 2024

View reviewed changes

move SdkAnalysisLevelMinimums to Versioning

ccdd486

Nigusu-Allehu requested review from nkolev92, kartheekp-ms and zivkan July 16, 2024 18:31

nkolev92 reviewed Jul 16, 2024

View reviewed changes

Nigusu-Allehu added 2 commits July 16, 2024 13:51

move to nuget.commands and make internal

d7a9c2e

add tests

945f947

Nigusu-Allehu requested a review from nkolev92 July 16, 2024 21:00

cleanup

58bec1d

aortiz-msft changed the title ~~Use SdkAnalysisLevel in restorecommand http-erros~~ Use SdkAnalysisLevel in restorecommand http-errors Jul 16, 2024

nkolev92 previously approved these changes Jul 16, 2024

View reviewed changes

jebriede reviewed Jul 16, 2024

View reviewed changes

zivkan previously approved these changes Jul 17, 2024

View reviewed changes

white space

e55f3d0

Nigusu-Allehu dismissed stale reviews from zivkan and nkolev92 via e55f3d0 July 17, 2024 20:36

Nigusu-Allehu requested review from nkolev92 and zivkan July 17, 2024 20:36

zivkan approved these changes Jul 17, 2024

View reviewed changes

Nigusu-Allehu merged commit 18a6790 into dev Jul 17, 2024
27 of 29 checks passed

Nigusu-Allehu deleted the dev-nyenework-restore-http-error-uses-sdkAnalysisLevel branch July 17, 2024 22:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use SdkAnalysisLevel in restorecommand http-errors #5925

Use SdkAnalysisLevel in restorecommand http-errors #5925

Nigusu-Allehu commented Jul 15, 2024 •

edited

Loading

nkolev92 left a comment

zivkan left a comment

zivkan Jul 16, 2024

Nigusu-Allehu Jul 16, 2024

zivkan Jul 17, 2024

zivkan Jul 16, 2024

Nigusu-Allehu Jul 16, 2024

nkolev92 left a comment

nkolev92 Jul 16, 2024

jebriede Jul 16, 2024 •

edited

Loading

zivkan Jul 17, 2024

		string httpSourceUrl = "http://api.source/index.json";
		string httpsSourceUrl = "https://api.source/index.json";

Use SdkAnalysisLevel in restorecommand http-errors #5925

Use SdkAnalysisLevel in restorecommand http-errors #5925

Conversation

Nigusu-Allehu commented Jul 15, 2024 • edited Loading

Bug

Description

Concerns

PR Checklist

nkolev92 left a comment

Choose a reason for hiding this comment

zivkan left a comment

Choose a reason for hiding this comment

zivkan Jul 16, 2024

Choose a reason for hiding this comment

Nigusu-Allehu Jul 16, 2024

Choose a reason for hiding this comment

zivkan Jul 17, 2024

Choose a reason for hiding this comment

zivkan Jul 16, 2024

Choose a reason for hiding this comment

Nigusu-Allehu Jul 16, 2024

Choose a reason for hiding this comment

nkolev92 left a comment

Choose a reason for hiding this comment

nkolev92 Jul 16, 2024

Choose a reason for hiding this comment

jebriede Jul 16, 2024 • edited Loading

Choose a reason for hiding this comment

zivkan Jul 17, 2024

Choose a reason for hiding this comment

Nigusu-Allehu commented Jul 15, 2024 •

edited

Loading

jebriede Jul 16, 2024 •

edited

Loading