fix: omit failed eth_blockNumber calls from sentry (#6267)

* build: upgrade sentry

* fix: omit failed eth_blockNumber calls from sentry

* test: beforeSend

* fix: bring to parity with #6281

* docs: type filterKnownErrors to beforeSend

package.json

@@ -37,6 +37,7 @@
       "src/lib/utils/**/*.ts*",
       "src/pages/**/*.ts*",
       "src/state/**/*.ts*",
+      "src/tracing/**/*.ts*",
       "src/utils/**/*.ts*"
     ],
     "coveragePathIgnorePatterns": [

src/tracing/errors.test.ts

+import { ErrorEvent } from '@sentry/types'
+
+import { filterKnownErrors } from './errors'
+
+describe('filterKnownErrors', () => {
+  const ERROR = {} as ErrorEvent
+  it('propagates an error', () => {
+    expect(filterKnownErrors(ERROR, {})).toBe(ERROR)
+  })
+
+  it('filters block number polling errors', () => {
+    const originalException = new (class extends Error {
+      requestBody = JSON.stringify({ method: 'eth_blockNumber' })
+    })()
+    expect(filterKnownErrors(ERROR, { originalException })).toBe(null)
+  })
+
+  it('filters network change errors', () => {
+    const originalException = new Error('underlying network changed')
+    expect(filterKnownErrors(ERROR, { originalException })).toBe(null)
+  })
+})

src/tracing/errors.ts

+import { ClientOptions, ErrorEvent, EventHint } from '@sentry/types'
+
+/** Identifies ethers request errors (as thrown by {@type import(@ethersproject/web).fetchJson}). */
+function isEthersRequestError(error: Error): error is Error & { requestBody: string } {
+  return 'requestBody' in error && typeof (error as unknown as Record<'requestBody', unknown>).requestBody === 'string'
+}
+
+/**
+ * Filters known (ignorable) errors out before sending them to Sentry.
+ * Intended as a {@link ClientOptions.beforeSend} callback. Returning null filters the error from Sentry.
+ */
+export const filterKnownErrors: Required<ClientOptions>['beforeSend'] = (event: ErrorEvent, hint: EventHint) => {
+  const error = hint.originalException
+  if (error instanceof Error) {
+    // ethers aggressively polls for block number, and it sometimes fails (whether spuriously or through rate-limiting).
+    // If block number polling, it should not be considered an exception.
+    if (isEthersRequestError(error)) {
+      const method = JSON.parse(error.requestBody).method
+      if (method === 'eth_blockNumber') return null
+    }
+
+    // If the error is a network change, it should not be considered an exception.
+    if (error.message.match(/underlying network changed/)) return null
+  }
+
+  return event
+}

src/tracing/index.ts

@@ -7,6 +7,8 @@ import { SharedEventName } from '@uniswap/analytics-events'
 import { isSentryEnabled } from 'utils/env'
 import { getEnvName, isProductionEnv } from 'utils/env'
 
+import { filterKnownErrors } from './errors'
+
 export { trace } from './trace'
 
 // Dump some metadata into the window to allow client verification.
@@ -17,13 +19,10 @@ const AMPLITUDE_DUMMY_KEY = '00000000000000000000000000000000'
 export const STATSIG_DUMMY_KEY = 'client-0000000000000000000000000000000000000000000'
 
 Sentry.init({
-  // General configuration:
   dsn: process.env.REACT_APP_SENTRY_DSN,
   release: process.env.REACT_APP_GIT_COMMIT_HASH,
   environment: getEnvName(),
-  // Exception reporting configuration:
   enabled: isSentryEnabled(),
-  // Performance tracing configuration:
   tracesSampleRate: Number(process.env.REACT_APP_SENTRY_TRACES_SAMPLE_RATE ?? 0),
   integrations: [
     new BrowserTracing({
@@ -31,6 +30,7 @@ Sentry.init({
       startTransactionOnPageLoad: true,
     }),
   ],
+  beforeSend: filterKnownErrors,
 })
 
 initializeAnalytics(AMPLITUDE_DUMMY_KEY, OriginApplication.INTERFACE, {