Merge pull request #196 from grafana/195-drop-javascript-configuratio…

…n-customization

refactor: removed JavaScript configuration customization feature

.golangci.yml

@@ -32,12 +32,9 @@ issues:
    - path: js\/modules\/k6\/http\/.*_test\.go
      linters:
        # k6/http module's tests are quite complex because they often have several nested levels.
-       # The module is in maintainance mode, so we don't intend to port the tests to a parallel version.
+       # The module is in maintenance mode, so we don't intend to port the tests to a parallel version.
        - paralleltest
        - tparallel
-   - linters:
-     - staticcheck # Tracked in https://github.com/grafana/xk6-grpc/issues/14
-     text: "The entire proto file grpc/reflection/v1alpha/reflection.proto is marked as deprecated."
    - linters:
      - forbidigo
      text: 'use of `os\.(SyscallError|Signal|Interrupt)` forbidden'

dashboard/assets/packages/report/.testcontext.js

@@ -8,15 +8,14 @@ import { readFileSync } from "fs"
 import { gunzipSync, gzipSync } from "zlib"
 
 import config from "../config/dist/config.json"
-import custom from "../../../../.dashboard.js"
 
 let testdata = ""
 
 if (process.env.NODE_ENV != "production") {
   let data = readFileSync(".testdata.ndjson.gz")
   let text = gunzipSync(Buffer.from(data, "base64")).toString("utf8")
 
-  let conf = { event: "config", data: custom(config) }
+  let conf = { event: "config", data: config }
 
   testdata = gzipSync(JSON.stringify(conf) + "\n" + text).toString("base64")
 }

dashboard/customize.go

@@ -6,30 +6,14 @@ package dashboard
 
 import (
 	"encoding/json"
-	"errors"
-	"fmt"
 	"io"
-	"path/filepath"
-	"reflect"
-	"strings"
 
-	"github.com/grafana/sobek"
-	"github.com/sirupsen/logrus"
-	"go.k6.io/k6/js/compiler"
-	"go.k6.io/k6/lib"
 	"go.k6.io/k6/lib/fsext"
 )
 
-const (
-	defaultConfig    = ".dashboard.js"
-	defaultAltConfig = ".dashboard.json"
-)
+const defaultAltConfig = ".dashboard.json"
 
 func findDefaultConfig(fs fsext.Fs) string {
-	if exists(fs, defaultConfig) {
-		return defaultConfig
-	}
-
 	if exists(fs, defaultAltConfig) {
 		return defaultAltConfig
 	}
@@ -46,11 +30,7 @@ func customize(uiConfig json.RawMessage, proc *process) (json.RawMessage, error)
 		}
 	}
 
