feat(cli): add --max-fetch-concurrency to prevent stalled validators
#7450
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
|
No changes to documentation |
|
Component Testing Report Updated Aug 30, 2024 3:18 PM (UTC) ✅ All Tests Passed -- expand for details
|
cngonzalez
approved these changes
Sep 3, 2024
This was referenced Sep 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR addresses an issue where the
sanity documents validateCLI command times out for complex validation rules. The problem occurs when a set of documents with custom validators requires more concurrentclient.fetchrequests than the current hard-coded limit allows, potentially causing the validation process to block indefinitely.Changes introduced:
--max-fetch-concurrency.These changes aim to prevent situations where the validation process exhausts the available concurrent requests, leading to timeouts.
Related issue: SDX-1617
What to review
validateAction.ts,validateDocuments.ts, andvalidateDocument.tsto ensure the newmaxFetchConcurrencyoption is correctly implemented and passed through the validation process.validateDocumentsCommand.tsto confirm the new--max-fetch-concurrencyCLI flag is properly documented.maxCustomValidationConcurrencyandmaxFetchConcurrencyare set correctly (5 and 25, respectively).Testing
To test these changes:
sanity documents validatecommand on a dataset with complex validation rules that previously timed out.--max-fetch-concurrencyto ensure it affects the validation process as expected.--max-custom-validation-concurrencyvalue doesn't cause timeouts when combined with the increased fetch concurrency.I manually tested these changes by running a reproduction locally using the dataset and repo provided by Ken Jones (see slack thread attached to the ticket). With the increased fetch concurrency limit of 25, the validation process completed successfully without timeouts, confirming that the changes resolve the issue in this specific case.
Additional automated tests should be added to verify the behavior of the new concurrency settings.
Notes for release
This update addresses an issue where the
sanity documents validateCLI command could time out when validating documents with complex custom validation rules. The changes include:--max-fetch-concurrencyto allow users to adjust the maximum number of concurrentclient.fetchrequests during validation.Usage:
These changes should improve the performance and reliability of document validation for projects with complex custom validation rules. Users experiencing timeouts during validation should try increasing the
--max-fetch-concurrencyvalue if issues persist with the new default.