use @github/failbot with got (#22842)
* use @github/failbot Part of #1222 * tests are not working yet * fix unit tests * cleanup
This commit is contained in:
Peter Bengtsson
134
lib/failbot.js
134
lib/failbot.js
@@ -1,112 +1,34 @@
|
||||
import fetch from 'node-fetch'
|
||||
import got from 'got'
|
||||
import { Failbot, HTTPBackend, LogBackend } from '@github/failbot'
|
||||
|
||||
export default class FailBot {
|
||||
constructor({ app, haystackURL, headers }) {
|
||||
this.app = app
|
||||
this.headers = headers
|
||||
const HAYSTACK_APP = 'docs'
|
||||
|
||||
// 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)
|
||||
export function report(error, metadata) {
|
||||
// If there's no HAYSTACK_URL set, bail early
|
||||
if (!process.env.HAYSTACK_URL) return
|
||||
|
||||
// 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',
|
||||
const backends = [
|
||||
new HTTPBackend({
|
||||
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',
|
||||
},
|
||||
})
|
||||
fetchFn: got,
|
||||
}),
|
||||
]
|
||||
if (process.env.NODE_ENV !== 'test') {
|
||||
backends.push(new LogBackend({ log: console.log.bind(console) }))
|
||||
}
|
||||
const failbot = new Failbot({
|
||||
app: HAYSTACK_APP,
|
||||
backends: backends,
|
||||
})
|
||||
return failbot.report(error, metadata)
|
||||
}
|
||||
|
||||
// Kept for legacy so you can continue to do:
|
||||
//
|
||||
// import FailBot from './lib/failbot.js'
|
||||
// ...
|
||||
// FailBot.report(myError)
|
||||
//
|
||||
export default {
|
||||
report,
|
||||
}
|
||||
|
||||
15
package-lock.json
generated
15
package-lock.json
generated
@@ -8,6 +8,7 @@
|
||||
"license": "(MIT AND CC-BY-4.0)",
|
||||
"dependencies": {
|
||||
"@alex_neo/jest-expect-message": "^1.0.5",
|
||||
"@github/failbot": "0.7.0",
|
||||
"@hapi/accept": "^5.0.2",
|
||||
"@primer/components": "^31.1.0",
|
||||
"@primer/css": "^18.2.0",
|
||||
@@ -2084,6 +2085,15 @@
|
||||
"url": "https://github.com/sponsors/sindresorhus"
|
||||
}
|
||||
},
|
||||
"node_modules/@github/failbot": {
|
||||
"version": "0.7.0",
|
||||
"resolved": "https://registry.npmjs.org/@github/failbot/-/failbot-0.7.0.tgz",
|
||||
"integrity": "sha512-5wegzhUw5iFg9uPk4vsgXEB8j6vugcR0k9kOm0MEBlpwdQfs/gOx9nQj/2MpHRGSjY+OwBjVIcGJItEu9vM0Dw==",
|
||||
"engines": {
|
||||
"node": ">= 14.x",
|
||||
"npm": ">= 7.x"
|
||||
}
|
||||
},
|
||||
"node_modules/@graphql-inspector/core": {
|
||||
"version": "2.9.0",
|
||||
"resolved": "https://registry.npmjs.org/@graphql-inspector/core/-/core-2.9.0.tgz",
|
||||
@@ -24201,6 +24211,11 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"@github/failbot": {
|
||||
"version": "0.7.0",
|
||||
"resolved": "https://registry.npmjs.org/@github/failbot/-/failbot-0.7.0.tgz",
|
||||
"integrity": "sha512-5wegzhUw5iFg9uPk4vsgXEB8j6vugcR0k9kOm0MEBlpwdQfs/gOx9nQj/2MpHRGSjY+OwBjVIcGJItEu9vM0Dw=="
|
||||
},
|
||||
"@graphql-inspector/core": {
|
||||
"version": "2.9.0",
|
||||
"resolved": "https://registry.npmjs.org/@graphql-inspector/core/-/core-2.9.0.tgz",
|
||||
|
||||
@@ -10,6 +10,7 @@
|
||||
],
|
||||
"dependencies": {
|
||||
"@alex_neo/jest-expect-message": "^1.0.5",
|
||||
"@github/failbot": "0.7.0",
|
||||
"@hapi/accept": "^5.0.2",
|
||||
"@primer/components": "^31.1.0",
|
||||
"@primer/css": "^18.2.0",
|
||||
|
||||
@@ -2,16 +2,22 @@ import FailBot from '../../lib/failbot.js'
|
||||
import nock from 'nock'
|
||||
|
||||
describe('FailBot', () => {
|
||||
const requestBodiesSent = []
|
||||
|
||||
beforeEach(() => {
|
||||
nock('https://haystack.com')
|
||||
nock('https://haystack.example.com')
|
||||
.post('/')
|
||||
.reply(200, (uri, requestBody) => {
|
||||
requestBodiesSent.push(requestBody)
|
||||
return requestBody
|
||||
})
|
||||
})
|
||||
|
||||
afterEach(() => {
|
||||
delete process.env.HAYSTACK_URL
|
||||
// Reset the array to an empty one between tests
|
||||
// so it doesn't intefere across tests.
|
||||
requestBodiesSent.length = 0
|
||||
})
|
||||
|
||||
describe('.report', () => {
|
||||
@@ -21,19 +27,23 @@ describe('FailBot', () => {
|
||||
})
|
||||
|
||||
it('sends the expected report', async () => {
|
||||
process.env.HAYSTACK_URL = 'https://haystack.com'
|
||||
process.env.HAYSTACK_URL = 'https://haystack.example.com'
|
||||
const err = new Error('Kaboom')
|
||||
const result = await FailBot.report(err)
|
||||
const backendPromises = FailBot.report(err, { foo: 'bar' })
|
||||
// Note! You don't need to await the promises it returns to be
|
||||
// able to use `FailBot.report()`. It will send.
|
||||
// But here in the context of jest, we need to await *now*
|
||||
// so we can assert that it did make the relevant post requests.
|
||||
// Once we've done this, we can immediate check what it did.
|
||||
await Promise.all(await backendPromises)
|
||||
|
||||
// Check that we made a request
|
||||
expect(result.status).toBe(200)
|
||||
// It's not interesting or relevant what the `.report()` static
|
||||
// method returns. All that matters is that it did a POST
|
||||
// request.
|
||||
expect(requestBodiesSent.length).toBe(1)
|
||||
|
||||
// Verify the basic fetch params
|
||||
expect(result.headers.get('content-type')).toBe('application/json')
|
||||
|
||||
// Check that we send the expected body
|
||||
const body = await result.json()
|
||||
expect(body).toMatchObject({
|
||||
// Verify what was sent in that POST request.
|
||||
expect(requestBodiesSent[0]).toMatchObject({
|
||||
app: 'docs',
|
||||
backtrace: expect.stringContaining('Error: Kaboom'),
|
||||
class: 'Error',
|
||||
|
||||
Reference in New Issue
Block a user