Merge pull request #1270 from AArnott/libtemplateUpdate

AArnott · web-flow · commit 9065e6e4b559 · 2024-01-06T08:30:11.000-07:00
Merge latest Library.Template
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -3,19 +3,13 @@
   "isRoot": true,
   "tools": {
     "powershell": {
-      "version": "7.3.8",
+      "version": "7.4.0",
       "commands": [
         "pwsh"
       ]
     },
-    "dotnet-format": {
-      "version": "5.1.250801",
-      "commands": [
-        "dotnet-format"
-      ]
-    },
     "dotnet-coverage": {
-      "version": "17.9.3",
+      "version": "17.9.5",
       "commands": [
         "dotnet-coverage"
       ]
@@ -27,4 +21,4 @@
       ]
     }
   }
-}
+}
diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
@@ -1,5 +1,5 @@
 # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions
-FROM mcr.microsoft.com/dotnet/sdk:7.0.401-jammy
+FROM mcr.microsoft.com/dotnet/sdk:8.0.100-jammy
 
 # Installing mono makes `dotnet test` work without errors even for net472.
 # But installing it takes a long time, so it's excluded by default.
diff --git a/.editorconfig b/.editorconfig
@@ -40,6 +40,7 @@ indent_size = 4
 [*.{cs,vb}]
 # Sort using and Import directives with System.* appearing first
 dotnet_sort_system_directives_first = true
+dotnet_separate_import_directive_groups = false
 dotnet_style_qualification_for_field = true:warning
 dotnet_style_qualification_for_property = true:warning
 dotnet_style_qualification_for_method = true:warning
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -8,7 +8,4 @@ updates:
   schedule:
     interval: weekly
   ignore:
-  # This package has unlisted versions on nuget.org that are not supported. Avoid them.
-  - dependency-name: dotnet-format
-    versions: ["6.x", "7.x", "8.x"]
   - dependency-name: Microsoft.CodeAnalysis* # We intentionally target older VS versions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -5,5 +5,9 @@
   "omnisharp.enableEditorConfigSupport": true,
   "omnisharp.enableRoslynAnalyzers": true,
   "dotnet.completion.showCompletionItemsFromUnimportedNamespaces": true,
-  "dotnet.defaultSolution": "Microsoft.VisualStudio.Threading.sln"
+  "dotnet.defaultSolution": "Microsoft.VisualStudio.Threading.sln",
+  "editor.formatOnSave": true,
+  "[xml]": {
+    "editor.wordWrap": "off"
+  }
 }
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,11 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
 <Project>
   <PropertyGroup>
     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
     <RepoRootPath>$(MSBuildThisFileDirectory)</RepoRootPath>
     <BaseIntermediateOutputPath>$(RepoRootPath)obj\$([MSBuild]::MakeRelative($(RepoRootPath), $(MSBuildProjectDirectory)))\</BaseIntermediateOutputPath>
     <BaseOutputPath Condition=" '$(BaseOutputPath)' == '' ">$(RepoRootPath)bin\$(MSBuildProjectName)\</BaseOutputPath>
     <PackageOutputPath>$(RepoRootPath)bin\Packages\$(Configuration)\NuGet\</PackageOutputPath>
-    <LangVersion>11</LangVersion>
+    <LangVersion>12</LangVersion>
     <Nullable>enable</Nullable>
     <ImplicitUsings>disable</ImplicitUsings>
     <AnalysisLevel>latest</AnalysisLevel>
diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
 <Project>
   <PropertyGroup>
     <!-- Workaround https://github.com/dotnet/wpf/issues/1718 -->
@@ -8,4 +9,6 @@
     <!-- Avoid compile error about missing namespace when combining ImplicitUsings with .NET Framework target frameworks. -->
     <Using Remove="System.Net.Http" Condition="'$(TargetFrameworkIdentifier)'=='.NETFramework'" />
   </ItemGroup>
+
+  <Import Project="azure-pipelines\NuGetSbom.targets" Condition="'$(IsPackable)'!='false'" />
 </Project>
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
 <Project>
   <!-- https://learn.microsoft.com/nuget/consume-packages/central-package-management -->
   <PropertyGroup>
