extern/web-check
1
0
Fork 0
mirror of https://github.com/Lissy93/web-check.git synced 2024-11-22 16:23:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix timeout parsing, and show timeout on Vercel

Browse Source
This commit is contained in:
Alicia Sykes 2024-03-22 06:40:36 +00:00
parent ed53c29a55
commit 24ca677021
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
api/_common/middleware.js
View File

@ -2,9 +2,8 @@ const normalizeUrl = (url) => {
return url.startsWith('http') ? url : `https://${url}`; return url.startsWith('http') ? url : `https://${url}`;
}; };
// If present, set a shorter timeout for API requests // If present, set a shorter timeout for API requests
const TIMEOUT = parseInt(process.env.API_TIMEOUT_LIMIT, 10) || 60000; const TIMEOUT = process.env.API_TIMEOUT_LIMIT ? parseInt(process.env.API_TIMEOUT_LIMIT, 10) : 60000;
// If present, set CORS allowed origins for responses // If present, set CORS allowed origins for responses
const ALLOWED_ORIGINS = process.env.API_CORS_ORIGIN || '*'; const ALLOWED_ORIGINS = process.env.API_CORS_ORIGIN || '*';
@ -23,6 +22,15 @@ const headers = {
}; };
const timeoutErrorMsg = 'You can re-trigger this request, by clicking "Retry"\n'
+ 'If you\'re running your own instance of Web Check, then you can '
+ 'resolve this issue, by increasing the timeout limit in the '
+ '`API_TIMEOUT_LIMIT` environmental variable to a higher value (in milliseconds), '
+ 'or if you\'re hosting on Vercel increase the maxDuration in vercel.json.\n\n'
+ `The public instance currently has a lower timeout of ${TIMEOUT}ms `
+ 'in order to keep running costs affordable, so that Web Check can '
+ 'remain freely available for everyone.';
// A middleware function used by all API routes on all platforms // A middleware function used by all API routes on all platforms
const commonMiddleware = (handler) => { const commonMiddleware = (handler) => {
@ -30,14 +38,7 @@ const commonMiddleware = (handler) => {
const createTimeoutPromise = (timeoutMs) => { const createTimeoutPromise = (timeoutMs) => {
return new Promise((_, reject) => { return new Promise((_, reject) => {
setTimeout(() => { setTimeout(() => {
const howToResolve = 'You can re-trigger this request, by clicking "Retry"\n' reject(new Error(`Request timed-out after ${timeoutMs} ms`));
+ 'If you\'re running your own instance of Web Check, then you can '
+ 'resolve this issue, by increasing the timeout limit in the '
+ '`API_TIMEOUT_LIMIT` environmental variable to a higher value (in milliseconds). \n\n'
+ `The public instance currently has a lower timeout of ${timeoutMs}ms `
+ 'in order to keep running costs affordable, so that Web Check can '
+ 'remain freely available for everyone.';
reject(new Error(`Request timed-out after ${timeoutMs} ms.\n\n${howToResolve}`));
}, timeoutMs); }, timeoutMs);
}); });
}; };
@ -69,8 +70,9 @@ const commonMiddleware = (handler) => {
} }
} catch (error) { } catch (error) {
let errorCode = 500; let errorCode = 500;
if (error.message.includes('timed-out')) { if (error.message.includes('timed-out') || response.statusCode === 504) {
errorCode = 408; errorCode = 408;
error.message = `${error.message}\n\n${timeoutErrorMsg}`;
} }
response.status(errorCode).json({ error: error.message }); response.status(errorCode).json({ error: error.message });
} }