Merge pull request #68 from Navigraph/feat/token-buffers

Author: SkySails

.changeset/giant-dryers-fetch.md

@@ -0,0 +1,6 @@
+---
+"@navigraph/auth": patch
+---
+
+Added request buffers to all token requests, including user verification.
+This ensures that the SDK does not send multiple identical token requests in parallel and instead returns one response for all requests, ultimately increasing both speed and reliability.

packages/auth/src/api/requestToken.ts

@@ -2,17 +2,32 @@ import axios from "axios";
 import { getIdentityTokenEndpoint } from "../constants";
 import { NavigraphCancelToken } from "../lib/navigraphRequest";
 import { TokenResponse } from "./types";
-import { AuthenticationAbortedError, Scope } from "@navigraph/app";
+import { AuthenticationAbortedError, Logger, NotInitializedError, Scope, getApp } from "@navigraph/app";
 import { tokenStorage } from "../internals/storage";
 import { setUser } from "../internals/user";
 import { decodeUser } from "../util";
 
+const requests = new Map<string, Promise<TokenResponse> | null>();
+
 /** Requests a token using provided options and updates the credential stores with the result. Also sets the user variable. */
 export async function requestToken(params: Record<string, string>, cancelToken?: NavigraphCancelToken) {
-  return axios
+  const app = getApp();
+  if (!app) throw new NotInitializedError("Auth");
+
+  const key = JSON.stringify(params);
+  const ongoingRequest = requests.get(key);
+
+  if (ongoingRequest) {
+    Logger.debug("Found ongoing request with key " + key);
+    return ongoingRequest;
+  }
+
+  Logger.debug("No ongoing request found with key " + key);
+
+  const requestPromise = axios
     .post<TokenResponse>(getIdentityTokenEndpoint(), new URLSearchParams(params), {
       cancelToken,
-      withCredentials: params.scope?.includes(Scope.TILES) ? true : undefined,
+      withCredentials: app.scopes.includes(Scope.TILES) ? true : undefined,
       headers: { "Content-Type": "application/x-www-form-urlencoded" },
     })
     .then(async ({ data }) => {
@@ -27,5 +42,9 @@ export async function requestToken(params: Record<string, string>, cancelToken?:
       if (axios.isCancel(err)) throw new AuthenticationAbortedError();
 
       throw err;
-    });
+    })
+    .finally(() => requests.delete(key));
+
+  requests.set(key, requestPromise);
+  return requestPromise;
 }

packages/auth/src/internals/verifyUser.ts

@@ -1,9 +1,11 @@
-import { NotInitializedError, getApp } from "@navigraph/app";
+import { Logger, NotInitializedError, getApp } from "@navigraph/app";
 import { tokenStorage } from "./storage";
 import { isExpiredToken, decodeUser, runWithLock } from "../util";
 import { setUser, USER, User } from "./user";
 import { requestToken } from "../api/requestToken";
 
+let verifyUserPromise: Promise<User | null> | null = null;
+
 /**
  * Verifies the validity of the currently stored access token. If the token is invalid or expired, a refresh attempt will be made.
  * @returns {Promise<User|null>} The currently authenticated user
@@ -21,7 +23,12 @@ export default async function verifyUser() {
     return user;
   }
 
-  return new Promise<User | null>((resolve, reject) => {
+  if (verifyUserPromise) {
+    Logger.debug("Found ongoing verification request, returning promise early");
+    return verifyUserPromise;
+  }
+
+  verifyUserPromise = new Promise<User | null>((resolve, reject) => {
     runWithLock("NAVIGRAPH_SDK_INIT", async () => {
       const REFRESH_TOKEN = await tokenStorage.getRefreshToken();
 
@@ -35,6 +42,10 @@ export default async function verifyUser() {
       }
 
       resolve(USER);
-    }).catch(reject);
+    })
+      .catch(reject)
+      .finally(() => (verifyUserPromise = null));
   });
+
+  return verifyUserPromise;
 }