include CancelationToken parameter for ICommand

arturcic · arturcic · commit 2410b6a8f5c6 · 2024-03-04T17:22:18.000+01:00
diff --git a/new-cli/Directory.Packages.props b/new-cli/Directory.Packages.props
@@ -8,7 +8,6 @@
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="4.9.2" />
     <PackageVersion Include="Microsoft.CSharp" Version="4.7.0" />
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
-    <PackageVersion Include="Microsoft.Extensions.Logging.Console" Version="8.0.0" />
     <PackageVersion Include="Polly" Version="8.3.0" />
     <PackageVersion Include="Scriban" Version="5.9.1" />
     <PackageVersion Include="Serilog.Extensions.Logging" Version="8.0.0" />
diff --git a/new-cli/GitVersion.Calculation/CalculateCommand.cs b/new-cli/GitVersion.Calculation/CalculateCommand.cs
@@ -18,7 +18,7 @@ public CalculateCommand(ILogger logger, IService service, IGitRepository reposit
         this.repository = repository;
     }
 
-    public Task<int> InvokeAsync(CalculateSettings settings)
+    public Task<int> InvokeAsync(CalculateSettings settings, CancellationToken cancellationToken = default)
     {
         var value = service.Call();
         this.repository.DiscoverRepository(settings.WorkDir.FullName);
diff --git a/new-cli/GitVersion.Cli/GitVersion.Cli.csproj b/new-cli/GitVersion.Cli/GitVersion.Cli.csproj
@@ -12,7 +12,6 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.Extensions.Logging.Console" />
         <PackageReference Include="System.CommandLine" />
 
         <PackageReference Include="Serilog.Extensions.Logging" />
diff --git a/new-cli/GitVersion.Common.Command/ICommand.cs b/new-cli/GitVersion.Common.Command/ICommand.cs
@@ -2,7 +2,7 @@ namespace GitVersion;
 
 public interface ICommand<in T>
 {
-    public Task<int> InvokeAsync(T settings);
+    public Task<int> InvokeAsync(T settings, CancellationToken cancellationToken = default);
 }
 
 public interface ICommandImpl
diff --git a/new-cli/GitVersion.Configuration/ConfigCommand.cs b/new-cli/GitVersion.Configuration/ConfigCommand.cs
@@ -16,7 +16,7 @@ public ConfigCommand(ILogger logger, IService service)
         this.service = service;
     }
 
-    public Task<int> InvokeAsync(ConfigSettings settings)
+    public Task<int> InvokeAsync(ConfigSettings settings, CancellationToken cancellationToken = default)
     {
         var value = service.Call();
         logger.LogInformation($"Command : 'config', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");
diff --git a/new-cli/GitVersion.Configuration/Init/ConfigInitCommand.cs b/new-cli/GitVersion.Configuration/Init/ConfigInitCommand.cs
@@ -16,7 +16,7 @@ public ConfigInitCommand(ILogger logger, IService service)
         this.service = service;
     }
 
-    public Task<int> InvokeAsync(ConfigInitSettings settings)
+    public Task<int> InvokeAsync(ConfigInitSettings settings, CancellationToken cancellationToken = default)
     {
         var value = service.Call();
         logger.LogInformation($"Command : 'config init', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");
diff --git a/new-cli/GitVersion.Configuration/Show/ConfigShowCommand.cs b/new-cli/GitVersion.Configuration/Show/ConfigShowCommand.cs
@@ -16,7 +16,7 @@ public ConfigShowCommand(ILogger logger, IService service)
         this.service = service;
     }
 
-    public Task<int> InvokeAsync(ConfigShowSettings settings)
+    public Task<int> InvokeAsync(ConfigShowSettings settings, CancellationToken cancellationToken = default)
     {
         var value = service.Call();
         logger.LogInformation($"Command : 'config show', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");
diff --git a/new-cli/GitVersion.Core/GitVersion.Core.csproj b/new-cli/GitVersion.Core/GitVersion.Core.csproj
@@ -4,7 +4,6 @@
     </ItemGroup>
     <ItemGroup>
         <PackageReference Include="Microsoft.Extensions.DependencyInjection" />
-        <PackageReference Include="Microsoft.Extensions.Logging.Console" />
         <PackageReference Include="Serilog.Extensions.Logging" />
         <PackageReference Include="Serilog.Sinks.Console" />
         <PackageReference Include="Serilog.Sinks.File" />
diff --git a/new-cli/GitVersion.Core/Infrastructure/ContainerRegistrar.cs b/new-cli/GitVersion.Core/Infrastructure/ContainerRegistrar.cs
@@ -56,7 +56,10 @@ private static Serilog.Core.Logger CreateLogger()
             // serilog.sinks.map will defer the configuration of the sink to be on demand
             // allowing us to look at the properties set by the enricher to set the path appropriately
             .WriteTo.Console()
-            .WriteTo.Map(LoggingEnricher.LogFilePathPropertyName, (logFilePath, wt) => wt.File(logFilePath), 1)
+            .WriteTo.Map(LoggingEnricher.LogFilePathPropertyName, (logFilePath, wt) =>
+            {
+                if (!string.IsNullOrEmpty(logFilePath)) wt.File(logFilePath);
+            }, 1)
             .CreateLogger();
         return logger;
     }
