Merge pull request #55 from purview-dev/updated-sample-app

feat: updated sample app to use Minimal API

Author: kieronlanning

README.md

@@ -66,6 +66,8 @@ interface IEntityStoreTelemetry
 }
 ```
 
-Checkout the [.NET Aspire Sample](https://github.com/purview-dev/purview-telemetry-sourcegenerator/tree/main/samples/SampleApp) Project to see the Activities, Logging, and Metrics working with the dashaboard.
-
 For more information see the [wiki](https://github.com/purview-dev/purview-telemetry-sourcegenerator/wiki).
+
+Checkout the [.NET Aspire Sample](https://github.com/purview-dev/purview-telemetry-sourcegenerator/tree/main/samples/SampleApp) Project to see the Activities, Logging, and Metrics working with the Aspire Dashboard.
+
+> This sample project has `EmitCompilerGeneratedFiles` set to `true`, so you can easily see the generated output.

samples/SampleApp/SampleApp.Host/APIs/Models.cs

@@ -0,0 +1,11 @@
+using Microsoft.AspNetCore.Mvc;
+using SampleApp.Host.Services;
+
+record DefaultWeatherRequest(
+	[FromServices] IWeatherService WeatherService,
+	CancellationToken Token);
+
+record WeatherRequest(
+	int RequestCount,
+	[FromServices] IWeatherService WeatherService,
+	CancellationToken Token);

samples/SampleApp/SampleApp.Host/APIs/WeatherAPI.cs

@@ -0,0 +1,61 @@
+using Microsoft.AspNetCore.Http.HttpResults;
+
+namespace SampleApp.Host.APIs;
+
+static class WeatherAPI
+{
+	public static IEndpointRouteBuilder MapWeatherAPIv1(this IEndpointRouteBuilder app)
+	{
+		var api = app
+			.MapGroup("/weatherforecast")
+			//.MapToApiVersion(1.0)
+			.WithDisplayName("Weather APIs")
+		;
+
+		api.MapGet("/", GetDefaultWeatherRequestAsync)
+			.WithDescription("Gets the weather forecasts, defaults to 5.")
+			.WithDisplayName("5 Weather Forecasts")
+		;
+
+		api.MapGet("/{requestCount:int}", GetWeatherRequestAsync)
+			.WithDescription("Gets the weather forecasts.")
+			.WithDisplayName("Weather Forecasts")
+		;
+
+		return api;
+	}
+
+	static async Task<Results<Ok<WeatherForecast[]>, NoContent, ProblemHttpResult>> GetDefaultWeatherRequestAsync([AsParameters] DefaultWeatherRequest request)
+	{
+		try
+		{
+			var results = await request.WeatherService.GetWeatherForecastsAsync(5, request.Token);
+			return results.Any()
+				? TypedResults.Ok(results.ToArray())
+				: TypedResults.NoContent();
+		}
+		catch (Exception ex)
+		{
+			return TypedResults.Problem(detail: ex.Message, statusCode: 502);
+		}
+	}
+
+	static async Task<Results<Ok<WeatherForecast[]>, NoContent, ProblemHttpResult, BadRequest<string>>> GetWeatherRequestAsync([AsParameters] WeatherRequest request)
+	{
+		try
+		{
+			var results = await request.WeatherService.GetWeatherForecastsAsync(request.RequestCount, request.Token);
+			return results.Any()
+				? TypedResults.Ok(results.ToArray())
+				: TypedResults.NoContent();
+		}
+		catch (ArgumentOutOfRangeException ex)
+		{
+			return TypedResults.BadRequest(ex.Message);
+		}
+		catch (Exception ex)
+		{
+			return TypedResults.Problem(detail: ex.Message, statusCode: 502);
+		}
+	}
+}

samples/SampleApp/SampleApp.Host/Controllers/WeatherForecastController.cs

@@ -1,46 +1,31 @@
+using SampleApp.Host.APIs;
 using SampleApp.Host.Services;
 
-namespace SampleApp.Host;
+var builder = WebApplication.CreateSlimBuilder(args);
 
-public class Program
-{
-	public static void Main(string[] args)
-	{
-		var builder = WebApplication.CreateBuilder(args);
-		builder.AddServiceDefaults();
-		builder.Services.AddMetrics();
+builder
+	.AddServiceDefaults()
+	.AddDefaultOpenAPI(
+	//builder.Services.AddApiVersioning()
+	)
+;
 
-		// Add services to the container.
+builder.Services
+	.AddScoped<IWeatherService, WeatherService>()
+	.AddWeatherServiceTelemetry()
+;
 
-		// This is a generated method that adds the
-		// IWeatherServiceTelemetry interface to the container
-		// as a singleton.
-		builder.Services.AddWeatherServiceTelemetry();
+var app = builder.Build();
 
-		builder.Services.AddTransient<IWeatherService, WeatherService>();
+app.MapDefaultEndpoints();
 
-		builder.Services.AddControllers();
-		// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
-		builder.Services.AddEndpointsApiExplorer();
-		builder.Services.AddSwaggerGen();
+//app
+//.NewVersionedApi("Weather API")
+//.MapToApiVersion(1.0)
+//;
 
-		var app = builder.Build();
+app.MapWeatherAPIv1();
 
-		app.MapDefaultEndpoints();
+app.UseDefaultOpenAPI();
 
-		// Configure the HTTP request pipeline.
-		if (app.Environment.IsDevelopment())
-		{
-			app.UseSwagger();
-			app.UseSwaggerUI();
-		}
-
-		app.UseHttpsRedirection();
-
-		app.UseAuthorization();
-
-		app.MapControllers();
-
-		app.Run();
-	}
-}
+await app.RunAsync();

samples/SampleApp/SampleApp.Host/Program.cs

@@ -13,7 +13,7 @@
       "commandName": "Project",
       "dotnetRunMessages": true,
       "launchBrowser": true,
-      "launchUrl": "swagger",
+      "launchUrl": "",
       "applicationUrl": "http://localhost:5275",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
@@ -23,7 +23,7 @@
       "commandName": "Project",
       "dotnetRunMessages": true,
       "launchBrowser": true,
-      "launchUrl": "swagger",
+      "launchUrl": "",
       "applicationUrl": "https://localhost:7015;http://localhost:5275",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
@@ -32,7 +32,7 @@
     "IIS Express": {
       "commandName": "IISExpress",
       "launchBrowser": true,
-      "launchUrl": "swagger",
+      "launchUrl": "",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       }

samples/SampleApp/SampleApp.Host/Properties/launchSettings.json

@@ -14,7 +14,6 @@
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
 		</PackageReference>
-		<PackageReference Include="Swashbuckle.AspNetCore" Version="7.2.0" />
 	</ItemGroup>
 
 	<ItemGroup>

samples/SampleApp/SampleApp.Host/SampleApp.Host.csproj

@@ -2,5 +2,5 @@
 
 public interface IWeatherService
 {
-	IEnumerable<WeatherForecast> GetWeatherForecastsAsync(int requestCount, CancellationToken cancellationToken = default);
+	Task<IEnumerable<WeatherForecast>> GetWeatherForecastsAsync(int requestCount, CancellationToken cancellationToken = default);
 }

samples/SampleApp/SampleApp.Host/Services/IWeatherService.cs

@@ -19,30 +19,48 @@ namespace SampleApp.Host.Services;
 [Meter]
 public interface IWeatherServiceTelemetry
 {
+	// --> Start: Activities
+
 	[Activity(ActivityKind.Client)]
-	Activity? GettingWeatherForecastFromUpstreamService([Baggage] string someRandomBaggageInfo, int requestedCount, int validatedRequestedCount);
+	Activity? GettingWeatherForecastFromUpstreamService([Baggage] string someRandomBaggageInfo, int requestedCount);
 
 	[Event]
 	void ForecastReceived(Activity? activity, int minTempInC, int maxTempInC);
 
-	[Event]
+	[Event(ActivityStatusCode.Error)]
 	void FailedToRetrieveForecast(Activity? activity, Exception ex);
 
+	[Event(ActivityStatusCode.Ok)]
+	void TemperaturesReceived(Activity? activity, TimeSpan elapsed);
+
+	// --> END: Activities
+
+	// --> START: Meters
+
 	[AutoCounter]
 	void WeatherForecastRequested();
 
 	[AutoCounter]
 	void ItsTooCold(int tooColdCount);
 
+	[Histogram]
+	void HistogramOfTemperature(int temperature);
+
+	// --> END: Meters
+
+	// --> START: Logs
+
 	[Log(LogLevel.Warning)]
 	void TemperatureOutOfRange(int minTempInC);
 
-	[Warning]
-	void RequestedCountIsTooSmall(int requestCount, int validatedRequestedCount);
+	[Error]
+	void RequestedCountIsTooSmall(int requestCount);
 
 	[Info]
-	void TemperatureWithinRange();
+	void TemperaturesWithinRange();
 
-	[Error]
+	[Critical]
 	void WeatherForecastRequestFailed(Exception ex);
+
+	// --> END: Logs
 }

samples/SampleApp/SampleApp.Host/Services/IWeatherServiceTelemetry.cs

@@ -1,27 +1,30 @@
-namespace SampleApp.Host.Services;
+using System.Diagnostics;
+
+namespace SampleApp.Host.Services;
 
 sealed class WeatherService(IWeatherServiceTelemetry telemetry) : IWeatherService
 {
-	const int _tooColdTempInC = -10;
+	const int TooColdTempInC = -10;
 
-	static readonly string[] _summaries =
+	static readonly string[] Summaries =
 	[
 		"Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
 	];
 
-	public IEnumerable<WeatherForecast> GetWeatherForecastsAsync(int requestCount, CancellationToken cancellationToken = default)
+	public Task<IEnumerable<WeatherForecast>> GetWeatherForecastsAsync(int requestCount, CancellationToken cancellationToken = default)
 	{
-		var validatedRequestedCount = requestCount;
-		if (validatedRequestedCount < 5)
+		const int minRequestCount = 5;
+		const int maxRequestCount = 20;
+
+		if (requestCount < minRequestCount || requestCount > maxRequestCount)
 		{
-			validatedRequestedCount = 5;
+			telemetry.RequestedCountIsTooSmall(requestCount);
 
-			telemetry.RequestedCountIsTooSmall(requestCount, validatedRequestedCount);
+			throw new ArgumentOutOfRangeException(nameof(requestCount), $"Requested count must be at least {minRequestCount}, and no greater than {maxRequestCount}.");
 		}
 
-		using var activity = telemetry.GettingWeatherForecastFromUpstreamService($"{Guid.NewGuid()}",
-			requestCount,
-			validatedRequestedCount);
+		var sw = Stopwatch.StartNew();
+		using var activity = telemetry.GettingWeatherForecastFromUpstreamService($"{Guid.NewGuid()}", requestCount);
 
 		telemetry.WeatherForecastRequested();
 
@@ -39,27 +42,35 @@ public IEnumerable<WeatherForecast> GetWeatherForecastsAsync(int requestCount, C
 			throw ex;
 		}
 
-		var results = Enumerable.Range(1, validatedRequestedCount).Select(index => new WeatherForecast
+		var results = Enumerable.Range(1, requestCount).Select(index => new WeatherForecast
 		{
-			Date = DateOnly.FromDateTime(DateTime.UtcNow.AddDays(index)),
+			Date = DateOnly.FromDateTime(DateTime.UtcNow.AddDays(--index)),
 			TemperatureC = Random.Shared.Next(-20, 55),
-			Summary = _summaries[Random.Shared.Next(_summaries.Length)]
+			Summary = Summaries[Random.Shared.Next(Summaries.Length)]
 		}).ToArray();
 
+		foreach (var wf in results)
+			telemetry.HistogramOfTemperature(wf.TemperatureC);
+
 		var minTempInC = results.Min(m => m.TemperatureC);
 		telemetry.ForecastReceived(activity,
 			minTempInC,
 			results.Max(wf => wf.TemperatureC)
 		);
 
-		if (minTempInC < _tooColdTempInC)
+		if (minTempInC < TooColdTempInC)
 		{
 			telemetry.TemperatureOutOfRange(minTempInC);
-			telemetry.ItsTooCold(results.Count(wf => wf.TemperatureC < _tooColdTempInC));
+			telemetry.ItsTooCold(results.Count(wf => wf.TemperatureC < TooColdTempInC));
 		}
 		else
-			telemetry.TemperatureWithinRange();
+			telemetry.TemperaturesWithinRange();
+
+		sw.Stop();
+
+		telemetry.TemperaturesReceived(activity, sw.Elapsed);
 
-		return results;
+		// This isn't really async, we're just pretending.
+		return Task.FromResult(results.AsEnumerable());
 	}
 }