More cleanup

excos-platform · Feb 2, 2025 · adc71c2 · adc71c2
1 parent 62ff1cc
commit adc71c2
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 10 deletions.
diff --git a/src/Excos.Platform.Common/Marten/StoreConfigurationExtensions.cs b/src/Excos.Platform.Common/Marten/StoreConfigurationExtensions.cs
@@ -19,6 +19,14 @@ namespace Excos.Platform.Common.Marten;
 
 public static class StoreConfigurationExtensions
 {
+	/// <summary>
+	/// Adds a Marten store for the custom <typeparamref name="TStore"/> interface and prepares it to work with Wolverine
+	/// with multi-tenancy support.
+	/// </summary>
+	/// <typeparam name="TStore">Custom data store interface</typeparam>
+	/// <param name="build">Host builder</param>
+	/// <param name="dbSchemaName">Database schema name for the store, also used for wolverine subscriptions and keyed services.</param>
+	/// <param name="configureOptions">Extra configuration</param>
 	public static IHostApplicationBuilder AddExcosMartenStore<TStore>(
 		this IHostApplicationBuilder builder,
 		string dbSchemaName,
@@ -36,12 +44,12 @@ public static IHostApplicationBuilder AddExcosMartenStore<TStore>(
 	/// Adds a Marten store for the custom <typeparamref name="TStore"/> interface and prepares it to work with Wolverine
 	/// with multi-tenancy support.
 	/// </summary>
-	/// <typeparam name="TStore"></typeparam>
-	/// <param name="services"></param>
-	/// <param name="hostEnvironment"></param>
-	/// <param name="configuration"></param>
-	/// <param name="dbSchemaName"></param>
-	/// <param name="configureOptions"></param>
+	/// <typeparam name="TStore">Custom data store interface</typeparam>
+	/// <param name="services">Dependency injection services collection</param>
+	/// <param name="hostEnvironment">Environment</param>
+	/// <param name="configuration">Configuration</param>
+	/// <param name="dbSchemaName">Database schema name for the store, also used for wolverine subscriptions and keyed services.</param>
+	/// <param name="configureOptions">Extra configuration</param>
 	/// <returns></returns>
 	public static IServiceCollection AddExcosMartenStore<TStore>(
 		this IServiceCollection services,

diff --git a/src/Excos.Platform.Common/Wolverine/Telemetry/EventLoggingPolicy.cs b/src/Excos.Platform.Common/Wolverine/Telemetry/EventLoggingPolicy.cs
@@ -8,6 +8,9 @@
 
 namespace Excos.Platform.Common.Wolverine.Telemetry;
 
+/// <summary>
+/// Add event fields logging on the current activity for all event handlers.
+/// </summary>
 public class EventLoggingPolicy : IHandlerPolicy
 {
 	public void Apply(IReadOnlyList<HandlerChain> chains, GenerationRules rules, IServiceContainer container)

diff --git a/src/Excos.Platform.Common/Wolverine/Telemetry/LoggingEventHandler.cs b/src/Excos.Platform.Common/Wolverine/Telemetry/LoggingEventHandler.cs
@@ -13,12 +13,20 @@ namespace Excos.Platform.Common.Wolverine.Telemetry
 {
 	public static class LoggingEventHandlerExtensions
 	{
+		/// <summary>
+		/// Add an event handler which will log event details.
+		/// </summary>
+		/// <typeparam name="T">Event type</typeparam>
 		public static HandlerDiscovery AddLogger<T>(this HandlerDiscovery discovery)
 		{
 			return discovery.IncludeType(typeof(LoggingEventHandler<T>));
 		}
 	}
 
+	/// <summary>
+	/// An event hadnler which logs event details.
+	/// </summary>
+	/// <typeparam name="T">Event type</typeparam>
 	public static class LoggingEventHandler<T>
 	{
 		public static void Handle(T message, Envelope envelope, ILogger<T> logger, PrivacyValueRedactor redactor)
@@ -32,7 +40,6 @@ public static void Handle(T message, Envelope envelope, ILogger<T> logger, Priva
 			{
 				{ "EnvelopeId", envelope.Id },
 				{ "ConversationId", envelope.ConversationId == Guid.Empty ? null : envelope.ConversationId },
-				// { "CorrelationId", envelope.CorrelationId }, this is just trace id so it's stamped on logs anyways
 				{ "TenantId", envelope.TenantId },
 				{ "Source", envelope.Source },
 				{ "SentAt", envelope.SentAt },

diff --git a/src/Excos.Platform.WebApiHost/Excos.Platform.WebApiHost.csproj b/src/Excos.Platform.WebApiHost/Excos.Platform.WebApiHost.csproj
@@ -18,6 +18,10 @@
 		<PackageReference Include="WolverineFx.Marten" />
 	</ItemGroup>
 
+	<ItemGroup>
+		<ProjectReference Include="..\Excos.Platform.Common\Excos.Platform.Common.csproj" />
+	</ItemGroup>
+
 	<PropertyGroup>
 		<ContainerRepository>excos</ContainerRepository>
 		<ContainerImageTags>latest;$(InformationalVersion)</ContainerImageTags>
@@ -26,8 +30,5 @@
 	<ItemGroup>
 		<ContainerPort Include="80" Type="tcp" />
 	</ItemGroup>
-	<ItemGroup>
-	  <ProjectReference Include="..\Excos.Platform.Common\Excos.Platform.Common.csproj" />
-	</ItemGroup>
 
 </Project>