@@ -24,7 +25,7 @@
     <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.CodeFix.Testing.XUnit" Version="$(CodefixTestingVersion)" />
     <PackageVersion Include="Microsoft.Diagnostics.Runtime.Utilities" Version="$(MicrosoftDiagnosticsRuntimeVersion)" />
     <PackageVersion Include="Microsoft.Diagnostics.Runtime" Version="$(MicrosoftDiagnosticsRuntimeVersion)" />
-    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.7.2" />
+    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
     <PackageVersion Include="Microsoft.VisualStudio.Internal.MicroBuild.NonShipping" Version="$(MicroBuildVersion)" />
     <PackageVersion Include="Microsoft.VisualStudio.Interop" Version="17.4.33103.184" />
     <PackageVersion Include="Microsoft.VisualStudio.Shell.15.0" Version="17.4.33103.184" />
@@ -34,16 +35,16 @@
     <PackageVersion Include="Microsoft.Windows.CsWin32" Version="0.2.188-beta" />
     <PackageVersion Include="Nullable" Version="1.3.1" />
     <PackageVersion Include="System.Collections.Immutable" Version="6.0.0" />
-    <PackageVersion Include="System.Drawing.Common" Version="7.0.0" />
+    <PackageVersion Include="System.Drawing.Common" Version="8.0.0" />
     <PackageVersion Include="System.Memory" Version="4.5.5" />
     <PackageVersion Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />
     <PackageVersion Include="System.Threading.Tasks.Dataflow" Version="7.0.0" />
     <PackageVersion Include="System.Threading.Tasks.Extensions" Version="4.5.4" />
     <PackageVersion Include="System.ValueTuple" Version="4.5.0" />
-    <PackageVersion Include="xunit" Version="2.5.3" />
+    <PackageVersion Include="xunit" Version="2.6.3" />
     <PackageVersion Include="xunit.abstractions" Version="2.0.3" />
-    <PackageVersion Include="Xunit.Combinatorial" Version="1.5.25" />
-    <PackageVersion Include="xunit.runner.visualstudio" Version="2.5.3" />
+    <PackageVersion Include="Xunit.Combinatorial" Version="1.6.24" />
+    <PackageVersion Include="xunit.runner.visualstudio" Version="2.5.5" />
     <PackageVersion Include="Xunit.SkippableFact" Version="1.4.13" />
     <PackageVersion Include="Xunit.StaFact" Version="1.1.11" />
   </ItemGroup>
@@ -56,6 +57,6 @@
     <GlobalPackageReference Include="StyleCop.Analyzers.Unstable" Version="1.2.0.507" />
   </ItemGroup>
   <ItemGroup>
-    <GlobalPackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" />
+    <GlobalPackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
   </ItemGroup>
 </Project>
diff --git a/azure-pipelines/Install-NuGetPackage.ps1 b/azure-pipelines/Install-NuGetPackage.ps1
@@ -45,7 +45,7 @@ try {
 
     if ($PSCmdlet.ShouldProcess($PackageId, 'nuget install')) {
         $p = Start-Process $nugetPath $nugetArgs -NoNewWindow -Wait -PassThru
-        if ($p.ExitCode -ne 0) { throw }
+        if ($null -ne $p.ExitCode -and $p.ExitCode -ne 0) { throw }
     }
 
     # Provide the path to the installed package directory to our caller.
diff --git a/azure-pipelines/NuGetSbom.targets b/azure-pipelines/NuGetSbom.targets
@@ -0,0 +1,12 @@
+<Project>
+  <PropertyGroup>
+    <GenerateSBOMThisProject>true</GenerateSBOMThisProject>
+    <TargetsForTfmSpecificBuildOutput>$(TargetsForTfmSpecificBuildOutput);IncludeSbomInNupkg</TargetsForTfmSpecificBuildOutput>
+  </PropertyGroup>
+
+  <Target Name="IncludeSbomInNupkg">
+    <ItemGroup>
+      <BuildOutputInPackage Include="@(SbomOutput)" />
+    </ItemGroup>
+  </Target>
+</Project>
diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/azure-pipelines/artifacts/_stage_all.ps1
@@ -30,6 +30,12 @@ function Create-SymbolicLink {
     } else {
         cmd /c "mklink `"$Link`" `"$Target`"" | Out-Null
     }
+
+    if ($LASTEXITCODE -ne 0) {
+        # Windows requires admin privileges to create symbolic links
+        # unless Developer Mode has been enabled.
+        throw "Failed to create symbolic link at $Link that points to $Target"
+    }
 }
 
 # Stage all artifacts
diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml
@@ -68,6 +68,9 @@ jobs:
   - template: dotnet.yml
     parameters:
       RunTests: ${{ parameters.RunTests }}
+  - script: dotnet format --verify-no-changes --no-restore
+    displayName: 💅 Verify formatted code
+    enabled: false
 
 - job: macOS
   condition: and(${{ parameters.includeMacOS }}, ne(variables['OptProf'], 'true'))
diff --git a/azure-pipelines/variables/TeamName.ps1 b/azure-pipelines/variables/TeamName.ps1
@@ -1,2 +1,2 @@
-# This value is used to craft a \\cpvsbuild\drops path for symbol archival.
+# This value is used as an input to the MicroBuild Insert VS task.
 'VS IDE'
diff --git a/global.json b/global.json
@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "7.0.401",
+    "version": "8.0.100",
     "rollForward": "patch",
     "allowPrerelease": false
   },
diff --git a/init.ps1 b/init.ps1
diff --git a/settings.VisualStudio.json b/settings.VisualStudio.json
@@ -0,0 +1,3 @@
+{
+  "textEditor.codeCleanup.profile": "profile1"
+}
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
 <Project>
   <!-- Include and reference README in nuget package, if a README is in the project directory. -->
   <PropertyGroup>
diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
 <Project>
   <ItemGroup>
     <Compile Include="$(MSBuildThisFileDirectory)AssemblyInfo.cs" />
diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs
@@ -47,9 +47,9 @@ internal static async Task<ImmutableArray<string>> ReadAdditionalFilesAsync(IEnu
         }
 
         IEnumerable<TextDocument>? docs = from doc in additionalFiles.OrderBy(x => x.FilePath, StringComparer.Ordinal)
