Infrastructure/verdaccio
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-04-01 02:42:23 -05:00
Code Issues Activity

fix: handling for uplink timeouts (#5153)

Browse source 
* chore(storage): service unavailable message

* fix: handling for uplink timeouts

* remove extra changeset
This commit is contained in:
Marc Bernard 2025-03-23 12:47:02 +01:00 • committed by GitHub
parent b3fa5df7bb
commit 2eb8cc24e8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 43 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
.changeset/ninety-hotels-dance.md Normal file
View file

@ -0,0 +1,7 @@
---
'@verdaccio/core': patch
'@verdaccio/proxy': patch
'@verdaccio/store': patch
---
fix: handling for uplink timeouts

3
packages/core/core/src/constants.ts
View file

@ -78,6 +78,9 @@ export const HTTP_STATUS = {
SERVICE_UNAVAILABLE: httpCodes.SERVICE_UNAVAILABLE,
LOOP_DETECTED: 508,
CANNOT_HANDLE: 590,
REQUEST_TIMEOUT: httpCodes.REQUEST_TIMEOUT, // 408
BAD_GATEWAY: httpCodes.BAD_GATEWAY, // 502
GATEWAY_TIMEOUT: httpCodes.GATEWAY_TIMEOUT, // 504
};
export const ERROR_CODE = {

34
packages/proxy/src/proxy.ts
View file

@ -431,26 +431,18 @@ class ProxyStorage implements IProxy {
const code = err.response.statusCode;
debug('error code %s', code);
if (code === HTTP_STATUS.NOT_FOUND) {
throw errorUtils.getNotFound(errorUtils.API_ERROR.NOT_PACKAGE_UPLINK);
throw errorUtils.getNotFound(API_ERROR.NOT_PACKAGE_UPLINK);
}
if (!(code >= HTTP_STATUS.OK && code < HTTP_STATUS.MULTIPLE_CHOICES)) {
const error = errorUtils.getInternalError(
`${errorUtils.API_ERROR.BAD_STATUS_CODE}: ${code}`
);
const error = errorUtils.getInternalError(`${API_ERROR.BAD_STATUS_CODE}: ${code}`);
// we need this code to identify outside which status code triggered the error
error.remoteStatus = code;
throw error;
}
} else if (err.code === 'ETIMEDOUT') {
} else if (this._isRequestTimeout(err)) {
debug('error code timeout');
const code = err.code;
const error = errorUtils.getInternalError(
`${errorUtils.API_ERROR.SERVER_TIME_OUT}: ${code}`
);
// we need this code to identify outside which status code triggered the error
error.remoteStatus = code;
throw error;
throw errorUtils.getServiceUnavailable(API_ERROR.SERVER_TIME_OUT);
}
throw err;
}
@ -562,6 +554,24 @@ class ProxyStorage implements IProxy {
);
}
/**
* Check if the request timed out (network or http errors).
* @param {RequestError} err
* @return {boolean}
*/
private _isRequestTimeout(err: RequestError): boolean {
const code = err?.response?.statusCode;
return (
err.code === 'ETIMEDOUT' ||
err.code === 'ESOCKETTIMEDOUT' ||
err.code === 'ECONNRESET' ||
code === HTTP_STATUS.REQUEST_TIMEOUT ||
code === HTTP_STATUS.BAD_GATEWAY ||
code === HTTP_STATUS.SERVICE_UNAVAILABLE ||
code === HTTP_STATUS.GATEWAY_TIMEOUT
);
}
/**
* Set up a proxy.
* @param {*} hostname

4
packages/proxy/test/proxy.metadata.spec.ts
View file

@ -343,7 +343,7 @@ describe('proxy', () => {
prox1.getRemoteMetadata('jquery', {
retry: { limit: 0 },
})
).rejects.toThrow('ETIMEDOUT');
).rejects.toThrow(errorUtils.getServiceUnavailable(API_ERROR.SERVER_TIME_OUT));
}, 10000);
test('fail for one failure and timeout (2 seconds)', async () => {
@ -363,7 +363,7 @@ describe('proxy', () => {
prox1.getRemoteMetadata('jquery', {
retry: { limit: 1 },
})
).rejects.toThrow('ETIMEDOUT');
).rejects.toThrow(errorUtils.getServiceUnavailable(API_ERROR.SERVER_TIME_OUT));
}, 10000);
// test('retry count is exceded and uplink goes offline with logging activity', async () => {

9
packages/store/src/storage.ts
View file

@ -1134,7 +1134,7 @@ class Storage {
throw errorUtils.getNotFound();
}
const hasPackage = await storage.hasPackage(pkgName);
debug('has package %o for %o', pkgName, hasPackage);
debug('has package %o is %o', pkgName, hasPackage);
return hasPackage;
}
@ -1505,6 +1505,7 @@ class Storage {
name: string,
username: string | undefined
): Promise<void> {
debug('creating new package %o for user %o', name, username);
const storage: pluginUtils.StorageHandler = this.getPrivatePackageStorage(name);
if (!storage) {
@ -1675,7 +1676,7 @@ class Storage {
// etag??
});
// if either local data and upstream data are empty, we throw an error
// if both local data and upstream data are empty, we throw an error
if (!remoteManifest && _.isNull(data)) {
throw errorUtils.getNotFound(`${API_ERROR.NOT_PACKAGE_UPLINK}: ${name}`);
// if the remote manifest is empty, we return local data
@ -1782,9 +1783,9 @@ class Storage {
debug('uplinks sync failed with %o errors', uplinksErrors.length);
for (const err of uplinksErrors) {
const { code } = err;
if (code === 'ETIMEDOUT' || code === 'ESOCKETTIMEDOUT' || code === 'ECONNRESET') {
if (code === HTTP_STATUS.SERVICE_UNAVAILABLE) {
debug('uplinks sync failed with timeout error');
throw errorUtils.getServiceUnavailable(err.code);
throw err;
}
// we bubble up the 304 special error case
if (code === HTTP_STATUS.NOT_MODIFIED) {

9
packages/store/test/storage.spec.ts
View file

@ -1954,9 +1954,8 @@ describe('storage', () => {
).rejects.toThrow(errorUtils.getNotFound());
});
// TODO: fix this test, stopped to work from vitest 3.x migration
test.skip('should get ETIMEDOUT with uplink', { retry: 3 }, async () => {
nock(domain).get('/foo2').replyWithError({
test('should get ETIMEDOUT with uplink', { retry: 3 }, async () => {
nock(domain).get('/foo3').replyWithError({
code: 'ETIMEDOUT',
error: 'ETIMEDOUT',
});
@ -1984,7 +1983,7 @@ describe('storage', () => {
await storage.init(config);
await expect(
storage.getPackageByOptions({
name: 'foo2',
name: 'foo3',
uplinksLook: true,
retry: { limit: 0 },
requestOptions: {
@ -1993,7 +1992,7 @@ describe('storage', () => {
host: req.get('host') as string,
},
})
).rejects.toThrow(errorUtils.getServiceUnavailable(API_ERROR.NO_PACKAGE));
).rejects.toThrow(errorUtils.getServiceUnavailable(API_ERROR.SERVER_TIME_OUT));
});
test('should fetch abbreviated version of manifest ', async () => {