Implement package testing in ASP.NET Core repo

[rquackenbush]

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

Adding health checks with AddHealthChecks().AddCheck() prevents calls to IHealthCheckPublisher.PublishAsync.

Expected Behavior

I expect IHealthCheckPublisher.PublishAsync to be called where .AddCheck has been called or not.

Steps To Reproduce

https://github.com/anvilcloud/HealthChecksRepro

Exceptions (if any)

None.

.NET Version

7.0.100

Anything else?

IDE
Microsoft Visual Studio Professional 2022 (64-bit) - Current
Version 17.4.2

dotnet --info

.NET SDK:
 Version:   7.0.100
 Commit:    e12b7af219

Runtime Environment:
 OS Name:     Windows
 OS Version:  10.0.19044
 OS Platform: Windows
 RID:         win10-x64
 Base Path:   C:\Program Files\dotnet\sdk\7.0.100\

Host:
  Version:      7.0.0
  Architecture: x64
  Commit:       d099f075e4

.NET SDKs installed:
  7.0.100 [C:\Program Files\dotnet\sdk]

.NET runtimes installed:
  Microsoft.AspNetCore.All 2.1.30 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All]
  Microsoft.AspNetCore.App 2.1.30 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
  Microsoft.AspNetCore.App 3.1.31 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
  Microsoft.AspNetCore.App 6.0.11 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
  Microsoft.AspNetCore.App 7.0.0 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
  Microsoft.NETCore.App 2.1.30 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 3.1.31 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 5.0.17 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 6.0.9 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 6.0.11 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 7.0.0 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.WindowsDesktop.App 3.1.31 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
  Microsoft.WindowsDesktop.App 6.0.11 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
  Microsoft.WindowsDesktop.App 7.0.0 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

Other architectures found:
  x86   [C:\Program Files (x86)\dotnet]
    registered at [HKLM\SOFTWARE\dotnet\Setup\InstalledVersions\x86\InstallLocation]

Environment variables:
  Not set

global.json file:
  Not found

Learn more:
  https://aka.ms/dotnet/info

Download .NET:
  https://aka.ms/dotnet/download

Update: This works if the TargetFramework is set to net7.0. Unfortunately I need to do this in net6.0.

[rquackenbush]

Downgrading the HealthChecks packages worked for me

<PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions" Version="6.0.14" />
<PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="6.0.14" />

[halter73]

Thanks for the repro. You're issue seems to be mainly that you're mixing Microsoft.Extensions.Diagnostics.HealthChecks 7.0.3 with a net6.0 target framework. This forces you to use it as a netstandard2.0 dependency since there's only a net7.0 and no net6.0 dependency.

When used as a netstandard2.0 dependency on net6.0, you apparently need Microsoft.Bcl.AsyncInterfaces because we call DisposeAsync in DefaultHealthCheckService.RunCheckAsync, but RunCheckAsync gets skipped if there are no registrations.

aspnetcore/src/HealthChecks/HealthChecks/src/DefaultHealthCheckService.cs

Lines 78 to 81 in 63a0251

	var scope = _scopeFactory.CreateAsyncScope();
	await using (scope.ConfigureAwait(false))
	{
	var healthCheck = registration.Factory(scope.ServiceProvider);

System.IO.FileNotFoundException: 'Could not load file or assembly 'Microsoft.Bcl.AsyncInterfaces, Version=7.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51'. The system cannot find the file specified.'
   at Microsoft.Extensions.Diagnostics.HealthChecks.DefaultHealthCheckService.RunCheckAsync(HealthCheckRegistration registration, CancellationToken cancellationToken)
   at System.Threading.Tasks.Task`1.InnerInvoke() in /_/src/libraries/System.Private.CoreLib/src/System/Threading/Tasks/Future.cs:line 503

aspnetcore/src/HealthChecks/HealthChecks/src/DefaultHealthCheckService.cs

Line 79 in 63a0251

await using (scope.ConfigureAwait(false))

For now, you can work around this issue by either.

1. Upgrading your app to target net7.0, so Microsoft.Extensions.Diagnostics.HealthChecks can be used as a net7.0 depencency.
2. Downgrading your Microsoft.Extensions.Diagnostics.HealthChecks dependency to 6.0.14, so it can be used as a net6.0 dependency.
3. Manually adding the <PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="7.0.0" /> package reference that Microsoft.Extensions.Diagnostics.HealthChecks probably should have added transitively for you.

Our recommendation is always to try to keep versions aligned if possible since that will keep you on the most well-tested path, but I still think we should probably add Microsoft.Bcl.AsyncInterfaces as a netstandard2.0 dependency for this package.

@dotnet/dnceng @dotnet/aspnet-build. Is there some way to automatically detect we're using IAsyncDisposable or IAsyncEnumerable to a NuGet package targeting netstandard2.0 and fail the build if there's no Microsoft.Bcl.AsyncInterfaces dependency?

[halter73]

@rquackenbush Thanks for the bug report and posting the resolution yourself, I'm reopening this to track the following question:

@dotnet/dnceng @dotnet/aspnet-build. Is there some way to automatically detect we're using IAsyncDisposable or IAsyncEnumerable to a NuGet package targeting netstandard2.0 and fail the build if there's no Microsoft.Bcl.AsyncInterfaces dependency?

[alexperovich]

@dotnet/dnceng @dotnet/aspnet-build. Is there some way to automatically detect we're using IAsyncDisposable or IAsyncEnumerable to a NuGet package targeting netstandard2.0 and fail the build if there's no Microsoft.Bcl.AsyncInterfaces dependency?

You shouldn't be able to compile code using them without the reference. I'm surprised the package compiled in the netstandard2.0 trm.

[alexperovich]

The result should be one of the "Missing Compiler required member" errors.

[dougbu]

@rquackenbush Thanks for the bug report and posting the resolution yourself, I'm reopening this to track the following question:

@dotnet/dnceng @dotnet/aspnet-build. Is there some way to automatically detect we're using IAsyncDisposable or IAsyncEnumerable to a NuGet package targeting netstandard2.0 and fail the build if there's no Microsoft.Bcl.AsyncInterfaces dependency?

@dotnet/nuget-team sorry for the broad notification. Would appreciate your thoughts on any options that may be available. My only thought would involve complicated msbuild bits in a Microsoft.Extensions.Diagnostics.HealthChecks.targets file. That would only cover this specific issue and hunting for all IAsyncDisposable code in our repo would also ignore all other dotnet/* code.

To @alexperovich's point, it's not clear how compilation succeeded. Has anyone gathered a binary log to help us (or the Roslyn team) figure that part out❔

[alexperovich]

This should be easily fixed with a <PackageReference Condition="'$(TargetFramework)' == 'netstandard2.0'" Include="Microsoft.Bcl.AsyncInterfaces" />

[dougbu]

This should be easily fixed with a <PackageReference Condition="'$(TargetFramework)' == 'netstandard2.0'" Include="Microsoft.Bcl.AsyncInterfaces" />

Yeah, my "complicated msbuild bits" comment was a wild exaggeration. Still worried about the general issue of finding all the packages we ship that might hit similar issues.

[alexperovich]

The code compiling is the real problem. It should fail building.

[dougbu]

Let's get a binary log (someone❔) and bring in @jaredpar to get his opinion.