ExtraErrorData + AxiosError don't work

[naseemkullah]

Though ExtraErrorData is enabled, I've noticed that for Axios errors, everything is [undefined] (except for [config])(https://github.com/axios/axios/blob/7d6bddba2d8de29c263feaef4c40daa50cb4b176/lib/core/enhanceError.js#L14)

Workaround is to use a beforeSend hook to ensure the AxiosError props, or at least the desired ones, do make their way to Sentry, but feels like there should not be the need for this with extraErrorData integrated:

Any idea why this might be happening?

Version:

6.13.2

[kamilogorek]

Is there any way that you could provide a repro-case for this issue that we'll be able to use for debugging?

[naseemkullah]

Hi @kamilogorek,

Sure thing, here:

1. start this server:

const express = require('express')
const app = express()
const port = 3000

app.get('/', (_req, res) => {
  res.sendStatus(400)
})

app.listen(port, () => {
  console.log(`Example app listening at http://localhost:${port}`)
})

2. then run this client (DSN value):

const axios = require('axios');
const Sentry = require ("@sentry/node");
const { ExtraErrorData } = require("@sentry/integrations");

Sentry.init({
  debug: true,
  dsn: PUT YOUR DSN HERE
  integrations: [new ExtraErrorData(
    {
      depth: 10
    }
  )],
})

axios.get('/', {baseURL: "http://localhost:3000"})
  .then(console.log)
  .catch(Sentry.captureException)

Thanks!

[kamilogorek]

Thanks for the repro.

So the problem is that we are calling toJSON of anything that we normalize (which is a valid behavior). However, axios is trying to enhance all its errors, including failed requests, with some additional data (like request and response objects), see: https://github.com/axios/axios/blob/master/lib/core/enhanceError.js (as you already pointed out above).

Because of this, an error from catch clause, is effectively "not" an error, but rather a custom object that has some data attached to it. We could drop all undefined keys, but this can hide some mistakes that developers do (eg. typos in the attached data).

The easiest fix that you can implement here is:

import { dropUndefinedKeys } from '@sentry/utils';

Sentry.init({
  beforeSend(event, hint) {
    if (hint.originalException?.isAxiosError) {
      event.contexts = dropUndefinedKeys(event.contexts);
      // or to be more specific: event.contexts.Error = dropUndefinedKeys(event.contexts.Error);
    }
    return event;
  }
});

[naseemkullah]

I see, thanks for that info!

Just co confirm dropUndefinedKeys will do what the name says so we won't get the desired additional data that comes from axios' enhanceError? (Also worth noting that the values are [undefined] not undefined so they are not dropped).

[kamilogorek]

Ah, damn. You are right, it's already after normalization, so these won't be dropped. However, Axios give you access to interceptors, so it's easy to fix it there (tested it locally).

axios.interceptors.response.use(
  (res) => res,
  (err) => {
    err.toJSON = () => {
      return {
        request: {
          path: err.request.path,
          protocol: err.request.protocol,
          host: err.request.host,
        },
        response: {
          statusText: err.response.statusText,
          status: err.response.status
        }
      }
    }
    throw err;
  }
);

axios
  .get("/", { baseURL: "http://localhost:3000" })
  .catch(Sentry.captureException);

You can put whatever data you want from request/response to that JSON method.

[naseemkullah]

I see, thanks for that workaround!

I was wondering if it would make sense to add a skip on calling toJSON() for axios errors , if you get a chance could you try the above repro case with a skip on toJSON()?

sentry-javascript/packages/utils/src/object.ts

Line 287 in 8c77bb6

if (value !== null && value !== undefined && typeof value.toJSON === 'function') {

[rchl]

I'm reading the discussion here and I don't understand one thing. Why the values in the initial screenshot are undefined? Shouldn't the object returned by the axios' toJSON have those values set properly? Why do those show as undefined?

[kamilogorek]

I was wondering if it would make sense to add a skip on calling toJSON() for axios errors

We don't want to have such specific cases tbh.

@rchl I dug into this a bit more, and there's one correction. It is all about toJSON, however I mistakenly stated that it's called on the error object, but rather it's properties.