-                   let fileName = Path.GetFileName(doc.Name)
-                   where fileNamePattern.IsMatch(fileName)
-                   select doc;
+                                          let fileName = Path.GetFileName(doc.Name)
+                                          where fileNamePattern.IsMatch(fileName)
+                                          select doc;
         ImmutableArray<string>.Builder? result = ImmutableArray.CreateBuilder<string>();
         foreach (TextDocument? doc in docs)
         {
diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs
@@ -71,9 +71,9 @@ private void AnalyzeNode(OperationAnalysisContext context)
                 if (firstArgExpression is IDelegateCreationOperation { Target: IAnonymousFunctionOperation anonFunc })
                 {
                     System.Collections.Generic.IEnumerable<IInvocationOperation>? problems = from invocation in anonFunc.Descendants().OfType<IInvocationOperation>()
-                                   let invokedSymbol = invocation.TargetMethod
-                                   where invokedSymbol is object && CommonInterest.SyncBlockingMethods.Any(m => m.Method.IsMatch(invokedSymbol))
-                                   select invocation;
+                                                                                             let invokedSymbol = invocation.TargetMethod
+                                                                                             where invokedSymbol is object && CommonInterest.SyncBlockingMethods.Any(m => m.Method.IsMatch(invokedSymbol))
+                                                                                             select invocation;
                     IInvocationOperation? firstProblem = problems.FirstOrDefault();
                     if (firstProblem is object)
                     {
diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs
@@ -36,14 +36,14 @@ public class AsyncLazy<T>
     private readonly object syncObject = new object();
 
     /// <summary>
-    /// The unique instance identifier.
+    /// An optional means to avoid deadlocks when synchronous APIs are called that must invoke async methods in user code.
     /// </summary>
-    private AsyncLocal<object>? recursiveFactoryCheck;
+    private readonly JoinableTaskFactory? jobFactory;
 
     /// <summary>
-    /// An optional means to avoid deadlocks when synchronous APIs are called that must invoke async methods in user code.
+    /// The unique instance identifier.
     /// </summary>
-    private readonly JoinableTaskFactory? jobFactory;
+    private AsyncLocal<object>? recursiveFactoryCheck;
 
     /// <summary>
     /// The function to invoke to produce the task.
diff --git a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs
@@ -121,7 +121,7 @@ public static void ApplyResultTo<T>(this Task<T> task, TaskCompletionSource<T> t
     /// <param name="task">The task whose completion should be applied to another.</param>
     /// <param name="tcs">The task that should receive the completion status.</param>
     public static void ApplyResultTo<T>(this Task task, TaskCompletionSource<T> tcs)
-        //// where T : defaultable
+    //// where T : defaultable
     {
         Requires.NotNull(task, nameof(task));
         Requires.NotNull(tcs, nameof(tcs));
diff --git a/test/Directory.Build.props b/test/Directory.Build.props
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
 <Project>
   <Import Project="$([MSBuild]::GetPathOfFileAbove($(MSBuildThisFile), $(MSBuildThisFileDirectory)..))" />
 
diff --git a/test/Directory.Build.targets b/test/Directory.Build.targets
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
 <Project>
   <Import Project="$([MSBuild]::GetPathOfFileAbove($(MSBuildThisFile), $(MSBuildThisFileDirectory)..))" />
 </Project>
diff --git a/test/IsolatedTestHost/App.config b/test/IsolatedTestHost/App.config
@@ -10,13 +10,13 @@
     <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
       <dependentAssembly>
         <assemblyIdentity name="xunit.core" publicKeyToken="8d05b1bb7a6fdb6c" culture="neutral" />
-        <bindingRedirect oldVersion="0.0.0.0-2.5.3.0" newVersion="2.5.3.0" />
+        <bindingRedirect oldVersion="0.0.0.0-2.6.3.0" newVersion="2.6.3.0" />
       </dependentAssembly>
     </assemblyBinding>
     <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
       <dependentAssembly>
         <assemblyIdentity name="xunit.execution.desktop" publicKeyToken="8d05b1bb7a6fdb6c" culture="neutral" />
-        <bindingRedirect oldVersion="0.0.0.0-2.5.3.0" newVersion="2.5.3.0" />
+        <bindingRedirect oldVersion="0.0.0.0-2.6.3.0" newVersion="2.6.3.0" />
       </dependentAssembly>
     </assemblyBinding>
   </runtime>
diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs
@@ -330,8 +330,8 @@ public class Test : CSharpCodeFixVerifier<VSTHRD002UseJtfRunAnalyzer, EmptyCodeF
             protected override IEnumerable<DiagnosticAnalyzer> GetDiagnosticAnalyzers()
             {
                 IEnumerable<DiagnosticAnalyzer>? analyzers = from type in typeof(VSTHRD002UseJtfRunAnalyzer).Assembly.GetTypes()
-                                where type.GetCustomAttributes(typeof(DiagnosticAnalyzerAttribute), true).Any()
-                                select (DiagnosticAnalyzer?)Activator.CreateInstance(type) ?? throw Assumes.Fail("Unable to instantiate the analyzer");
+                                                             where type.GetCustomAttributes(typeof(DiagnosticAnalyzerAttribute), true).Any()
+                                                             select (DiagnosticAnalyzer?)Activator.CreateInstance(type) ?? throw Assumes.Fail("Unable to instantiate the analyzer");
                 return analyzers.ToImmutableArray();
             }
         }
diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs
@@ -74,9 +74,9 @@ public void SetReturnsBeforeInlinedContinuations()
             .ContinueWith(
                 delegate
                 {
-                        // Arrange to synchronously block the continuation until Set() has returned,
-                        // which would deadlock if Set does not return until inlined continuations complete.
-                        Assert.True(setReturned.Wait(AsyncDelay));
+                    // Arrange to synchronously block the continuation until Set() has returned,
+                    // which would deadlock if Set does not return until inlined continuations complete.
+                    Assert.True(setReturned.Wait(AsyncDelay));
                 },
                 TaskContinuationOptions.ExecuteSynchronously);
         this.evt.Set();
diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs
@@ -4512,7 +4512,7 @@ await Task.WhenAll(
                     await secondLockInQueue.SetAsync();
                 }),
                 secondLockObtained.Task);
-            });
+        });
     }
 
     private Task UncontestedTopLevelLocksAllocFreeHelperAsync(Func<AsyncReaderWriterLock.Awaitable> locker, bool yieldingLock)
diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs
@@ -410,8 +410,8 @@ public void GetHangReportProducesDgmlWithNamedJoinableCollections()
             this.Logger.WriteLine(report.Content);
             var dgml = XDocument.Parse(report.Content);
             IEnumerable<string>? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements()
-                                    where node.Attribute(XName.Get("Category"))?.Value == "Collection"
-                                    select node.Attribute(XName.Get("Label"))?.Value;
+                                                    where node.Attribute(XName.Get("Category"))?.Value == "Collection"
+                                                    select node.Attribute(XName.Get("Label"))?.Value;
             Assert.Contains(collectionLabels, label => label == jtcName);
             return Task.CompletedTask;
         });
@@ -433,8 +433,8 @@ public void GetHangReportProducesDgmlWithMethodNameRequestingMainThread()
         this.Logger.WriteLine(report.Content);
         var dgml = XDocument.Parse(report.Content);
         IEnumerable<string>? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements()
-                                where node.Attribute(XName.Get("Category"))?.Value == "Task"
-                                select node.Attribute(XName.Get("Label"))?.Value;
+                                                where node.Attribute(XName.Get("Category"))?.Value == "Task"
+                                                select node.Attribute(XName.Get("Label"))?.Value;
         Assert.Contains(collectionLabels, label => label.Contains(nameof(this.GetHangReportProducesDgmlWithMethodNameRequestingMainThread)));
     }
 
@@ -456,8 +456,8 @@ public void GetHangReportProducesDgmlWithMethodNameYieldingOnMainThread()
             this.Logger.WriteLine(report.Content);
             var dgml = XDocument.Parse(report.Content);
             IEnumerable<string>? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements()
-                                    where node.Attribute(XName.Get("Category"))?.Value == "Task"
-                                    select node.Attribute(XName.Get("Label"))?.Value;
+                                                    where node.Attribute(XName.Get("Category"))?.Value == "Task"
+                                                    select node.Attribute(XName.Get("Label"))?.Value;
             Assert.Contains(collectionLabels, label => label.Contains(nameof(this.YieldingMethodAsync)));
         });
     }

Original file line number	Diff line number	Diff line change
`@@ -3,19 +3,13 @@`
`3`	`3`	`"isRoot": true,`
`4`	`4`	`"tools": {`
`5`	`5`	`"powershell": {`
`6`		`- "version": "7.3.8",`
	`6`	`+ "version": "7.4.0",`
`7`	`7`	`"commands": [`
`8`	`8`	`"pwsh"`
`9`	`9`	`]`
`10`	`10`	`},`
`11`		`- "dotnet-format": {`
`12`		`- "version": "5.1.250801",`
`13`		`- "commands": [`
`14`		`- "dotnet-format"`
`15`		`- ]`
`16`		`- },`
`17`	`11`	`"dotnet-coverage": {`
`18`		`- "version": "17.9.3",`
	`12`	`+ "version": "17.9.5",`
`19`	`13`	`"commands": [`
`20`	`14`	`"dotnet-coverage"`
`21`	`15`	`]`
`@@ -27,4 +21,4 @@`
`27`	`21`	`]`
`28`	`22`	`}`
`29`	`23`	`}`
`30`		`-}`
	`24`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ try {`
`45`	`45`
`46`	`46`	`if ($PSCmdlet.ShouldProcess($PackageId, 'nuget install')) {`
`47`	`47`	`$p = Start-Process $nugetPath $nugetArgs -NoNewWindow -Wait -PassThru`
`48`		`- if ($p.ExitCode -ne 0) { throw }`
	`48`	`+ if ($null -ne $p.ExitCode -and $p.ExitCode -ne 0) { throw }`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`# Provide the path to the installed package directory to our caller.`