command: added backend indicator (default: true)

Jani Giannoudis · Jani Giannoudis · commit 084b56fa4f97 · 2025-02-25T21:27:48.000+01:00
refactored commnad manager for optional http client connection
command: enhanced api error handling (scripting exceptions)
updated version to 0.9.0-beta.3
diff --git a/Client.Core/Command/CommandBase.cs b/Client.Core/Command/CommandBase.cs
@@ -11,6 +11,9 @@ public abstract class CommandBase : ICommand
     /// <inheritdoc />
     public virtual string Name => GetType().Name;
 
+    /// <inheritdoc />
+    public virtual bool BackendCommand => true;
+
     /// <inheritdoc />
     public abstract ICommandParameters GetParameters(CommandLineParser parser);
 
@@ -59,12 +62,17 @@ protected void ProcessError(ICommandConsole console, Exception exception)
             return;
         }
 
-        // log
-        Log.Error(exception, exception.GetBaseException().Message);
-
-        // display
-        var message = exception.GetApiErrorMessage();
-        console.DisplayErrorLine(message);
+        // api error
+        var apiError = exception.GetApiErrorMessage();
+        if (!string.IsNullOrWhiteSpace(apiError))
+        {
+            console.DisplayErrorLine(apiError);
+        }
+        else
+        {
+            // generic error log
+            Log.Error(exception, exception.GetBaseException().Message);
+        }
     }
 
     /// <summary>
diff --git a/Client.Core/Command/CommandContext.cs b/Client.Core/Command/CommandContext.cs
@@ -11,30 +11,17 @@ public class CommandContext
     /// Command context.
     /// </summary>
     /// <param name="commandManager">Command manager.</param>
-    /// <param name="console">Command console.</param>
-    /// <param name="displayLevel">Command display level.</param>
-    public CommandContext(CommandManager commandManager, ICommandConsole console, DisplayLevel displayLevel = DisplayLevel.Full)
-    {
-        CommandManager = commandManager ?? throw new ArgumentNullException(nameof(commandManager));
-        Console = console ?? throw new ArgumentNullException(nameof(console));
-        DisplayLevel = displayLevel;
-    }
-
-    /// <summary>
-    /// Command context.
-    /// </summary>
-    /// <param name="commandManager">Command manager.</param>
-    /// <param name="httpClient">Http client.</param>
     /// <param name="logger">Command logger.</param>
     /// <param name="console">Command console.</param>
+    /// <param name="httpClient">Http client.</param>
     /// <param name="displayLevel">Command display level.</param>
-    public CommandContext(CommandManager commandManager, PayrollHttpClient httpClient,
-        ILogger logger, ICommandConsole console, DisplayLevel displayLevel = DisplayLevel.Full)
+    public CommandContext(CommandManager commandManager, ICommandConsole console, ILogger logger = null,
+        PayrollHttpClient httpClient = null, DisplayLevel displayLevel = DisplayLevel.Full)
     {
         CommandManager = commandManager ?? throw new ArgumentNullException(nameof(commandManager));
         Console = console ?? throw new ArgumentNullException(nameof(console));
-        HttpClient = httpClient ?? throw new ArgumentNullException(nameof(httpClient));
-        Logger = logger ?? throw new ArgumentNullException(nameof(logger));
+        Logger = logger;
+        HttpClient = httpClient;
         DisplayLevel = displayLevel;
     }
 
