From 4c653cf9fbd33aa35ddabcc40e1a9898e3edb689 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9rgio=20Silveira?= <sdsilveira@gmail.com>
Date: Wed, 22 May 2024 17:02:37 +0200
Subject: [PATCH] minor changes to the plugin interface

---
 src/EventStore.Plugins/IPlugableComponent.cs  |  7 +++----
 src/EventStore.Plugins/Plugin.cs              | 21 ++++++++++++-------
 .../Diagnostics/PluginMetricsTests.cs         |  2 +-
 .../PluginBaseTests.cs                        |  6 +++---
 4 files changed, 21 insertions(+), 15 deletions(-)

diff --git a/src/EventStore.Plugins/IPlugableComponent.cs b/src/EventStore.Plugins/IPlugableComponent.cs
index baf9347..6c34b51 100644
--- a/src/EventStore.Plugins/IPlugableComponent.cs
+++ b/src/EventStore.Plugins/IPlugableComponent.cs
@@ -43,13 +43,12 @@ public interface IPlugableComponent {
 	/// </summary>
 	/// <param name="services">The IServiceCollection to use for configuration.</param>
 	/// <param name="configuration">The IConfiguration to use for configuration.</param>
-	/// <returns>The configured IServiceCollection.</returns>
-	IServiceCollection ConfigureServices(IServiceCollection services, IConfiguration configuration);
+	void ConfigureServices(IServiceCollection services, IConfiguration configuration);
 
 	/// <summary>
 	///     Configures the application using the provided WebHostBuilderContext and IApplicationBuilder.
 	/// </summary>
 	/// <param name="builder">The IApplicationBuilder to use for configuration.</param>
-	/// <returns>The configured IApplicationBuilder.</returns>
-	IApplicationBuilder Configure(IApplicationBuilder builder);
+	/// <param name="configuration">The IConfiguration to use for configuration.</param>
+	void ConfigureApplication(IApplicationBuilder builder, IConfiguration configuration);
 }
\ No newline at end of file
diff --git a/src/EventStore.Plugins/Plugin.cs b/src/EventStore.Plugins/Plugin.cs
index 0b2aabe..6d3a9af 100644
--- a/src/EventStore.Plugins/Plugin.cs
+++ b/src/EventStore.Plugins/Plugin.cs
@@ -84,17 +84,15 @@ public virtual void ConfigureApplication(IApplicationBuilder app, IConfiguration
 
 	public virtual (bool Enabled, string EnableInstructions) IsEnabled(IConfiguration configuration) => (true, "");
 
-	IServiceCollection IPlugableComponent.ConfigureServices(IServiceCollection services, IConfiguration configuration) {
+	void IPlugableComponent.ConfigureServices(IServiceCollection services, IConfiguration configuration) {
 		Configuration = configuration;
 		IsEnabledResult = IsEnabled(configuration);
 
 		if (Enabled)
 			ConfigureServices(services, configuration);
-
-		return services;
 	}
 
-	IApplicationBuilder IPlugableComponent.Configure(IApplicationBuilder app) {
+	void IPlugableComponent.ConfigureApplication(IApplicationBuilder app, IConfiguration configuration) {
 		PublishDiagnostics(new() { ["enabled"] = Enabled });
 
 		var logger = app.ApplicationServices.GetRequiredService<ILoggerFactory>().CreateLogger(GetType());
@@ -109,7 +107,7 @@ IApplicationBuilder IPlugableComponent.Configure(IApplicationBuilder app) {
 				Version, IsEnabledResult.EnableInstructions
 			);
 
-			return app;
+			return;
 		}
 
 		logger.LogInformation("{Version} plugin enabled.", Version);
@@ -117,10 +115,14 @@ IApplicationBuilder IPlugableComponent.Configure(IApplicationBuilder app) {
 		ConfigureApplication(app, Configuration);
 
 		PublishDiagnostics(new() { ["enabled"] = Enabled });
-
-		return app;
 	}
 
+	/// <summary>
+	///   Publishes diagnostics data.
+	///   Used for ESDB telemetry
+	/// </summary>
+	/// <param name="eventName">The name of the event to publish.</param>
+	/// <param name="eventData">The data to publish.</param>
 	protected internal void PublishDiagnostics(string eventName, Dictionary<string, object?> eventData) {
 		DiagnosticListener.Write(
 			nameof(PluginDiagnosticsData),
@@ -133,6 +135,11 @@ protected internal void PublishDiagnostics(string eventName, Dictionary<string,
 		);
 	}
 
+	/// <summary>
+	///   Publishes diagnostics data.
+	///   Used for ESDB telemetry
+	/// </summary>
+	/// <param name="eventData">The data to publish.</param>
 	protected internal void PublishDiagnostics(Dictionary<string, object?> eventData) =>
 		PublishDiagnostics(nameof(PluginDiagnosticsData), eventData);
 
diff --git a/test/EventStore.Plugins.Tests/Diagnostics/PluginMetricsTests.cs b/test/EventStore.Plugins.Tests/Diagnostics/PluginMetricsTests.cs
index 0cc0ac2..2d51cd2 100644
--- a/test/EventStore.Plugins.Tests/Diagnostics/PluginMetricsTests.cs
+++ b/test/EventStore.Plugins.Tests/Diagnostics/PluginMetricsTests.cs
@@ -18,7 +18,7 @@ public void can_receive_metrics_from_plugin() {
 
 		using var app = builder.Build();
 
-		plugin.Configure(app);
+		plugin.ConfigureApplication(app, builder.Configuration);
 
 		using var collector = new MetricCollector<int>(
 			app.Services.GetRequiredService<IMeterFactory>(),
diff --git a/test/EventStore.Plugins.Tests/PluginBaseTests.cs b/test/EventStore.Plugins.Tests/PluginBaseTests.cs
index 375d179..6ff092d 100644
--- a/test/EventStore.Plugins.Tests/PluginBaseTests.cs
+++ b/test/EventStore.Plugins.Tests/PluginBaseTests.cs
@@ -50,7 +50,7 @@ public void comercial_plugin_is_disabled_when_licence_is_missing() {
 
 		using var app = builder.Build();
 
-		Action configure = () => plugin.Configure(app);
+		var configure = () => plugin.ConfigureApplication(app, EmptyConfiguration);
 
 		// Act & Assert
 		configure.Should().Throw<PluginLicenseException>().Which
@@ -75,7 +75,7 @@ public void comercial_plugin_is_disabled_when_licence_is_invalid() {
 
 		using var app = builder.Build();
 
-		Action configure = () => plugin.Configure(app);
+		var configure = () => plugin.ConfigureApplication(app, EmptyConfiguration);
 
 		// Act & Assert
 		configure.Should().Throw<PluginLicenseException>().Which
@@ -99,7 +99,7 @@ public void comercial_plugin_is_enabled_when_licence_is_present() {
 
 		using var app = builder.Build();
 
-		Action configure = () => plugin.Configure(app);
+		var configure = () => plugin.ConfigureApplication(app, builder.Configuration);
 
 		// Act & Assert
 		configure.Should().NotThrow<Exception>();