What?

It changes the sorting algorithm for printing groups (and their metrics) in the end-of-test summary (full), from alphabetically, to preserving the same order as declared in the code, as discussed in #4724 and historically implemented as part of #1316.

It also fixes a bug with nesting groups within groups, that right now aren't correctly padded to the right.

Why?

Because preserving the same order as declared in the code is something that was discussed in the past (see #1316), and implemented, and thus it makes all sense to keep the new end of test
summary following the same principle (the same rationale remains).

Example

When executing a script like this:

import { group } from 'k6';

export default function () {
	group('E', function () {});
	group('D', function () {});
	group('C', function () {
		group('B', function () {
			group('A', function () {
				group('too much nesting', function () {
					// ...
				});
			});
		});
	});
}

the current output in v1.0.0 looks like this:

  █ GROUP: C 

    ↳ GROUP: B 

    ↳ GROUP: A 

    ↳ GROUP: too much nesting 


  █ GROUP: D 


  █ GROUP: E

where we have the groups ordered alphabetically (at least on the top level) and the indentation of the inner groups isn't applied consistently.

With change on this PR, it will preserve the order of the groups in the output and will indent inner groups consistently, regardless of how much nesting there is.

  █ GROUP: E


  █ GROUP: D


  █ GROUP: C

    ↳ GROUP: B

      ↳ GROUP: A

        ↳ GROUP: too much nesting 

Checklist

• I have performed a self-review of my code.
• I have commented on my code, particularly in hard-to-understand areas.
• I have added tests for my changes.
• I have run linter and tests locally (make check) and all pass.

Checklist: Documentation (only for k6 maintainers and if relevant)

Please do not merge this PR until the following items are filled out.

• I have added the correct milestone and labels to the PR.
• I have updated the release notes: link
• I have updated or added an issue to the k6-documentation: grafana/k6-docs#NUMBER if applicable
• I have updated or added an issue to the TypeScript definitions: grafana/k6-DefinitelyTyped#NUMBER if applicable

Related PR(s)/Issue(s)

Closes #4724