diff --git a/new-cli/GitVersion.Core/Infrastructure/LoggingEnricher.cs b/new-cli/GitVersion.Core/Infrastructure/LoggingEnricher.cs
@@ -6,8 +6,8 @@ namespace GitVersion.Infrastructure;
 public class LoggingEnricher : ILogEventEnricher
 {
     public static readonly LoggingLevelSwitch LogLevel = new();
-    private string? cachedLogFilePath;
-    private LogEventProperty? cachedLogFilePathProperty;
+    private string? _cachedLogFilePath;
+    private LogEventProperty? _cachedLogFilePathProperty;
 
     // this path and level will be set by the LogInterceptor.cs after parsing the settings
     public static string Path = string.Empty;
@@ -20,17 +20,17 @@ public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
         // we won't have the setting so a default value for the log file will be required
         LogEventProperty logFilePathProperty;
 
-        if (cachedLogFilePathProperty != null && Path.Equals(cachedLogFilePath))
+        if (this._cachedLogFilePathProperty != null && Path.Equals(this._cachedLogFilePath))
         {
             // Path hasn't changed, so let's use the cached property
-            logFilePathProperty = cachedLogFilePathProperty;
+            logFilePathProperty = this._cachedLogFilePathProperty;
         }
         else
         {
             // We've got a new path for the log. Let's create a new property
             // and cache it for future log events to use
-            cachedLogFilePath = Path;
-            cachedLogFilePathProperty = logFilePathProperty = propertyFactory.CreateProperty(LogFilePathPropertyName, Path);
+            this._cachedLogFilePath = Path;
+            this._cachedLogFilePathProperty = logFilePathProperty = propertyFactory.CreateProperty(LogFilePathPropertyName, Path);
         }
 
         logEvent.AddPropertyIfAbsent(logFilePathProperty);
diff --git a/new-cli/GitVersion.Normalization/NormalizeCommand.cs b/new-cli/GitVersion.Normalization/NormalizeCommand.cs
@@ -16,7 +16,7 @@ public NormalizeCommand(ILogger logger, IService service)
         this.service = service;
     }
 
-    public Task<int> InvokeAsync(NormalizeSettings settings)
+    public Task<int> InvokeAsync(NormalizeSettings settings, CancellationToken cancellationToken = default)
     {
         var value = service.Call();
         logger.LogInformation($"Command : 'normalize', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");
diff --git a/new-cli/GitVersion.Output/AssemblyInfo/OutputAssemblyInfoCommand.cs b/new-cli/GitVersion.Output/AssemblyInfo/OutputAssemblyInfoCommand.cs
@@ -14,7 +14,7 @@ public OutputAssemblyInfoCommand(ILogger logger, IService service)
         this.service = service;
     }
 
-    public Task<int> InvokeAsync(OutputAssemblyInfoSettings settings)
+    public Task<int> InvokeAsync(OutputAssemblyInfoSettings settings, CancellationToken cancellationToken = default)
     {
         var value = service.Call();
         var versionInfo = settings.VersionInfo.Value;
diff --git a/new-cli/GitVersion.Output/OutputCommand.cs b/new-cli/GitVersion.Output/OutputCommand.cs
@@ -14,7 +14,7 @@ public OutputCommand(ILogger logger, IService service)
         this.service = service;
     }
 
-    public Task<int> InvokeAsync(OutputSettings settings)
+    public Task<int> InvokeAsync(OutputSettings settings, CancellationToken cancellationToken = default)
     {
         var value = service.Call();
         logger.LogInformation($"Command : 'output', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");
diff --git a/new-cli/GitVersion.Output/Project/OutputProjectCommand.cs b/new-cli/GitVersion.Output/Project/OutputProjectCommand.cs
@@ -14,7 +14,7 @@ public OutputProjectCommand(ILogger logger, IService service)
         this.service = service;
     }
 
-    public Task<int> InvokeAsync(OutputProjectSettings settings)
+    public Task<int> InvokeAsync(OutputProjectSettings settings, CancellationToken cancellationToken = default)
     {
         var value = service.Call();
         logger.LogInformation($"Command : 'output project', LogFile : '{settings.LogFile}', WorkDir : '{settings.OutputDir}', InputFile: '{settings.InputFile}', Project: '{settings.ProjectFile}' ");
diff --git a/new-cli/GitVersion.Output/Wix/OutputWixCommand.cs b/new-cli/GitVersion.Output/Wix/OutputWixCommand.cs
@@ -14,7 +14,7 @@ public OutputWixCommand(ILogger logger, IService service)
         this.service = service;
     }
 
