Skip to content

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

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

Closed
DrGalio wants to merge 1 commit into from
Closed

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

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
16 changes: 14 additions & 2 deletions src/utils/generate/registry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,26 @@
}
}

const REGISTRY_FETCH_TIMEOUT_MS = 5000;

export async function registryValidation(registryUrl?: string, registryAuth?: string, registryToken?: string) {
if (!registryUrl) { return; }
const controller = new AbortController();
const timeoutId = setTimeout(() => controller.abort(), REGISTRY_FETCH_TIMEOUT_MS);
try {
const response = await fetch(registryUrl as string);
const response = await fetch(registryUrl as string, { method: 'HEAD', signal: controller.signal });

Check warning on line 16 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=AZ0UTHivS-WNYeg2qslU&open=AZ0UTHivS-WNYeg2qslU&pullRequest=2073
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 {
} catch (err: unknown) {
if (err instanceof DOMException && err.name === 'AbortError') {
throw new Error(`Registry URL timed out after ${REGISTRY_FETCH_TIMEOUT_MS / 1000}s: ${registryUrl}`);
}
if (err instanceof Error && err.message.startsWith('You Need to pass')) {
throw err;
}
throw new Error(`Can't fetch registryURL: ${registryUrl}`);
} finally {
clearTimeout(timeoutId);
}
}
Loading