feat: introduces the RealmUnhandledPanicException type to represent…

… an error thrown when a panic is not handled in the realm.
gnolang · Jul 25, 2024 · eead428 · eead428
1 parent 8f148b1
commit eead428
Show file tree

Hide file tree

Showing 9 changed files with 84 additions and 17 deletions.
diff --git a/gno.land/pkg/sdk/vm/keeper.go b/gno.land/pkg/sdk/vm/keeper.go
@@ -537,12 +537,15 @@ func (vm *VMKeeper) Call(ctx sdk.Context, msg MsgCall) (res string, err error) {
 	m.SetActivePackage(mpv)
 	defer func() {
 		if r := recover(); r != nil {
-			switch r.(type) {
+			switch r := r.(type) {
 			case store.OutOfGasException: // panic in consumeGas()
 				panic(r)
+			case gno.RealmUnhandledPanicException:
+				err = errors.Wrap(fmt.Errorf("%v", r), "VM call panic: %s\nStacktrace: %s\n",
+					r.Descriptor, m.ExceptionsStacktrace())
 			default:
 				err = errors.Wrap(fmt.Errorf("%v", r), "VM call panic: %v\nMachine State:%s\nStacktrace: %s\n",
-					r, m.String(), m.ExceptionsStacktrace())
+					r, m.String(), m.Stacktrace().String())
 				return
 			}
 		}

diff --git a/gnovm/cmd/gno/run.go b/gnovm/cmd/gno/run.go
@@ -188,8 +188,14 @@ func listNonTestFiles(dir string) ([]string, error) {
 func runExpr(m *gno.Machine, expr string) {
 	defer func() {
 		if r := recover(); r != nil {
-			fmt.Printf("panic running expression %s: %v\nMachine State:%s\nStacktrace: %s\n",
-				expr, r, m.String(), m.ExceptionsStacktrace())
+			switch r := r.(type) {
+			case gno.RealmUnhandledPanicException:
+				fmt.Printf("panic running expression %s: %v\nStacktrace: %s\n",
+					expr, r, m.ExceptionsStacktrace())
+			default:
+				fmt.Printf("panic running expression %s: %v\nMachine State:%s\nStacktrace: %s\n",
+					expr, r, m.String(), m.Stacktrace().String())
+			}
 			panic(r)
 		}
 	}()

diff --git a/gnovm/pkg/gnolang/debugger_test.go b/gnovm/pkg/gnolang/debugger_test.go
@@ -59,7 +59,16 @@ func evalTest(debugAddr, in, file string) (out, err, stacktrace string) {
 
 	defer m.Release()
 	defer func() {
-		stacktrace = strings.TrimSpace(strings.ReplaceAll(m.ExceptionsStacktrace(), "../../tests/files/", "files/"))
+		if r := recover(); r != nil {
+			switch r.(type) {
+			case gnolang.RealmUnhandledPanicException:
+				stacktrace = m.ExceptionsStacktrace()
+			default:
+				stacktrace = m.Stacktrace().String()
+			}
+			stacktrace = strings.TrimSpace(strings.ReplaceAll(stacktrace, "../../tests/files/", "files/"))
+			panic(r)
+		}
 	}()
 
 	if debugAddr != "" {

diff --git a/gnovm/pkg/gnolang/eval_test.go b/gnovm/pkg/gnolang/eval_test.go
@@ -27,8 +27,7 @@ func TestEvalFiles(t *testing.T) {
 				t.Fatalf("unexpected error\nWant: %s\n Got: %s", wantErr, err)
 			}
 
-			if wantStacktrace != "" && !strings.Contains(stacktrace, wantStacktrace) ||
-				wantStacktrace == "" && stacktrace != "" {
+			if wantStacktrace != "" && !strings.Contains(stacktrace, wantStacktrace) {
 				t.Fatalf("unexpected stacktrace\nWant: %s\n Got: %s", wantStacktrace, stacktrace)
 			}
 			if wantOut != "" && out != wantOut {

diff --git a/gnovm/pkg/gnolang/frame.go b/gnovm/pkg/gnolang/frame.go
@@ -128,7 +128,7 @@ func (s Stacktrace) String() string {
 			fmt.Fprintf(&builder, "    %s/%s:%d\n", call.Frame.Func.PkgPath, call.Frame.Func.FileName, call.Stmt.GetLine())
 		case call.Frame.GoFunc != nil:
 			fmt.Fprintf(&builder, "%s\n", toExprTrace(cx))
-			fmt.Fprintf(&builder, "    %s\n", call.Frame.GoFunc.Value.Type())
+			fmt.Fprintf(&builder, "    gofunction:%s\n", call.Frame.GoFunc.Value.Type())
 		default:
 			panic("StacktraceCall has a non-call Frame")
 		}

diff --git a/gnovm/pkg/gnolang/machine.go b/gnovm/pkg/gnolang/machine.go
@@ -33,6 +33,15 @@ func (e Exception) Sprint(m *Machine) string {
 	return e.Value.Sprint(m)
 }
 
+// RealmUnhandledPanicException represents an error thrown when a panic is not handled in the realm.
+type RealmUnhandledPanicException struct {
+	Descriptor string // Description of the unhandled panic.
+}
+
+func (e RealmUnhandledPanicException) String() string {
+	return e.Descriptor
+}
+
 //----------------------------------------
 // Machine
 
@@ -775,8 +784,14 @@ func (m *Machine) resavePackageValues(rlm *Realm) {
 func (m *Machine) RunFunc(fn Name) {
 	defer func() {
 		if r := recover(); r != nil {
-			fmt.Printf("Machine.RunFunc(%q) panic: %v\nMachine State:%s\nStacktrace: %s\n",
-				fn, r, m.String(), m.ExceptionsStacktrace())
+			switch r := r.(type) {
+			case RealmUnhandledPanicException:
+				fmt.Printf("Machine.RunFunc(%q) panic: %v\nStacktrace: %s\n",
+					fn, r.Descriptor, m.ExceptionsStacktrace())
+			default:
+				fmt.Printf("Machine.RunFunc(%q) panic: %v\nMachine State:%s\nStacktrace: %s\n",
+					fn, r, m.String(), m.Stacktrace().String())
+			}
 			panic(r)
 		}
 	}()
@@ -786,8 +801,14 @@ func (m *Machine) RunFunc(fn Name) {
 func (m *Machine) RunMain() {
 	defer func() {
 		if r := recover(); r != nil {
-			fmt.Printf("Machine.RunMain() panic: %v\nMachine State:%s\nStacktrace: %s\n",
-				r, m.String(), m.ExceptionsStacktrace())
+			switch r := r.(type) {
+			case RealmUnhandledPanicException:
+				fmt.Printf("Machine.RunMain() panic: %v\nStacktrace: %s\n",
+					r.Descriptor, m.ExceptionsStacktrace())
+			default:
+				fmt.Printf("Machine.RunMain() panic: %v\nMachine State:%s\nStacktrace: %s\n",
+					r, m.String(), m.Stacktrace())
+			}
 			panic(r)
 		}
 	}()

diff --git a/gnovm/pkg/gnolang/op_call.go b/gnovm/pkg/gnolang/op_call.go
@@ -427,7 +427,9 @@ func (m *Machine) doOpPanic2() {
 			for i, ex := range m.Exceptions {
 				exs[i] = ex.Sprint(m)
 			}
-			panic(strings.Join(exs, "\n\t"))
+			panic(RealmUnhandledPanicException{
+				Descriptor: strings.Join(exs, "\n\t"),
+			})
 		}
 		m.PushOp(OpPanic2)
 		m.PushOp(OpReturnCallDefers) // XXX rename, not return?

diff --git a/gnovm/tests/file.go b/gnovm/tests/file.go
@@ -260,6 +260,8 @@ func RunFileTest(rootDir string, path string, opts ...RunFileTestOption) error {
 						errstr = v.Sprint(m)
 					case *gno.PreprocessError:
 						errstr = v.Unwrap().Error()
+					case gno.RealmUnhandledPanicException:
+						errstr = v.Descriptor
 					default:
 						errstr = strings.TrimSpace(fmt.Sprintf("%v", pnc))
 					}
@@ -375,11 +377,16 @@ func RunFileTest(rootDir string, path string, opts ...RunFileTestOption) error {
 					}
 				}
 			case "Stacktrace":
-				if pnc == nil {
-					panic(fmt.Sprintf("fail on %s: got nil error, want: %q", path, stacktraceWanted))
-				}
 				if stacktraceWanted != "" {
-					stacktrace := m.ExceptionsStacktrace()
+					var stacktrace string
+
+					switch pnc.(type) {
+					case gno.RealmUnhandledPanicException:
+						stacktrace = m.ExceptionsStacktrace()
+					default:
+						stacktrace = m.Stacktrace().String()
+					}
+
 					if !strings.Contains(stacktrace, stacktraceWanted) {
 						diff, _ := difflib.GetUnifiedDiffString(difflib.UnifiedDiff{
 							A:        difflib.SplitLines(stacktraceWanted),

diff --git a/gnovm/tests/files/time17_native.gno b/gnovm/tests/files/time17_native.gno
@@ -0,0 +1,20 @@
+package main
+
+import (
+	"fmt"
+	"time"
+)
+
+func main() {
+	now := time.Now()
+	now.In(nil)
+}
+
+// Error:
+// time: missing Location in call to Time.In
+
+// Stacktrace:
+// now<VPBlock(1,0)>.In(gonative{*time.Location})
+//     gofunction:func(*time.Location) time.Time
+// main<VPBlock(1,0)>()
+//     main/files/time17_native.gno:10