Skip to main content

Network Interception

Sentry Testkit supports using network interception libraries, without the need to change your application's Sentry.init function. The testkit is agnostic to the interception library you use.

API​

initNetworkInterceptor​

Sentry Testkit exports a initNetworkInterceptor callback function, where you can init your interceptor. The interceptor should intercept requests from baseUrl and pass the request body (as json) to the handleRequestBody function. For envelope requests (such as performance events), we use the emitted request event, since in a reply function nock automatically tries to parse the body as json, and fails since Sentry are using a non-standard json with a json request header. Envelope requests may carry multiple items (for example an error event batched together with a session update) — the testkit parses all items of an envelope and captures every supported item type, regardless of its position in the envelope.

info

See https://develop.sentry.dev/sdk/envelopes/ for more information on envelope requests.

Example using nock​

const nock = require('nock')
const sentryTestkit = require('sentry-testkit')
const { testkit, initNetworkInterceptor } = sentryTestkit()

beforeAll(() => {
    const myAppDSN = '<your DSN goes here>'
    initNetworkInterceptor(myAppDSN, (baseUrl, handleRequestBody, handleEnvelopeRequestBody) => {
      nock(baseUrl)
        .persist()
        .post(/\/api\/.*\/store/)
          .reply(200, (_, requestBody) => {
            handleRequestBody(requestBody)
          })
          .post(/\/api\/.*\/envelope/)
          .reply(200)
          .on('request', (_, interceptor, body) => {
            if (interceptor.uri.test('/api/000000/envelope')) {
              handleEnvelopeRequestBody(body)
            }
          })
    })
})

test('findReport example', async function() {
    const err = new Error('error to look for')

    // Some faulty scenario that will report err

    const report = testkit.findReport(err)
    expect(report).toBeDefined()
})