Merge pull request #35 from thygesteffensen/refactor/exception

Refactor/exception

Author: thygesteffensen

PowerAutomateMockUp/ExpressionParser/ExpressionGrammar.cs

@@ -14,7 +14,6 @@ public class ExpressionGrammar
         public ExpressionGrammar(IEnumerable<IFunction> functions)
         {
             var functionCollection = functions ?? throw new ArgumentNullException(nameof(functions));
-            // TODO: Go through parsers and reflect on the generic type. 1) Should they all be the same?
 
             #region BasicAuxParsers
 
@@ -31,8 +30,7 @@ public ExpressionGrammar(IEnumerable<IFunction> functions)
                 Parse.AnyChar.Except(Parse.Char('@')).Except(Parse.Char('(').Except(Parse.Char(')'))).AtLeastOnce()
                     .Text().Select(x => new ConstantRule(new ValueContainer(x)));
 
-            Parser<char> escapedCharacters
-                = // TODO: Figure out which characters are escaped and where they are escaped -> simpleString or allowedString?
+            Parser<char> escapedCharacters =
                 from c in
                     Parse.String("''").Select(n => '\'')
                         .Or(Parse.String("''").Select(n => '\''))
@@ -43,14 +41,11 @@ from content in Parse.CharExcept('\'').Or(escapedCharacters).Many().Text()
                     .Contained(Parse.Char('\''), Parse.Char('\''))
                 select new StringLiteralRule(new ValueContainer(content));
 
-            Parser<string> allowedCharacters = // TODO: Verify valid characters 
-                Parse.Char('.')
-                    .Or(Parse.Char(','))
-                    .Or(Parse.Char('-'))
-                    .Or(Parse.String("@@").Select(_ => '@'))
-                    .Or(Parse.Char('@')).Except(Parse.String("@{"))
-                    .Or(Parse.Char(' '))
-                    .Select(character => character.ToString());
+            Parser<string> allowedCharacters =
+                Parse.String("@@").Select(_ => '@')
+                    .Or(Parse.AnyChar)
+                    .Except(Parse.String("@{"))
+                    .Select(c => c.ToString());
 
             #endregion
 
@@ -133,7 +128,7 @@ public string EvaluateToString(string input)
 
             return output.GetValue<string>();
         }
