fix: add timeout and error handling to registry URL validation#2095
Open
DragonBot00 wants to merge 2 commits intoasyncapi:masterfrom
Open
fix: add timeout and error handling to registry URL validation#2095DragonBot00 wants to merge 2 commits intoasyncapi:masterfrom
DragonBot00 wants to merge 2 commits intoasyncapi:masterfrom
Conversation
- Add 5s timeout via AbortController to prevent CLI from hanging indefinitely when --registry-url points to an unreachable host - Switch from GET to HEAD for lightweight URL validation - Surface meaningful error messages for timeout vs network errors - Add unit tests for registryURLParser and registryValidation Fixes asyncapi#2027
DragonBot00
requested review from
AayushSaini101,
Amzani,
Shurtu-gal,
Souvikns and
asyncapi-bot-eve
as code owners
🦋 Changeset detectedLatest commit: 390adb3 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
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
1 participant
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.
Summary
Fixes #2027
The CLI hangs indefinitely when
--registry-urlpoints to an unreachable host becauseregistryValidation()callsfetch()with no timeout or abort mechanism.Changes
src/utils/generate/registry.ts:AbortControllerwith a 5-second timeout so unreachable hosts fail fastGETtoHEADfor lightweight URL validation (no need to download the full response body)test/unit/utils/registry.test.ts(new):registryURLParser(valid/invalid URL formats)registryValidation(timeout on unreachable host, error on invalid hostname)Before (broken)
\
$ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --registry-url http://10.255.255.1
CLI hangs forever...
\\
After (fixed)
\
$ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --registry-url http://10.255.255.1
Error: Registry URL 'http://10.255.255.1' is unreachable (timed out after 5s). Please verify the URL is correct and accessible.
\\