Log NU1105 error for badly specified framework

[Nigusu-Allehu]

Bug

Fixes: NuGet/Home#12943

Description

Ensure misconfigured projects (specifically projects with badly specified framework) fail with a coded error (NU1105), improving error clarity and debugging

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. Document badly specified framework error in Nu1105 Home#14149

[jgonz120]

lgtm, not my area of expertise. Could you provide a screenshot of what the command prompt showed before your change?

[jeffkl]

Is it in scope of this change to log an error for each invalid target framework and then throw after the foreach if any were invalid? Not a huge improvement but would be better to tell the user about all invalid frameworks instead of just the first.

[Nigusu-Allehu]

I was thinking about that actually. However, framework.GetShortFolderName() returns "unsupported" instead of the name of the specific framework the user entered. Is there another way to get the name of the fmw name the user entered? I have tried framework.Framework as well.

If we don't have the specific framework name and we try to aggregate the list of all the problematic fmws the error would end up looking like

Invalid framework : "unsupported", "unsupported", "unsupported"

[jeffkl]

We could do something like this:

Hashset<string> invalidFrameworks = new Hashset<string>();

 // Verify frameworks are valid
foreach (var framework in frameworks.Where(f => !f.IsSpecificFramework))
{
    string frameworkShortFolderName = framework.GetShortFolderName();

    if (!invalidFrameworks.Add(frameworkShortFolderName))
    {
        continue;
    }

    var message = string.Format(CultureInfo.CurrentCulture, Strings.SpecValidationInvalidFramework,frameworkShortFolderName);

    logger.Log(new RestoreLogMessage(LogLevel.Error, NuGetLogCode.NU1105, message));
}

if (invalidFrameworks.Count > 0)
{
    throw RestoreSpecException.Create("", files);
}

[Nigusu-Allehu]

The issue is that GetShortFolderName() returns "unsupported" instead of the actual framework name that the user provided. This makes it difficult to provide meaningful error messages when logging multiple invalid frameworks.

If we want to log all invalid frameworks before throwing, we need a way to retrieve the exact framework string the user specified. framework.Framework doesn't seem to provide that either.

Do we have another way to access the raw user input for the framework?

If we log each invalid framework individually, the output might look like:

NU1105: Invalid framework: "unsupported"
NU1105: Invalid framework: "unsupported"
NU1105: Invalid framework: "unsupported"

[jeffkl]

My code is using a hashset to at least de-dupe entries. I don't see anywhere in the code where NuGetFramework.Parse() stores the original string.

[Nigusu-Allehu]

Ahh I see. If we had the original string, that would have been really handy here. Without it, I don't think we should iterate through all the frameworks. We won't be able to provide the user an additional information

[nkolev92]

What does TargetAlias contain? Maybe we can report that?

fwiw, NuGet/Home#8174 exists too.

On another note, this doesn't lead to an assets file with an error, so it'd still fail the whole operation.

I'm wondering if we can replicate what VS does?
That might be a bigger piece of work, but worth checking.