Update diag UI

cschleiden · cschleiden · commit a1d9f868c2e1 · 2023-07-07T17:41:15.000Z
diff --git a/diag/app/build/asset-manifest.json b/diag/app/build/asset-manifest.json
@@ -1,13 +1,13 @@
 {
   "files": {
     "main.css": "./static/css/main.8b0db0ad.css",
-    "main.js": "./static/js/main.cf32ac93.js",
+    "main.js": "./static/js/main.b236aa1e.js",
     "index.html": "./index.html",
     "main.8b0db0ad.css.map": "./static/css/main.8b0db0ad.css.map",
-    "main.cf32ac93.js.map": "./static/js/main.cf32ac93.js.map"
+    "main.b236aa1e.js.map": "./static/js/main.b236aa1e.js.map"
   },
   "entrypoints": [
     "static/css/main.8b0db0ad.css",
-    "static/js/main.cf32ac93.js"
+    "static/js/main.b236aa1e.js"
   ]
 }
diff --git a/diag/app/build/index.html b/diag/app/build/index.html
@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><title>go-workflows</title><script defer="defer" src="./static/js/main.cf32ac93.js"></script><link href="./static/css/main.8b0db0ad.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><title>go-workflows</title><script defer="defer" src="./static/js/main.b236aa1e.js"></script><link href="./static/css/main.8b0db0ad.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
diff --git a/diag/app/build/static/js/main.b236aa1e.js b/diag/app/build/static/js/main.b236aa1e.js
diff --git a/diag/app/build/static/js/main.b236aa1e.js.LICENSE.txt b/diag/app/build/static/js/main.b236aa1e.js.LICENSE.txt
diff --git a/diag/app/build/static/js/main.b236aa1e.js.map b/diag/app/build/static/js/main.b236aa1e.js.map
diff --git a/diag/app/build/static/js/main.cf32ac93.js.map b/diag/app/build/static/js/main.cf32ac93.js.map
diff --git a/diag/app/src/Components.tsx b/diag/app/src/Components.tsx
@@ -20,10 +20,18 @@ export function decodePayloads(payload: { [key: string]: any }): any {
         r[key] = payload[key].map((p: any) => decodePayload(p));
         break;
 
+      case "error":
+        r[key] = decodePayloads(payload[key]);
+        break;
+
       case "result":
         r[key] = decodePayload(payload[key]);
         break;
 
+      case "stacktrace":
+        r[key] = ("" + payload[key]).replaceAll("\t", "    ").split("\n");
+        break;
+
       default:
         r[key] = payload[key];
     }
