Add Sentry error logging to Audius query C-2800 (#3656)

Co-authored-by: Nikki Kang <kangaroo233@gmail.com>
AudiusProject · Jun 27, 2023 · 6a2f008 · 6a2f008
1 parent 79213de
commit 6a2f008
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 2 deletions.
diff --git a/packages/common/src/audius-query/AudiusQueryContext.ts b/packages/common/src/audius-query/AudiusQueryContext.ts
@@ -5,10 +5,13 @@ import { AudiusSdk } from '@audius/sdk'
 import type { AudiusAPIClient } from 'services/audius-api-client'
 import { AudiusBackend } from 'services/index'
 
+import { ReportToSentryArgs } from '../models'
+
 export type AudiusQueryContextType = {
   apiClient: AudiusAPIClient
   audiusSdk: () => Promise<AudiusSdk>
   audiusBackend: AudiusBackend
+  reportToSentry: (args: ReportToSentryArgs) => void
 }
 
 export const AudiusQueryContext = createContext<AudiusQueryContextType | null>(

diff --git a/packages/common/src/audius-query/createApi.ts b/packages/common/src/audius-query/createApi.ts
@@ -8,6 +8,7 @@ import { useDispatch, useSelector } from 'react-redux'
 import { Dispatch } from 'redux'
 
 import { useProxySelector } from 'hooks/useProxySelector'
+import { ErrorLevel } from 'models/ErrorReporting'
 import { Kind } from 'models/Kind'
 import { Status } from 'models/Status'
 import { getCollection } from 'store/cache/collections/selectors'
@@ -39,6 +40,7 @@ import {
   QueryHookResults
 } from './types'
 import { capitalize, getKeyFromFetchArgs, selectCommonEntityMap } from './utils'
+
 const { addEntries } = cacheActions
 
 export const createApi = <
@@ -296,6 +298,14 @@ const fetchData = async <Args, Data>(
 
     endpoint.onQuerySuccess?.(data, fetchArgs, { dispatch })
   } catch (e) {
+    context.reportToSentry({
+      error: e as Error,
+      level: ErrorLevel.Error,
+      additionalInfo: { fetchArgs, endpoint },
+      name: `${
+        endpoint.options?.type === 'mutation' ? 'Mutate' : 'Query'
+      } ${capitalize(endpointName)} error`
+    })
     dispatch(
       // @ts-ignore
       actions[`fetch${capitalize(endpointName)}Error`]({

diff --git a/packages/mobile/src/app/App.tsx b/packages/mobile/src/app/App.tsx
@@ -33,6 +33,7 @@ import {
   forceRefreshConnectivity,
   subscribeToNetworkStatusUpdates
 } from 'app/utils/reachability'
+import { reportToSentry } from 'app/utils/reportToSentry'
 
 import { Drawers } from './Drawers'
 import ErrorBoundary from './ErrorBoundary'
@@ -87,7 +88,8 @@ const App = () => {
             value={{
               apiClient,
               audiusSdk,
-              audiusBackend: audiusBackendInstance
+              audiusBackend: audiusBackendInstance,
+              reportToSentry
             }}
           >
             <PersistGate loading={null} persistor={persistor}>

diff --git a/packages/web/src/app.tsx b/packages/web/src/app.tsx
@@ -19,6 +19,7 @@ import { audiusSdk } from 'services/audius-sdk/audiusSdk'
 import history from 'utils/history'
 
 import { store } from './store/configureStore'
+import { reportToSentry } from './store/errors/reportToSentry'
 
 import './services/webVitals'
 import './index.css'
@@ -27,7 +28,12 @@ const AudiusApp = () => {
   return (
     <Provider store={store}>
       <AudiusQueryContext.Provider
-        value={{ apiClient, audiusBackend: audiusBackendInstance, audiusSdk }}
+        value={{
+          apiClient,
+          audiusBackend: audiusBackendInstance,
+          audiusSdk,
+          reportToSentry
+        }}
       >
         <ConnectedRouter history={history}>
           <LastLocationProvider>