Skip to content

fix: add timeout handling for registry URL validation#2074

Open
HuiNeng6 wants to merge 1 commit intoasyncapi:masterfrom
HuiNeng6:fix-registry-timeout-issue-2027
Open

fix: add timeout handling for registry URL validation#2074
HuiNeng6 wants to merge 1 commit intoasyncapi:masterfrom
HuiNeng6:fix-registry-timeout-issue-2027

Conversation

@HuiNeng6
Copy link

Description

Fixes #2027

This PR adds timeout handling to prevent the CLI from hanging indefinitely when --registry-url\ points to an unreachable host.

Changes

  • 5-second timeout: Uses \AbortController\ to timeout the fetch request after 5 seconds
  • HEAD request: Uses \HEAD\ instead of \GET\ for a lightweight connectivity check (no body download needed)
  • Meaningful error messages: Provides clear, actionable error messages for different failure scenarios
  • Comprehensive tests: Added unit tests to verify the timeout behavior

Before (Bug)

When running:
\\�ash
asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --registry-url http://10.255.255.1
\\

The CLI would hang indefinitely with no feedback.

After (Fixed)

Now the CLI fails fast with a clear error message:

\
Error: Registry URL validation timed out after 5 seconds. Could not reach: http://10.255.255.1. Please check if the URL is correct and the server is accessible.
\\

Testing

  • All 12 new unit tests pass
  • Build completes successfully
  • Lint passes

Related Issue

Fixes #2027

Fixes asyncapi#2027

- Add 5-second timeout using AbortController to prevent CLI hanging
- Use HEAD request instead of GET for lightweight connectivity check
- Provide meaningful error messages for timeout and network errors
- Add comprehensive unit tests for the fix

Previously, when --registry-url pointed to an unreachable host,
the CLI would hang indefinitely. Now it fails fast with a clear
error message.
@changeset-bot
Copy link

changeset-bot bot commented Mar 22, 2026

⚠️ No Changeset found

Latest commit: 5defc22

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