Simplify error handling in recipe execution (#16195)

OrchardCMS · May 30, 2024 · 50aec63 · 50aec63
1 parent 265e586
commit 50aec63
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 18 deletions.
diff --git a/...dCore.Modules/OrchardCore.Deployment.Remote/Controllers/ImportRemoteInstanceController.cs b/...dCore.Modules/OrchardCore.Deployment.Remote/Controllers/ImportRemoteInstanceController.cs
@@ -93,7 +93,7 @@ public async Task<IActionResult> Import(ImportViewModel model)
             {
                 _logger.LogError(e, "Unable to import a recipe from deployment plan.");
 
-                await _notifier.ErrorAsync(H["The deployment plan failed with the following errors: {0}", string.Join(' ', e.StepResult.Errors.SelectMany(x => x.Value))]);
+                await _notifier.ErrorAsync(H["The deployment plan failed with the following errors: {0}", string.Join(' ', e.StepResult.Errors)]);
             }
             catch (Exception e)
             {

diff --git a/src/OrchardCore.Modules/OrchardCore.Deployment/Controllers/ImportController.cs b/src/OrchardCore.Modules/OrchardCore.Deployment/Controllers/ImportController.cs
@@ -1,7 +1,6 @@
 using System;
 using System.IO;
 using System.IO.Compression;
-using System.Linq;
 using System.Text.Json;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Authorization;
@@ -102,7 +101,7 @@ public async Task<IActionResult> Import(IFormFile importedPackage)
                 {
                     _logger.LogError(e, "Unable to import a deployment package.");
 
-                    await _notifier.ErrorAsync(H["The import failed with the following errors: {0}", string.Join(' ', e.StepResult.Errors.SelectMany(x => x.Value))]);
+                    await _notifier.ErrorAsync(H["The import failed with the following errors: {0}", string.Join(' ', e.StepResult.Errors)]);
                 }
                 catch (Exception e)
                 {
@@ -171,7 +170,7 @@ public async Task<IActionResult> Json(ImportJsonViewModel model)
                 {
                     _logger.LogError(e, "Unable to import a recipe from JSON input.");
 
-                    ModelState.AddModelError(nameof(model.Json), string.Join(' ', e.StepResult.Errors.SelectMany(x => x.Value)));
+                    ModelState.AddModelError(nameof(model.Json), string.Join(' ', e.StepResult.Errors));
                 }
                 catch (Exception e)
                 {

diff --git a/src/OrchardCore.Modules/OrchardCore.Recipes/Controllers/AdminController.cs b/src/OrchardCore.Modules/OrchardCore.Recipes/Controllers/AdminController.cs
@@ -124,7 +124,7 @@ public async Task<ActionResult> Execute(string basePath, string fileName)
             {
                 _logger.LogError(e, "Unable to import a recipe file.");
 
-                await _notifier.ErrorAsync(H["The recipe '{0}' failed to run do to the following errors: {1}", recipe.DisplayName, string.Join(' ', e.StepResult.Errors.SelectMany(x => x.Value))]);
+                await _notifier.ErrorAsync(H["The recipe '{0}' failed to run do to the following errors: {1}", recipe.DisplayName, string.Join(' ', e.StepResult.Errors)]);
             }
             catch (Exception e)
             {

diff --git a/src/OrchardCore/OrchardCore.Recipes.Abstractions/Models/RecipeStepResult.cs b/src/OrchardCore/OrchardCore.Recipes.Abstractions/Models/RecipeStepResult.cs
@@ -1,5 +1,3 @@
-using System.Collections.Generic;
-
 namespace OrchardCore.Recipes.Models;
 
 public class RecipeStepResult
@@ -10,5 +8,5 @@ public class RecipeStepResult
 
     public bool IsSuccessful { get; set; }
 
-    public Dictionary<string, string[]> Errors { get; set; }
+    public string[] Errors { get; set; }
 }
diff --git a/src/OrchardCore/OrchardCore.Recipes.Core/Services/RecipeExecutor.cs b/src/OrchardCore/OrchardCore.Recipes.Core/Services/RecipeExecutor.cs
@@ -105,10 +105,7 @@ public async Task<string> ExecuteAsync(string executionId, RecipeDescriptor reci
                                     if (recipeStep.Errors.Count > 0)
                                     {
                                         stepResult.IsSuccessful = false;
-                                        stepResult.Errors = new Dictionary<string, string[]>
-                                        {
-                                            { recipeStep.Name, recipeStep.Errors.ToArray() }
-                                        };
+                                        stepResult.Errors = recipeStep.Errors.ToArray();
                                     }
                                     else
                                     {
@@ -118,10 +115,7 @@ public async Task<string> ExecuteAsync(string executionId, RecipeDescriptor reci
                                 catch (Exception e)
                                 {
                                     stepResult.IsSuccessful = false;
-                                    stepResult.Errors = new Dictionary<string, string[]>
-                                    {
-                                        { recipeStep.Name, [S["Unexpected error occurred while executing the '{0}' step.", stepResult.StepName]] }
-                                    };
+                                    stepResult.Errors = [S["Unexpected error occurred while executing the '{0}' step.", stepResult.StepName]];
 
                                     // Because we can't do some async processing the in catch or finally
                                     // blocks, we store the exception to throw it later.

diff --git a/src/OrchardCore/OrchardCore.Setup.Core/SetupService.cs b/src/OrchardCore/OrchardCore.Setup.Core/SetupService.cs
@@ -235,7 +235,7 @@ await scope.ServiceProvider.GetService<IShellDescriptorManager>()
                 {
                     _logger.LogError(e, "Unable to import a recipe during setup.");
 
-                    context.Errors.Add(string.Empty, string.Join(' ', e.StepResult.Errors.SelectMany(x => x.Value)));
+                    context.Errors.Add(string.Empty, string.Join(' ', e.StepResult.Errors));
                 }
                 catch (Exception e)
                 {

diff --git a/test/OrchardCore.Tests/Recipes/RecipeExecutorTests.cs b/test/OrchardCore.Tests/Recipes/RecipeExecutorTests.cs
@@ -73,7 +73,7 @@ await context.UsingTenantScopeAsync(async scope =>
                     await recipeExecutor.ExecuteAsync(executionId, recipeDescriptor, new Dictionary<string, object>(), CancellationToken.None);
                 });
 
-                Assert.Contains("Unable to add content-part to the 'Message' content-type. The part name cannot be null or empty.", exception.StepResult.Errors["ContentDefinition"]);
+                Assert.Contains("Unable to add content-part to the 'Message' content-type. The part name cannot be null or empty.", exception.StepResult.Errors);
             });
         }