-    public Task<int> InvokeAsync(OutputWixSettings settings)
+    public Task<int> InvokeAsync(OutputWixSettings settings, CancellationToken cancellationToken = default)
     {
         var value = service.Call();
         logger.LogInformation($"Command : 'output wix', LogFile : '{settings.LogFile}', WorkDir : '{settings.OutputDir}', InputFile: '{settings.InputFile}', WixFile: '{settings.WixFile}' ");

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public CalculateCommand(ILogger logger, IService service, IGitRepository reposit`
`18`	`18`	`this.repository = repository;`
`19`	`19`	`}`
`20`	`20`
`21`		`- public Task<int> InvokeAsync(CalculateSettings settings)`
	`21`	`+ public Task<int> InvokeAsync(CalculateSettings settings, CancellationToken cancellationToken = default)`
`22`	`22`	`{`
`23`	`23`	`var value = service.Call();`
`24`	`24`	`this.repository.DiscoverRepository(settings.WorkDir.FullName);`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ namespace GitVersion;`
`2`	`2`
`3`	`3`	`public interface ICommand<in T>`
`4`	`4`	`{`
`5`		`- public Task<int> InvokeAsync(T settings);`
	`5`	`+ public Task<int> InvokeAsync(T settings, CancellationToken cancellationToken = default);`
`6`	`6`	`}`
`7`	`7`
`8`	`8`	`public interface ICommandImpl`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public ConfigCommand(ILogger logger, IService service)`
`16`	`16`	`this.service = service;`
`17`	`17`	`}`
`18`	`18`
`19`		`- public Task<int> InvokeAsync(ConfigSettings settings)`
	`19`	`+ public Task<int> InvokeAsync(ConfigSettings settings, CancellationToken cancellationToken = default)`
`20`	`20`	`{`
`21`	`21`	`var value = service.Call();`
`22`	`22`	`logger.LogInformation($"Command : 'config', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public ConfigInitCommand(ILogger logger, IService service)`
`16`	`16`	`this.service = service;`
`17`	`17`	`}`
`18`	`18`
`19`		`- public Task<int> InvokeAsync(ConfigInitSettings settings)`
	`19`	`+ public Task<int> InvokeAsync(ConfigInitSettings settings, CancellationToken cancellationToken = default)`
`20`	`20`	`{`
`21`	`21`	`var value = service.Call();`
`22`	`22`	`logger.LogInformation($"Command : 'config init', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public ConfigShowCommand(ILogger logger, IService service)`
`16`	`16`	`this.service = service;`
`17`	`17`	`}`
`18`	`18`
`19`		`- public Task<int> InvokeAsync(ConfigShowSettings settings)`
	`19`	`+ public Task<int> InvokeAsync(ConfigShowSettings settings, CancellationToken cancellationToken = default)`
`20`	`20`	`{`
`21`	`21`	`var value = service.Call();`
`22`	`22`	`logger.LogInformation($"Command : 'config show', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@ namespace GitVersion.Infrastructure;`
`6`	`6`	`public class LoggingEnricher : ILogEventEnricher`
`7`	`7`	`{`
`8`	`8`	`public static readonly LoggingLevelSwitch LogLevel = new();`
`9`		`- private string? cachedLogFilePath;`
`10`		`- private LogEventProperty? cachedLogFilePathProperty;`
	`9`	`+ private string? _cachedLogFilePath;`
	`10`	`+ private LogEventProperty? _cachedLogFilePathProperty;`
`11`	`11`
`12`	`12`	`// this path and level will be set by the LogInterceptor.cs after parsing the settings`
`13`	`13`	`public static string Path = string.Empty;`
`@@ -20,17 +20,17 @@ public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)`
`20`	`20`	`// we won't have the setting so a default value for the log file will be required`
`21`	`21`	`LogEventProperty logFilePathProperty;`
`22`	`22`
`23`		`- if (cachedLogFilePathProperty != null && Path.Equals(cachedLogFilePath))`
	`23`	`+ if (this._cachedLogFilePathProperty != null && Path.Equals(this._cachedLogFilePath))`
`24`	`24`	`{`
`25`	`25`	`// Path hasn't changed, so let's use the cached property`
`26`		`- logFilePathProperty = cachedLogFilePathProperty;`
	`26`	`+ logFilePathProperty = this._cachedLogFilePathProperty;`
`27`	`27`	`}`
`28`	`28`	`else`
`29`	`29`	`{`
`30`	`30`	`// We've got a new path for the log. Let's create a new property`
`31`	`31`	`// and cache it for future log events to use`
`32`		`- cachedLogFilePath = Path;`
`33`		`- cachedLogFilePathProperty = logFilePathProperty = propertyFactory.CreateProperty(LogFilePathPropertyName, Path);`
	`32`	`+ this._cachedLogFilePath = Path;`
	`33`	`+ this._cachedLogFilePathProperty = logFilePathProperty = propertyFactory.CreateProperty(LogFilePathPropertyName, Path);`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`logEvent.AddPropertyIfAbsent(logFilePathProperty);`