Fixed Summary Generated Events

cmd/run.go

@@ -190,7 +190,7 @@ func (c *cmdRun) run(cmd *cobra.Command, args []string) (err error) {
 	if !testRunState.RuntimeOptions.NoSummary.Bool {
 		defer func() {
 			logger.Debug("Generating the end-of-test summary...")
-			summaryResult, hsErr := test.initRunner.HandleSummary(globalCtx, &lib.Summary{
+			summaryResult, summaryJs, hsErr := test.initRunner.HandleSummary(globalCtx, &lib.Summary{
 				Metrics:         metricsEngine.ObservedMetrics,
 				RootGroup:       testRunState.Runner.GetDefaultGroup(),
 				TestRunDuration: executionState.GetCurrentTestRunDuration(),
@@ -202,6 +202,11 @@ func (c *cmdRun) run(cmd *cobra.Command, args []string) (err error) {
 			})
 			if hsErr == nil {
 				hsErr = handleSummaryResult(c.gs.FS, c.gs.Stdout, c.gs.Stderr, summaryResult)
+				waitForSummaryGeneratedEvent := emitEvent(&event.Event{
+					Type: event.TestSummaryGenerated,
+					Data: &event.SummaryData{Summary: summaryJs},
+				})
+				waitForSummaryGeneratedEvent()
 			}
 			if hsErr != nil {
 				logger.WithError(hsErr).Error("failed to handle the end-of-test summary")

cmd/tests/cmd_run_test.go

@@ -2073,6 +2073,7 @@ func TestEventSystemOK(t *testing.T) {
 		`got event IterStart with data '{Iteration:4 VUID:1 ScenarioName:default Error:<nil>}'`,
 		`got event IterEnd with data '{Iteration:4 VUID:1 ScenarioName:default Error:<nil>}'`,
 		`got event TestEnd with data '<nil>'`,
+		`got event TestSummaryGenerated with data '&{Summary:map[...]...}'`,
 		`got event Exit with data '&{Error:<nil>}'`,
 	}
 	log := ts.LoggerHook.Lines()
@@ -2107,6 +2108,7 @@ func TestEventSystemError(t *testing.T) {
 				"got event IterStart with data '{Iteration:0 VUID:1 ScenarioName:default Error:<nil>}'",
 				"got event IterEnd with data '{Iteration:0 VUID:1 ScenarioName:default Error:test aborted: oops! at file:///-:11:16(6)}'",
 				"got event TestEnd with data '<nil>'",
+				"got event TestSummaryGenerated with data '&{Summary:map[...]...}'",
 				"got event Exit with data '&{Error:test aborted: oops! at file:///-:11:16(6)}'",
 				"test aborted: oops! at file:///-:11:16(6)",
 			},
@@ -2143,6 +2145,7 @@ func TestEventSystemError(t *testing.T) {
 				"got event IterEnd with data '{Iteration:1 VUID:1 ScenarioName:default Error:Error: oops!\n\tat file:///-:9:11(3)\n}'",
 				"Error: oops!\n\tat file:///-:9:11(3)\n",
 				"got event TestEnd with data '<nil>'",
+				"got event TestSummaryGenerated with data '&{Summary:map[...]...}'",
 				"got event Exit with data '&{Error:<nil>}'",
 			},
 			expExitCode: 0,

event/type.go

@@ -18,12 +18,14 @@ const (
 	IterEnd
 	// Exit is emitted when the k6 process is about to exit.
 	Exit
+	// TestSummaryGenerated is emitted when the summary is generated.
+	TestSummaryGenerated
 )
 
 //nolint:gochecknoglobals
 var (
 	// GlobalEvents are emitted once per test run.
-	GlobalEvents = []Type{Init, TestStart, TestEnd, Exit}
+	GlobalEvents = []Type{Init, TestStart, TestEnd, TestSummaryGenerated, Exit}
 	// VUEvents are emitted multiple times per each VU.
 	VUEvents = []Type{IterStart, IterEnd}
 )
@@ -41,3 +43,13 @@ type IterData struct {
 	ScenarioName string
 	Error        error
 }
+
+// SummaryData is the data sent in the TestSummaryGenerated event.
+type SummaryData struct {
+	Summary map[string]interface{}
+}
+
+// String Overiding for tests
+func (s *SummaryData) String() string {
+	return "&{Summary:map[...]...}"
+}

js/runner.go

@@ -362,7 +362,9 @@ func (r *Runner) IsExecutable(name string) bool {
 }
 
 // HandleSummary calls the specified summary callback, if supplied.
-func (r *Runner) HandleSummary(ctx context.Context, summary *lib.Summary) (map[string]io.Reader, error) {
+func (r *Runner) HandleSummary(ctx context.Context, summary *lib.Summary) (
+	map[string]io.Reader, map[string]interface{}, error,
+) {
 	summaryDataForJS := summarizeMetricsToObject(summary, r.Bundle.Options, r.setupData)
 
 	out := make(chan metrics.SampleContainer, 100)
@@ -378,7 +380,7 @@ func (r *Runner) HandleSummary(ctx context.Context, summary *lib.Summary) (map[s
 
 	vu, err := r.newVU(summaryCtx, 0, 0, out)
 	if err != nil {
-		return nil, err
+		return nil, nil, err
 	}
 
 	go func() {
@@ -392,7 +394,7 @@ func (r *Runner) HandleSummary(ctx context.Context, summary *lib.Summary) (map[s
 	if fn != nil {
 		handleSummaryFn, ok := goja.AssertFunction(fn)
 		if !ok {
-			return nil, fmt.Errorf("exported identifier %s must be a function", consts.HandleSummaryFn)
+			return nil, nil, fmt.Errorf("exported identifier %s must be a function", consts.HandleSummaryFn)
 		}
 
 		callbackResult, _, _, err = vu.runFn(summaryCtx, false, handleSummaryFn, nil, vu.Runtime.ToValue(summaryDataForJS))
@@ -405,11 +407,11 @@ func (r *Runner) HandleSummary(ctx context.Context, summary *lib.Summary) (map[s
 	wrapper := strings.Replace(summaryWrapperLambdaCode, "/*JSLIB_SUMMARY_CODE*/", jslibSummaryCode, 1)
 	handleSummaryWrapperRaw, err := vu.Runtime.RunString(wrapper)
 	if err != nil {
-		return nil, fmt.Errorf("unexpected error while getting the summary wrapper: %w", err)
+		return nil, nil, fmt.Errorf("unexpected error while getting the summary wrapper: %w", err)
 	}
 	handleSummaryWrapper, ok := goja.AssertFunction(handleSummaryWrapperRaw)
 	if !ok {
-		return nil, fmt.Errorf("unexpected error did not get a callable summary wrapper")
+		return nil, nil, fmt.Errorf("unexpected error did not get a callable summary wrapper")
 	}
 
 	wrapperArgs := []goja.Value{
@@ -420,13 +422,14 @@ func (r *Runner) HandleSummary(ctx context.Context, summary *lib.Summary) (map[s
 	rawResult, _, _, err := vu.runFn(summaryCtx, false, handleSummaryWrapper, nil, wrapperArgs...)
 
 	if deadlineError := r.checkDeadline(summaryCtx, consts.HandleSummaryFn, rawResult, err); deadlineError != nil {
-		return nil, deadlineError
+		return nil, nil, deadlineError
 	}
 
 	if err != nil {
-		return nil, fmt.Errorf("unexpected error while generating the summary: %w", err)
+		return nil, nil, fmt.Errorf("unexpected error while generating the summary: %w", err)
 	}
-	return getSummaryResult(rawResult)
+	res, err := getSummaryResult(rawResult)
+	return res, summaryDataForJS, err
 }
 
 func (r *Runner) checkDeadline(ctx context.Context, name string, result goja.Value, err error) error {

js/summary_test.go

@@ -62,7 +62,7 @@ func TestTextSummary(t *testing.T) {
 			)
 			require.NoError(t, err)
 
-			result, err := runner.HandleSummary(context.Background(), summary)
+			result, _, err := runner.HandleSummary(context.Background(), summary)
 			require.NoError(t, err)
 
 			require.Len(t, result, 1)
@@ -116,7 +116,7 @@ func TestTextSummaryWithSubMetrics(t *testing.T) {
 	)
 	require.NoError(t, err)
 
-	result, err := runner.HandleSummary(context.Background(), summary)
+	result, _, err := runner.HandleSummary(context.Background(), summary)
 	require.NoError(t, err)
 
 	require.Len(t, result, 1)
@@ -307,7 +307,7 @@ func TestOldJSONExport(t *testing.T) {
 	require.NoError(t, err)
 
 	summary := createTestSummary(t)
-	result, err := runner.HandleSummary(context.Background(), summary)
+	result, _, err := runner.HandleSummary(context.Background(), summary)
 	require.NoError(t, err)
 
 	require.Len(t, result, 2)
@@ -577,7 +577,7 @@ func TestRawHandleSummaryData(t *testing.T) {
 	require.NoError(t, err)
 
 	summary := createTestSummary(t)
-	result, err := runner.HandleSummary(context.Background(), summary)
+	result, _, err := runner.HandleSummary(context.Background(), summary)
 	require.NoError(t, err)
 
 	require.Len(t, result, 2)
@@ -612,7 +612,7 @@ func TestRawHandleSummaryDataWithSetupData(t *testing.T) {
 	runner.SetSetupData([]byte("5"))
 
 	summary := createTestSummary(t)
-	result, err := runner.HandleSummary(context.Background(), summary)
+	result, _, err := runner.HandleSummary(context.Background(), summary)
 	require.NoError(t, err)
 	dataWithSetup, err := io.ReadAll(result["dataWithSetup.json"])
 	require.NoError(t, err)
@@ -635,7 +635,7 @@ func TestRawHandleSummaryPromise(t *testing.T) {
 	runner.SetSetupData([]byte("5"))
 
 	summary := createTestSummary(t)
-	result, err := runner.HandleSummary(context.Background(), summary)
+	result, _, err := runner.HandleSummary(context.Background(), summary)
 	require.NoError(t, err)
 	dataWithSetup, err := io.ReadAll(result["dataWithSetup.json"])
 	require.NoError(t, err)
@@ -660,7 +660,7 @@ func TestWrongSummaryHandlerExportTypes(t *testing.T) {
 			require.NoError(t, err)
 
 			summary := createTestSummary(t)
-			_, err = runner.HandleSummary(context.Background(), summary)
+			_, _, err = runner.HandleSummary(context.Background(), summary)
 			require.Error(t, err)
 		})
 	}
@@ -685,7 +685,7 @@ func TestExceptionInHandleSummaryFallsBackToTextSummary(t *testing.T) {
 	require.NoError(t, err)
 
 	summary := createTestSummary(t)
-	result, err := runner.HandleSummary(context.Background(), summary)
+	result, _, err := runner.HandleSummary(context.Background(), summary)
 	require.NoError(t, err)
 
 	require.Len(t, result, 1)

lib/runner.go

@@ -86,7 +86,7 @@ type Runner interface {
 	// function in the script.
 	IsExecutable(string) bool
 
-	HandleSummary(context.Context, *Summary) (map[string]io.Reader, error)
+	HandleSummary(context.Context, *Summary) (map[string]io.Reader, map[string]interface{}, error)
 }
 
 // UIState describes the state of the UI, which might influence what

lib/testutils/minirunner/minirunner.go

@@ -24,7 +24,7 @@ type MiniRunner struct {
 	Fn              func(ctx context.Context, state *lib.State, out chan<- metrics.SampleContainer) error
 	SetupFn         func(ctx context.Context, out chan<- metrics.SampleContainer) ([]byte, error)
 	TeardownFn      func(ctx context.Context, out chan<- metrics.SampleContainer) error
-	HandleSummaryFn func(context.Context, *lib.Summary) (map[string]io.Reader, error)
+	HandleSummaryFn func(context.Context, *lib.Summary) (map[string]io.Reader, map[string]interface{}, error)
 
 	SetupData []byte
 
@@ -117,11 +117,13 @@ func (r *MiniRunner) SetOptions(opts lib.Options) error {
 }
 
 // HandleSummary calls the specified summary callback, if supplied.
-func (r *MiniRunner) HandleSummary(ctx context.Context, s *lib.Summary) (map[string]io.Reader, error) {
+func (r *MiniRunner) HandleSummary(ctx context.Context, s *lib.Summary) (
+	map[string]io.Reader, map[string]interface{}, error,
+) {
 	if r.HandleSummaryFn != nil {
 		return r.HandleSummaryFn(ctx, s)
 	}
-	return nil, nil //nolint:nilnil
+	return nil, nil, nil //nolint:nilnilnil
 }
 
 // VU is a mock VU, spawned by a MiniRunner.