Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve background token refresh #3052

Merged
merged 1 commit into from
Nov 4, 2024
Merged

Improve background token refresh #3052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 62 additions & 30 deletions web/src/components/health/healthcheck.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { useCallback, useEffect, useState } from "react";
import { getSecondsUntilExpiration } from "@/lib/time";
import { User } from "@/lib/types";
import { mockedRefreshToken, refreshToken } from "./refreshUtils";
import { CUSTOM_REFRESH_URL } from "@/lib/constants";
import { NEXT_PUBLIC_CUSTOM_REFRESH_URL } from "@/lib/constants";

export const HealthCheckBanner = () => {
const { error } = useSWR("/api/health", errorHandlingFetcher);
Expand Down Expand Up @@ -35,57 +35,89 @@ export const HealthCheckBanner = () => {
}, [user, updateExpirationTime]);

useEffect(() => {
if (CUSTOM_REFRESH_URL) {
const refreshUrl = CUSTOM_REFRESH_URL;
let refreshTimeoutId: NodeJS.Timeout;
if (NEXT_PUBLIC_CUSTOM_REFRESH_URL) {
const refreshUrl = NEXT_PUBLIC_CUSTOM_REFRESH_URL;
let refreshIntervalId: NodeJS.Timer;
let expireTimeoutId: NodeJS.Timeout;

const attemptTokenRefresh = async () => {
try {
// NOTE: This is a mocked refresh token for testing purposes.
// const refreshTokenData = mockedRefreshToken();

const refreshTokenData = await refreshToken(refreshUrl);

const response = await fetch(
"/api/enterprise-settings/refresh-token",
{
method: "POST",
headers: {
"Content-Type": "application/json",
},
body: JSON.stringify(refreshTokenData),
let retryCount = 0;
const maxRetries = 3;

while (retryCount < maxRetries) {
try {
// NOTE: This is a mocked refresh token for testing purposes.
// const refreshTokenData = mockedRefreshToken();

const refreshTokenData = await refreshToken(refreshUrl);
if (!refreshTokenData) {
throw new Error("Failed to refresh token");
}
);
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}
await new Promise((resolve) => setTimeout(resolve, 4000));

await mutateUser(undefined, { revalidate: true });
updateExpirationTime();
} catch (error) {
console.error("Error refreshing token:", error);
const response = await fetch(
"/api/enterprise-settings/refresh-token",
{
method: "POST",
headers: {
"Content-Type": "application/json",
},
body: JSON.stringify(refreshTokenData),
}
);
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}
await new Promise((resolve) => setTimeout(resolve, 4000));

await mutateUser(undefined, { revalidate: true });
updateExpirationTime();
break; // Success - exit the retry loop
} catch (error) {
console.error(
`Error refreshing token (attempt ${
retryCount + 1
}/${maxRetries}):`,
error
);
retryCount++;

if (retryCount === maxRetries) {
console.error("Max retry attempts reached");
} else {
// Wait before retrying (exponential backoff)
await new Promise((resolve) =>
setTimeout(resolve, Math.pow(2, retryCount) * 1000)
);
}
}
}
};

const scheduleRefreshAndExpire = () => {
if (secondsUntilExpiration !== null) {
const timeUntilRefresh = (secondsUntilExpiration + 0.5) * 1000;
refreshTimeoutId = setTimeout(attemptTokenRefresh, timeUntilRefresh);
const refreshInterval = 60 * 15; // 15 mins
refreshIntervalId = setInterval(
attemptTokenRefresh,
refreshInterval * 1000
);

const timeUntilExpire = (secondsUntilExpiration + 10) * 1000;
expireTimeoutId = setTimeout(() => {
console.debug("Session expired. Setting expired state to true.");
setExpired(true);
}, timeUntilExpire);

// if we're going to timeout before the next refresh, kick off a refresh now!
if (secondsUntilExpiration < refreshInterval) {
attemptTokenRefresh();
}
}
};

scheduleRefreshAndExpire();

return () => {
clearTimeout(refreshTimeoutId);
clearInterval(refreshIntervalId);
clearTimeout(expireTimeoutId);
};
}
Expand Down
11 changes: 9 additions & 2 deletions web/src/components/health/refreshUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,21 @@ export function mockedRefreshToken(): CustomRefreshTokenResponse {

export async function refreshToken(
customRefreshUrl: string
): Promise<CustomRefreshTokenResponse> {
): Promise<CustomRefreshTokenResponse | null> {
try {
console.debug("Sending request to custom refresh URL");
const url = new URL(customRefreshUrl);
// support both absolute and relative
const url = customRefreshUrl.startsWith("http")
? new URL(customRefreshUrl)
: new URL(customRefreshUrl, window.location.origin);
url.searchParams.append("info", "json");
url.searchParams.append("access_token_refresh_interval", "3600");

const response = await fetch(url.toString());
if (!response.ok) {
console.error(`Failed to refresh token: ${await response.text()}`);
return null;
}

return await response.json();
} catch (error) {
Expand Down
3 changes: 2 additions & 1 deletion web/src/lib/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ export const NEXT_PUBLIC_DEFAULT_SIDEBAR_OPEN =
export const TOGGLED_CONNECTORS_COOKIE_NAME = "toggled_connectors";

/* Enterprise-only settings */
export const CUSTOM_REFRESH_URL = process.env.NEXT_PUBLIC_CUSTOM_REFRESH_URL;
export const NEXT_PUBLIC_CUSTOM_REFRESH_URL =
process.env.NEXT_PUBLIC_CUSTOM_REFRESH_URL;

// NOTE: this should ONLY be used on the server-side. If used client side,
// it will not be accurate (will always be false).
Expand Down
Loading