common

Documentation

Index

• func Bind(rt *goja.Runtime, v interface{}, ctxPtr *context.Context) map[string]interface{}
• func BindToGlobal(rt *goja.Runtime, data map[string]interface{}) func()
• func FieldName(t reflect.Type, f reflect.StructField) string
• func GetRuntime(ctx context.Context) *goja.Runtime
• func MethodName(t reflect.Type, m reflect.Method) string
• func NewRandSource() goja.RandSource
• func RunString(rt *goja.Runtime, src string) (goja.Value, error)
• func Throw(rt *goja.Runtime, err error)
• func WithRuntime(ctx context.Context, rt *goja.Runtime) context.Context
• func WithState(ctx context.Context, state *State) context.Context
• type FieldNameMapper
  • func (FieldNameMapper) FieldName(t reflect.Type, f reflect.StructField) string
  • func (FieldNameMapper) MethodName(t reflect.Type, m reflect.Method) string
• type InitContextError
  • func NewInitContextError(msg string) InitContextError
  • func (i InitContextError) Error() string
  • func (i InitContextError) String() string
• type State
  • func GetState(ctx context.Context) *State

Functions

func Bind

func Bind(rt *goja.Runtime, v interface{}, ctxPtr *context.Context) map[string]interface{}

func BindToGlobal

func BindToGlobal(rt *goja.Runtime, data map[string]interface{}) func()

Binds an object's members to the global scope. Returns a function that un-binds them. Note that this will panic if passed something that isn't a struct; please don't do that.

func FieldName

func FieldName(t reflect.Type, f reflect.StructField) string

Returns the JS name for an exported struct field. The name is snake_cased, with respect for certain common initialisms (URL, ID, HTTP, etc).

func GetRuntime

func GetRuntime(ctx context.Context) *goja.Runtime

func MethodName

func MethodName(t reflect.Type, m reflect.Method) string

Returns the JS name for an exported method. The first letter of the method's name is lowercased, otherwise it is unaltered.

func NewRandSource

func NewRandSource() goja.RandSource

NewRandSource is copied from goja's source code: https://github.com/dop251/goja/blob/master/goja/main.go#L44 The returned RandSource is NOT safe for concurrent use: https://golang.org/pkg/math/rand/#NewSource

func RunString

func RunString(rt *goja.Runtime, src string) (goja.Value, error)

Runs an ES6 string in the given runtime. Use this rather than writing ES5 in tests.

func Throw

func Throw(rt *goja.Runtime, err error)

Throws a JS error; avoids re-wrapping GoErrors.

func WithRuntime

func WithRuntime(ctx context.Context, rt *goja.Runtime) context.Context

func WithState

func WithState(ctx context.Context, state *State) context.Context

Types

type FieldNameMapper

type FieldNameMapper struct{}

FieldNameMapper for goja.Runtime.SetFieldNameMapper()

func (FieldNameMapper) FieldName

func (FieldNameMapper) FieldName(t reflect.Type, f reflect.StructField) string

func (FieldNameMapper) MethodName

func (FieldNameMapper) MethodName(t reflect.Type, m reflect.Method) string

type InitContextError

type InitContextError string

InitContextError is an error that happened during the a test init context

func NewInitContextError

func NewInitContextError(msg string) InitContextError

NewInitContextError returns a new InitContextError with the provided message

func (InitContextError) Error

func (i InitContextError) Error() string

func (InitContextError) String

func (i InitContextError) String() string

type State

type State struct {
	// Global options.
	Options lib.Options

	// Logger. Avoid using the global logger.
	Logger *log.Logger

	// Current group; all emitted metrics are tagged with this.
	Group *lib.Group

	// Networking equipment.
	Transport http.RoundTripper
	Dialer    *netext.Dialer
	CookieJar *cookiejar.Jar
	TLSConfig *tls.Config

	// Rate limits.
	RPSLimit *rate.Limiter

	// Sample channel, possibly buffered
	Samples chan<- stats.SampleContainer

	// Buffer pool; use instead of allocating fresh buffers when possible.
	// TODO: maybe use https://golang.org/pkg/sync/#Pool ?
	BPool *bpool.BufferPool

	Vu, Iteration int64
}

State provides the volatile state for a VU.

func GetState

func GetState(ctx context.Context) *State