fix: add timeout to registry URL validation to prevent CLI hang (#2027)#2045
Open
shengxinzhe wants to merge 2 commits intoasyncapi:masterfrom
Open
fix: add timeout to registry URL validation to prevent CLI hang (#2027)#2045shengxinzhe wants to merge 2 commits intoasyncapi:masterfrom
shengxinzhe wants to merge 2 commits intoasyncapi:masterfrom
Conversation
When --registry-url points to an unreachable host, the CLI hangs indefinitely because fetch() has no timeout or AbortController. Changes: - Add 5s timeout via AbortController to registryValidation() - Use HEAD instead of GET for lightweight validation - Provide clear error message distinguishing timeout from other errors - Add unit tests for registryURLParser and registryValidation Fixes asyncapi#2027
shengxinzhe
requested review from
AayushSaini101,
Amzani,
Shurtu-gal,
Souvikns and
asyncapi-bot-eve
as code owners
🦋 Changeset detectedLatest commit: cf698d7 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 |
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
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 because thefetch()call inregistryValidation()has no timeout or abort mechanism.Problem
In
src/utils/generate/registry.ts,registryValidation()callsfetch(registryUrl)without:AbortControllerWhen the target host is unreachable (e.g.,
http://10.255.255.1), the TCP connection attempt hangs indefinitely, blocking the CLI and any CI pipeline using it.Solution
AbortControllerwith 5-second timeout — The fetch call now aborts after 5 seconds if no response is receivedGETtoHEAD— Only reachability needs to be checked, not content"Registry URL timed out after 5s") from other fetch errors ("Can't fetch registryURL")clearTimeout()infinallyblock prevents timer leaksChanges Made
src/utils/generate/registry.ts— Added timeout + AbortController + HEAD methodtest/unit/utils/registry.test.ts— New unit tests for bothregistryURLParserandregistryValidationTesting
registryURLParser(): undefined input, valid URLs, invalid URLsregistryValidation(): undefined input, unreachable host timeout, connection refusedChecklist