ci/soak: doSoakTest(): name parameters#1817
Merged
Merged
Conversation
Convert `doSoakTest()` function arguments to named object properties. This makes it much easier to see what each number is, which is very helpful when understanding, modifying and investigating soak test failures, changes etc. Ref getodk#1791
20 tasks
sadiqkhoja
approved these changes
Apr 28, 2026
Contributor
sadiqkhoja
left a comment
sadiqkhoja
left a comment
There was a problem hiding this comment.
I ❤️ this change. I read somewhere that anytime you've more than few arguments in function than it's time to introduce an object.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Convert
doSoakTest()function arguments to named object properties. This makes it much easier to see what each number is, which is very helpful when understanding, modifying and investigating soak test failures, changes etc.Ref #1791
What has been done to verify that this works as intended?
These changes have been in use in multiple CI runs at #1791.
Why is this the best possible solution? Were any other approaches considered?
Just a helpful little change. #1791 adds a new param to the function, which change becomes very hard to read with non-named function params.
How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?
No change - just in tests.
Does this change require updates to the API documentation? If so, please update docs/api.yaml as part of this PR.
No.
Before submitting this PR, please make sure you have:
make testand confirmed all checks still pass, or witnessed Github completing all checks with success