Cleanup and acceptance test for incompatible metrics use (#534)

* Significant cleanup

* Small refactoring

* Previous feature had a public default constructor which was public. Bring it back

* Add an acceptance test for the throwing scenario

* Don't use $(SolutionDir) in key path

* Update NServiceBus

* Move Recoverability wire up back to EnableMetrics

* Replace Guards with built-in helpers

* Configure serializer

* Clean up workflow files

* Use primary constructors

* Make struct readonly

---------

Co-authored-by: Brandon Ording <[email protected]>

.github/workflows/ci.yml

@@ -29,7 +29,6 @@ jobs:
         uses: actions/[email protected]
         with:
           dotnet-version: 8.0.x
-          dotnet-quality: 'preview'
       - name: Build
         run: dotnet build src --configuration Release
       - name: Upload packages

.github/workflows/release.yml

@@ -18,7 +18,6 @@ jobs:
         uses: actions/[email protected]
         with:
           dotnet-version: 8.0.x
-          dotnet-quality: 'preview'
       - name: Build
         run: dotnet build src --configuration Release
       - name: Sign NuGet packages

src/NServiceBus.Metrics.AcceptanceTests/EndpointTemplates/DefaultServer.cs

@@ -1,38 +1,23 @@
 namespace NServiceBus.AcceptanceTests.EndpointTemplates
 {
     using System;
-    using System.Collections.Generic;
     using System.IO;
     using System.Threading.Tasks;
     using AcceptanceTesting.Customization;
     using AcceptanceTesting.Support;
 
     public class DefaultServer : IEndpointSetupTemplate
     {
-        public DefaultServer()
-        {
-            typesToInclude = [];
-        }
-
-        public DefaultServer(List<Type> typesToInclude)
-        {
-            this.typesToInclude = typesToInclude;
-        }
-
         public async Task<EndpointConfiguration> GetConfiguration(RunDescriptor runDescriptor, EndpointCustomizationConfiguration endpointConfiguration, Func<EndpointConfiguration, Task> configurationBuilderCustomization)
         {
-            var types = endpointConfiguration.GetTypesScopedByTestClass();
-
-            typesToInclude.AddRange(types);
-
             var configuration = new EndpointConfiguration(endpointConfiguration.EndpointName);
 
-            configuration.TypesToIncludeInScan(typesToInclude);
             configuration.EnableInstallers();
 
             configuration.UsePersistence<AcceptanceTestingPersistence>();
             var storageDir = Path.Combine(NServiceBusAcceptanceTest.StorageRootDir, NUnit.Framework.TestContext.CurrentContext.Test.ID);
             configuration.UseTransport(new LearningTransport { StorageDirectory = storageDir });
+            configuration.UseSerialization<SystemJsonSerializer>();
 
             var recoverability = configuration.Recoverability();
             recoverability.Delayed(delayed => delayed.NumberOfRetries(0));
@@ -42,9 +27,10 @@ public async Task<EndpointConfiguration> GetConfiguration(RunDescriptor runDescr
 
             await configurationBuilderCustomization(configuration);
 
+            // scan types at the end so that all types used by the configuration have been loaded into the AppDomain
+            configuration.ScanTypesForTest(endpointConfiguration);
+
             return configuration;
         }
-
-        List<Type> typesToInclude;
     }
 }

src/NServiceBus.Metrics.AcceptanceTests/NServiceBus.Metrics.AcceptanceTests.csproj

@@ -13,7 +13,7 @@
   <ItemGroup>
     <PackageReference Include="GitHubActionsTestLogger" Version="2.3.3"/>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
-    <PackageReference Include="NServiceBus.AcceptanceTesting" Version="9.0.0-alpha.1" />
+    <PackageReference Include="NServiceBus.AcceptanceTesting" Version="9.0.0" />
     <PackageReference Include="NUnit" Version="3.14.0" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
   </ItemGroup>

src/NServiceBus.Metrics.AcceptanceTests/Tests/When_having_metrics_handlers_registered.cs

@@ -26,7 +26,7 @@ public When_having_metrics_handlers_registered()
     {
         var probesNames = typeof(IProbe).Assembly.GetTypes()
             .Where(t => t.GetCustomAttribute<ProbePropertiesAttribute>() != null)
-            .Select(t => t.GetCustomAttribute<ProbePropertiesAttribute>().Name)
+            .Select(t => t.GetCustomAttribute<ProbePropertiesAttribute>()!.Name)
             .ToArray();
 
         errorProbes =
@@ -67,8 +67,7 @@ public async Task Should_call_fail_probes_on_success()
         var context = await Scenario.Define<Context>()
             .WithEndpoint<ThrowingReporter>(b => b.When(s => s.SendLocal(new MyMessage())).DoNotFailOnErrorMessages())
             .Done(c => c.Values.Count >= errorProbes.Count)
-            .Run()
-            .ConfigureAwait(false);
+            .Run();
 
         foreach (var kvp in context.Values)
         {
@@ -86,30 +85,24 @@ class Context : ScenarioContext
 
     class ConsumingReporter : EndpointConfigurationBuilder
     {
-        public ConsumingReporter()
-        {
+        public ConsumingReporter() =>
             EndpointSetup<DefaultServer>((c, r) =>
             {
                 var context = (Context)r.ScenarioContext;
 
                 c.EnableMetrics().RegisterObservers(
                     ctx => { RegisterWritesToTestContext(ctx, context); });
             });
-        }
 
         public class MyHandler : IHandleMessages<MyMessage>
         {
-            public Task Handle(MyMessage message, IMessageHandlerContext context)
-            {
-                return Task.Delay(100);
-            }
+            public Task Handle(MyMessage message, IMessageHandlerContext context) => Task.Delay(100);
         }
     }
 
     class ThrowingReporter : EndpointConfigurationBuilder
     {
-        public ThrowingReporter()
-        {
+        public ThrowingReporter() =>
             EndpointSetup<DefaultServer>((c, r) =>
             {
                 c.Recoverability().Immediate(immediate => immediate.NumberOfRetries(1));
@@ -118,17 +111,12 @@ public ThrowingReporter()
                 c.EnableMetrics().RegisterObservers(
                     ctx => { RegisterWritesToTestContext(ctx, context); });
             });
-        }
 
 
         public class MyHandler : IHandleMessages<MyMessage>
         {
             public Task Handle(MyMessage message, IMessageHandlerContext context)
-            {
-                var tcs = new TaskCompletionSource<object>();
-                tcs.SetException(new Exception());
-                return tcs.Task;
-            }
+                => Task.FromException<Exception>(new Exception());
         }
     }