1
0
mirror of synced 2025-12-21 02:46:50 -05:00
Files
docs/middleware/timeout.js
Peter Bengtsson b96f16e44e too often we don't know the path of 503'ing requests (#23744)
* Too often we don't know the path of 503'ing requests

* actually, use both
2021-12-15 17:25:32 +00:00

40 lines
1.5 KiB
JavaScript

import timeout from 'express-timeout-handler'
import statsd from '../lib/statsd.js'
// Heroku router requests timeout after 30 seconds. We should stop them earlier!
const maxRequestTimeout = parseInt(process.env.REQUEST_TIMEOUT, 10) || 10000
export default timeout.handler({
// Default timeout for all endpoints
// To override for a given router/endpoint, use `xExpressTimeoutHandler.set(...)`
timeout: maxRequestTimeout,
// IMPORTANT:
// We cannot allow the middleware to disable the `res` object's methods like
// it does by default if we want to use `next` in the `onTimeout` handler!
disable: [],
onTimeout: function (req, res, next) {
// The `req.pagePath` can come later so it's not guaranteed to always
// be present. It's added by the `handle-next-data-path.js` middleware
// we translates those "cryptic" `/_next/data/...` URLs from
// client-side routing.
const incrementTags = [`path:${req.pagePath || req.path}`]
if (req.context?.currentCategory) {
incrementTags.push(`product:${req.context.currentCategory}`)
}
statsd.increment('middleware.timeout', 1, incrementTags)
// Create a custom timeout error
const timeoutError = new Error('Request timed out')
timeoutError.statusCode = 503
timeoutError.code = 'ETIMEDOUT'
// Pass the error to our Express error handler for consolidated processing
return next(timeoutError)
},
// Can also set an `onDelayedResponse` property IF AND ONLY IF you allow for disabling methods
})