centralize log assignment

Author: Mpdreamz

.editorconfig

@@ -213,6 +213,9 @@ csharp_style_namespace_declarations = file_scoped
 dotnet_analyzer_diagnostic.severity = warning
 dotnet_analyzer_diagnostic.category-Style.severity = warning
 
+# can be made static
+dotnet_diagnostic.CA1822.severity = suggestion
+
 # https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1848
 dotnet_diagnostic.CA1848.severity = suggestion
 # https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca2201

src/tooling/docs-assembler/Cli/DeployCommands.cs

@@ -103,8 +103,6 @@ public async Task<int> Apply(
 	/// <param name="redirectsFile">Path to the redirects mapping pre-generated by docs-assembler</param>
 	/// <param name="ctx"></param>
 	[Command("update-redirects")]
-	[ConsoleAppFilter<StopwatchFilter>]
-	[ConsoleAppFilter<CatchExceptionFilter>]
 	public async Task<int> UpdateRedirects(
 		string environment,
 		string redirectsFile = ".artifacts/assembly/redirects.json",

src/tooling/docs-assembler/Cli/NavigationCommands.cs

@@ -29,8 +29,6 @@ private void AssignOutputLogger()
 	/// <summary> Validates navigation.yml does not contain colliding path prefixes </summary>
 	/// <param name="ctx"></param>
 	[Command("validate")]
-	[ConsoleAppFilter<StopwatchFilter>]
-	[ConsoleAppFilter<CatchExceptionFilter>]
 	public async Task<int> Validate(Cancel ctx = default)
 	{
 		AssignOutputLogger();
@@ -56,8 +54,6 @@ public async Task<int> Validate(Cancel ctx = default)
 	/// <param name="file">Path to `links.json` defaults to '.artifacts/docs/html/links.json'</param>
 	/// <param name="ctx"></param>
 	[Command("validate-link-reference")]
-	[ConsoleAppFilter<StopwatchFilter>]
-	[ConsoleAppFilter<CatchExceptionFilter>]
 	public async Task<int> ValidateLocalLinkReference([Argument] string? file = null, Cancel ctx = default)
 	{
 		AssignOutputLogger();

src/tooling/docs-assembler/Program.cs

@@ -2,13 +2,15 @@
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
 
+using System.Diagnostics.CodeAnalysis;
 using Actions.Core.Services;
 using ConsoleAppFramework;
 using Documentation.Assembler.Cli;
 using Elastic.Documentation.Diagnostics;
 using Elastic.Documentation.Tooling;
 using Elastic.Documentation.Tooling.Filters;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
 
 await using var serviceProvider = DocumentationTooling.CreateServiceProvider(ref args, services => services
 	.AddSingleton<DiagnosticsChannel>()
@@ -19,6 +21,7 @@
 ConsoleApp.ServiceProvider = serviceProvider;
 
 var app = ConsoleApp.Create();
+app.UseFilter<ReplaceLogFilter>();
 app.UseFilter<StopwatchFilter>();
 app.UseFilter<CatchExceptionFilter>();
 
@@ -35,3 +38,16 @@
 	args = command.Split(' ');
 
 await app.RunAsync(args);
+
+internal sealed class ReplaceLogFilter(ConsoleAppFilter next, ILogger<Program> logger)
+	: ConsoleAppFilter(next)
+{
+	[SuppressMessage("Usage", "CA2254:Template should be a static expression")]
+	public override Task InvokeAsync(ConsoleAppContext context, Cancel cancellationToken)
+	{
+		ConsoleApp.Log = msg => logger.LogInformation(msg);
+		ConsoleApp.LogError = msg => logger.LogError(msg);
+
+		return Next.InvokeAsync(context, cancellationToken);
+	}
+}

src/tooling/docs-builder/Cli/Commands.cs

@@ -2,7 +2,6 @@
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
 
-using System.Diagnostics.CodeAnalysis;
 using System.IO.Abstractions;
 using System.IO.Abstractions.TestingHelpers;
 using Actions.Core.Services;
@@ -13,7 +12,6 @@
 using Elastic.Documentation.Configuration.Versions;
 using Elastic.Documentation.Refactor;
 using Elastic.Documentation.Tooling.Diagnostics.Console;
-using Elastic.Documentation.Tooling.Filters;
 using Elastic.Markdown;
 using Elastic.Markdown.Exporters;
 using Elastic.Markdown.IO;
@@ -22,16 +20,9 @@
 
 namespace Documentation.Builder.Cli;
 
-internal sealed class Commands(ILoggerFactory logger, ICoreService githubActionsService, IOptions<VersionsConfiguration> versionsConfigOption)
+internal sealed class Commands(ILoggerFactory logFactory, ICoreService githubActionsService, IOptions<VersionsConfiguration> versionsConfigOption)
 {
-	private readonly ILogger<Program> _log = logger.CreateLogger<Program>();
-
-	[SuppressMessage("Usage", "CA2254:Template should be a static expression")]
-	private void AssignOutputLogger()
-	{
-		ConsoleApp.Log = msg => _log.LogInformation(msg);
-		ConsoleApp.LogError = msg => _log.LogError(msg);
-	}
+	private readonly ILogger<Program> _log = logFactory.CreateLogger<Program>();
 
 	/// <summary>
 	///	Continuously serve a documentation folder at http://localhost:3000.
@@ -43,11 +34,9 @@ private void AssignOutputLogger()
 	/// <param name="port">Port to serve the documentation.</param>
 	/// <param name="ctx"></param>
 	[Command("serve")]
-	[ConsoleAppFilter<CheckForUpdatesFilter>]
 	public async Task Serve(string? path = null, int port = 3000, Cancel ctx = default)
 	{
-		AssignOutputLogger();
-		var host = new DocumentationWebHost(path, port, logger, new FileSystem(), new MockFileSystem(), versionsConfigOption.Value);
+		var host = new DocumentationWebHost(path, port, logFactory, new FileSystem(), new MockFileSystem(), versionsConfigOption.Value);
 		_log.LogInformation("Find your documentation at http://localhost:{Port}/{Path}", port,
 			host.GeneratorState.Generator.DocumentationSet.FirstInterestingUrl.TrimStart('/')
 		);
@@ -56,22 +45,20 @@ public async Task Serve(string? path = null, int port = 3000, Cancel ctx = defau
 	}
 
 	/// <summary>
-	/// Serve html files directly
+	/// Serve HTML files directly
 	/// </summary>
 	/// <param name="port">Port to serve the documentation.</param>
 	/// <param name="ctx"></param>
 	[Command("serve-static")]
-	[ConsoleAppFilter<CheckForUpdatesFilter>]
 	public async Task ServeStatic(int port = 4000, Cancel ctx = default)
 	{
-		AssignOutputLogger();
 		var host = new StaticWebHost(port);
 		await host.RunAsync(ctx);
 		await host.StopAsync(ctx);
 	}
 
 	/// <summary>
-	/// Converts a source markdown folder or file to an output folder
+	/// Converts a source Markdown folder or file to an output folder
 	/// <para>global options:</para>
 	/// --log-level level
 	/// </summary>
@@ -80,14 +67,11 @@ public async Task ServeStatic(int port = 4000, Cancel ctx = default)
 	/// <param name="pathPrefix"> Specifies the path prefix for urls </param>
 	/// <param name="force"> Force a full rebuild of the destination folder</param>
 	/// <param name="strict"> Treat warnings as errors and fail the build on warnings</param>
-	/// <param name="allowIndexing"> Allow indexing and following of html files</param>
+	/// <param name="allowIndexing"> Allow indexing and following of HTML files</param>
 	/// <param name="metadataOnly"> Only emit documentation metadata to output</param>
 	/// <param name="canonicalBaseUrl"> The base URL for the canonical url tag</param>
 	/// <param name="ctx"></param>
 	[Command("generate")]
-	[ConsoleAppFilter<StopwatchFilter>]
-	[ConsoleAppFilter<CatchExceptionFilter>]
-	[ConsoleAppFilter<CheckForUpdatesFilter>]
 	public async Task<int> Generate(
 		string? path = null,
 		string? output = null,
@@ -100,10 +84,9 @@ public async Task<int> Generate(
 		Cancel ctx = default
 	)
 	{
-		AssignOutputLogger();
 		pathPrefix ??= githubActionsService.GetInput("prefix");
 		var fileSystem = new FileSystem();
-		await using var collector = new ConsoleDiagnosticsCollector(logger, githubActionsService).StartAsync(ctx);
+		await using var collector = new ConsoleDiagnosticsCollector(logFactory, githubActionsService).StartAsync(ctx);
 
 		var runningOnCi = !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("GITHUB_ACTIONS"));
 		BuildContext context;
@@ -139,7 +122,7 @@ public async Task<int> Generate(
 			var outputDirectory = !string.IsNullOrWhiteSpace(output)
 				? fileSystem.DirectoryInfo.New(output)
 				: fileSystem.DirectoryInfo.New(Path.Combine(Paths.WorkingDirectoryRoot.FullName, ".artifacts/docs/html"));
-			// we temporarily do not error when pointed to a non documentation folder.
+			// we temporarily do not error when pointed to a non-documentation folder.
 			_ = fileSystem.Directory.CreateDirectory(outputDirectory.FullName);
 
 			ConsoleApp.Log($"Skipping build as we are running on a merge commit and the docs folder is out of date and has no docset.yml. {e.Message}");
@@ -152,7 +135,7 @@ public async Task<int> Generate(
 			await githubActionsService.SetOutputAsync("skip", "false");
 
 		// always delete output folder on CI
-		var set = new DocumentationSet(context, logger);
+		var set = new DocumentationSet(context, logFactory);
 		if (runningOnCi)
 			set.ClearOutputDirectory();
 
@@ -161,11 +144,11 @@ public async Task<int> Generate(
 			metadataOnly ??= metaValue;
 		var exporter = metadataOnly.HasValue && metadataOnly.Value ? new NoopDocumentationFileExporter() : null;
 
-		var generator = new DocumentationGenerator(set, logger, null, null, null, exporter);
+		var generator = new DocumentationGenerator(set, logFactory, null, null, null, exporter);
 		_ = await generator.GenerateAll(ctx);
 
 
-		var openApiGenerator = new OpenApiGenerator(context, generator.MarkdownStringRenderer, logger);
+		var openApiGenerator = new OpenApiGenerator(context, generator.MarkdownStringRenderer, logFactory);
 		await openApiGenerator.Generate(ctx);
 
 		if (runningOnCi)
@@ -180,21 +163,18 @@ public async Task<int> Generate(
 	}
 
 	/// <summary>
-	/// Converts a source markdown folder or file to an output folder
+	/// Converts a source Markdown folder or file to an output folder
 	/// </summary>
 	/// <param name="path"> -p, Defaults to the`{pwd}/docs` folder</param>
 	/// <param name="output"> -o, Defaults to `.artifacts/html` </param>
 	/// <param name="pathPrefix"> Specifies the path prefix for urls </param>
 	/// <param name="force"> Force a full rebuild of the destination folder</param>
 	/// <param name="strict"> Treat warnings as errors and fail the build on warnings</param>
-	/// <param name="allowIndexing"> Allow indexing and following of html files</param>
+	/// <param name="allowIndexing"> Allow indexing and following of HTML files</param>
 	/// <param name="metadataOnly"> Only emit documentation metadata to output</param>
 	/// <param name="canonicalBaseUrl"> The base URL for the canonical url tag</param>
 	/// <param name="ctx"></param>
 	[Command("")]
-	[ConsoleAppFilter<StopwatchFilter>]
-	[ConsoleAppFilter<CatchExceptionFilter>]
-	[ConsoleAppFilter<CheckForUpdatesFilter>]
 	public async Task<int> GenerateDefault(
 		string? path = null,
 		string? output = null,
@@ -218,9 +198,6 @@ public async Task<int> GenerateDefault(
 	/// <param name="dryRun">Dry run the move operation</param>
 	/// <param name="ctx"></param>
 	[Command("mv")]
-	[ConsoleAppFilter<StopwatchFilter>]
-	[ConsoleAppFilter<CatchExceptionFilter>]
-	[ConsoleAppFilter<CheckForUpdatesFilter>]
 	public async Task<int> Move(
 		[Argument] string source,
 		[Argument] string target,
@@ -229,13 +206,12 @@ public async Task<int> Move(
 		Cancel ctx = default
 	)
 	{
-		AssignOutputLogger();
 		var fileSystem = new FileSystem();
-		await using var collector = new ConsoleDiagnosticsCollector(logger, null).StartAsync(ctx);
+		await using var collector = new ConsoleDiagnosticsCollector(logFactory, null).StartAsync(ctx);
 		var context = new BuildContext(collector, fileSystem, fileSystem, versionsConfigOption.Value, path, null);
-		var set = new DocumentationSet(context, logger);
+		var set = new DocumentationSet(context, logFactory);
 
-		var moveCommand = new Move(fileSystem, fileSystem, set, logger);
+		var moveCommand = new Move(fileSystem, fileSystem, set, logFactory);
 		var result = await moveCommand.Execute(source, target, dryRun ?? false, ctx);
 		await collector.StopAsync(ctx);
 		return result;

src/tooling/docs-builder/Cli/DiffCommands.cs

@@ -26,14 +26,8 @@ internal sealed class DiffCommands(ILoggerFactory logger, ICoreService githubAct
 	/// <param name="ctx"></param>
 	[SuppressMessage("Usage", "CA2254:Template should be a static expression")]
 	[Command("validate")]
-	[ConsoleAppFilter<StopwatchFilter>]
-	[ConsoleAppFilter<CatchExceptionFilter>]
 	public async Task<int> ValidateRedirects([Argument] string? path = null, Cancel ctx = default)
 	{
-		var log = logger.CreateLogger<Program>();
-		ConsoleApp.Log = msg => log.LogInformation(msg);
-		ConsoleApp.LogError = msg => log.LogError(msg);
-
 		path ??= "docs";
 
 		await using var collector = new ConsoleDiagnosticsCollector(logger, githubActionsService).StartAsync(ctx);

src/tooling/docs-builder/Cli/InboundLinkCommands.cs

@@ -20,21 +20,11 @@ internal sealed class InboundLinkCommands(ILoggerFactory logger, ICoreService gi
 	private readonly LinkIndexLinkChecker _linkIndexLinkChecker = new(logger);
 	private readonly ILogger<Program> _log = logger.CreateLogger<Program>();
 
-	[SuppressMessage("Usage", "CA2254:Template should be a static expression")]
-	private void AssignOutputLogger()
-	{
-		ConsoleApp.Log = msg => _log.LogInformation(msg);
-		ConsoleApp.LogError = msg => _log.LogError(msg);
-	}
-
 	/// <summary> Validate all published cross_links in all published links.json files. </summary>
 	/// <param name="ctx"></param>
 	[Command("validate-all")]
-	[ConsoleAppFilter<StopwatchFilter>]
-	[ConsoleAppFilter<CatchExceptionFilter>]
 	public async Task<int> ValidateAllInboundLinks(Cancel ctx = default)
 	{
-		AssignOutputLogger();
 		await using var collector = new ConsoleDiagnosticsCollector(logger, githubActionsService).StartAsync(ctx);
 		await _linkIndexLinkChecker.CheckAll(collector, ctx);
 		await collector.StopAsync(ctx);
@@ -46,11 +36,8 @@ public async Task<int> ValidateAllInboundLinks(Cancel ctx = default)
 	/// <param name="to">Outbound links 'to' repository form others</param>
 	/// <param name="ctx"></param>
 	[Command("validate")]
-	[ConsoleAppFilter<StopwatchFilter>]
-	[ConsoleAppFilter<CatchExceptionFilter>]
 	public async Task<int> ValidateRepoInboundLinks(string? from = null, string? to = null, Cancel ctx = default)
 	{
-		AssignOutputLogger();
 		var fs = new FileSystem();
 		var root = fs.DirectoryInfo.New(Paths.WorkingDirectoryRoot.FullName);
 		if (from == null && to == null)
@@ -72,11 +59,8 @@ public async Task<int> ValidateRepoInboundLinks(string? from = null, string? to
 	/// <param name="path"> -p, Defaults to the `{pwd}` folder</param>
 	/// <param name="ctx"></param>
 	[Command("validate-link-reference")]
-	[ConsoleAppFilter<StopwatchFilter>]
-	[ConsoleAppFilter<CatchExceptionFilter>]
 	public async Task<int> ValidateLocalLinkReference(string? file = null, string? path = null, Cancel ctx = default)
 	{
-		AssignOutputLogger();
 		file ??= ".artifacts/docs/html/links.json";
 		var fs = new FileSystem();
 		var root = !string.IsNullOrEmpty(path) ? fs.DirectoryInfo.New(path) : fs.DirectoryInfo.New(Paths.WorkingDirectoryRoot.FullName);

src/tooling/docs-builder/Program.cs

@@ -2,21 +2,39 @@
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
 
+using System.Diagnostics.CodeAnalysis;
 using ConsoleAppFramework;
 using Documentation.Builder.Cli;
-using Elastic.Documentation.Diagnostics;
 using Elastic.Documentation.Tooling;
-using Microsoft.Extensions.DependencyInjection;
+using Elastic.Documentation.Tooling.Filters;
+using Microsoft.Extensions.Logging;
 
-await using var serviceProvider = DocumentationTooling.CreateServiceProvider(ref args, services => services
-	.AddSingleton<DiagnosticsChannel>()
-	.AddSingleton<DiagnosticsCollector>()
-);
+await using var serviceProvider = DocumentationTooling.CreateServiceProvider(ref args, _ => { });
 ConsoleApp.ServiceProvider = serviceProvider;
 
 var app = ConsoleApp.Create();
+
+app.UseFilter<ReplaceLogFilter>();
+app.UseFilter<StopwatchFilter>();
+app.UseFilter<CatchExceptionFilter>();
+app.UseFilter<CheckForUpdatesFilter>();
+
 app.Add<Commands>();
 app.Add<InboundLinkCommands>("inbound-links");
 app.Add<DiffCommands>("diff");
 
 await app.RunAsync(args).ConfigureAwait(false);
+
+
+internal sealed class ReplaceLogFilter(ConsoleAppFilter next, ILogger<Program> logger)
+	: ConsoleAppFilter(next)
+{
+	[SuppressMessage("Usage", "CA2254:Template should be a static expression")]
+	public override Task InvokeAsync(ConsoleAppContext context, Cancel cancellationToken)
+	{
+		ConsoleApp.Log = msg => logger.LogInformation(msg);
+		ConsoleApp.LogError = msg => logger.LogError(msg);
+
+		return Next.InvokeAsync(context, cancellationToken);
+	}
+}