1
0
mirror of https://github.com/robertkrimen/otto synced 2025-10-12 20:27:30 +08:00
otto/error_test.go
Conrad Pankoff 67dbb5d65b fix: mishandling of message parameter in runtime.newErrorObject
runtime.newErrorObject is used to implement the Error constructor, and as such
it takes input from JavaScript via calls like `new Error('xxx')`. The actual
underlying error information is stored in an ottoError object, which is
constructed using newError. newError takes a couple of mandatory arguments,
then treats the remaining parameters (collected as `in ...interface{}`) as a
printf-style format string and parameter list, which it uses to populate the
message field of the returned ottoError object. newErrorObject was passing the
message parameter from the Error function exposed to JavaScript directly
through to newError as the first optional parameter, which led to it being
treated as a format string, which resulted in any code like `throw new
Error('%s')` behaving incorrectly, with the resultant error having a message
like "%!s(MISSING)".

This change fixes this behaviour in the least intrusive way I could find, and
adds some tests to make sure it doesn't come back.

The logic for newErrorObject and newErrorObjectError are very similar, so it
was tempting to try to merge them, but it appears they're used in somewhat
fragile ways with very little test coverage so I'll leave that as a problem
for another day.
2023-07-06 20:41:55 +10:00

467 lines
10 KiB
Go

