113 lines
3.3 KiB
JavaScript
113 lines
3.3 KiB
JavaScript
import fetch from 'node-fetch'
|
|
|
|
export default class FailBot {
|
|
constructor({ app, haystackURL, headers }) {
|
|
this.app = app
|
|
this.headers = headers
|
|
|
|
// Since we're using `node-fetch` we can't rely on it deconstructing the
|
|
// basic authentication credentials from the URL (e.g.
|
|
// https://user:pass@failbotdomain/path) because `node-fetch` will always
|
|
// strip it. See https://github.com/node-fetch/node-fetch/issues/1330
|
|
// and it's not a bug.
|
|
// The correct thing is to extract it manually and add an `Authorization`
|
|
// header based on it from the URL.
|
|
const url = new URL(haystackURL)
|
|
|
|
// remove the basic auth portion of the url since it throws an error in node-fetch
|
|
this.haystackURL = `${url.origin}${url.pathname}`
|
|
|
|
const { username, password } = url
|
|
if (username || password) {
|
|
this.headers.Authorization = `Basic ${Buffer.from(`${username}:${password}`).toString(
|
|
'base64'
|
|
)}`
|
|
} else {
|
|
console.warn(`The haystack URL does not contain authentication credentials`)
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Report an error to Sentry
|
|
* @param {Error} error
|
|
* @param {any} metadata
|
|
* @param {any} [headers]
|
|
*/
|
|
static async report(error, metadata, headers = {}) {
|
|
// If there's no HAYSTACK_URL set, bail early
|
|
if (!process.env.HAYSTACK_URL) return
|
|
|
|
const failbot = new FailBot({
|
|
app: 'docs',
|
|
haystackURL: process.env.HAYSTACK_URL,
|
|
headers,
|
|
})
|
|
|
|
return failbot.sendException(error, metadata)
|
|
}
|
|
|
|
/**
|
|
* Create a rollup of this error by generating a base64 representation
|
|
* @param {Error} error
|
|
*/
|
|
createRollup(error) {
|
|
const stackLine = error.stack && error.stack.split('\n')[1]
|
|
const str = `${error.name}:${stackLine}`.replace(/=/g, '')
|
|
return Buffer.from(str).toString('base64')
|
|
}
|
|
|
|
/**
|
|
* Format the error to a plain JSON object with additional data
|
|
* @param {Error} error
|
|
* @param {any} metadata
|
|
*/
|
|
formatJSON(error, metadata) {
|
|
return Object.assign({}, metadata, {
|
|
/* eslint-disable camelcase */
|
|
created_at: new Date().toISOString(),
|
|
rollup: this.createRollup(error),
|
|
class: error.name,
|
|
message: error.message,
|
|
backtrace: error.stack || '',
|
|
js_environment: `Node.js ${process.version}`,
|
|
/* eslint-enable camelcase */
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Populate default context from settings. Since settings commonly comes from
|
|
* ENV, this allows setting defaults for the context via the environment.
|
|
*/
|
|
getFailbotContext() {
|
|
const failbotKeys = {}
|
|
|
|
for (const key in process.env) {
|
|
if (key.startsWith('FAILBOT_CONTEXT_')) {
|
|
const formattedKey = key.replace(/^FAILBOT_CONTEXT_/, '').toLowerCase()
|
|
failbotKeys[formattedKey] = process.env[key]
|
|
}
|
|
}
|
|
|
|
return failbotKeys
|
|
}
|
|
|
|
/**
|
|
* Send the error to Sentry
|
|
* @param {Error} error
|
|
* @param {any} metadata
|
|
*/
|
|
async sendException(error, metadata = {}) {
|
|
const data = Object.assign({ app: this.app }, this.getFailbotContext(), metadata)
|
|
const body = this.formatJSON(error, Object.assign({ app: this.app }, data))
|
|
|
|
return fetch(this.haystackURL, {
|
|
method: 'POST',
|
|
body: JSON.stringify(body),
|
|
headers: {
|
|
...this.headers,
|
|
'Content-Type': 'application/json',
|
|
},
|
|
})
|
|
}
|
|
}
|