handle-errors.js

const { liquid } = require('../lib/render-content')
const layouts = require('../lib/layouts')
const FailBot = require('../lib/failbot')
const loadSiteData = require('../lib/site-data')
const builtAssets = require('../lib/built-asset-urls')

function shouldLogException (error) {
  const IGNORED_ERRORS = [
    // avoid sending CSRF token errors (from bad-actor POST requests)
    'EBADCSRFTOKEN',
    // Client connected aborted
    'ECONNRESET'
  ]

  if (IGNORED_ERRORS.includes(error.code)) {
    return false
  }

  // We should log this exception
  return true
}

async function logException (error, req) {
  if (process.env.NODE_ENV !== 'test' && shouldLogException(error)) {
    await FailBot.report(error, {
      path: req.path
    })
  }
}

module.exports = async function handleError (error, req, res, next) {
  try {
    // If the headers have already been sent or the request was aborted...
    if (res.headersSent || req.aborted) {
      // Report to Failbot
      await logException(error, req)

      // We MUST delegate to the default Express error handler
      return next(error)
    }

    // if the error is thrown before req.context is created (say, in the Page class),
    // set req.context.site here so we can pass data/ui.yml text to the 500 layout
    if (!req.context) {
      const site = await loadSiteData()
      req.context = { site: site[req.language || 'en'].site, builtAssets }
    }

    // display error on the page in development, but not in production
    if (process.env.NODE_ENV !== 'production' && req.context) {
      req.context.error = error
    }

    // Special handling for when a middleware calls `next(404)`
    if (error === 404) {
      return res
        .status(404)
        .send(await liquid.parseAndRender(layouts['error-404'], req.context))
    }

    // If the error contains a status code, just send that back. This is usually
    // from a middleware like `express.json()` or `csrf`.
    if (error.statusCode || error.status) {
      return res.sendStatus(error.statusCode || error.status)
    }

    if (process.env.NODE_ENV !== 'test') {
      console.error('500 error!', req.path)
      console.error(error)
    }

    res.status(500).send(await liquid.parseAndRender(layouts['error-500'], req.context))

    // Report to Failbot AFTER responding to the user
    await logException(error, req)
  } catch (error) {
    console.error('An error occurred in the error handling middleware!', error)
    return next(error)
  }
}