Added ability to clear failed effects before restarting a flow

Author: stidsborg

Core/Cleipnir.ResilientFunctions.Tests/InMemoryTests/RFunctionTests/ControlPanelTests.cs

@@ -181,4 +181,8 @@ public override Task CorrelationsCanBeChanged()
     [TestMethod]
     public override Task DeleteRemovesFunctionFromAllStores()
         => DeleteRemovesFunctionFromAllStores(FunctionStoreFactory.Create());
+
+    [TestMethod]
+    public override Task ClearFailedEffectsRemovesFailedEffectBeforeRestart()
+        => ClearFailedEffectsRemovesFailedEffectBeforeRestart(FunctionStoreFactory.Create());
 }

Core/Cleipnir.ResilientFunctions.Tests/TestTemplates/FunctionTests/ControlPanelTests.cs

@@ -1699,4 +1699,47 @@ await store.EffectsStore
 
         unhandledExceptionCatcher.ShouldNotHaveExceptions();
     }
+    
+    public abstract Task ClearFailedEffectsRemovesFailedEffectBeforeRestart();
+    protected async Task ClearFailedEffectsRemovesFailedEffectBeforeRestart(Task<IFunctionStore> storeTask)
+    {
+        var unhandledExceptionCatcher = new UnhandledExceptionCatcher();
+        
+        var store = await storeTask;
+        var functionId = TestFlowId.Create();
+        var (flowType, flowInstance) = functionId;
+        using var functionsRegistry = new FunctionsRegistry(store, new Settings(unhandledExceptionCatcher.Catch));
+
+        var shouldFail = true;
+        var registration = functionsRegistry.RegisterParamless(
+            flowType,
+            inner: async workflow =>
+            {
+                await workflow.Effect.Capture(() =>
+                {
+                    if (shouldFail)
+                        throw new TimeoutException("Timeout!");
+                });
+            } 
+        );
+
+        try
+        {
+            await registration.Invoke(flowInstance);
+        }
+        catch (FatalWorkflowException exception)
+        {
+            exception.ErrorType.ShouldBe(typeof(TimeoutException));
+        }
+        
+        var controlPanel = await registration.ControlPanel(flowInstance.Value);
+        controlPanel.ShouldNotBeNull();
+
+        await controlPanel.BusyWaitUntil(c => c.Status == Status.Failed);
+
+        shouldFail = false;
+        await controlPanel.Restart(clearFailedEffects: true);
+        
+        unhandledExceptionCatcher.ShouldNotHaveExceptions();
+    }
 }

Core/Cleipnir.ResilientFunctions/Domain/ControlPanel.cs

@@ -307,15 +307,21 @@ public async Task SaveChanges()
 
     public Task Delete() => _invocationHelper.Delete(StoredId);
 
-    public async Task<TReturn> Restart()
+    public async Task<TReturn> Restart(bool clearFailedEffects = false)
     {
+        if (clearFailedEffects)
+            await Effects.RemoveFailed();
+        
         if (_innerParamChanged)
             await SaveChanges();
 
         return await _invoker.Restart(StoredId.Instance, Epoch);   
     }
-    public async Task ScheduleRestart()
+    public async Task ScheduleRestart(bool clearFailedEffects = false)
     {
+        if (clearFailedEffects)
+            await Effects.RemoveFailed();
+            
         if (_innerParamChanged)
             await SaveChanges();
 

Core/Cleipnir.ResilientFunctions/Domain/ExistingEffects.cs

@@ -53,6 +53,13 @@ public async Task<WorkStatus> GetStatus(EffectId effectId)
         return storedEffects[effectId].WorkStatus;
     }
 
+    public async Task RemoveFailed()
+    {
+        foreach (var effectId in await AllIds)
+            if (await GetStatus(effectId) == WorkStatus.Failed)
+                await Remove(effectId);
+    }
+
     public Task Remove(string effectId) => Remove(effectId.ToEffectId());
     public async Task Remove(EffectId effectId)
     {

Stores/MariaDB/Cleipnir.ResilientFunctions.MariaDB.Tests/RFunctionTests/ControlPanelTests.cs

@@ -180,4 +180,8 @@ public override Task CorrelationsCanBeChanged()
     [TestMethod]
     public override Task DeleteRemovesFunctionFromAllStores()
         => DeleteRemovesFunctionFromAllStores(FunctionStoreFactory.Create());
+    
+    [TestMethod]
+    public override Task ClearFailedEffectsRemovesFailedEffectBeforeRestart()
+        => ClearFailedEffectsRemovesFailedEffectBeforeRestart(FunctionStoreFactory.Create());
 }

Stores/PostgreSQL/Cleipnir.ResilientFunctions.PostgreSQL.Tests/RFunctionTests/ControlPanelTests.cs

@@ -181,4 +181,8 @@ public override Task CorrelationsCanBeChanged()
     [TestMethod]
     public override Task DeleteRemovesFunctionFromAllStores()
         => DeleteRemovesFunctionFromAllStores(FunctionStoreFactory.Create());
+    
+    [TestMethod]
+    public override Task ClearFailedEffectsRemovesFailedEffectBeforeRestart()
+        => ClearFailedEffectsRemovesFailedEffectBeforeRestart(FunctionStoreFactory.Create());
 }

Stores/SqlServer/Cleipnir.ResilientFunctions.SqlServer.Tests/RFunctionTests/ControlPanelTests.cs

@@ -182,4 +182,8 @@ public override Task CorrelationsCanBeChanged()
     [TestMethod]
     public override Task DeleteRemovesFunctionFromAllStores()
         => DeleteRemovesFunctionFromAllStores(FunctionStoreFactory.Create());
+    
+    [TestMethod]
+    public override Task ClearFailedEffectsRemovesFailedEffectBeforeRestart()
+        => ClearFailedEffectsRemovesFailedEffectBeforeRestart(FunctionStoreFactory.Create());
 }