Summary: Use lib.LegacySummary to avoid breaking the API #4649
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joanlopez
requested review from
codebien,
inancgumus,
mstoykov,
olegbespalov and
oleiade
and removed request for
a team
joanlopez
force-pushed
the
dont-break-summary-api
branch
from
7bce6d0 to
174c0be
Compare
mstoykov
previously approved these changes
Mar 24, 2025
Contributor
mstoykov
left a comment
mstoykov
left a comment
There was a problem hiding this comment.
Can we please now get a test on the structure of the thing provided to handlesummary and the result of summary-export.
AFAIK require.JSONEq does the reording of keys
codebien
approved these changes
Mar 24, 2025
inancgumus
approved these changes
Mar 24, 2025
oleiade
approved these changes
Mar 25, 2025
This was referenced Mar 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
It moves back "programmatic" interfaces of the end-of-test summary (both custom
handleSummary()and JSON output through--summary-export) to the legacy data structure (lib.LegacySummary), despite of the--summary-mode.It technically makes #4089 non-breaking.
Why?
Because after having caught #4640, and while discussing #4647, we realized that maybe it's better to play safe and don't break this until v2.0, whenever that comes. Also, because the re-design of the machine-readable format (JSON) hasn't been planned until then.
Checklist
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.
Related PR(s)/Issue(s)