Added more comments

cthtrifork · Nov 12, 2022 · cb98a17 · cb98a17
1 parent a84369d
commit cb98a17
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 3 deletions.
diff --git a/TodoApi.Tests/TodoApplication.cs b/TodoApi.Tests/TodoApplication.cs
@@ -42,12 +42,12 @@ protected override IHost CreateHost(IHostBuilder builder)
             services.AddDbContextFactory<TodoDbContext>(options => options.UseInMemoryDatabase("Testing", root));
         });
 
+        // We need to configure signing keys for CI scenarios where
+        // there's no user-jwts tool
         var keyBytes = new byte[32];
         RandomNumberGenerator.Fill(keyBytes);
         var base64Key = Convert.ToBase64String(keyBytes);
 
-        // We need to configure signing keys for CI scenarios where
-        // there's no user-jwts tool
         builder.ConfigureAppConfiguration(config =>
         {
             config.AddInMemoryCollection(new Dictionary<string, string?>

diff --git a/TodoApi/OpenApiExtensions.cs b/TodoApi/OpenApiExtensions.cs
@@ -5,6 +5,7 @@ namespace TodoApi;
 
 public static class OpenApiExtensions
 {
+    // Adds the JWT security scheme to the Open API description
     public static IEndpointConventionBuilder AddOpenApiSecurityRequirement(this IEndpointConventionBuilder builder)
     {
         var scheme = new OpenApiSecurityScheme()

diff --git a/TodoApi/OpenTelemetryExtensions.cs b/TodoApi/OpenTelemetryExtensions.cs
@@ -6,6 +6,8 @@ namespace TodoApi;
 
 public static class OpenTelemetryExtensions
 {
+    // Configures logging, distributed tracing, and metrics (with a prometheus endpoint)
+    // Other exporters can be configured to send telemetry to.
     public static WebApplicationBuilder AddOpenTelemetry(this WebApplicationBuilder builder)
     {
         var resourceBuilder = ResourceBuilder.CreateDefault().AddService(builder.Environment.ApplicationName);

diff --git a/TodoApi/Program.cs b/TodoApi/Program.cs
@@ -39,5 +39,7 @@
 
 // Configure the prometheus endpoint for scraping metrics
 app.MapPrometheusScrapingEndpoint();
+    // NOTE: This should only be exposed on an internal port!
+    // .RequireHost("*:9100");
 
 app.Run();
diff --git a/TodoApi/UserId.cs b/TodoApi/UserId.cs
@@ -2,11 +2,13 @@
 
 namespace TodoApi;
 
+// This is a struct that we're using to bind the relevant user
+// claims in a more friendly way.
 public record struct UserId(string Id, bool IsAdmin)
 {
     public static ValueTask<UserId> BindAsync(HttpContext context)
     {
-        // Grab the id claim
+        // Grab the id claim and check if the user is an admin
         var id = context.User.FindFirstValue("id")!;
         var isAdmin = context.User.IsInRole("admin");