diff --git a/Client.Core/Command/CommandLineParser.cs b/Client.Core/Command/CommandLineParser.cs
@@ -109,7 +109,7 @@ public string Get(int index, string name = null, bool allowToggle = false)
         // name
         if (name != null)
         {
-            var namedParameter = arg.IndexOf(':') > 0;
+            var namedParameter = arg.StartsWith($"{name}:", StringComparison.InvariantCultureIgnoreCase);
             // ignore other named parameter
             if (namedParameter || !allowToggle && IsToggleArgument(arg))
             {
diff --git a/Client.Core/Command/CommandManager.cs b/Client.Core/Command/CommandManager.cs
@@ -95,11 +95,31 @@ public ICommand GetCommand(string name)
         return null;
     }
 
+    /// <summary>
+    /// Get command line command
+    /// </summary>
+    public ICommand GetCommandLineCommand()
+    {
+        var parser = CommandLineParser.NewFromEnvironment();
+        if (parser.Count == 0)
+        {
+            return null;
+        }
+
+        var argCommand = parser.Get(1);
+        if (string.IsNullOrWhiteSpace(argCommand))
+        {
+            return null;
+        }
+
+        return GetCommand(argCommand);
+    }
+
     /// <summary>
     /// Execute command using the environment command line arguments
     /// </summary>
     /// <returns>Exit code</returns>
-    public async Task<int> ExecuteAsync(PayrollHttpClient httpClient)
+    public async Task<int> ExecuteAsync(PayrollHttpClient httpClient = null)
     {
         var parser = CommandLineParser.NewFromEnvironment();
         if (parser.Count == 0)
@@ -125,7 +145,7 @@ public async Task<int> ExecuteAsync(PayrollHttpClient httpClient)
             // command file
             if (!string.IsNullOrWhiteSpace(argCommand) && IsCommandFile(argCommand))
             {
-                return await ExecuteFileAsync(httpClient, parser);
+                return await ExecuteFileAsync(parser, httpClient);
             }
 
             // single command using the environment command line parser
@@ -140,27 +160,23 @@ public async Task<int> ExecuteAsync(PayrollHttpClient httpClient)
         {
             return -1;
         }
-        return await ExecuteAsync(httpClient, command, parser);
+        return await ExecuteAsync(command, parser, httpClient);
     }
 
     /// <summary>
     /// Execute specific command using the environment command line arguments
     /// </summary>
     /// <returns>Exit code</returns>
-    public async Task<int> ExecuteAsync(PayrollHttpClient httpClient, ICommand command) =>
-        await ExecuteAsync(httpClient, command, CommandLineParser.NewFromEnvironment());
+    public async Task<int> ExecuteAsync(ICommand command, PayrollHttpClient httpClient = null) =>
+        await ExecuteAsync(command, CommandLineParser.NewFromEnvironment(), httpClient);
 
     /// <summary>
     /// Execute specific command using a custom command line parser
     /// </summary>
     /// <returns>Exit code</returns>
-    private async Task<int> ExecuteAsync(PayrollHttpClient httpClient,
-        ICommand command, CommandLineParser commandLineParser)
+    private async Task<int> ExecuteAsync(ICommand command, CommandLineParser commandLineParser,
+        PayrollHttpClient httpClient = null)
     {
-        if (httpClient == null)
-        {
-            throw new ArgumentNullException(nameof(httpClient));
-        }
         if (command == null)
         {
             throw new ArgumentNullException(nameof(command));
@@ -199,9 +215,9 @@ private async Task<int> ExecuteAsync(PayrollHttpClient httpClient,
 
             var context = new CommandContext(
                 commandManager: this,
-                httpClient: httpClient,
-                logger: Logger,
                 console: Console,
+                logger: Logger,
+                httpClient: httpClient,
                 displayLevel: Console.DisplayLevel);
             var result = await command.ExecuteAsync(context, parameters);
             Logger?.Trace($"{command} result: {result}");
@@ -238,12 +254,8 @@ public FileItem(string text, CommandLineParser parser, List<FileItem> children)
         internal List<FileItem> Children { get; } = [];
     }
 
-    private async Task<int> ExecuteFileAsync(PayrollHttpClient httpClient, CommandLineParser parser)
+    private async Task<int> ExecuteFileAsync(CommandLineParser parser, PayrollHttpClient httpClient = null)
     {
-        if (httpClient == null)
-        {
-            throw new ArgumentNullException(nameof(httpClient));
-        }
         if (parser == null)
         {
             throw new ArgumentNullException(nameof(parser));
@@ -261,7 +273,7 @@ private async Task<int> ExecuteFileAsync(PayrollHttpClient httpClient, CommandLi
 
         foreach (var item in items)
         {
-            var exitCode = await ExecuteFileItemAsync(httpClient, item);
+            var exitCode = await ExecuteFileItemAsync(item, httpClient);
             if (exitCode != 0)
             {
                 return exitCode;
@@ -274,12 +286,12 @@ private async Task<int> ExecuteFileAsync(PayrollHttpClient httpClient, CommandLi
         return 0;
     }
 
-    private async Task<int> ExecuteFileItemAsync(PayrollHttpClient httpClient, FileItem item)
+    private async Task<int> ExecuteFileItemAsync(FileItem item, PayrollHttpClient httpClient = null)
     {
         // command
         if (item.Command != null)
         {
-            return await ExecuteAsync(httpClient, item.Command, item.Parser);
+            return await ExecuteAsync(item.Command, item.Parser, httpClient);
         }
 
         // command file
@@ -303,7 +315,7 @@ private async Task<int> ExecuteFileItemAsync(PayrollHttpClient httpClient, FileI
         // process children
         foreach (var children in item.Children)
         {
-            var result = await ExecuteFileItemAsync(httpClient, children);
+            var result = await ExecuteFileItemAsync(children, httpClient);
             if (result != 0)
             {
                 return result;
diff --git a/Client.Core/Command/ICommand.cs b/Client.Core/Command/ICommand.cs
@@ -12,6 +12,11 @@ public interface ICommand
     /// </summary>
     string Name { get; }
 
+    /// <summary>
+    /// Backend command.
+    /// </summary>
+    bool BackendCommand { get; }
+
     /// <summary>
     /// Get command parameters.
     /// </summary>
diff --git a/Client.Core/ConsoleProgram.cs b/Client.Core/ConsoleProgram.cs
@@ -112,7 +112,7 @@ public virtual async Task ExecuteAsync()
             await SetupLogAsync();
 
             // http client
-            if (UseHttpClient && !await SetupHttpClientAsync())
+            if (UseHttpClient() && !await SetupHttpClientAsync())
             {
                 return;
             }
@@ -184,7 +184,6 @@ private static void EnsureExitCode()
     protected virtual int MandatoryArgumentCount => 0;
 
     /// <summary>Test for single command line argument help</summary>
-    /// <returns></returns>
     private static bool IsHelpMode()
     {
         var firstArgument = ConsoleArguments.Get(1, allowToggle: true);
@@ -206,7 +205,7 @@ protected virtual Task HelpAsync()
     protected PayrollHttpClient HttpClient { get; private set; }
 
     /// <summary>Use the payroll http client, default is true</summary>
-    protected virtual bool UseHttpClient => true;
+    protected virtual bool UseHttpClient() => true;
 
     /// <summary>Show the connection status, default is true</summary>
     protected virtual bool ShowConnectionInfo => true;
diff --git a/Client.Core/ExceptionExtensions.cs b/Client.Core/ExceptionExtensions.cs
@@ -1,5 +1,8 @@
 ﻿using System;
+using System.Net;
+using System.Linq;
 using System.Text;
+using System.Net.Http;
 using System.Text.Json;
 
 namespace PayrollEngine.Client;
@@ -40,24 +43,22 @@ public static string GetApiErrorMessage(this Exception exception)
             return apiException.Message;
         }
 
-        // maybe a plain exception message
-        // use first line only, remove the stack trace lines
-        var message = exception.GetBaseMessage();
-        message = message.Replace("\\r\\n", "\n");
-        var lines = message.Split(['\n']);
-        if (lines.Length > 1)
+        // script errors
+        var scriptErrors = GetScriptErrors(exception);
+        if (scriptErrors != null)
         {
-            message = lines[0];
+            return string.Join("\n", scriptErrors);
         }
 
-        // trim quotes and line separators
-        return message.Trim('\r', '\n', '"');
+        // plain exception message
+        // use first line only, remove the stack trace lines
+        return GetPlainErrorMessage(exception, maxLines: 1);
     }
 
     /// <summary>Get the exception message from an API error</summary>
     /// <param name="exception">The exception</param>
     /// <returns>The payroll API error, null on others errors</returns>
-    public static ApiError GetApiError(this Exception exception)
+    private static ApiError GetApiError(this Exception exception)
     {
         if (exception == null)
         {
@@ -91,7 +92,7 @@ public static ApiError GetApiError(this Exception exception)
     /// <summary>Get the exception message from an API exception</summary>
     /// <param name="exception">The exception</param>
     /// <returns>The payroll API error, null on others errors</returns>
-    public static ApiException GetApiException(Exception exception)
+    private static ApiException GetApiException(Exception exception)
     {
         if (exception == null)
         {
@@ -122,6 +123,45 @@ public static ApiException GetApiException(Exception exception)
         return null;
     }
 
+    /// <summary>Get script errors</summary>
+    /// <param name="exception">The exception</param>
+    /// <returns>The payroll API error, null on others errors</returns>
+    private static string GetScriptErrors(Exception exception)
+    {
+        // script errors resulting to a http request exception with status code unprocessable
+        if (exception is not HttpRequestException httpException ||
+            httpException.StatusCode != HttpStatusCode.UnprocessableContent)
+        {
+            return null;
+        }
+
+        // script errors
+        var message = GetPlainErrorMessage(exception);
+        return string.IsNullOrWhiteSpace(message) ? null : message;
+    }
+
+    /// <summary>Get plain error message</summary>
+    /// <param name="exception">The exception</param>
+    /// <param name="maxLines">Maximum exception lines</param>
+    private static string GetPlainErrorMessage(Exception exception, int maxLines = 0)
+    {
+        var message = exception.GetBaseMessage();
+        message = message.Replace(@"\r\n", "\n");
+        var lines = message.Split(['\n'], StringSplitOptions.RemoveEmptyEntries).ToList();
+
+        if (maxLines > 0 && lines.Count > maxLines)
+        {
+            lines.RemoveRange(maxLines, lines.Count - maxLines);
+        }
+
+        // trim quotes and line separators
+        for (var i = 0; i < lines.Count; i++)
+        {
+            lines[i] = lines[i].Trim('\r', '\n', '"');
+        }
+        return string.Join("\n", lines);
+    }
+
     private static string GetExceptionMessage(Exception exception) =>
         exception.GetBaseMessage().Trim('"')
             .Replace("\\u0027", "'")
diff --git a/Client.Core/PayrollEngine.Client.Core.csproj b/Client.Core/PayrollEngine.Client.Core.csproj
@@ -89,7 +89,7 @@
 	  </None>
 	</ItemGroup>
 	<ItemGroup>
-	  <PackageReference Include="PayrollEngine.Core" Version="0.9.0-beta.1" />
+	  <PackageReference Include="PayrollEngine.Core" Version="0.9.0-beta.3" />
 	</ItemGroup>
 
 	<!--  build json schema -->
diff --git a/Client.Core/PayrollEngine.Client.Core.xml b/Client.Core/PayrollEngine.Client.Core.xml
diff --git a/Directory.Build.props b/Directory.Build.props

Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ public string Get(int index, string name = null, bool allowToggle = false)`
`109`	`109`	`// name`
`110`	`110`	`if (name != null)`
`111`	`111`	`{`
`112`		`- var namedParameter = arg.IndexOf(':') > 0;`
	`112`	`+ var namedParameter = arg.StartsWith($"{name}:", StringComparison.InvariantCultureIgnoreCase);`
`113`	`113`	`// ignore other named parameter`
`114`	`114`	`if (namedParameter \|\| !allowToggle && IsToggleArgument(arg))`
`115`	`115`	`{`