Throw exceptions in Run when building the application.

icalvo · Jan 9, 2022 · 14746de · 14746de
1 parent 0e366a8
commit 14746de
Show file tree

Hide file tree

Showing 27 changed files with 298 additions and 265 deletions.
diff --git a/src/Cocona.Core/Command/CoconaBootstrapper.cs b/src/Cocona.Core/Command/CoconaBootstrapper.cs
@@ -0,0 +1,73 @@
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Cocona.Application;
+using Cocona.Command.Dispatcher;
+using Cocona.CommandLine;
+using Cocona.Internal;
+using Cocona.Resources;
+
+namespace Cocona.Command;
+
+public class CoconaBootstrapper : ICoconaBootstrapper
+{
+    private readonly ICoconaCommandLineArgumentProvider _commandLineArgumentProvider;
+    private readonly ICoconaCommandProvider _commandProvider;
+    private readonly ICoconaCommandResolver _commandResolver;
+    private readonly ICoconaCommandDispatcher _dispatcher;
+    private readonly ICoconaConsoleProvider _console;
+
+    private CommandCollection? _commandCollection;
+    public CoconaBootstrapper(
+        ICoconaCommandLineArgumentProvider commandLineArgumentProvider,
+        ICoconaCommandProvider commandProvider,
+        ICoconaCommandResolver commandResolver,
+        ICoconaCommandDispatcher dispatcher,
+        ICoconaConsoleProvider console
+    )
+    {
+        _commandLineArgumentProvider = commandLineArgumentProvider;
+        _commandProvider = commandProvider;
+        _commandResolver = commandResolver;
+        _dispatcher = dispatcher;
+        _console = console;
+    }
+
+    public void Initialize()
+    {
+        _commandCollection = _commandProvider.GetCommandCollection();
+    }
+
+    public async ValueTask<int> RunAsync(CancellationToken cancellationToken)
+    {
+        try
+        {
+            var resolved = _commandResolver.ParseAndResolve(_commandCollection ?? throw new CoconaException("Call Initialize before RunAsync"), _commandLineArgumentProvider.GetArguments());
+            return await _dispatcher.DispatchAsync(resolved, cancellationToken);
+        }
+        catch (CommandNotFoundException cmdNotFoundEx)
+        {
+            if (string.IsNullOrWhiteSpace(cmdNotFoundEx.Command))
+            {
+                _console.Error.WriteLine(string.Format(Strings.Dispatcher_Error_CommandNotFound, cmdNotFoundEx.Message));
+            }
+            else
+            {
+                _console.Error.WriteLine(string.Format(Strings.Dispatcher_Error_NotACommand, cmdNotFoundEx.Command));
+            }
+
+            var similarCommands = cmdNotFoundEx.ImplementedCommands.All.Where(x => Levenshtein.GetDistance(cmdNotFoundEx.Command.ToLowerInvariant(), x.Name.ToLowerInvariant()) < 3).ToArray();
+            if (similarCommands.Any())
+            {
+                _console.Error.WriteLine();
+                _console.Error.WriteLine(Strings.Dispatcher_Error_SimilarCommands);
+                foreach (var c in similarCommands)
+                {
+                    _console.Error.WriteLine($"  {c.Name}");
+                }
+            }
+
+            return 1;
+        }
+    }
+}
diff --git a/src/Cocona.Core/Command/CoconaCommandResolver.cs b/src/Cocona.Core/Command/CoconaCommandResolver.cs
@@ -8,24 +8,20 @@ namespace Cocona.Command
 {
     public class CoconaCommandResolver : ICoconaCommandResolver
     {
-        private readonly ICoconaCommandProvider _commandProvider;
         private readonly ICoconaCommandLineParser _commandLineParser;
         private readonly ICoconaCommandMatcher _commandMatcher;
 
         public CoconaCommandResolver(
-            ICoconaCommandProvider commandProvider,
             ICoconaCommandLineParser commandLineParser,
             ICoconaCommandMatcher commandMatcher
         )
         {
-            _commandProvider = commandProvider;
             _commandLineParser = commandLineParser;
             _commandMatcher = commandMatcher;
         }
 
-        public CommandResolverResult ParseAndResolve(IReadOnlyList<string> args)
+        public CommandResolverResult ParseAndResolve(CommandCollection commandCollection, IReadOnlyList<string> args)
         {
-            var commandCollection = _commandProvider.GetCommandCollection();
             var subCommandStack = new List<CommandDescriptor>();
 
             Retry:

diff --git a/src/Cocona.Core/Command/Dispatcher/CoconaCommandDispatcher.cs b/src/Cocona.Core/Command/Dispatcher/CoconaCommandDispatcher.cs
@@ -14,38 +14,31 @@ namespace Cocona.Command.Dispatcher
     public class CoconaCommandDispatcher : ICoconaCommandDispatcher
     {
         private readonly IServiceProvider _serviceProvider;
-        private readonly ICoconaCommandLineArgumentProvider _commandLineArgumentProvider;
-        private readonly ICoconaCommandResolver _commandResolver;
         private readonly ICoconaCommandDispatcherPipelineBuilder _dispatcherPipelineBuilder;
         private readonly ICoconaInstanceActivator _activator;
         private readonly ICoconaAppContextAccessor _appContext;
 
         public CoconaCommandDispatcher(
             IServiceProvider serviceProvider,
-            ICoconaCommandLineArgumentProvider commandLineArgumentProvider,
-            ICoconaCommandResolver commandResolver,
             ICoconaCommandDispatcherPipelineBuilder dispatcherPipelineBuilder,
             ICoconaInstanceActivator activator,
             ICoconaAppContextAccessor appContext
         )
         {
             _serviceProvider = serviceProvider;
-            _commandLineArgumentProvider = commandLineArgumentProvider;
-            _commandResolver = commandResolver;
             _dispatcherPipelineBuilder = dispatcherPipelineBuilder;
             _activator = activator;
             _appContext = appContext;
         }
 
-        public async ValueTask<int> DispatchAsync(CancellationToken cancellationToken)
+        public async ValueTask<int> DispatchAsync(CommandResolverResult commandResolverResult, CancellationToken cancellationToken)
         {
-            var result = _commandResolver.ParseAndResolve(_commandLineArgumentProvider.GetArguments());
-            if (result.Success)
+            if (commandResolverResult.Success)
             {
                 // Found a command and dispatch.
-                var parsedCommandLine = result.ParsedCommandLine!;
-                var matchedCommand = result.MatchedCommand!;
-                var subCommandStack = result.SubCommandStack!;
+                var parsedCommandLine = commandResolverResult.ParsedCommandLine!;
+                var matchedCommand = commandResolverResult.MatchedCommand!;
+                var subCommandStack = commandResolverResult.SubCommandStack!;
 
                 var dispatchAsync = _dispatcherPipelineBuilder.Build();
 
@@ -63,7 +56,7 @@ public async ValueTask<int> DispatchAsync(CancellationToken cancellationToken)
 
                 // Set CoconaAppContext
                 _appContext.Current = new CoconaAppContext(matchedCommand, cancellationToken);
-                _appContext.Current.Features.Set<ICoconaCommandFeature>(new CoconaCommandFeature(result.CommandCollection, matchedCommand, subCommandStack, commandInstance));
+                _appContext.Current.Features.Set<ICoconaCommandFeature>(new CoconaCommandFeature(commandResolverResult.CommandCollection, matchedCommand, subCommandStack, commandInstance));
 
                 // Dispatch the command
                 try
@@ -90,7 +83,7 @@ public async ValueTask<int> DispatchAsync(CancellationToken cancellationToken)
             {
                 throw new CommandNotFoundException(
                     string.Empty,
-                    result.CommandCollection,
+                    commandResolverResult.CommandCollection,
                     Strings.Command_NotYetImplemented
                 );
             }

diff --git a/src/Cocona.Core/Command/Dispatcher/ICoconaCommandDispatcher.cs b/src/Cocona.Core/Command/Dispatcher/ICoconaCommandDispatcher.cs
@@ -1,10 +1,10 @@
-using System.Threading;
+using System.Threading;
 using System.Threading.Tasks;
 
 namespace Cocona.Command.Dispatcher
 {
     public interface ICoconaCommandDispatcher
     {
-        ValueTask<int> DispatchAsync(CancellationToken cancellationToken = default);
+        ValueTask<int> DispatchAsync(CommandResolverResult commandResolverResult, CancellationToken cancellationToken = default);
     }
 }
diff --git a/src/Cocona.Core/Command/Dispatcher/Middlewares/HandleExceptionAndExitMiddleware.cs b/src/Cocona.Core/Command/Dispatcher/Middlewares/HandleExceptionAndExitMiddleware.cs
@@ -1,11 +1,13 @@
-using Cocona.Application;
+using Cocona.Application;
 using Cocona.Command.Binder;
 using Cocona.Help;
+using Cocona.Internal;
 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using Cocona.Resources;
 
 namespace Cocona.Command.Dispatcher.Middlewares
 {
@@ -40,6 +42,13 @@ public override async ValueTask<int> DispatchAsync(CommandDispatchContext ctx)
                 }
                 return exitEx.ExitCode;
             }
+            catch (Exception ex)
+            {
+                _console.Error.WriteLine($"Unhandled Exception: {ex.GetType().FullName}: {ex.Message}");
+                _console.Error.WriteLine(ex.StackTrace);
+
+                return 1;
+            }
         }
     }
 }
diff --git a/src/Cocona.Core/Command/ICoconaBootstrapper.cs b/src/Cocona.Core/Command/ICoconaBootstrapper.cs
@@ -0,0 +1,14 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Cocona.Command
+{
+    public interface ICoconaBootstrapper
+    {
+        void Initialize();
+        ValueTask<int> RunAsync(CancellationToken cancellationToken);
+    }
+}
diff --git a/src/Cocona.Core/Command/ICoconaCommandResolver.cs b/src/Cocona.Core/Command/ICoconaCommandResolver.cs
@@ -4,6 +4,6 @@ namespace Cocona.Command
 {
     public interface ICoconaCommandResolver
     {
-        CommandResolverResult ParseAndResolve(IReadOnlyList<string> args);
+        CommandResolverResult ParseAndResolve(CommandCollection commandCollection, IReadOnlyList<string> args);
     }
 }
diff --git a/src/Cocona.Core/Resources/Strings.Designer.cs b/src/Cocona.Core/Resources/Strings.Designer.cs
diff --git a/src/Cocona.Core/Resources/Strings.ja-jp.resx b/src/Cocona.Core/Resources/Strings.ja-jp.resx
@@ -74,4 +74,13 @@
     <data name="OptionLikeCommand_MethodNotFound" xml:space="preserve">
         <value>オプション風コマンド '{0}' のメソッドが '{1}' に見つかりませんでした。</value>
     </data>
+    <data name="Dispatcher_Error_CommandNotFound" xml:space="preserve">
+        <value>エラー: {0}</value>
+    </data>
+    <data name="Dispatcher_Error_NotACommand" xml:space="preserve">
+        <value>エラー: '{0}' はコマンドではありません。 '--help' で使用方法を確認できます。</value>
+    </data>
+    <data name="Dispatcher_Error_SimilarCommands" xml:space="preserve">
+        <value>類似するコマンド:</value>
+    </data>
 </root>
diff --git a/src/Cocona.Core/Resources/Strings.resx b/src/Cocona.Core/Resources/Strings.resx
@@ -180,4 +180,13 @@
   <data name="Help_Description_AllowedValues" xml:space="preserve">
       <value>Allowed values</value>
   </data>
+  <data name="Dispatcher_Error_CommandNotFound" xml:space="preserve">
+      <value>Error: {0}</value>
+  </data>
+  <data name="Dispatcher_Error_NotACommand" xml:space="preserve">
+      <value>Error: '{0}' is not a command. See '--help' for usage.</value>
+  </data>
+  <data name="Dispatcher_Error_SimilarCommands" xml:space="preserve">
+      <value>Similar commands:</value>
+  </data>
 </root>
diff --git a/src/Cocona.Core/ShellCompletion/Candidate/CoconaCompletionCandidates.cs b/src/Cocona.Core/ShellCompletion/Candidate/CoconaCompletionCandidates.cs
@@ -11,21 +11,24 @@ public class CoconaCompletionCandidates : ICoconaCompletionCandidates
         private readonly ICoconaCompletionCandidatesMetadataFactory _completionCandidatesMetadataFactory;
         private readonly ICoconaCompletionCandidatesProviderFactory _completionCandidatesProviderFactory;
         private readonly ICoconaCommandResolver _commandResolver;
+        private readonly ICoconaCommandProvider _commandProvider;
 
         public CoconaCompletionCandidates(
             ICoconaCompletionCandidatesMetadataFactory completionCandidatesMetadataFactory,
             ICoconaCompletionCandidatesProviderFactory completionCandidatesProviderFactory,
-            ICoconaCommandResolver commandResolver
+            ICoconaCommandResolver commandResolver,
+            ICoconaCommandProvider commandProvider
         )
         {
             _completionCandidatesMetadataFactory = completionCandidatesMetadataFactory;
             _completionCandidatesProviderFactory = completionCandidatesProviderFactory;
             _commandResolver = commandResolver;
+            _commandProvider = commandProvider;
         }
 
         public IReadOnlyList<CompletionCandidateValue> GetOnTheFlyCandidates(string paramName, IReadOnlyList<string> args, int curPos, string? candidateHint)
         {
-            var result = _commandResolver.ParseAndResolve(args);
+            var result = _commandResolver.ParseAndResolve(_commandProvider.GetCommandCollection(), args);
 
             if (result.Success)
             {

diff --git a/src/Cocona.Lite/CoconaLiteAppOptions.cs b/src/Cocona.Lite/CoconaLiteAppOptions.cs
@@ -8,11 +8,6 @@ namespace Cocona
     /// </summary>
     public class CoconaLiteAppOptions
     {
-        /// <summary>
-        /// Sets or gets whether Cocona or a command throws an exception, handle it and exit normally. The default value is true.
-        /// </summary>
-        public bool HandleExceptionAtRuntime { get; set; } = true;
-
         /// <summary>
         /// If the type has public methods, Cocona treats as a command. The default value is true.
         /// </summary>