From d20238c2a7cac8cbc1e643a2420f7762d7cf7fb0 Mon Sep 17 00:00:00 2001
From: Nick Johnson <arachnid@notdot.net>
Date: Wed, 24 Aug 2016 12:14:47 +0100
Subject: internal/ethapi: Improve tracer error reporting and serialization
---
internal/ethapi/tracer.go | 33 ++++++++++++++++++++++++---------
internal/ethapi/tracer_test.go | 4 ++--
2 files changed, 26 insertions(+), 11 deletions(-)
diff --git a/internal/ethapi/tracer.go b/internal/ethapi/tracer.go
index 27af1166b..37cb7ec36 100644
--- a/internal/ethapi/tracer.go
+++ b/internal/ethapi/tracer.go
@@ -17,6 +17,7 @@
package ethapi
import (
+ "encoding/json"
"errors"
"fmt"
"math/big"
@@ -55,6 +56,11 @@ func (ocw *opCodeWrapper) isPush() bool {
return ocw.op.IsPush()
}
+// MarshalJSON serializes the opcode as JSON
+func (ocw *opCodeWrapper) MarshalJSON() ([]byte, error) {
+ return json.Marshal(ocw.op.String())
+}
+
// toValue returns an otto.Value for the opCodeWrapper
func (ocw *opCodeWrapper) toValue(vm *otto.Otto) otto.Value {
value, _ := vm.ToValue(ocw)
@@ -165,8 +171,6 @@ type JavascriptTracer struct {
traceobj *otto.Object // User-supplied object to call
log map[string]interface{} // (Reusable) map for the `log` arg to `step`
logvalue otto.Value // JS view of `log`
- opcode *opCodeWrapper // Wrapper around the opcode
- opcodevalue otto.Value // JS view of 'opcode'
memory *memoryWrapper // Wrapper around the VM memory
memvalue otto.Value // JS view of `memory`
stack *stackWrapper // Wrapper around the VM stack
@@ -213,7 +217,6 @@ func NewJavascriptTracer(code string) (*JavascriptTracer, error) {
logvalue, _ := vm.ToValue(log)
// Create persistent wrappers for memory and stack
- opcode := &opCodeWrapper{}
mem := &memoryWrapper{}
stack := &stackWrapper{}
db := &dbWrapper{}
@@ -223,8 +226,6 @@ func NewJavascriptTracer(code string) (*JavascriptTracer, error) {
traceobj: jstracer,
log: log,
logvalue: logvalue,
- opcode: opcode,
- opcodevalue: opcode.toValue(vm),
memory: mem,
memvalue: mem.toValue(vm),
stack: stack,
@@ -265,16 +266,26 @@ func (jst *JavascriptTracer) callSafely(method string, argumentList ...interface
return ret, err
}
+func wrapError(context string, err error) error {
+ var message string
+ switch err := err.(type) {
+ case *otto.Error:
+ message = err.String()
+ default:
+ message = err.Error()
+ }
+ return fmt.Errorf("%v in server-side tracer function '%v'", message, context)
+}
+
// CaptureState implements the Tracer interface to trace a single step of VM execution
func (jst *JavascriptTracer) CaptureState(env vm.Environment, pc uint64, op vm.OpCode, gas, cost *big.Int, memory *vm.Memory, stack *vm.Stack, contract *vm.Contract, depth int, err error) {
if jst.err == nil {
- jst.opcode.op = op
jst.memory.memory = memory
jst.stack.stack = stack
jst.db.db = env.Db()
jst.log["pc"] = pc
- jst.log["op"] = jst.opcodevalue
+ jst.log["op"] = &opCodeWrapper{op}
jst.log["gas"] = gas.Int64()
jst.log["gasPrice"] = cost.Int64()
jst.log["memory"] = jst.memvalue
@@ -285,7 +296,7 @@ func (jst *JavascriptTracer) CaptureState(env vm.Environment, pc uint64, op vm.O
_, err := jst.callSafely("step", jst.logvalue, jst.dbvalue)
if err != nil {
- jst.err = err
+ jst.err = wrapError("step", err)
}
}
}
@@ -296,5 +307,9 @@ func (jst *JavascriptTracer) GetResult() (result interface{}, err error) {
return nil, jst.err
}
- return jst.callSafely("result")
+ result, err = jst.callSafely("result")
+ if err != nil {
+ err = wrapError("result", err)
+ }
+ return
}
diff --git a/internal/ethapi/tracer_test.go b/internal/ethapi/tracer_test.go
index 2f1dfa0be..dbc38bbbc 100644
--- a/internal/ethapi/tracer_test.go
+++ b/internal/ethapi/tracer_test.go
@@ -161,7 +161,7 @@ func TestHalt(t *testing.T) {
tracer.Stop(timeout)
}()
- if _, err = runTrace(tracer); err != timeout {
+ if _, err = runTrace(tracer); err.Error() != "stahp in server-side tracer function 'step'" {
t.Errorf("Expected timeout error, got %v", err)
}
}
@@ -180,7 +180,7 @@ func TestHaltBetweenSteps(t *testing.T) {
tracer.Stop(timeout)
tracer.CaptureState(env, 0, 0, big.NewInt(0), big.NewInt(0), nil, nil, contract, 0, nil)
- if _, err := tracer.GetResult(); err != timeout {
+ if _, err := tracer.GetResult(); err.Error() != "stahp in server-side tracer function 'step'" {
t.Errorf("Expected timeout error, got %v", err)
}
}
--
cgit v1.2.3