Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

catching of VU panics #1697

Merged
merged 2 commits into from
Nov 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions js/runner.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,15 @@
package js

import (
"bytes"
"context"
"crypto/tls"
"encoding/json"
"fmt"
"net"
"net/http"
"net/http/cookiejar"
"runtime/debug"
"strconv"
"time"

Expand Down Expand Up @@ -601,9 +603,8 @@ func (u *ActiveVU) RunOnce() error {

func (u *VU) runFn(
ctx context.Context, isDefault bool, fn goja.Callable, args ...goja.Value,
) (goja.Value, bool, time.Duration, error) {
) (v goja.Value, isFullIteration bool, t time.Duration, err error) {
imiric marked this conversation as resolved.
Show resolved Hide resolved
if !u.Runner.Bundle.Options.NoCookiesReset.ValueOrZero() {
var err error
u.state.CookieJar, err = cookiejar.New(nil)
if err != nil {
return goja.Undefined(), false, time.Duration(0), err
Expand All @@ -621,11 +622,26 @@ func (u *VU) runFn(
u.Runtime.Set("__ITER", u.Iteration)
u.Iteration++

defer func() {
if r := recover(); r != nil {
gojaStack := u.Runtime.CaptureCallStack(20, nil)
err = fmt.Errorf("a panic occurred in VU code but was caught: %s", r)
// TODO figure out how to use PanicLevel without panicing .. this might require changing
// the logger we use see
// https://github.com/sirupsen/logrus/issues/1028
// https://github.com/sirupsen/logrus/issues/993
b := new(bytes.Buffer)
for _, s := range gojaStack {
s.Write(b)
}
u.state.Logger.Log(logrus.ErrorLevel, "panic: ", r, "\n", string(debug.Stack()), "\nGoja stack:\n", b.String())
}
}()

startTime := time.Now()
v, err := fn(goja.Undefined(), args...) // Actually run the JS script
v, err = fn(goja.Undefined(), args...) // Actually run the JS script
endTime := time.Now()

var isFullIteration bool
select {
case <-ctx.Done():
isFullIteration = false
Expand Down
65 changes: 65 additions & 0 deletions js/runner_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,12 @@ import (
"net/http"
"net/url"
"os"
"strings"
"sync"
"testing"
"time"

"github.com/sirupsen/logrus"
logtest "github.com/sirupsen/logrus/hooks/test"
"github.com/spf13/afero"
"github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -1735,3 +1737,66 @@ func TestSystemTags(t *testing.T) {
})
}
}

func TestVUPanic(t *testing.T) {
r1, err := getSimpleRunner(t, "/script.js", `
var group = require("k6").group;
exports.default = function() {
group("panic here", function() {
if (__ITER == 0) {
panic("here we panic");
}
console.log("here we don't");
})
}`,
)
require.NoError(t, err)

r2, err := NewFromArchive(testutils.NewLogger(t), r1.MakeArchive(), lib.RuntimeOptions{})
if !assert.NoError(t, err) {
return
}

runners := map[string]*Runner{"Source": r1, "Archive": r2}
for name, r := range runners {
r := r
t.Run(name, func(t *testing.T) {
initVU, err := r.NewVU(1234, make(chan stats.SampleContainer, 100))
if !assert.NoError(t, err) {
return
}

logger := logrus.New()
logger.SetLevel(logrus.InfoLevel)
logger.Out = ioutil.Discard
hook := testutils.SimpleLogrusHook{
HookedLevels: []logrus.Level{logrus.InfoLevel, logrus.ErrorLevel, logrus.FatalLevel, logrus.PanicLevel},
}
logger.AddHook(&hook)

ctx, cancel := context.WithCancel(context.Background())
defer cancel()
vu := initVU.Activate(&lib.VUActivationParams{RunContext: ctx})
vu.(*ActiveVU).Runtime.Set("panic", func(str string) { panic(str) })
vu.(*ActiveVU).state.Logger = logger

vu.(*ActiveVU).Console.logger = logger.WithField("source", "console")
err = vu.RunOnce()
require.Error(t, err)
assert.Contains(t, err.Error(), "a panic occurred in VU code but was caught: here we panic")
entries := hook.Drain()
require.Len(t, entries, 1)
assert.Equal(t, logrus.ErrorLevel, entries[0].Level)
require.True(t, strings.HasPrefix(entries[0].Message, "panic: here we panic"))
require.True(t, strings.HasSuffix(entries[0].Message, "Goja stack:\nfile:///script.js:3:4(12)"))

err = vu.RunOnce()
assert.NoError(t, err)

entries = hook.Drain()
require.Len(t, entries, 1)
assert.Equal(t, logrus.InfoLevel, entries[0].Level)
require.Contains(t, entries[0].Message, "here we don't")
})
}
}