Skip to content

fix: add timeout to registry validation to prevent indefinite hanging #2057

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ryan-the-zilla wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: add timeout to registry validation to prevent indefinite hanging #2057

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions src/utils/generate/registry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,34 @@

export async function registryValidation(registryUrl?: string, registryAuth?: string, registryToken?: string) {
if (!registryUrl) { return; }

// Set timeout to prevent indefinite hanging
const timeoutMs = 10000; // 10 seconds
const controller = new AbortController();
const timeoutId = setTimeout(() => controller.abort(), timeoutMs);

try {
const response = await fetch(registryUrl as string);
// Use HEAD request for lightweight validation
const response = await fetch(registryUrl as string, {

Check warning on line 19 in src/utils/generate/registry.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

This assertion is unnecessary since it does not change the type of the expression. 


See more on https://sonarcloud.io/project/issues?id=asyncapi_cli&issues=AZ0CSyUpTERx1hCrNyKb&open=AZ0CSyUpTERx1hCrNyKb&pullRequest=2057
method: 'HEAD',
signal: controller.signal
});

clearTimeout(timeoutId);

if (response.status === 401 && !registryAuth && !registryToken) {
throw new Error('You Need to pass either registryAuth in username:password encoded in Base64 or need to pass registryToken');
}
} catch {
throw new Error(`Can't fetch registryURL: ${registryUrl}`);
} catch (error) {
clearTimeout(timeoutId);

// Provide specific error messages
if (error instanceof Error && error.name === 'AbortError') {
throw new Error(`Registry URL validation timed out after ${timeoutMs/1000}s: ${registryUrl}`);
}
if (error instanceof Error && error.message.includes('registryAuth')) {
throw error; // Re-throw auth errors as-is
}
throw new Error(`Can't fetch registryURL: ${registryUrl}. Error: ${error instanceof Error ? error.message : String(error)}`);
}
}
Loading