Send error details to Sentry

[daniellemaxwell]

Scope of changes

Fixes Object captured as exception Sentry error.

Type of change

• bug fix
• new feature
• documentation
• other (describe)

Acceptance criteria

Describe how reviewers can test this change to be sure that it works correctly. Add a checklist if possible

Author checklist

• I have manually tested the change and/or added automation in the form of unit tests or integration tests
• I have updated the dependencies list
• I have recompiled and included new protocol buffers to reflect changes I made
• I have added new test fixtures as needed to support added tests
• Check this box if a reviewer can merge this pull request after approval (leave it unchecked if you want to do it yourself)
• I have moved the associated Shortcut story to "Ready for Review"

Reviewer(s) checklist

• Any new user-facing content that has been added for this PR has been QA'ed to ensure correct grammar, spelling, and understandability.

[daniellemaxwell]

After reading this comment, it seems that Sentry didn't think err is an error object: getsentry/sentry-react-native#391 (comment)

err?.original returns an object inside the error object with more details, so this could potentially resolve the issue.

I should note that if a user enters incorrect log in details, they see an error message explaining that the username or password is invalid. This change will not affect that.

[bbengfort]

When it comes to the ?. syntax, what will be passed into captureException if the original property is not on err? Probably we would just want to pass in err in that case, right?

I may just be unfamiliar with ?. but how does this code differ?

try {
    Sentry.captureException(err);
} catch {
     Sentry.captureException(err?.original);
}

or is it more like:

if (err?.original) {
    Sentry.captureException(err?.original);
} else {
    Sentry.captureException(err);
}

Or is it that we can always guarantee that there is an err.original on the error object?

[daniellemaxwell]

err returns an object with the error, error code, error description, and another object (original) that contains the error and error description.

?. will check if err is undefined before attempting to read what's inside the original object. It was added to prevent an undefined error from being returned.

If original isn't included, then err wouldn't be passed into the exception. I didn't include an else because we currently pass err into Sentry.captureException and get an error message. I thought possibly passing in this object directly could be helpful. The error didn't trigger in development mode for me to confirm if this is truly the solution.

From what I can see, err.original will be included in the err object. However, this is coming from Auth0 so I can't quite guarantee this won't ever change.

[bbengfort]

Ok, I see now that this is already in a try/catch block for Auth0 specific handling. Thank you for clarifying this!

[bbengfort]

Thanks for making this fix!