Refactor command logging a tad (#1547)

* centralize log assignment

* Normalize ILoggerFactory arguments

* fix post browser conflict resolve build error

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/Elastic.ApiExplorer/OpenApiGenerator.cs

@@ -38,9 +38,9 @@ public record ApiEndpoint(List<ApiOperation> Operations, string? Name) : IApiGro
 	public Task RenderAsync(FileSystemStream stream, ApiRenderContext context, CancellationToken ctx = default) => Task.CompletedTask;
 }
 
-public class OpenApiGenerator(BuildContext context, IMarkdownStringRenderer markdownStringRenderer, ILoggerFactory logger)
+public class OpenApiGenerator(ILoggerFactory logFactory, BuildContext context, IMarkdownStringRenderer markdownStringRenderer)
 {
-	private readonly ILogger _logger = logger.CreateLogger<OpenApiGenerator>();
+	private readonly ILogger _logger = logFactory.CreateLogger<OpenApiGenerator>();
 	private readonly IFileSystem _writeFileSystem = context.WriteFileSystem;
 	private readonly StaticFileContentHashProvider _contentHashProvider = new(new EmbeddedOrPhysicalFileProvider(context));
 

src/Elastic.Markdown/DocumentationGenerator.cs

@@ -53,7 +53,7 @@ public class DocumentationGenerator
 
 	public DocumentationGenerator(
 		DocumentationSet docSet,
-		ILoggerFactory logger,
+		ILoggerFactory logFactory,
 		INavigationHtmlWriter? navigationHtmlWriter = null,
 		IDocumentationFileOutputProvider? documentationFileOutputProvider = null,
 		IMarkdownExporter[]? markdownExporters = null,
@@ -67,7 +67,7 @@ public DocumentationGenerator(
 		_documentationFileOutputProvider = documentationFileOutputProvider;
 		_conversionCollector = conversionCollector;
 		_writeFileSystem = docSet.Context.WriteFileSystem;
-		_logger = logger.CreateLogger(nameof(DocumentationGenerator));
+		_logger = logFactory.CreateLogger(nameof(DocumentationGenerator));
 
 		DocumentationSet = docSet;
 		Context = docSet.Context;

src/Elastic.Markdown/IO/DocumentationSet.cs

@@ -134,7 +134,7 @@ public class DocumentationSet : INavigationLookups, IPositionalNavigation
 
 	public DocumentationSet(
 		BuildContext context,
-		ILoggerFactory logger,
+		ILoggerFactory logFactory,
 		ICrossLinkResolver? linkResolver = null,
 		TableOfContentsTreeCollector? treeCollector = null
 	)
@@ -144,7 +144,7 @@ public DocumentationSet(
 		SourceDirectory = context.DocumentationSourceDirectory;
 		OutputDirectory = context.DocumentationOutputDirectory;
 		LinkResolver =
-			linkResolver ?? new CrossLinkResolver(new ConfigurationCrossLinkFetcher(context.Configuration, Aws3LinkIndexReader.CreateAnonymous(), logger));
+			linkResolver ?? new CrossLinkResolver(new ConfigurationCrossLinkFetcher(logFactory, context.Configuration, Aws3LinkIndexReader.CreateAnonymous()));
 		Configuration = context.Configuration;
 		EnabledExtensions = InstantiateExtensions();
 		treeCollector ??= new TableOfContentsTreeCollector();

src/Elastic.Markdown/Links/CrossLinks/ConfigurationCrossLinkFetcher.cs

@@ -10,7 +10,7 @@
 
 namespace Elastic.Markdown.Links.CrossLinks;
 
-public class ConfigurationCrossLinkFetcher(ConfigurationFile configuration, ILinkIndexReader linkIndexProvider, ILoggerFactory logger) : CrossLinkFetcher(linkIndexProvider, logger)
+public class ConfigurationCrossLinkFetcher(ILoggerFactory logFactory, ConfigurationFile configuration, ILinkIndexReader linkIndexProvider) : CrossLinkFetcher(logFactory, linkIndexProvider)
 {
 	public override async Task<FetchedCrossLinks> Fetch(Cancel ctx)
 	{

src/Elastic.Markdown/Links/CrossLinks/CrossLinkFetcher.cs

@@ -32,9 +32,9 @@ public record FetchedCrossLinks
 	};
 }
 
-public abstract class CrossLinkFetcher(ILinkIndexReader linkIndexProvider, ILoggerFactory logger) : IDisposable
+public abstract class CrossLinkFetcher(ILoggerFactory logFactory, ILinkIndexReader linkIndexProvider) : IDisposable
 {
-	private readonly ILogger _logger = logger.CreateLogger(nameof(CrossLinkFetcher));
+	private readonly ILogger _logger = logFactory.CreateLogger(nameof(CrossLinkFetcher));
 	private readonly HttpClient _client = new();
 	private LinkRegistry? _linkIndex;
 
@@ -151,7 +151,7 @@ private void WriteLinksJsonCachedFile(string repository, LinkRegistryEntry linkR
 	public void Dispose()
 	{
 		_client.Dispose();
-		logger.Dispose();
+		logFactory.Dispose();
 		GC.SuppressFinalize(this);
 	}
 }

src/Elastic.Markdown/Links/InboundLinks/LinkIndexCrossLinkFetcher.cs

@@ -10,7 +10,7 @@
 
 namespace Elastic.Markdown.Links.InboundLinks;
 
-public class LinksIndexCrossLinkFetcher(ILinkIndexReader linkIndexProvider, ILoggerFactory logger) : CrossLinkFetcher(linkIndexProvider, logger)
+public class LinksIndexCrossLinkFetcher(ILoggerFactory logFactory, ILinkIndexReader linkIndexProvider) : CrossLinkFetcher(logFactory, linkIndexProvider)
 {
 	public override async Task<FetchedCrossLinks> Fetch(Cancel ctx)
 	{

src/Elastic.Markdown/Links/InboundLinks/LinkIndexLinkChecker.cs

@@ -11,9 +11,9 @@
 
 namespace Elastic.Markdown.Links.InboundLinks;
 
-public class LinkIndexLinkChecker(ILoggerFactory logger)
+public class LinkIndexLinkChecker(ILoggerFactory logFactory)
 {
-	private readonly ILogger _logger = logger.CreateLogger<LinkIndexLinkChecker>();
+	private readonly ILogger _logger = logFactory.CreateLogger<LinkIndexLinkChecker>();
 	private readonly ILinkIndexReader _linkIndexProvider = Aws3LinkIndexReader.CreateAnonymous();
 	private sealed record RepositoryFilter
 	{
@@ -25,7 +25,7 @@ private sealed record RepositoryFilter
 
 	public async Task CheckAll(IDiagnosticsCollector collector, Cancel ctx)
 	{
-		var fetcher = new LinksIndexCrossLinkFetcher(_linkIndexProvider, logger);
+		var fetcher = new LinksIndexCrossLinkFetcher(logFactory, _linkIndexProvider);
 		var resolver = new CrossLinkResolver(fetcher);
 		var crossLinks = await resolver.FetchLinks(ctx);
 
@@ -34,7 +34,7 @@ public async Task CheckAll(IDiagnosticsCollector collector, Cancel ctx)
 
 	public async Task CheckRepository(IDiagnosticsCollector collector, string? toRepository, string? fromRepository, Cancel ctx)
 	{
-		var fetcher = new LinksIndexCrossLinkFetcher(_linkIndexProvider, logger);
+		var fetcher = new LinksIndexCrossLinkFetcher(logFactory, _linkIndexProvider);
 		var resolver = new CrossLinkResolver(fetcher);
 		var crossLinks = await resolver.FetchLinks(ctx);
 		var filter = new RepositoryFilter
@@ -48,7 +48,7 @@ public async Task CheckRepository(IDiagnosticsCollector collector, string? toRep
 
 	public async Task CheckWithLocalLinksJson(IDiagnosticsCollector collector, string repository, string localLinksJson, Cancel ctx)
 	{
-		var fetcher = new LinksIndexCrossLinkFetcher(_linkIndexProvider, logger);
+		var fetcher = new LinksIndexCrossLinkFetcher(logFactory, _linkIndexProvider);
 		var resolver = new CrossLinkResolver(fetcher);
 		// ReSharper disable once RedundantAssignment
 		var crossLinks = await resolver.FetchLinks(ctx);

src/authoring/Elastic.Documentation.Refactor/Move.cs

@@ -15,10 +15,10 @@ public record ChangeSet(IFileInfo From, IFileInfo To);
 public record Change(IFileInfo Source, string OriginalContent, string NewContent);
 public record LinkModification(string OldLink, string NewLink, string SourceFile, int LineNumber, int ColumnNumber);
 
-public partial class Move(IFileSystem readFileSystem, IFileSystem writeFileSystem, DocumentationSet documentationSet, ILoggerFactory loggerFactory)
+public partial class Move(ILoggerFactory logFactory, IFileSystem readFileSystem, IFileSystem writeFileSystem, DocumentationSet documentationSet)
 {
 
-	private readonly ILogger _logger = loggerFactory.CreateLogger<Move>();
+	private readonly ILogger _logger = logFactory.CreateLogger<Move>();
 	private readonly Dictionary<ChangeSet, List<Change>> _changes = [];
 	private readonly Dictionary<ChangeSet, List<LinkModification>> _linkModifications = [];
 

src/tooling/Elastic.Documentation.Tooling/Diagnostics/Console/ConsoleDiagnosticsCollector.cs

@@ -10,8 +10,8 @@
 
 namespace Elastic.Documentation.Tooling.Diagnostics.Console;
 
-public class ConsoleDiagnosticsCollector(ILoggerFactory loggerFactory, ICoreService? githubActions = null)
-	: DiagnosticsCollector([new Log(loggerFactory.CreateLogger<Log>()), new GithubAnnotationOutput(githubActions)]
+public class ConsoleDiagnosticsCollector(ILoggerFactory logFactory, ICoreService? githubActions = null)
+	: DiagnosticsCollector([new Log(logFactory.CreateLogger<Log>()), new GithubAnnotationOutput(githubActions)]
 	)
 {
 	private readonly List<Diagnostic> _errors = [];