Errors in Chrome Extension Message Handlers not Logged

[scottfr]

Package + Version

• @sentry/browser

Version:

5.5.0

Description

I am using Sentry to instrument a Chrome Extension. For the most part this works well.

However, uncaught errors in listeners registered via:

chrome.runtime.onMessage.addListener

are surprisingly not logged by sentry.

Note that uncaught errors in these handlers have a slightly different form when printed to the console. A normal uncaught error might log like this:

Uncaught TypeError: XYZ

While errors in the onMessage handler log something like:

Error in event handler: TypeError: XYZ

[kamilogorek]

Can you provide any repository that would help me reproduce this? Setting a whole extension from scratch would take me some time.

[scottfr]

See the attached POC:
extension.zip

1. Unpack the zip file
2. Set the DSN in background_script.js
3. Install the extension
4. Visit any web page so the content_script.js is triggered thereby triggering the onMessage handler.

After this in the console of the background script you will see the errors from the two throws in background_script.js

In Sentry you won't see the error from the onMessage event handler.

[kamilogorek]

@scottfr async messages are not bubbling up to the main onerror listener, as they are meant to be used in communication between channels.

Your best bet here (which works just fine, tested it locally) is to use Sentry.wrap

chrome.runtime.onMessage.addListener(function(request, sender, sendResponse) {
  Sentry.wrap(function() {
    throw new Error(
    "I am an error registered in an onMessage handler. I will incorrectly not be logged to sentry. You will still see me in the console."
    );
  });
});

[scottfr]

Thanks for the guidance Kamil. That looks straightforward.

Just to confirm though, that you will not be changing the behavior on Sentry to catch these exceptions by default? (If you were going to do that, I would just wait for the updated Sentry version rather than adding the Sentry.wrap() calls)

[kamilogorek]

that you will not be changing the behavior on Sentry to catch these exceptions by default?

Not really, as chrome.runtime doesn't have any API we could hook into for unhandled rejections/errors. And wrapping this rarely used API inside the core SDK would be too much.

[kamilogorek]

There should be a possibility to write an integration that could do something like:

const _addListener = chrome.runtime.onMessage.addListener;

chrome.runtime.onMessage.addListener = function(cb) {
  return function(request, sender, sendResponse) {
    Sentry.wrap(function() {
      cb(request, sender, sendResponse);
    });
  };
};

But we don't have enough capacity now to play with it 😅

[scottfr]

OK, sounds good. Thanks for looking into this.

[csandman]

Do you still need to wrap the content of the function with Sentry.wrap to make it work? I saw that in a guide but it seems like it's working regardless of whether I have it wrapped and wanted to make sure.

I'm using @sentry/browser@6.13.3 by the way.