Skip to content

fix: add timeout and HEAD method to registry URL validation#2073

Open
DrGalio wants to merge 1 commit intoasyncapi:masterfrom
DrGalio:fix/registry-url-timeout
Open

fix: add timeout and HEAD method to registry URL validation#2073
DrGalio wants to merge 1 commit intoasyncapi:masterfrom
DrGalio:fix/registry-url-timeout

Conversation

@DrGalio
Copy link

@DrGalio DrGalio commented Mar 22, 2026

Fixes #2027

Problem

When --registry-url points to an unreachable host (e.g. a blackholed IP like http://10.255.255.1), the CLI hangs indefinitely because registryValidation() calls fetch() without any timeout or abort mechanism.

Changes

  • Added AbortController with a 5-second timeout to registryValidation()
  • Changed fetch method from GET to HEAD for a lightweight connectivity check
  • Added timeout-specific error message: Registry URL timed out after 5s: <url>
  • Preserved existing error paths (auth error, generic fetch failure)
  • Proper cleanup via finally block

Testing

# Before fix: hangs indefinitely
asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --registry-url http://10.255.255.1

# After fix: fails fast with actionable error after ~5s
# Error: Registry URL timed out after 5s: http://10.255.255.1

Related

Previously, registryValidation() called fetch() without any timeout
or abort mechanism. When --registry-url pointed to an unreachable host
(e.g. a blackholed IP), the CLI would hang indefinitely.

Changes:
- Add AbortController with 5-second timeout
- Use HEAD instead of GET for lightweight connectivity check
- Surface timeout-specific error message for actionable feedback
- Preserve existing error paths (auth error, generic fetch failure)

Fixes asyncapi#2027
@changeset-bot
Copy link

changeset-bot bot commented Mar 22, 2026

⚠️ No Changeset found

Latest commit: ba96e5b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@sonarqubecloud
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: To Triage

Development

Successfully merging this pull request may close these issues.

[BUG] CLI hangs indefinitely when --registry-url points to an unreachable host (no timeout handling)

1 participant