Add "Include Error Detail=true" to API postgres connection strings (#44)

Adds an extension method .WithDevSettings that can be called on an
IResourceBuilder<PostgresDatabaseResource> resource that appends common
development settings to the connection string.

Currently, it only adds "Include Error Detail=true" to show detailed
error messages, but additional settings could be added as needed in the
future.

Author: sei-aschlackman

Crucible.AppHost/AppHost.cs

@@ -111,7 +111,8 @@ public static void AddPlayer(this IDistributedApplicationBuilder builder, IResou
         if (!options.AddAllApplications && !options.Player)
             return;
 
-        var playerDb = postgres.AddDatabase("playerDb", "player");
+        var playerDb = postgres.AddDatabase("playerDb", "player")
+            .WithDevSettings();
 
         builder.ConfigureApiSecrets(
             new Projects.Player_Api().ProjectPath,
@@ -149,8 +150,10 @@ public static void AddPlayer(this IDistributedApplicationBuilder builder, IResou
 
     private static void AddPlayerVm(this IDistributedApplicationBuilder builder, IResourceBuilder<PostgresServerResource> postgres, IResourceBuilder<KeycloakResource> keycloak, bool startByDefault)
     {
-        var vmDb = postgres.AddDatabase("vmDb", "player_vm");
-        var vmLoggingDb = postgres.AddDatabase("vmLoggingDb", "player_vm_logging");
+        var vmDb = postgres.AddDatabase("vmDb", "player_vm")
+            .WithDevSettings();
+        var vmLoggingDb = postgres.AddDatabase("vmLoggingDb", "player_vm_logging")
+            .WithDevSettings();
 
         builder.ConfigureApiSecrets(
             new Projects.Player_Vm_Api().ProjectPath,
@@ -205,7 +208,8 @@ public static void AddCaster(this IDistributedApplicationBuilder builder, IResou
         if (!options.AddAllApplications && !options.Caster)
             return;
 
-        var casterDb = postgres.AddDatabase("casterDb", "caster");
+        var casterDb = postgres.AddDatabase("casterDb", "caster")
+            .WithDevSettings();
 
         builder.ConfigureApiSecrets(
             new Projects.Caster_Api().ProjectPath,
@@ -268,7 +272,8 @@ public static void AddAlloy(this IDistributedApplicationBuilder builder, IResour
         if (!options.AddAllApplications && !options.Alloy)
             return;
 
-        var alloyDb = postgres.AddDatabase("alloyDb", "alloy");
+        var alloyDb = postgres.AddDatabase("alloyDb", "alloy")
+            .WithDevSettings();
 
         builder.ConfigureApiSecrets(
             new Projects.Alloy_Api().ProjectPath,
@@ -316,7 +321,8 @@ public static void AddTopoMojo(this IDistributedApplicationBuilder builder, IRes
         if (!options.AddAllApplications && !options.TopoMojo)
             return;
 
-        var topoDb = postgres.AddDatabase("topoDb", "topomojo");
+        var topoDb = postgres.AddDatabase("topoDb", "topomojo")
+            .WithDevSettings();
 
         builder.ConfigureApiSecrets(
             new Projects.TopoMojo_Api().ProjectPath,
@@ -385,7 +391,8 @@ public static void AddSteamfitter(this IDistributedApplicationBuilder builder, I
         if (!options.AddAllApplications && !options.Steamfitter)
             return;
 
-        var steamfitterDb = postgres.AddDatabase("steamfitterDb", "steamfitter");
+        var steamfitterDb = postgres.AddDatabase("steamfitterDb", "steamfitter")
+            .WithDevSettings();
 
         builder.ConfigureApiSecrets(
             new Projects.Steamfitter_Api().ProjectPath,
@@ -431,7 +438,8 @@ public static void AddCite(this IDistributedApplicationBuilder builder, IResourc
         if (!options.AddAllApplications && !options.Cite)
             return;
 
-        var citeDb = postgres.AddDatabase("citeDb", "cite");
+        var citeDb = postgres.AddDatabase("citeDb", "cite")
+            .WithDevSettings();
 
         builder.ConfigureApiSecrets(
             new Projects.Cite_Api().ProjectPath,
@@ -477,7 +485,8 @@ public static void AddGallery(this IDistributedApplicationBuilder builder, IReso
         if (!options.AddAllApplications && !options.Gallery)
             return;
 
-        var galleryDb = postgres.AddDatabase("galleryDb", "gallery");
+        var galleryDb = postgres.AddDatabase("galleryDb", "gallery")
+            .WithDevSettings();
 
         builder.ConfigureApiSecrets(
             new Projects.Gallery_Api().ProjectPath,
@@ -523,7 +532,8 @@ public static void AddBlueprint(this IDistributedApplicationBuilder builder, IRe
         if (!options.AddAllApplications && !options.Blueprint)
             return;
 
-        var blueprintDb = postgres.AddDatabase("blueprintDb", "blueprint");
+        var blueprintDb = postgres.AddDatabase("blueprintDb", "blueprint")
+            .WithDevSettings();
 
         builder.ConfigureApiSecrets(
             new Projects.Blueprint_Api().ProjectPath,
@@ -568,7 +578,8 @@ public static void AddGameboard(this IDistributedApplicationBuilder builder, IRe
         if (!options.AddAllApplications && !options.Gameboard)
             return;
 
-        var gameboardDb = postgres.AddDatabase("gameboardDb", "gameboard");
+        var gameboardDb = postgres.AddDatabase("gameboardDb", "gameboard")
+            .WithDevSettings();
 
         builder.ConfigureApiSecrets(
             new Projects.Gameboard_Api().ProjectPath,
@@ -781,4 +792,5 @@ private static void SetUserSecret(string projectFilePath, string key, string val
             return -1;
         }
     }
+
 }

Crucible.AppHost/ConnectionStringExtensions.cs

@@ -0,0 +1,38 @@
+// Copyright 2025 Carnegie Mellon University. All Rights Reserved.
+// Released under a MIT (SEI)-style license. See LICENSE.md in the project root for license information.
+
+public static class ConnectionStringExtensions
+{
+    /// <summary>
+    /// Append common dev settings to the connection string of a postgres database. e.g. "Include Error Detail=true".
+    /// </summary>
+    /// <param name="database">The postgres database whose connection string will be appended to</param>
+    /// <returns>An IResourceWithConnectionString, rather than the original IResourceBuilder PostgresDatabaseResource.
+    /// If the caller needs any specific properties of the original resource beyond those available in the IResourceWithConnectionString interface,
+    /// they may need to be added to the AppendConnectionStringResource.</returns>
+    public static IResourceBuilder<IResourceWithConnectionString> WithDevSettings(this IResourceBuilder<PostgresDatabaseResource> database)
+    {
+        return database.AddConnectionStringData($"Include Error Detail=True");
+    }
+
+    // Adapted from https://github.com/dotnet/aspire/discussions/3605#discussioncomment-9090161
+    // Adds a custom resource that appends to another resource's connection string
+    public static IResourceBuilder<IResourceWithConnectionString> AddConnectionStringData(this IResourceBuilder<IResourceWithConnectionString> builder, ReferenceExpression.ExpressionInterpolatedStringHandler connectionStringData)
+    {
+        return builder.ApplicationBuilder.AddResource(new AppendConnectionStringResource(builder.Resource, ReferenceExpression.Create(connectionStringData)))
+            .WithInitialState(new CustomResourceSnapshot
+            {
+                Properties = [],
+                ResourceType = "ConnectionStringData",
+                State = "Hidden" // Hide from the dashboard
+            });
+    }
+
+    class AppendConnectionStringResource(IResourceWithConnectionString previous, ReferenceExpression referenceExpression) :
+        Resource($"{previous.Name}-ConnectionString"), IResourceWithConnectionString
+    {
+        public string? ConnectionStringEnvironmentVariable => previous.ConnectionStringEnvironmentVariable;
+
+        public ReferenceExpression ConnectionStringExpression => ReferenceExpression.Create($"{previous};{referenceExpression}");
+    }
+}

Crucible.AppHost/Crucible.AppHost.csproj

@@ -5,7 +5,9 @@
     <TargetFramework>net10.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <NoWarn>$(NoWarn);ASPIRECERTIFICATES001</NoWarn>
+    <NoWarn>$(NoWarn);1591</NoWarn>
     <UserSecretsId>98efcc77-ed92-4f61-8c56-50f0fbbb7eb2</UserSecretsId>
   </PropertyGroup>