-        
+
         public ValueContainer EvaluateToValueContainer(string input)
         {
             return _input.Parse(input);

…/Functions/Base/ActionExecutorFactory.cs …ActionExecutors/ActionExecutorFactory.csPowerAutomateMockUp/ExpressionParser/Functions/Base/ActionExecutorFactory.cs renamed to PowerAutomateMockUp/FlowParser/ActionExecutors/ActionExecutorFactory.cs PowerAutomateMockUp/ExpressionParser/Functions/Base/ActionExecutorFactory.cs renamed to PowerAutomateMockUp/FlowParser/ActionExecutors/ActionExecutorFactory.cs

@@ -2,9 +2,8 @@
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.Extensions.DependencyInjection;
-using Parser.FlowParser.ActionExecutors;
 
-namespace Parser.ExpressionParser.Functions.Base
+namespace Parser.FlowParser.ActionExecutors
 {
     public interface IActionExecutorFactory
     {

…tions/Base/ActionExecutorRegistration.cs …nExecutors/ActionExecutorRegistration.csPowerAutomateMockUp/ExpressionParser/Functions/Base/ActionExecutorRegistration.cs renamed to PowerAutomateMockUp/FlowParser/ActionExecutors/ActionExecutorRegistration.cs PowerAutomateMockUp/ExpressionParser/Functions/Base/ActionExecutorRegistration.cs renamed to PowerAutomateMockUp/FlowParser/ActionExecutors/ActionExecutorRegistration.cs

@@ -1,6 +1,6 @@
 using System;
 
-namespace Parser.ExpressionParser.Functions.Base
+namespace Parser.FlowParser.ActionExecutors
 {
     public class ActionExecutorRegistration
     {

PowerAutomateMockUp/FlowParser/ActionExecutors/Implementations/TerminateActionExecutor.cs

@@ -3,7 +3,6 @@
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
 using Parser.ExpressionParser;
-using Parser.FlowParser.CustomExceptions;
 
 namespace Parser.FlowParser.ActionExecutors.Implementations
 {
@@ -34,7 +33,7 @@ public override Task<ActionResult> Execute()
                     var exceptionMessage = "Terminate action with status: Failed.";
 
                     if (!Inputs.GetValue<Dictionary<string, ValueContainer>>()
-                        .TryGetValue("runError", out var runErrorDict)) throw new FlowRunnerException(exceptionMessage);
+                        .TryGetValue("runError", out var runErrorDict)) throw new PowerAutomateMockUpException(exceptionMessage);
 
                     var dict = runErrorDict.GetValue<Dictionary<string, ValueContainer>>();
 
@@ -45,13 +44,13 @@ public override Task<ActionResult> Execute()
 
                     if (dict.TryGetValue("message", out var message))
                     {
-                        exceptionMessage += $" Error code: {message}.";
+                        exceptionMessage += $" Error message: {message}.";
                     }
 
                     _logger.LogInformation(
                         $"Terminate Action {ActionName} reached with status {runStatus}. Error code: {code}. Error message: {message}. Throwing exception.");
 
-                    throw new FlowRunnerException(exceptionMessage);
+                    throw new PowerAutomateMockUpException(exceptionMessage);
                 default:
                     throw new Exception($"Unknown runStatus: {runStatus}");
             }

PowerAutomateMockUp/FlowParser/CustomExceptions/FlowRunnerException.cs

@@ -112,11 +112,11 @@ private async Task RunFlow()
                     actionDescName = t.NextAction;
                 }
 
-                if (currentAd == null && actionResult.ActionStatus == ActionStatus.Failed)
+                if (currentAd == null && actionResultStatus == ActionStatus.Failed)
                 {
                     _logger.LogError(
                         "No succeeding action found after last action had status: Failed. Throwing error.");
-                    throw actionResult.ActionExecutorException ??
+                    throw actionResult?.ActionExecutorException ??
                           new PowerAutomateMockUpException(
                               $"No exception recorded - {actionExecutor.ActionName} ended with status: Failed.");
                 }

PowerAutomateMockUp/FlowParser/FlowRunner.cs

@@ -1,32 +1,11 @@
-using System;
-using System.Collections.Generic;
-using System.IO;
-using Microsoft.Extensions.DependencyInjection;
-using Newtonsoft.Json;
+using System.Collections.Generic;
 
 namespace Parser.FlowParser
 {
     public class FlowSettings
     {
-
-        public Action<IServiceCollection> ServiceConfiguration { get; set; }
-
         public bool FailOnUnknownAction { get; set; } = true;
 
         public List<string> IgnoreActions { get; set; } = new List<string>();
-
-        public Stream GetAsJsonStream()
-        {
-            var m = new MemoryStream();
-            var w = new StreamWriter(m);
-            using var writer = new JsonTextWriter(w);
-
-            var serializer = new JsonSerializer();
-
-            serializer.Serialize(writer, this);
-            writer.Flush();
-            m.Position = 0;
-            return m;
-        }
     }
 }

PowerAutomateMockUp/FlowParser/FlowSettings.cs

@@ -49,8 +49,6 @@ var path = "<path to flow definition>";
 // from Microsoft.Extensions.DependencyInjection
 var services = new ServiceCollection();
 
-services.Configure<FlowSettings>(x => { }); // Optional way to add settings
-
 // Required to set up required dependencies
 services.AddFlowRunner(); 
 
@@ -65,6 +63,18 @@ await flowRunner.Trigger();
 // Your flow have now ran
 ```
 
+### Configuration
+This is optional and the settings class has the default values mentioned below.
+
+The settings object is configured this way:
+```cs
+services.Configure<FlowSettings>(x => { }); // Optional way to add settings
+```
+The possbile values to set is:
+
+ * `x.FailOnUnknownAction` (default: `true`): If an action cannot be found and exception is thrown. This can be avoid and the action is ignored and the status is assumed to be `Succeeded`.
+ * `x.IgnoreActions` (default: `empty`): List of action names which are ignored during exectuion, the action is not executed and the status is assumed to be `Succeeded`.
+
 ### Adding actions
 Actions can be added in three ways
 
@@ -106,20 +116,39 @@ Currently there are two classes to extend, one is **DefaultBaseActionExecutor**
 ```c#
 private class ActionExecutor : DefaultBaseActionExecutor
 {
-    private readonly IState _state;
+    private readonly IExpressionEngine _expression;
 
     // Using dependency injection to get dependencies
-    public TriggerActionExecutor(IState state)
+    public TriggerActionExecutor(IExpressionEngine expression)
     {
-        _state = state ?? throw new ArgumentNullException(nameof(state));
+        _expression = expression ?? throw new ArgumentNullException(nameof(expression));
     }
 
     public override Task<ActionResult> Execute()
     {
-        // ... Execute action functionality
-
-        return Task.FromResult(
-            new ActionResult {ActionStatus = ActionStatus.Succeeded});
+        var result = new ActionResult();
+
+        try
+        {
+            // Some dangerous operation
+            // ...
+
+            result.ActionOutput = new ValueContainer(new Dictionary<string, ValueContainer>()
+            {
+                {"Key", new ValueContainer("Value")}
+            });
+            // Corresponds to: outputs('<action>').Key || outputs('<action>')['Key']
+
+            result.ActionStatus = ActionStatus.Succeeded;
+        } 
+        catch(EvenMoreDangerousException exp)
+        {
+            // PAMU handles the exceptions...
+            result.ActionStatus = ActionStatus.Failed;
+            result.ActionExecutorException = exp;
+        }
+
+        return Task.FromResult(result);
     }
 }
 ```
@@ -141,8 +170,7 @@ private class ActionExecutor : OpenApiConnectionActionExecutorBase
 
         var entityName = parameters["string"].GetValue<string>();
 
-        return Task.FromResult(
-            new ActionResult {ActionStatus = ActionStatus.Failed});
+        // ...
     }
 }
 ```

ReadMe.md

@@ -6,7 +6,6 @@
 using Parser.ExpressionParser.Functions.Base;
 using Parser.FlowParser.ActionExecutors;
 using Parser.FlowParser.ActionExecutors.Implementations;
-using Parser.FlowParser.CustomExceptions;
 
 namespace Test.ActionTests
 {
@@ -49,7 +48,7 @@ public void TerminateFailedNoMessageTest()
                 "{\"Terminate\": { \"runAfter\": {}, \"type\": \"Terminate\", \"inputs\": { \"runStatus\": \"Failed\", \"runError\": { \"code\": \"1234\" } } } }";
             action.InitializeActionExecutor("TerminateAction", JToken.Parse(json).First.First);
 
-            var exception = Assert.ThrowsAsync<FlowRunnerException>(async () => { await action.Execute(); });
+            var exception = Assert.ThrowsAsync<PowerAutomateMockUpException>(async () => { await action.Execute(); });
 
             Assert.AreEqual("Terminate action with status: Failed. Error code: 1234.",exception.Message);
         }

Test/ActionTests/TerminateActionTest.cs

@@ -99,6 +99,7 @@ public override Task<ActionResult> Execute()
 
                 Console.WriteLine($"Email Title: {Parameters["NotificationEmailDefinition/notificationSubject"]}");
                 Console.WriteLine($"Email Content: {Parameters["NotificationEmailDefinition/notificationBody"]}");
+                
                 return Task.FromResult(new ActionResult {ActionOutput = new ValueContainer(true)});
             }