fix: Use `POST` for main process ping so it does not result in fetch breadcrumb #612

timfish · 2022-12-30T20:14:14Z

While debugging e2e tests I noticed we still capture a breadcrumb for the ping IPC command.

      {
        timestamp: 1671415619.64,
        category: 'fetch',
        data: {
          method: 'GET',
          url: 'sentry-ipc://sentry-electron.ping/sentry_key',
          status_code: 200
        },
        type: 'http'
      }

This is because the @sentry/browser code that ignores urls with sentry_key in them only matches for POST requests.

lforst · 2023-01-06T14:45:44Z

src/renderer/ipc.ts

@@ -13,7 +13,7 @@ function getImplementation(): IPCInterface {

  logger.log('IPC was not configured in preload script, falling back to custom protocol and fetch');

-  fetch(`${PROTOCOL_SCHEME}://${IPCChannel.PING}/sentry_key`).catch(() =>
+  fetch(`${PROTOCOL_SCHEME}://${IPCChannel.PING}/sentry_key`, { method: 'POST', body: '' }).catch(() =>


Just a thought: Alternatively we could filter for this request in beforeBreadcrumb but I think this is also fine.

I would love integrations to have more hooks like for beforeBreadcrumb!

timfish added 2 commits December 30, 2022 20:11

Use POST so ping does not result in fetch breadcrumb

6ba5735

typo

733ed7e

timfish changed the title ~~fix: Use POST for ping IPC so it does not result in fetch breadcrumb~~ fix: Use POST for main process ping so it does not result in fetch breadcrumb Dec 30, 2022

timfish self-assigned this Dec 30, 2022

lforst approved these changes Jan 6, 2023

View reviewed changes

timfish merged commit ed784c3 into getsentry:master Jan 9, 2023

timfish deleted the fix/fetch-ipc-breadcrumbs branch January 9, 2023 21:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Use `POST` for main process ping so it does not result in fetch breadcrumb #612

fix: Use `POST` for main process ping so it does not result in fetch breadcrumb #612

timfish commented Dec 30, 2022 •

edited

Loading

lforst Jan 6, 2023

timfish Jan 9, 2023

fix: Use POST for main process ping so it does not result in fetch breadcrumb #612

fix: Use POST for main process ping so it does not result in fetch breadcrumb #612

Conversation

timfish commented Dec 30, 2022 • edited Loading

lforst Jan 6, 2023

Choose a reason for hiding this comment

timfish Jan 9, 2023

Choose a reason for hiding this comment

fix: Use `POST` for main process ping so it does not result in fetch breadcrumb #612

fix: Use `POST` for main process ping so it does not result in fetch breadcrumb #612

timfish commented Dec 30, 2022 •

edited

Loading