Add support in .NET SDK for implicit versions of AspNetCore.App and .All #2533

dsplaisted · 2018-09-13T22:32:28Z

This adds support for implicit versions on PackageReferences to Microsoft.AspNetCore.App and Microsoft.AspNetCore.All. Currently this is implemented in the Web SDK, which causes problems when you have a non-Web project (for example a test project) referencing a Web project. Adding this to the base Microsoft.NET.Sdk will allow the versionless AspNetCore PackageReference in any project.

Description

Move logic to implicitly set version of ASP.NET package references into .NET SDK.

Customer Impact

Allows projects which do not use the Web SDK to reference Microsoft.AspNetCore.App without specifying the version. This is especially important for test projects which reference Web projects. Currently, the test project needs reference the ASP.NET package, and specify the exact version. Since the version is implicit in the ASP.NET project, it's hard to know which version to use, and it can change, leading to package downgrade warnings, if the project is built with a RID specified.

With this change, the test project will be able to specify a versionless PackageReference to ASP.NET the same way the web project can.

Regression?

No

Risk

In addition to moving the logic, this PR uses an MSBuild task to select the implicit version instead of static MSBuild logic. So there is some risk associated with that change, but it is counterbalanced by the fact that the version selection code becomes a lot clearer, which reduces the risk of getting it wrong.

Notes

Additional PRs will be required along with this PR:

Add ImplicitPackageReferenceVersion items to bundled versions file cli#10018: adding the ImplicitPackageReferenceVersion items in the bundled versions file
Add property to disable Web SDK implicit version logic websdk#414: allow the existing version selection logic there to be turned off

nguerrera

The items are definitely cleaner than a bunch of conditions and properties, so I approve of the approach in principle. My only concern is that we make sure that it doesn't have unintended consequences for VS.

nguerrera · 2018-09-14T22:10:52Z

src/Tasks/Microsoft.NET.Build.Tasks/ApplyImplicitVersions.cs

