2023-08-06 23:05:14 +02:00
|
|
|
const normalizeUrl = (url) => {
|
2023-08-09 23:31:47 +02:00
|
|
|
return url.startsWith('http') ? url : `https://${url}`;
|
2023-08-06 23:05:14 +02:00
|
|
|
};
|
|
|
|
|
2024-03-20 21:43:51 +01:00
|
|
|
// If present, set a shorter timeout for API requests
|
2024-03-22 07:40:36 +01:00
|
|
|
const TIMEOUT = process.env.API_TIMEOUT_LIMIT ? parseInt(process.env.API_TIMEOUT_LIMIT, 10) : 60000;
|
2024-03-20 21:43:51 +01:00
|
|
|
|
|
|
|
// If present, set CORS allowed origins for responses
|
|
|
|
const ALLOWED_ORIGINS = process.env.API_CORS_ORIGIN || '*';
|
|
|
|
|
|
|
|
// Set the platform currently being used
|
|
|
|
let PLATFORM = 'NETLIFY';
|
|
|
|
if (process.env.PLATFORM) { PLATFORM = process.env.PLATFORM.toUpperCase(); }
|
|
|
|
else if (process.env.VERCEL) { PLATFORM = 'VERCEL'; }
|
|
|
|
else if (process.env.WC_SERVER) { PLATFORM = 'NODE'; }
|
|
|
|
|
|
|
|
// Define the headers to be returned with each response
|
2023-09-03 13:26:41 +02:00
|
|
|
const headers = {
|
2024-03-20 21:43:51 +01:00
|
|
|
'Access-Control-Allow-Origin': ALLOWED_ORIGINS,
|
2023-09-03 13:26:41 +02:00
|
|
|
'Access-Control-Allow-Credentials': true,
|
|
|
|
'Content-Type': 'application/json;charset=UTF-8',
|
|
|
|
};
|
|
|
|
|
2024-03-20 21:43:51 +01:00
|
|
|
|
2024-03-22 07:40:36 +01:00
|
|
|
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.';
|
|
|
|
|
2024-03-20 21:43:51 +01:00
|
|
|
// A middleware function used by all API routes on all platforms
|
2023-08-06 23:05:14 +02:00
|
|
|
const commonMiddleware = (handler) => {
|
2024-03-20 21:43:51 +01:00
|
|
|
|
|
|
|
// Create a timeout promise, to throw an error if a request takes too long
|
|
|
|
const createTimeoutPromise = (timeoutMs) => {
|
|
|
|
return new Promise((_, reject) => {
|
|
|
|
setTimeout(() => {
|
2024-03-22 07:40:36 +01:00
|
|
|
reject(new Error(`Request timed-out after ${timeoutMs} ms`));
|
2024-03-20 21:43:51 +01:00
|
|
|
}, timeoutMs);
|
|
|
|
});
|
|
|
|
};
|
|
|
|
|
2023-09-03 13:26:41 +02:00
|
|
|
// Vercel
|
|
|
|
const vercelHandler = async (request, response) => {
|
|
|
|
const queryParams = request.query || {};
|
|
|
|
const rawUrl = queryParams.url;
|
|
|
|
|
|
|
|
if (!rawUrl) {
|
|
|
|
return response.status(500).json({ error: 'No URL specified' });
|
|
|
|
}
|
|
|
|
|
|
|
|
const url = normalizeUrl(rawUrl);
|
|
|
|
|
|
|
|
try {
|
2024-03-20 21:43:51 +01:00
|
|
|
// Race the handler against the timeout
|
|
|
|
const handlerResponse = await Promise.race([
|
|
|
|
handler(url, request),
|
|
|
|
createTimeoutPromise(TIMEOUT)
|
|
|
|
]);
|
|
|
|
|
2023-09-03 13:26:41 +02:00
|
|
|
if (handlerResponse.body && handlerResponse.statusCode) {
|
|
|
|
response.status(handlerResponse.statusCode).json(handlerResponse.body);
|
|
|
|
} else {
|
|
|
|
response.status(200).json(
|
|
|
|
typeof handlerResponse === 'object' ? handlerResponse : JSON.parse(handlerResponse)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
} catch (error) {
|
2024-03-20 21:43:51 +01:00
|
|
|
let errorCode = 500;
|
2024-03-22 07:40:36 +01:00
|
|
|
if (error.message.includes('timed-out') || response.statusCode === 504) {
|
2024-03-20 21:43:51 +01:00
|
|
|
errorCode = 408;
|
2024-03-22 07:40:36 +01:00
|
|
|
error.message = `${error.message}\n\n${timeoutErrorMsg}`;
|
2024-03-20 21:43:51 +01:00
|
|
|
}
|
|
|
|
response.status(errorCode).json({ error: error.message });
|
2023-09-03 13:26:41 +02:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
// Netlify
|
|
|
|
const netlifyHandler = async (event, context, callback) => {
|
2023-08-11 23:50:37 +02:00
|
|
|
const queryParams = event.queryStringParameters || event.query || {};
|
|
|
|
const rawUrl = queryParams.url;
|
2023-09-03 13:26:41 +02:00
|
|
|
|
2023-08-09 23:31:47 +02:00
|
|
|
if (!rawUrl) {
|
2023-08-06 23:05:14 +02:00
|
|
|
callback(null, {
|
2023-08-09 23:31:47 +02:00
|
|
|
statusCode: 500,
|
|
|
|
body: JSON.stringify({ error: 'No URL specified' }),
|
2023-09-03 13:26:41 +02:00
|
|
|
headers,
|
2023-08-06 23:05:14 +02:00
|
|
|
});
|
2023-09-03 13:26:41 +02:00
|
|
|
return;
|
2023-08-09 23:31:47 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
const url = normalizeUrl(rawUrl);
|
|
|
|
|
|
|
|
try {
|
2024-03-20 21:43:51 +01:00
|
|
|
// Race the handler against the timeout
|
|
|
|
const handlerResponse = await Promise.race([
|
|
|
|
handler(url, event, context),
|
|
|
|
createTimeoutPromise(TIMEOUT)
|
|
|
|
]);
|
|
|
|
|
2023-09-03 13:26:41 +02:00
|
|
|
if (handlerResponse.body && handlerResponse.statusCode) {
|
|
|
|
callback(null, handlerResponse);
|
2023-08-09 23:31:47 +02:00
|
|
|
} else {
|
|
|
|
callback(null, {
|
|
|
|
statusCode: 200,
|
2023-09-03 13:26:41 +02:00
|
|
|
body: typeof handlerResponse === 'object' ? JSON.stringify(handlerResponse) : handlerResponse,
|
|
|
|
headers,
|
2023-08-09 23:31:47 +02:00
|
|
|
});
|
|
|
|
}
|
2023-08-06 23:05:14 +02:00
|
|
|
} catch (error) {
|
|
|
|
callback(null, {
|
|
|
|
statusCode: 500,
|
|
|
|
body: JSON.stringify({ error: error.message }),
|
2023-09-03 13:26:41 +02:00
|
|
|
headers,
|
2023-08-06 23:05:14 +02:00
|
|
|
});
|
|
|
|
}
|
|
|
|
};
|
2023-09-03 13:26:41 +02:00
|
|
|
|
2023-09-03 16:32:58 +02:00
|
|
|
// The format of the handlers varies between platforms
|
2024-03-20 21:43:51 +01:00
|
|
|
const nativeMode = (['VERCEL', 'NODE'].includes(PLATFORM));
|
2023-09-03 16:32:58 +02:00
|
|
|
return nativeMode ? vercelHandler : netlifyHandler;
|
2023-08-06 23:05:14 +02:00
|
|
|
};
|
|
|
|
|
2024-06-18 23:07:27 +02:00
|
|
|
if (PLATFORM === 'NETLIFY') {
|
|
|
|
module.exports = commonMiddleware;
|
|
|
|
}
|
|
|
|
|
2024-05-06 22:51:32 +02:00
|
|
|
export default commonMiddleware;
|