package otto
import (
"errors"
"testing"
"github.com/stretchr/testify/require"
)
func TestError(t *testing.T) {
tt(t, func() {
test, _ := test()
test(`
[ Error.prototype.name, Error.prototype.message, Error.prototype.hasOwnProperty("message") ];
`, "Error,,true")
})
}
func TestError_instanceof(t *testing.T) {
tt(t, func() {
test, _ := test()
test(`(new TypeError()) instanceof Error`, true)
})
}
func TestPanicValue(t *testing.T) {
tt(t, func() {
test, vm := test()
vm.Set("abc", func(call FunctionCall) Value {
value, err := call.Otto.Run(`({ def: 3.14159 })`)
is(err, nil)
panic(value)
})
test(`
try {
abc();
}
catch (err) {
error = err;
}
[ error instanceof Error, error.message, error.def ];
`, "false,,3.14159")
})
}
func Test_catchPanic(t *testing.T) {
tt(t, func() {
vm := New()
_, err := vm.Run(`
A syntax error that
does not define
var;
abc;
`)
is(err, "!=", nil)
_, err = vm.Call(`abc.def`, nil)
is(err, "!=", nil)
})
}
func asError(t *testing.T, err error) *Error {
t.Helper()
var oerr *Error
require.True(t, errors.As(err, &oerr))
return oerr
}
func TestErrorContext(t *testing.T) {
tt(t, func() {
vm := New()
_, err := vm.Run(`
undefined();
`)
{
err := asError(t, err)
is(err.message, `"undefined" is not a function`)
is(len(err.trace), 1)
is(err.trace[0].location(), "<anonymous>:2:13")
}
_, err = vm.Run(`
({}).abc();
`)
{
err := asError(t, err)
is(err.message, `"abc" is not a function`)
is(len(err.trace), 1)
is(err.trace[0].location(), "<anonymous>:2:14")
}
_, err = vm.Run(`
("abc").abc();
`)
{
err := asError(t, err)
is(err.message, `"abc" is not a function`)
is(len(err.trace), 1)
is(err.trace[0].location(), "<anonymous>:2:14")
}
_, err = vm.Run(`
var ghi = "ghi";
ghi();
`)
{
err := asError(t, err)
is(err.message, `"ghi" is not a function`)
is(len(err.trace), 1)
is(err.trace[0].location(), "<anonymous>:3:13")
}
_, err = vm.Run(`
function def() {
undefined();
}
function abc() {
def();
}
abc();
`)
{
err := asError(t, err)
is(err.message, `"undefined" is not a function`)
is(len(err.trace), 3)
is(err.trace[0].location(), "def (<anonymous>:3:17)")
is(err.trace[1].location(), "abc (<anonymous>:6:17)")
is(err.trace[2].location(), "<anonymous>:8:13")
}
_, err = vm.Run(`
function abc() {
xyz();
}
abc();
`)
{
err := asError(t, err)
is(err.message, "'xyz' is not defined")
is(len(err.trace), 2)
is(err.trace[0].location(), "abc (<anonymous>:3:17)")
is(err.trace[1].location(), "<anonymous>:5:13")
}
_, err = vm.Run(`
mno + 1;
`)
{
err := asError(t, err)
is(err.message, "'mno' is not defined")
is(len(err.trace), 1)
is(err.trace[0].location(), "<anonymous>:2:13")
}
_, err = vm.Run(`
eval("xyz();");
`)
{
err := asError(t, err)
is(err.message, "'xyz' is not defined")
is(len(err.trace), 1)
is(err.trace[0].location(), "<anonymous>:1:1")
}
_, err = vm.Run(`
xyzzy = "Nothing happens."
eval("xyzzy();");
`)
{
err := asError(t, err)
is(err.message, `"xyzzy" is not a function`)
is(len(err.trace), 1)
is(err.trace[0].location(), "<anonymous>:1:1")
}
_, err = vm.Run(`
throw Error("xyzzy");
`)
{
err := asError(t, err)
is(err.message, "xyzzy")
is(len(err.trace), 1)
is(err.trace[0].location(), "<anonymous>:2:19")
}
_, err = vm.Run(`
throw new Error("xyzzy");
`)
{
err := asError(t, err)
is(err.message, "xyzzy")
is(len(err.trace), 1)
is(err.trace[0].location(), "<anonymous>:2:23")
}
script1, err := vm.Compile("file1.js",
`function A() {
throw new Error("test");
}
function C() {
var o = null;
o.prop = 1;
}
`)
is(err, nil)
_, err = vm.Run(script1)
is(err, nil)
script2, err := vm.Compile("file2.js",
`function B() {
A()
}
`)
is(err, nil)
_, err = vm.Run(script2)
is(err, nil)
script3, err := vm.Compile("file3.js", "B()")
is(err, nil)
_, err = vm.Run(script3)
{
err := asError(t, err)
is(err.message, "test")
is(len(err.trace), 3)
is(err.trace[0].location(), "A (file1.js:2:15)")
is(err.trace[1].location(), "B (file2.js:2:5)")
is(err.trace[2].location(), "file3.js:1:1")
}
{
f, _ := vm.Get("B")
_, err := f.Call(UndefinedValue())
err1 := asError(t, err)
is(err1.message, "test")
is(len(err1.trace), 2)
is(err1.trace[0].location(), "A (file1.js:2:15)")
is(err1.trace[1].location(), "B (file2.js:2:5)")
}
{
f, _ := vm.Get("C")
_, err := f.Call(UndefinedValue())
err1 := asError(t, err)
is(err1.message, `Cannot access member "prop" of null`)
is(len(err1.trace), 1)
is(err1.trace[0].location(), "C (file1.js:7:5)")
}
})
}
func TestMakeCustomErrorReturn(t *testing.T) {
tt(t, func() {
vm := New()
err := vm.Set("A", func(c FunctionCall) Value {
return vm.MakeCustomError("CarrotError", "carrots is life, carrots is love")
})
require.NoError(t, err)
s, err := vm.Compile("test.js", `
function B() { return A(); }
function C() { return B(); }
function D() { return C(); }
`)
require.NoError(t, err)
_, err = vm.Run(s)
require.NoError(t, err)
v, err := vm.Call("D", nil)
require.NoError(t, err)
is(v.Class(), classErrorName)
name, err := v.Object().Get("name")
require.NoError(t, err)
is(name.String(), "CarrotError")
message, err := v.Object().Get("message")
require.NoError(t, err)
is(message.String(), "carrots is life, carrots is love")
str, err := v.Object().Call("toString")
require.NoError(t, err)
is(str, "CarrotError: carrots is life, carrots is love")
i, err := v.Export()
require.NoError(t, err)
t.Logf("%#v\n", i)
})
}
func TestMakeCustomError(t *testing.T) {
tt(t, func() {
vm := New()
err := vm.Set("A", func(c FunctionCall) Value {
panic(vm.MakeCustomError("CarrotError", "carrots is life, carrots is love"))
})
require.NoError(t, err)
s, err := vm.Compile("test.js", `
function B() { A(); }
function C() { B(); }
function D() { C(); }
`)
require.NoError(t, err)
_, err = vm.Run(s)
require.NoError(t, err)
_, err = vm.Call("D", nil)
require.EqualError(t, err, "CarrotError: carrots is life, carrots is love")
er := asError(t, err)
is(er.name, "CarrotError")
is(er.message, "carrots is life, carrots is love")
})
}
func TestMakeCustomErrorFreshVM(t *testing.T) {
tt(t, func() {
vm := New()
e := vm.MakeCustomError("CarrotError", "carrots is life, carrots is love")
str, err := e.ToString()
require.NoError(t, err)
is(str, "CarrotError: carrots is life, carrots is love")
})
}
func TestMakeTypeError(t *testing.T) {
tt(t, func() {
vm := New()
err := vm.Set("A", func(c FunctionCall) Value {
panic(vm.MakeTypeError("these aren't my glasses"))
})
require.NoError(t, err)
s, err := vm.Compile("test.js", `
function B() { A(); }
function C() { B(); }
function D() { C(); }
`)
require.NoError(t, err)
_, err = vm.Run(s)
require.NoError(t, err)
_, err = vm.Call("D", nil)
require.EqualError(t, err, "TypeError: these aren't my glasses")
er := asError(t, err)
is(er.name, "TypeError")
is(er.message, "these aren't my glasses")
})
}
func TestMakeRangeError(t *testing.T) {
tt(t, func() {
vm := New()
err := vm.Set("A", func(c FunctionCall) Value {
panic(vm.MakeRangeError("too many"))
})
require.NoError(t, err)
s, err := vm.Compile("test.js", `
function B() { A(); }
function C() { B(); }
function D() { C(); }
`)
require.NoError(t, err)
_, err = vm.Run(s)
require.NoError(t, err)
_, err = vm.Call("D", nil)
require.EqualError(t, err, "RangeError: too many")
er := asError(t, err)
is(er.name, "RangeError")
is(er.message, "too many")
})
}
func TestMakeSyntaxError(t *testing.T) {
tt(t, func() {
vm := New()
err := vm.Set("A", func(c FunctionCall) Value {
panic(vm.MakeSyntaxError("i think you meant \"you're\""))
})
require.NoError(t, err)
s, err := vm.Compile("test.js", `
function B() { A(); }
function C() { B(); }
function D() { C(); }
`)
require.NoError(t, err)
_, err = vm.Run(s)
require.NoError(t, err)
_, err = vm.Call("D", nil)
require.EqualError(t, err, "SyntaxError: i think you meant \"you're\"")
er := asError(t, err)
is(er.name, "SyntaxError")
is(er.message, "i think you meant \"you're\"")
})
}
func TestErrorStackProperty(t *testing.T) {
tt(t, func() {
vm := New()
s, err := vm.Compile("test.js", `
function A() { throw new TypeError('uh oh'); }
function B() { return A(); }
function C() { return B(); }
var s = null;
try { C(); } catch (e) { s = e.stack; }
s;
`)
require.NoError(t, err)
v, err := vm.Run(s)
require.NoError(t, err)
is(v.String(), "TypeError: uh oh\n at A (test.js:2:29)\n at B (test.js:3:26)\n at C (test.js:4:26)\n at test.js:8:10\n")
})
}
func TestErrorMessageContainingFormatCharacters(t *testing.T) {
tt(t, func() {
test, tester := test()
tester.Set("F", func(call FunctionCall) Value {
return call.Otto.MakeCustomError(call.ArgumentList[0].String(), call.ArgumentList[1].String())
})
test("Error('literal percent-s: %s')", "Error: literal percent-s: %s")
test("new Error('literal percent-s: %s')", "Error: literal percent-s: %s")
test("F('TestError', 'literal percent-s: %s')", "TestError: literal percent-s: %s")
test("raise: throw Error('literal percent-s: %s')", "Error: literal percent-s: %s")
test("raise: throw new Error('literal percent-s: %s')", "Error: literal percent-s: %s")
test("raise: throw F('TestError', 'literal percent-s: %s')", "TestError: literal percent-s: %s")
})
}