+{
+
+    //  TODO: Provide way to opt out of warning when Version is specified (possibly with the DisableImplicitFrameworkReferences property)
+    public class ApplyImplicitVersions : TaskBase


nit: sealed

nguerrera · 2018-09-14T22:11:11Z

src/Tasks/Microsoft.NET.Build.Tasks/ApplyImplicitVersions.cs

+        public ITaskItem[] ImplicitPackageReferenceVersions { get; set; } = Array.Empty<ITaskItem>();
+
+        [Output]
+        public ITaskItem[] PackageReferencesToUpdate { get; set; }


nit: private set for output

nguerrera · 2018-09-14T22:11:25Z

src/Tasks/Microsoft.NET.Build.Tasks/ApplyImplicitVersions.cs

+        //  twice when building with implicit restore.  So instead we generate the warnings here, and keep them
+        //  in an item where they'll be logged in a target that runs before build, but not before restore.
+        [Output]
+        public string[] SdkBuildWarnings { get; set; }


nit: private set for output

nguerrera · 2018-09-14T22:13:58Z

src/Tasks/Microsoft.NET.Build.Tasks/ApplyImplicitVersions.cs

+                    string versionOnPackageReference = packageReference.GetMetadata(MetadataKeys.Version);
+                    if (string.IsNullOrEmpty(versionOnPackageReference))
+                    {
+


nit: extra whitespace

nguerrera · 2018-09-14T22:14:07Z

src/Tasks/Microsoft.NET.Build.Tasks/ApplyImplicitVersions.cs

+                        packageReference.SetMetadata("Publish", "true");
+
+                        packageReferencesToUpdate.Add(packageReference);
+


nit: extra whitespace

nguerrera · 2018-09-14T22:17:35Z

src/Tasks/Microsoft.NET.Build.Tasks/ApplyImplicitVersions.cs

+            var implicitReferencesForThisFramework = ImplicitPackageReferenceVersions
+                .Select(item => new ImplicitPackageReferenceVersion(item))
+                .Where(item => item.TargetFrameworkVersion == this.TargetFrameworkVersion)
+                .ToDictionary(implicitVersion => implicitVersion.Name);


N is small here, but this wouldn't be much more code if extracted into a simple loop and a separate method.

Are you saying a separate method to construct the dictionary?

Yes, that is what I was saying. Then you could use a few more lines in the extracted method to avoid all this LINQ. The reference to N being small was that it probably doesn't matter much for perf, but this is a new target that runs in design-time builds so I think it might be prudent to err on the safe side.

nguerrera · 2018-09-14T22:19:21Z

src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.DefaultItems.targets

+
+    <ItemGroup>
+      <PackageReference Remove="@(PackageReferenceToUpdate)" />
+      <PackageReference Include="@(PackageReferenceToUpdate)" />


We should check if this has an observable effect on what happens to duplicate package refs with conflicting metadata. F# ran into bugs around this.

nguerrera · 2018-09-14T22:19:46Z

src/Tasks/Microsoft.NET.Build.Tasks/ApplyImplicitVersions.cs

+            {
+                _item = item;
+            }
+            //  The name / Package ID


nit: newline between closing brace and comment

nguerrera · 2018-09-14T22:20:33Z

src/Tasks/Microsoft.NET.Build.Tasks/ApplyImplicitVersions.cs

+            public string DefaultVersion => _item.GetMetadata("DefaultVersion");
+
+            public string LatestVersion => _item.GetMetadata("LatestVersion");
+


nit: extra whitespace

nguerrera · 2018-09-14T22:23:04Z

src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.DefaultItems.targets

+
+  <UsingTask TaskName="ApplyImplicitVersions" AssemblyFile="$(MicrosoftNETBuildTasksAssembly)" />
+
+  <Target Name="ApplyImplicitVersions" BeforeTargets="_CheckForInvalidConfigurationAndPlatform;CollectPackageReferences">


We should make sure to test VS thoroughly with this new dependency on CollectPackageReferences target to set versions: e.g. does it impact the dependency node or nuget package manager UI in any unexpected ways.

jamshedd · 2018-09-18T18:32:33Z

Approved for 2.2.1xx.

dasMulli · 2018-09-19T04:22:39Z

src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.DefaultItems.targets

+
+      <!-- If we've already warned that an implicit PackageReference was overridden, don't also warn that the version was explicitly
+           specified -->
+      <PackageReference Update="@(_PackageReferenceToRemove)" AllowExplicitVersion="true"/>


Note that this will update all PackageReference items due to dotnet/msbuild#1618

nguerrera · 2018-09-19T21:03:35Z

src/Tests/Microsoft.NET.Build.Tests/GivenThatWeWantToBuildANetCoreApp.cs

@@ -39,7 +39,8 @@ public GivenThatWeWantToBuildANetCoreApp(ITestOutputHelper log) : base(log)
        [InlineData("netcoreapp1.0", "1.0.3", "1.0.3", "1.0.3")]
        [InlineData("netcoreapp1.1", null, "1.1.2", "1.1.2")]
        [InlineData("netcoreapp1.1", "1.1.0", "1.1.0", "1.1.0")]
-        [InlineData("netcoreapp1.1.1", null, "1.1.1", "1.1.1")]
+        //  Putting a patch in the TargetFramework property is no longer supported with the switch to ImplicitPackageReferenceVersion items


Hmm... Not sure about breaking this.

dsplaisted · 2018-09-20T01:45:41Z

@nguerrera @livarcocc This PR should be ready for review now. I've removed the WIP tag

dsplaisted · 2018-09-20T03:15:02Z

@dotnet/dnceng Leg failed due to out of disk space: https://ci.dot.net/job/dotnet_sdk/job/release_2.2.1xx/job/debug_ubuntu14.04_prtest/109/

dsplaisted · 2018-09-20T03:15:14Z

@dotnet-bot test Ubuntu14.04 Debug

jonfortescue · 2018-09-20T03:45:02Z

@dsplaisted Thank you for the tag. Looking into it.

jonfortescue · 2018-09-20T03:53:23Z

That's weird. I've never seen it happen twice in a row. Same machine both times. @mmitche machine was ubuntu1404-20180321-61b5913.

dsplaisted · 2018-09-20T04:13:51Z

@dotnet-bot test Ubuntu14.04 Debug

dsplaisted · 2018-09-20T17:16:16Z

@dotnet-bot test Ubuntu14.04 Debug

nguerrera

Code looks good. Still want to make sure we test VS scenarios and we should think about if anyone else might be depending on PackageReference items at evaluation.

nguerrera · 2018-09-20T21:34:40Z

src/Tasks/Common/Resources/Strings.resx

@@ -401,4 +401,7 @@ The following are names of parameters or literal values and should not be transl
    <value>NETSDK1070: The application configuration file must have root configuration element.</value>
    <comment>{StrBegin="NETSDK1070: "}</comment>
  </data>
-</root>
+  <data name="PackageReferenceVersionNotRecommended" xml:space="preserve">
+    <value>NETSDK1071: A PackageReference to '{0}' specified a Version of `{1}`. Specifying the version of this package is not recommended.  For more information, see https://aka.ms/sdkimplicitrefs</value>


We're not supposed to use two spaces after a period:

nguerrera · 2018-09-20T21:38:44Z

src/Tasks/Microsoft.NET.Build.Tasks/ApplyImplicitVersions.cs

+            var implicitReferencesForThisFramework = ImplicitPackageReferenceVersions
+                .Select(item => new ImplicitPackageReferenceVersion(item))
+                .Where(item => item.TargetFrameworkVersion == this.TargetFrameworkVersion)
+                .ToDictionary(implicitVersion => implicitVersion.Name);


Yes, that is what I was saying. Then you could use a few more lines in the extracted method to avoid all this LINQ. The reference to N being small was that it probably doesn't matter much for perf, but this is a new target that runs in design-time builds so I think it might be prudent to err on the safe side.

nguerrera · 2018-09-20T21:46:40Z

src/Tasks/Microsoft.NET.Build.Tasks/CheckForImplicitPackageReferenceOverrides.cs

+                            itemsToRemove.Add(item);
+                            string message = string.Format(CultureInfo.CurrentCulture, Strings.PackageReferenceOverrideWarning,
+                                item.ItemSpec,
+                                MoreInformationLink);


nit, you can pass arguments to LogWarning and let it format for you.

Log.LogWarning(Strings.PackageReferenceOverrideWarning, item.ItemSpec, MoreInformationLink);

(I know you just move this.)

nguerrera · 2018-09-20T21:53:24Z

src/Tasks/Microsoft.NET.Build.Tasks/CheckForImplicitPackageReferenceOverrides.cs

+                            //  won't generate another error.  The easiest way to do this is to add them both to a list of
+                            //  items to remove, and then a list of items which gets added back.
+                            itemsToRemove.Add(item);
+                            item.SetMetadata(MetadataKeys.AllowExplicitVersion, "true");


This makes me more curious about whether mutations to items are visible outside the task. Logically, I expected itemsToAdd to start via TaskItem(ITaskItem) "copy" constructor.

…oring

…icit

…nces are disabled

dasMulli · 2018-09-22T11:19:41Z

To be clear: this only adds support for the version less package references and there is no plan to port the 3.0 FrameworkReference back to 2.2 tools?

VictorioBerra · 2018-09-25T16:03:31Z

For the layman, does this mean we wont have to make our unit tests project reference the Web SDK or add a reference to App in our test projects? Implicit version will just work now?

dsplaisted · 2018-09-27T20:12:01Z

@dasMulli Yes, we decided not to add FrameworkReference to 2.2.

@VictorioBerra In 2.2, you will still need to have a PackageReference to Microsoft.AspNetCore.App or .All in your test project. But the test project won't need to use the Web SDK, and won't need to specify a version on the PackageReference.

In 3.0, the ASP.NET dependency will be expressed as a FrameworkReference, and we don't expect that you'll need to explicitly have it in your test project if you don't directly call any APIs from it.

dsplaisted mentioned this pull request Sep 13, 2018

[WIP] 2.2: Add support for referencing Microsoft.AspNetCore.App as a FrameworkReference #2501

Closed

dsplaisted changed the base branch from master to release/2.2.1xx September 14, 2018 01:18

nguerrera reviewed Sep 14, 2018

View reviewed changes

dsplaisted mentioned this pull request Sep 18, 2018

Add ImplicitPackageReferenceVersion items to bundled versions file dotnet/cli#10018

Merged

livarcocc added this to the 2.2.1xx milestone Sep 18, 2018

livarcocc added the Servicing-consider label Sep 18, 2018

dsplaisted mentioned this pull request Sep 18, 2018

Add property to disable Web SDK implicit version logic dotnet/websdk#414

Merged

jamshedd added Servicing-approved and removed Servicing-consider labels Sep 18, 2018

dasMulli reviewed Sep 19, 2018

View reviewed changes

nguerrera reviewed Sep 19, 2018

View reviewed changes

dsplaisted force-pushed the implicit-aspnet-version branch 2 times, most recently from 51c97c8 to c62981d Compare September 20, 2018 01:44

dsplaisted changed the title ~~WIP - Add support in .NET SDK for implicit versions of AspNetCore.App and .All~~ Add support in .NET SDK for implicit versions of AspNetCore.App and .All Sep 20, 2018

nguerrera approved these changes Sep 20, 2018

View reviewed changes

dsplaisted added 7 commits September 20, 2018 16:08

Add string for PackageReferenceVersionNotRecommended

f5fe242

Update stage 0

4584228

Add support in .NET SDK for implicit versions of AspNetCore.App and .All

72ddf54

Only log warning about explicit versions when building, not when rest…

d8596b6

…oring

Set implicit metadata on PackageReference items where version is impl…

d5c774a

…icit

Code review feedback

899fa65

Use ApplyImplicitVersions task for Microsoft.NETCore.App reference

bfac039

Update stage 0

db369bf

dsplaisted force-pushed the implicit-aspnet-version branch from fa77a9d to 901f8c8 Compare September 20, 2018 23:08

dsplaisted added 6 commits September 20, 2018 16:27

Disable Web SDK implicit logic, enable using RuntimeFrameworkVersion

830f74b

Fix test failures

b61e4a0

Add tests for implicit ASP.NET versions, and fix behavior

5f3b363

Support patch version in TargetFramework property

e7aab66

Don't warn about explicit package versions of implicit package refere…

4e4e0ac

…nces are disabled

Apply code review feedback

101e3fd

dsplaisted force-pushed the implicit-aspnet-version branch from 901f8c8 to 101e3fd Compare September 20, 2018 23:27

dsplaisted merged commit b662b1b into dotnet:release/2.2.1xx Sep 21, 2018

natemcmaster mentioned this pull request Sep 24, 2018

Remove support for the implicit package version of Microsoft.AspNetCore.App dotnet/aspnetcore#3292

Closed

natemcmaster mentioned this pull request Sep 26, 2018

M.A.App should be version-less dotnet/AspNetCore.Docs#8579

Closed

dsplaisted mentioned this pull request Oct 12, 2018

Fix issue where ASP.NET PackageReferences with implicit versions had incorrect PrivateAssets value #2581

Merged

guardrex mentioned this pull request Oct 24, 2018

Update Distributed cache topic+sample dotnet/AspNetCore.Docs#9129

Merged

natemcmaster mentioned this pull request Oct 24, 2018

Set explicit version for Microsoft.AspNetCore.App in Test Project to fix build errors csharpfritz/CoreWiki#332

Merged

guardrex mentioned this pull request Oct 24, 2018

Replace M.A.All meta-package with Microsoft.AspNetCore.App - MD files only dotnet/AspNetCore.Docs#5314

Closed

dasMulli mentioned this pull request Nov 14, 2018

Integration testing is hard to set up and may break on shared framework servicing dotnet/aspnetcore#3156

Closed

omajid mentioned this pull request Jan 9, 2019

Latest Microsoft.AspNetCore.App 2.2 version is not used automatically dotnet/source-build#942

Closed

dsplaisted mentioned this pull request Jan 31, 2020

Enable implicit versions tests in core-sdk master branch #9819

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support in .NET SDK for implicit versions of AspNetCore.App and .All #2533

Add support in .NET SDK for implicit versions of AspNetCore.App and .All #2533

dsplaisted commented Sep 13, 2018 •

edited

nguerrera left a comment

nguerrera Sep 14, 2018

nguerrera Sep 14, 2018

nguerrera Sep 14, 2018

nguerrera Sep 14, 2018

nguerrera Sep 14, 2018

nguerrera Sep 14, 2018

dsplaisted Sep 18, 2018

nguerrera Sep 20, 2018

nguerrera Sep 14, 2018

nguerrera Sep 14, 2018

nguerrera Sep 14, 2018

nguerrera Sep 14, 2018

jamshedd commented Sep 18, 2018

dasMulli Sep 19, 2018

nguerrera Sep 19, 2018

nguerrera Sep 19, 2018

dsplaisted commented Sep 20, 2018

dsplaisted commented Sep 20, 2018

dsplaisted commented Sep 20, 2018

jonfortescue commented Sep 20, 2018

jonfortescue commented Sep 20, 2018

dsplaisted commented Sep 20, 2018

dsplaisted commented Sep 20, 2018

nguerrera left a comment •

edited

nguerrera Sep 20, 2018

nguerrera Sep 20, 2018

nguerrera Sep 20, 2018

nguerrera Sep 20, 2018

dasMulli commented Sep 22, 2018

VictorioBerra commented Sep 25, 2018

dsplaisted commented Sep 27, 2018

		packageReference.SetMetadata("Publish", "true");

		packageReferencesToUpdate.Add(packageReference);

		public string DefaultVersion => _item.GetMetadata("DefaultVersion");

		public string LatestVersion => _item.GetMetadata("LatestVersion");


		<UsingTask TaskName="ApplyImplicitVersions" AssemblyFile="$(MicrosoftNETBuildTasksAssembly)" />

		<Target Name="ApplyImplicitVersions" BeforeTargets="_CheckForInvalidConfigurationAndPlatform;CollectPackageReferences">

Add support in .NET SDK for implicit versions of AspNetCore.App and .All #2533

Add support in .NET SDK for implicit versions of AspNetCore.App and .All #2533

Conversation

dsplaisted commented Sep 13, 2018 • edited

Description

Customer Impact

Regression?

Risk

Notes

nguerrera left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jamshedd commented Sep 18, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dsplaisted commented Sep 20, 2018

dsplaisted commented Sep 20, 2018

dsplaisted commented Sep 20, 2018

jonfortescue commented Sep 20, 2018

jonfortescue commented Sep 20, 2018

dsplaisted commented Sep 20, 2018

dsplaisted commented Sep 20, 2018

nguerrera left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dasMulli commented Sep 22, 2018

VictorioBerra commented Sep 25, 2018

dsplaisted commented Sep 27, 2018

dsplaisted commented Sep 13, 2018 •

edited

nguerrera left a comment •

edited