-	if filepath.Ext(filename) == ".json" {
-		return loadConfigJSON(filename, proc)
-	}
-
-	return loadConfigJS(filename, uiConfig, proc)
+	return loadConfigJSON(filename, proc)
 }
 
 func loadConfigJSON(filename string, proc *process) (json.RawMessage, error) {
@@ -80,222 +60,3 @@ func exists(fs fsext.Fs, filename string) bool {
 
 	return true
 }
-
-type configLoader struct {
-	runtime       *sobek.Runtime
-	compiler      *compiler.Compiler
-	defaultConfig *sobek.Object
-	proc          *process
-}
-
-func newConfigLoader(defaultConfig json.RawMessage, proc *process) (*configLoader, error) {
-	comp := compiler.New(proc.logger)
-
-	comp.Options.CompatibilityMode = lib.CompatibilityModeExtended
-	comp.Options.Strict = true
-
-	con := newConfigConsole(proc.logger)
-
-	runtime := sobek.New()
-
-	runtime.SetFieldNameMapper(sobek.UncapFieldNameMapper())
-
-	if err := runtime.Set("console", con); err != nil {
-		return nil, err
-	}
-
-	def, err := toObject(runtime, defaultConfig)
-	if err != nil {
-		return nil, err
-	}
-
-	loader := &configLoader{
-		runtime:       runtime,
-		compiler:      comp,
-		defaultConfig: def,
-		proc:          proc,
-	}
-
-	return loader, nil
-}
-
-func (loader *configLoader) load(filename string) (json.RawMessage, error) {
-	file, err := loader.proc.fs.Open(filename)
-	if err != nil {
-		return nil, err
-	}
-
-	src, err := io.ReadAll(file)
-	if err != nil {
-		return nil, err
-	}
-
-	val, err := loader.eval(src, filename)
-	if err != nil {
-		return nil, err
-	}
-
-	obj := val.ToObject(loader.runtime)
-
-	return obj.MarshalJSON()
-}
-
-func isObject(val sobek.Value) bool {
-	return val != nil && val.ExportType() != nil && val.ExportType().Kind() == reflect.Map
-}
-
-func (loader *configLoader) eval(src []byte, filename string) (*sobek.Object, error) {
-	prog, _, err := loader.compiler.Compile(string(src), filename, false)
-	if err != nil {
-		return nil, err
-	}
-
-	exports := loader.runtime.NewObject()
-	module := loader.runtime.NewObject()
-
-	if err = module.Set("exports", exports); err != nil {
-		return nil, err
-	}
-
-	val, err := loader.runtime.RunProgram(prog)
-	if err != nil {
-		return nil, err
-	}
-
-	call, isCallable := sobek.AssertFunction(val)
-	if !isCallable {
-		return nil, fmt.Errorf("%w, file: %s", errNotFunction, filename)
-	}
-
-	_, err = call(exports, module, exports)
-	if err != nil {
-		return nil, err
-	}
-
-	def := exports.Get("default")
-	if def == nil {
-		return nil, fmt.Errorf("%w, file: %s", errNoExport, filename)
-	}
-
-	if call, isCallable = sobek.AssertFunction(def); isCallable {
-		def, err = call(exports, loader.defaultConfig)
-		if err != nil {
-			return nil, err
-		}
-
-		if !isObject(def) {
-			return nil, errConfigNotObject
-		}
-	}
-
-	return def.ToObject(loader.runtime), nil
-}
-
-// toObject use JavaScript JSON.parse to create native goja object
-// there could be a better solution.... (but Object.UnmarshallJSON is missing).
-func toObject(runtime *sobek.Runtime, bin json.RawMessage) (*sobek.Object, error) {
-	val := runtime.Get("JSON").ToObject(runtime).Get("parse")
-
-	call, _ := sobek.AssertFunction(val)
-
-	val, err := call(runtime.GlobalObject(), runtime.ToValue(string(bin)))
-	if err != nil {
-		return nil, err
-	}
-
-	return val.ToObject(runtime), nil
-}
-
-func loadConfigJS(
-	filename string,
-	config json.RawMessage,
-	proc *process,
-) (json.RawMessage, error) {
-	loader, err := newConfigLoader(config, proc)
-	if err != nil {
-		return nil, err
-	}
-
-	return loader.load(filename)
-}
-
-// configConsole represents a JS configConsole implemented as a logrus.Logger.
-type configConsole struct {
-	logger logrus.FieldLogger
-}
-
-// Creates a console with the standard logrus logger.
-func newConfigConsole(logger logrus.FieldLogger) *configConsole {
-	return &configConsole{logger.WithField("source", "console").WithField("extension", "dashboard")}
-}
-
-func (c configConsole) log(level logrus.Level, args ...sobek.Value) {
-	var strs strings.Builder
-
-	for i := 0; i < len(args); i++ {
-		if i > 0 {
-			strs.WriteString(" ")
-		}
-
-		strs.WriteString(c.valueString(args[i]))
-	}
-
-	msg := strs.String()
-
-	switch level {
-	case logrus.DebugLevel:
-		c.logger.Debug(msg)
-
-	case logrus.InfoLevel:
-		c.logger.Info(msg)
-
-	case logrus.WarnLevel:
-		c.logger.Warn(msg)
-
-	case logrus.ErrorLevel:
-		c.logger.Error(msg)
-
-	default:
-		c.logger.Info(msg)
-	}
-}
-
-func (c configConsole) Log(args ...sobek.Value) {
-	c.Info(args...)
-}
-
-func (c configConsole) Debug(args ...sobek.Value) {
-	c.log(logrus.DebugLevel, args...)
-}
-
-func (c configConsole) Info(args ...sobek.Value) {
-	c.log(logrus.InfoLevel, args...)
-}
-
-func (c configConsole) Warn(args ...sobek.Value) {
-	c.log(logrus.WarnLevel, args...)
-}
-
-func (c configConsole) Error(args ...sobek.Value) {
-	c.log(logrus.ErrorLevel, args...)
-}
-
-func (c configConsole) valueString(value sobek.Value) string {
-	mv, ok := value.(json.Marshaler)
-	if !ok {
-		return value.String()
-	}
-
-	bin, err := json.Marshal(mv)
-	if err != nil {
-		return value.String()
-	}
-
-	return string(bin)
-}
-
-var (
-	errNotFunction     = errors.New("not a function")
-	errNoExport        = errors.New("missing default export")
-	errConfigNotObject = errors.New("returned configuration is not an object")
-)