Merge branch 'query-retry' into 'main'

queryClient: retry certain 5xx codes automatically

See merge request soapbox-pub/soapbox!3150

src/api/HTTPError.ts

@@ -1,10 +1,12 @@
 export class HTTPError extends Error {
 
   response: Response;
+  request: Request;
 
-  constructor(response: Response) {
+  constructor(response: Response, request: Request) {
     super(response.statusText);
     this.response = response;
+    this.request = request;
   }
 
 }

src/api/MastodonClient.ts

@@ -84,7 +84,7 @@ export class MastodonClient {
     const response = await this.fetch(request);
 
     if (!response.ok) {
-      throw new HTTPError(response);
+      throw new HTTPError(response, request);
     }
 
     return response;

src/api/hooks/instance/useInstanceV1.ts

@@ -3,7 +3,7 @@ import { useQuery, UseQueryOptions } from '@tanstack/react-query';
 import { useApi } from 'soapbox/hooks';
 import { InstanceV1, instanceV1Schema } from 'soapbox/schemas/instance';
 
-interface Opts extends Pick<UseQueryOptions<unknown>, 'enabled' | 'retry' | 'retryOnMount' | 'staleTime'> {
+interface Opts extends Pick<UseQueryOptions<unknown>, 'enabled' | 'retryOnMount' | 'staleTime'> {
   /** The base URL of the instance. */
   baseUrl?: string;
 }

src/api/hooks/instance/useInstanceV2.ts

@@ -3,7 +3,7 @@ import { useQuery, UseQueryOptions } from '@tanstack/react-query';
 import { useApi } from 'soapbox/hooks';
 import { InstanceV2, instanceV2Schema } from 'soapbox/schemas/instance';
 
-interface Opts extends Pick<UseQueryOptions<unknown>, 'enabled' | 'retry' | 'retryOnMount' | 'staleTime'> {
+interface Opts extends Pick<UseQueryOptions<unknown>, 'enabled' | 'retryOnMount' | 'staleTime'> {
   /** The base URL of the instance. */
   baseUrl?: string;
 }

src/hooks/useInstance.ts

@@ -17,16 +17,8 @@ interface Opts extends Pick<UseQueryOptions<unknown>, 'enabled' | 'retryOnMount'
 export function useInstance(opts: Opts = {}) {
   const { baseUrl, retryOnMount = false, staleTime = Infinity } = opts;
 
-  function retry(failureCount: number, error: Error): boolean {
-    if (error instanceof HTTPError && error.response.status === 404) {
-      return false;
-    } else {
-      return failureCount < 3;
-    }
-  }
-
-  const v2 = useInstanceV2({ baseUrl, retry, retryOnMount, staleTime });
-  const v1 = useInstanceV1({ baseUrl, retry, retryOnMount, staleTime, enabled: v2.isError });
+  const v2 = useInstanceV2({ baseUrl, retryOnMount, staleTime });
+  const v1 = useInstanceV1({ baseUrl, retryOnMount, staleTime, enabled: v2.isError });
 
   const instance = useMemo(() => {
     if (v2.instance) {

src/queries/client.ts

@@ -1,12 +1,30 @@
 import { QueryClient } from '@tanstack/react-query';
 
+import { HTTPError } from 'soapbox/api/HTTPError';
+
+/** HTTP response codes to retry. */
+const RETRY_CODES = [502, 503, 504, 521, 522];
+
 const queryClient = new QueryClient({
   defaultOptions: {
     queries: {
       refetchOnWindowFocus: false,
       staleTime: 60000, // 1 minute
       gcTime: Infinity,
-      retry: false,
+      retry(failureCount: number, error: Error): boolean {
+        if (error instanceof HTTPError) {
+          const { response } = error;
+
+          // TODO: Implement Retry-After.
+          // const retryAfter = response.headers.get('Retry-After');
+
+          if (RETRY_CODES.includes(response.status)) {
+            return failureCount < 3;
+          }
+        }
+
+        return false;
+      },
     },
   },
 });