diff --git a/diag/app/src/Instance.tsx b/diag/app/src/Instance.tsx
@@ -55,7 +55,7 @@ function Instance() {
   const inputs = startedEvent.attributes.inputs;
 
   let wfResult: string | undefined;
-  let wfError: string | undefined;
+  let wfError: {} | undefined;
   const finishedEvent = instance.history.find(
     (e) =>
       e.type === "WorkflowExecutionFinished" ||
@@ -127,7 +127,11 @@ function Instance() {
         <Card.Header as="h5">Result</Card.Header>
         <Card.Body>
           {wfResult && <Payload payloads={[decodePayload(wfResult)]} />}
-          {wfError && <Payload payloads={[wfError]} />}
+          {wfError && (
+            <Payload
+              payloads={[JSON.stringify(decodePayloads(wfError), undefined, 2)]}
+            />
+          )}
         </Card.Body>
       </Card>
 
diff --git a/internal/command/complete_workflow.go b/internal/command/complete_workflow.go
@@ -65,7 +65,7 @@ func (c *CompleteWorkflowCommand) Execute(clock clock.Clock) *CommandResult {
 			// Send completion message back to parent workflow instance
 			var historyEvent *history.Event
 
-			if c.Error != nil { // TODO: Is this enough?
+			if c.Error != nil {
 				// Sub workflow failed
 				historyEvent = history.NewPendingEvent(
 					clock.Now(),
diff --git a/internal/sync/context.go b/internal/sync/context.go
@@ -104,7 +104,7 @@ type Context interface {
 // Canceled is the error returned by Context.Err when the context is canceled.
 //
 //lint:ignore ST1012 for compat with "context" package
-var Canceled = errors.New("context canceled") // TODO: Need to make this a workflow.Error
+var Canceled = errors.New("context canceled")
 
 // An emptyCtx is never canceled, has no values, and has no deadline. It is not
 // struct{}, since vars of this type must have distinct addresses.
diff --git a/internal/sync/coroutine.go b/internal/sync/coroutine.go
@@ -33,8 +33,6 @@ type Coroutine interface {
 	Error() error
 
 	SetCoroutineCreator(creator CoroutineCreator)
-
-	SetPanicHandler(handler func(interface{}) error)
 }
 
 type key int
@@ -53,8 +51,7 @@ type coState struct {
 	shouldExit atomic.Value // coroutine should exit
 	progress   atomic.Value // did the coroutine make progress since last yield?
 
-	err          error
-	panicHandler func(interface{}) error
+	err error
 
 	logger logger
 
@@ -71,11 +68,7 @@ func NewCoroutine(ctx Context, fn func(ctx Context) error) Coroutine {
 		defer s.finish() // Ensure we always mark the coroutine as finished
 		defer func() {
 			if r := recover(); r != nil {
-				if s.panicHandler != nil {
-					s.err = s.panicHandler(r)
-				} else {
-					s.err = fmt.Errorf("panic: %v", r)
-				}
+				s.err = fmt.Errorf("panic: %v", r)
 			}
 		}()
 
@@ -114,10 +107,6 @@ func (s *coState) SetCoroutineCreator(creator CoroutineCreator) {
 	s.creator = creator
 }
 
-func (s *coState) SetPanicHandler(handler func(interface{}) error) {
-	s.panicHandler = handler
-}
-
 func (s *coState) Finished() bool {
 	v, ok := s.finished.Load().(bool)
 	return ok && v
diff --git a/internal/sync/coroutine_test.go b/internal/sync/coroutine_test.go
@@ -2,7 +2,6 @@ package sync
 
 import (
 	"errors"
-	"fmt"
 	"testing"
 	"time"
 
@@ -178,18 +177,3 @@ func Test_Coroutine_Panic(t *testing.T) {
 	require.Error(t, c.Error())
 	require.Equal(t, c.Error().Error(), "panic: test panic")
 }
-
-func Test_Coroutine_CallPanicHandlerIfSet(t *testing.T) {
-	c := NewCoroutine(Background(), func(ctx Context) error {
-		panic("test panic")
-	})
-
-	c.SetPanicHandler(func(r interface{}) error {
-		return fmt.Errorf("handled panic: %v", r)
-	})
-
-	c.Execute()
-
-	require.True(t, c.Finished())
-	require.EqualError(t, c.Error(), "handled panic: test panic")
-}
diff --git a/internal/sync/scheduler.go b/internal/sync/scheduler.go
@@ -1,8 +1,7 @@
 package sync
 
 type Scheduler struct {
-	coroutines   []Coroutine
-	panicHandler func(interface{}) error
+	coroutines []Coroutine
 }
 
 func NewScheduler() *Scheduler {
@@ -11,16 +10,9 @@ func NewScheduler() *Scheduler {
 	}
 }
 
-func (s *Scheduler) SetPanicHandler(handler func(interface{}) error) {
-	s.panicHandler = handler
-}
-
 // Starts a new co-routine and tracks it in this scheduler
 func (s *Scheduler) NewCoroutine(ctx Context, fn func(Context) error) {
 	c := NewCoroutine(ctx, fn)
-	if s.panicHandler != nil {
-		c.SetPanicHandler(s.panicHandler)
-	}
 	s.coroutines = append(s.coroutines, c)
 	c.SetCoroutineCreator(s)
 }
diff --git a/internal/workflow/executor.go b/internal/workflow/executor.go
@@ -650,7 +650,7 @@ func (e *executor) handleSideEffectResult(event *history.Event, a *history.SideE
 func (e *executor) workflowCompleted(result payload.Payload, wfErr error) error {
 	eventId := e.workflowState.GetNextScheduleEventID()
 
-	cmd := command.NewCompleteWorkflowCommand(eventId, e.workflowState.Instance(), result, workflowerrors.FromError(wfErr)) // TODO: can we have a more specific error? can we accept *Error for the function?
+	cmd := command.NewCompleteWorkflowCommand(eventId, e.workflowState.Instance(), result, workflowerrors.FromError(wfErr))
 	e.workflowState.AddCommand(cmd)
 
 	return nil
diff --git a/internal/workflow/executor_test.go b/internal/workflow/executor_test.go
@@ -482,7 +482,7 @@ func Test_Executor(t *testing.T) {
 
 				r1, err := e.ExecuteTask(context.Background(), task1)
 				require.NoError(t, err)
-				require.Nil(t, e.workflow.err)
+				require.Error(t, e.workflow.err)
 				require.True(t, e.workflow.Completed())
 				require.Len(t, e.workflowState.Commands(), 1)
 				require.Len(t, pendingCommands(e.workflowState.Commands()), 0)
diff --git a/internal/workflow/workflow.go b/internal/workflow/workflow.go
@@ -9,6 +9,7 @@ import (
 	"github.com/cschleiden/go-workflows/internal/converter"
 	"github.com/cschleiden/go-workflows/internal/payload"
 	"github.com/cschleiden/go-workflows/internal/sync"
+	"github.com/cschleiden/go-workflows/internal/workflowerrors"
 )
 
 type Workflow interface{}
@@ -22,9 +23,6 @@ type workflow struct {
 
 func NewWorkflow(workflowFn reflect.Value) *workflow {
 	s := sync.NewScheduler()
-	s.SetPanicHandler(func(i interface{}) error {
-		return workflowerrors.
-	})
 
 	return &workflow{
 		s:  s,
@@ -46,6 +44,13 @@ func (w *workflow) Execute(ctx sync.Context, inputs []payload.Payload) error {
 
 		args[0] = reflect.ValueOf(ctx)
 
+		// Handle panics in workflows
+		defer func() {
+			if r := recover(); r != nil {
+				w.err = workflowerrors.NewPanicError(fmt.Sprintf("panic in workflow: %v", r))
+			}
+		}()
+
 		// Call workflow function
 		r := w.fn.Call(args)
 
diff --git a/internal/workflow/workflow_test.go b/internal/workflow/workflow_test.go
@@ -0,0 +1,39 @@
+package workflow
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/cschleiden/go-workflows/internal/converter"
+	"github.com/cschleiden/go-workflows/internal/sync"
+	"github.com/cschleiden/go-workflows/internal/workflowerrors"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_Workflow_WrapsPanic(t *testing.T) {
+	f := func() {
+		panic("wf panic")
+	}
+
+	w := func(ctx sync.Context) error {
+		f()
+
+		return nil
+	}
+
+	ctx := sync.Background()
+	ctx = converter.WithConverter(ctx, converter.DefaultConverter)
+
+	wf := NewWorkflow(reflect.ValueOf(w))
+	err := wf.Execute(ctx, nil)
+	require.NoError(t, err)
+
+	for !wf.Completed() {
+		require.NoError(t, wf.Continue())
+	}
+
+	wfErr := wf.Error()
+	require.Error(t, wfErr)
+	var panicErr *workflowerrors.PanicError
+	require.ErrorAs(t, wfErr, &panicErr)
+}
diff --git a/samples/errors/errors.go b/samples/errors/errors.go
@@ -4,11 +4,13 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"net/http"
 	"os"
 	"os/signal"
 
 	"github.com/cschleiden/go-workflows/backend"
 	"github.com/cschleiden/go-workflows/client"
+	"github.com/cschleiden/go-workflows/diag"
 	"github.com/cschleiden/go-workflows/log"
 	"github.com/cschleiden/go-workflows/samples"
 	"github.com/cschleiden/go-workflows/worker"
@@ -21,6 +23,16 @@ func main() {
 
 	b := samples.GetBackend("errors")
 
+	db, ok := b.(diag.Backend)
+	if !ok {
+		panic("backend does not implement diag.Backend")
+	}
+
+	// Start diagnostic server under /diag
+	m := http.NewServeMux()
+	m.Handle("/diag/", http.StripPrefix("/diag", diag.NewServeMux(db)))
+	go http.ListenAndServe(":3000", m)
+
 	// Run worker
 	go RunWorker(ctx, b)
 
diff --git a/tester/tester_retries_test.go b/tester/tester_retries_test.go
@@ -38,7 +38,9 @@ func Test_withRetries_permanent(t *testing.T) {
 
 	attempts, err := tester.WorkflowResult()
 	require.Equal(t, 1, attempts)
-	require.NotEmpty(t, err) // TODO: Check for permanent error here ..
+	var permanentErr *workflowerrors.Error
+	require.ErrorAs(t, err, &permanentErr)
+	require.True(t, permanentErr.Permanent)
 	tester.AssertExpectations(t)
 
 	require.Equal(t, 1, attempts)

Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,13 @@`
`1`	`1`	`{`
`2`	`2`	`"files": {`
`3`	`3`	`"main.css": "./static/css/main.8b0db0ad.css",`
`4`		`- "main.js": "./static/js/main.cf32ac93.js",`
	`4`	`+ "main.js": "./static/js/main.b236aa1e.js",`
`5`	`5`	`"index.html": "./index.html",`
`6`	`6`	`"main.8b0db0ad.css.map": "./static/css/main.8b0db0ad.css.map",`
`7`		`- "main.cf32ac93.js.map": "./static/js/main.cf32ac93.js.map"`
	`7`	`+ "main.b236aa1e.js.map": "./static/js/main.b236aa1e.js.map"`
`8`	`8`	`},`
`9`	`9`	`"entrypoints": [`
`10`	`10`	`"static/css/main.8b0db0ad.css",`
`11`		`- "static/js/main.cf32ac93.js"`
	`11`	`+ "static/js/main.b236aa1e.js"`
`12`	`12`	`]`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><title>go-workflows</title><script defer="defer" src="./static/js/main.cf32ac93.js"></script><link href="./static/css/main.8b0db0ad.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>`
	`1`	`+<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><title>go-workflows</title><script defer="defer" src="./static/js/main.b236aa1e.js"></script><link href="./static/css/main.8b0db0ad.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>`