Merge pull request #307 from cschleiden/only-panic-in-test

Do not panic at runtime for pending futures

Author: cschleiden

internal/workflow/executor.go

@@ -7,6 +7,7 @@ import (
 	"log/slog"
 	"reflect"
 	"slices"
+	"testing"
 
 	"github.com/benbjohnson/clock"
 	"github.com/cschleiden/go-workflows/backend"
@@ -185,6 +186,7 @@ func (e *executor) ExecuteTask(ctx context.Context, t *backend.WorkflowTask) (*E
 		if err != nil {
 			logger.Error("Error while executing new events", "error", err)
 
+			// Transition workflow to error state
 			e.workflowCompleted(nil, err)
 		}
 	}
@@ -266,7 +268,6 @@ func (e *executor) executeNewEvents(newEvents []*history.Event) ([]*history.Even
 	}
 
 	if e.workflow.Completed() {
-		// TODO: Is this too early? We haven't committed some of the commands
 		if e.workflowState.HasPendingFutures() {
 			var pending []string
 			pf := e.workflowState.PendingFutureNames()
@@ -275,8 +276,11 @@ func (e *executor) executeNewEvents(newEvents []*history.Event) ([]*history.Even
 			}
 			slices.Sort(pending)
 
-			e.logger.Error("workflow completed, but there are still pending futures", "pending", pending)
-			panic(fmt.Sprintf("workflow completed, but there are still pending futures: %s", pending))
+			if testing.Testing() {
+				panic(fmt.Sprintf("workflow completed, but there are still pending futures: %s", pending))
+			}
+
+			return newEvents, fmt.Errorf("workflow completed, but there are still pending futures: %s", pending)
 		}
 
 		if canErr, ok := e.workflow.Error().(*continueasnew.Error); ok {