fix: retryable location hint (#1505)

Sometimes, it may take longer than 2000 ms. to retrieve the approximate location of the user.
We now try up to three times before we eventually give up.

packages/client/src/coordinator/connection/client.ts

@@ -110,6 +110,7 @@ export class StreamClient {
       this.locationHint = getLocationHint(
         options?.locationHintUrl,
         options?.locationHintTimeout,
+        options?.locationHintMaxAttempts,
       );
     }
 

packages/client/src/coordinator/connection/location.ts

@@ -1,26 +1,32 @@
 import { getLogger } from '../../logger';
 
-const logger = getLogger(['location']);
-const HINT_URL = `https://hint.stream-io-video.com/`;
-
 export const getLocationHint = async (
-  hintUrl: string = HINT_URL,
-  timeout: number = 2000,
-) => {
-  const abortController = new AbortController();
-  const timeoutId = setTimeout(() => abortController.abort(), timeout);
-  try {
-    const response = await fetch(hintUrl, {
-      method: 'HEAD',
-      signal: abortController.signal,
-    });
-    const awsPop = response.headers.get('x-amz-cf-pop') || 'ERR';
-    logger('debug', `Location header: ${awsPop}`);
-    return awsPop.substring(0, 3); // AMS1-P2 -> AMS
-  } catch (e) {
-    logger('warn', `Failed to get location hint from ${hintUrl}`, e);
-    return 'ERR';
-  } finally {
-    clearTimeout(timeoutId);
-  }
+  hintUrl = `https://hint.stream-io-video.com/`,
+  timeout = 2000,
+  maxAttempts = 3,
+): Promise<string> => {
+  const logger = getLogger(['location-hint']);
+
+  let attempt = 0;
+  let locationHint = 'ERR';
+  do {
+    const abortController = new AbortController();
+    const timeoutId = setTimeout(() => abortController.abort(), timeout);
+    try {
+      const response = await fetch(hintUrl, {
+        method: 'HEAD',
+        signal: abortController.signal,
+      });
+      const awsPop = response.headers.get('x-amz-cf-pop') || 'ERR';
+      logger('debug', `Location header: ${awsPop}`);
+      locationHint = awsPop.substring(0, 3); // AMS1-P2 -> AMS
+    } catch (e) {
+      logger('warn', `Failed to get location hint from ${hintUrl}`, e);
+      locationHint = 'ERR';
+    } finally {
+      clearTimeout(timeoutId);
+    }
+  } while (locationHint === 'ERR' && ++attempt < maxAttempts);
+
+  return locationHint;
 };

packages/client/src/coordinator/connection/types.ts

@@ -129,6 +129,10 @@ export type StreamClientOptions = Partial<AxiosRequestConfig> & {
    * The default timeout for requesting a location hint.
    */
   locationHintTimeout?: number;
+  /**
+   * The maximum number of attempts to request a location hint.
+   */
+  locationHintMaxAttempts?: number;
   /**
    * When true, user will be persisted on client. Otherwise if `connectUser` call fails, then you need to
    * call `connectUser` again to retry.