xk6-temporal.go

package temporal

import (
	"os"

	"go.k6.io/k6/js/modules"

	"github.com/temporalio/xk6-temporal/client"
	"github.com/temporalio/xk6-temporal/metrics"
)

func init() {
	modules.Register("k6/x/temporal", new(RootModule))
}

// RootModule is the global module object type. It is instantiated once per test
// run and will be used to create `k6/x/temporal` module instances for each VU.
type RootModule struct{}

// ModuleInstance represents an instance of the module for every VU.
type ModuleInstance struct {
	vu            modules.VU
	customMetrics metrics.CustomMetrics
}

// Ensure the interfaces are implemented correctly.
var (
	_ modules.Module   = &RootModule{}
	_ modules.Instance = &ModuleInstance{}
)

// NewModuleInstance implements the modules.Module interface to return
// a new instance for each VU.
func (*RootModule) NewModuleInstance(vu modules.VU) modules.Instance {
	return &ModuleInstance{
		vu:            vu,
		customMetrics: metrics.RegisterClientMetrics(vu.InitEnv().Registry),
	}
}

// Exports implements the modules.Instance interface and returns the exports
// of the JS module.
func (temporal *ModuleInstance) Exports() modules.Exports {
	return modules.Exports{Default: temporal}
}

// NewClient returns a new Temporal Client.
func (m *ModuleInstance) NewClient(options client.Options) (*client.Client, error) {
	if options.HostPort == "" {
		options.HostPort = os.Getenv("TEMPORAL_GRPC_ENDPOINT")
	}
	options.MetricsHandler = metrics.NewClientMetricsHandler(
		m.vu.Context(),
		m.vu.State().Samples,
		m.vu.State().Tags.GetCurrentValues(),
		m.customMetrics,
	)

	return client.NewClient(options)
}