Skip to content

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

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

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

Conversation

@Pyiner
Copy link
Copy Markdown

@Pyiner Pyiner commented Mar 28, 2026

Summary

Fixes #2027 — CLI hangs indefinitely when --registry-url points to an unreachable host.

Changes:

  • Added AbortController with 5-second timeout to registryValidation() in src/utils/generate/registry.ts
  • Switched from GET to HEAD for lightweight validation (no response body needed)
  • Improved error messages — distinct messages for timeout vs network failure
  • Added cleanupclearTimeout in finally block prevents timer leaks

Before:

asyncapi generate fromTemplate spec.yaml @asyncapi/html-template \
  --registry-url http://10.255.255.1
# CLI hangs indefinitely ❌

After:

asyncapi generate fromTemplate spec.yaml @asyncapi/html-template \
  --registry-url http://10.255.255.1
# Error: Registry URL validation timed out after 5s — the host at http://10.255.255.1 appears unreachable. ✅

Testing:

  • All 46 existing unit tests pass
  • Backward-compatible — no public API changes

…syncapi#2027)

Add AbortController with 5-second timeout to the fetch call in
registryValidation() so the CLI no longer hangs indefinitely. Switch
from GET to HEAD for a lighter validation request, and surface distinct
error messages for timeout vs general network failures.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 28, 2026

⚠️ No Changeset found

Latest commit: 86c186a

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
Copy Markdown
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
Copy Markdown

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