feat: allow skipping retries on specific pathnames (supabase#39894)

* feat: allow skipping retries on specific pathnames

* remove system route

Author: alaister

apps/studio/data/fetchers.ts

@@ -105,10 +105,15 @@ client.use(
 
         // add code field to body
         body.code = response.status
+
         body.requestId = request.headers.get('X-Request-Id')
+
         const retryAfterHeader = response.headers.get('Retry-After')
         body.retryAfter = retryAfterHeader ? parseInt(retryAfterHeader) : undefined
 
+        const requestUrl = new URL(request.url)
+        body.requestPathname = requestUrl.pathname
+
         return new Response(JSON.stringify(body), {
           headers: response.headers,
           status: response.status,
@@ -156,9 +161,13 @@ export const handleError = (error: unknown, options: HandleErrorOptions = {}): n
       'requestId' in error && typeof error.requestId === 'string' ? error.requestId : undefined
     const retryAfter =
       'retryAfter' in error && typeof error.retryAfter === 'number' ? error.retryAfter : undefined
+    const requestPathname =
+      'requestPathname' in error && typeof error.requestPathname === 'string'
+        ? error.requestPathname
+        : undefined
 
     if (errorMessage) {
-      throw new ResponseError(errorMessage, errorCode, requestId, retryAfter)
+      throw new ResponseError(errorMessage, errorCode, requestId, retryAfter, requestPathname)
     }
   }
 

apps/studio/data/query-client.ts

@@ -1,6 +1,8 @@
 import { QueryClient, onlineManager } from '@tanstack/react-query'
-import { IS_PLATFORM } from 'lib/constants'
+import { match } from 'path-to-regexp'
 import { useState } from 'react'
+
+import { IS_PLATFORM } from 'lib/constants'
 import { ResponseError } from 'types'
 
 // When running locally we don't need the internet
@@ -9,6 +11,13 @@ if (!IS_PLATFORM) {
   onlineManager.setOnline(true)
 }
 
+const SKIP_RETRY_PATHNAME_MATCHERS = [
+  '/platform/projects/:ref/run-lints',
+  '/platform/organizations/:slug/usage',
+  '/platform/pg-meta/:ref/query',
+  '/v1/projects/:ref/analytics/endpoints/logs.all',
+].map((pathname) => match(pathname))
+
 let queryClient: QueryClient | undefined
 
 export function getQueryClient() {
@@ -31,6 +40,14 @@ export function getQueryClient() {
               return false
             }
 
+            if (
+              error instanceof ResponseError &&
+              error.requestPathname &&
+              SKIP_RETRY_PATHNAME_MATCHERS.some((matchFn) => matchFn(error.requestPathname!))
+            ) {
+              return false
+            }
+
             if (failureCount < 3) {
               return true
             }

apps/studio/types/base.ts

@@ -89,12 +89,20 @@ export class ResponseError extends Error {
   code?: number
   requestId?: string
   retryAfter?: number
+  requestPathname?: string
 
-  constructor(message: string | undefined, code?: number, requestId?: string, retryAfter?: number) {
+  constructor(
+    message: string | undefined,
+    code?: number,
+    requestId?: string,
+    retryAfter?: number,
+    requestPathname?: string
+  ) {
     super(message || 'API error happened while trying to communicate with the server.')
     this.code = code
     this.requestId = requestId
     this.retryAfter = retryAfter
+    this.requestPathname = requestPathname
   }
 }