π OpenHands: AI-Driven Development
hotfix(frontend): Show auth modal on 401 (#8094)
sp.wack754dd05bf22f
diff --git a/frontend/__tests__/components/features/auth-modal.test.tsx b/frontend/__tests__/components/features/auth-modal.test.tsxindex 1803e644ca..95940f1c32 100644--- a/frontend/__tests__/components/features/auth-modal.test.tsx+++ b/frontend/__tests__/components/features/auth-modal.test.tsx@@ -6,7 +6,7 @@ import * as AuthHook from "#/context/auth-context";// Mock the useAuthUrl hookvi.mock("#/hooks/use-auth-url", () => ({- useAuthUrl: () => "https://gitlab.com/oauth/authorize"+ useAuthUrl: () => "https://gitlab.com/oauth/authorize",}));describe("AuthModal", () => {@@ -16,7 +16,8 @@ describe("AuthModal", () => {providersAreSet: false,setProvidersAreSet: vi.fn(),providerTokensSet: [],- setProviderTokensSet: vi.fn()+ setProviderTokensSet: vi.fn(),+ clear: vi.fn(),});});@@ -28,8 +29,12 @@ describe("AuthModal", () => {it("should render the GitHub and GitLab buttons", () => {render(<AuthModal githubAuthUrl="mock-url" appMode="saas" />);- const githubButton = screen.getByRole("button", { name: "GITHUB$CONNECT_TO_GITHUB" });- const gitlabButton = screen.getByRole("button", { name: "GITLAB$CONNECT_TO_GITLAB" });+ const githubButton = screen.getByRole("button", {+ name: "GITHUB$CONNECT_TO_GITHUB",+ });+ const gitlabButton = screen.getByRole("button", {+ name: "GITLAB$CONNECT_TO_GITLAB",+ });expect(githubButton).toBeInTheDocument();expect(gitlabButton).toBeInTheDocument();@@ -40,7 +45,9 @@ describe("AuthModal", () => {const mockUrl = "https://github.com/login/oauth/authorize";render(<AuthModal githubAuthUrl={mockUrl} appMode="saas" />);- const githubButton = screen.getByRole("button", { name: "GITHUB$CONNECT_TO_GITHUB" });+ const githubButton = screen.getByRole("button", {+ name: "GITHUB$CONNECT_TO_GITHUB",+ });await user.click(githubButton);expect(window.location.href).toBe(mockUrl);diff --git a/frontend/__tests__/components/features/conversation-panel/conversation-panel.test.tsx b/frontend/__tests__/components/features/conversation-panel/conversation-panel.test.tsxindex ce8ad1c8a7..4877031620 100644--- a/frontend/__tests__/components/features/conversation-panel/conversation-panel.test.tsx+++ b/frontend/__tests__/components/features/conversation-panel/conversation-panel.test.tsx@@ -12,7 +12,6 @@ import { ConversationPanel } from "#/components/features/conversation-panel/convimport OpenHands from "#/api/open-hands";import { AuthProvider } from "#/context/auth-context";import { clickOnEditButton } from "./utils";-import { queryClientConfig } from "#/query-client-config";import { renderWithProviders } from "test-utils";describe("ConversationPanel", () => {@@ -24,7 +23,7 @@ describe("ConversationPanel", () => {},]);- const renderConversationPanel = (config?: QueryClientConfig) =>+ const renderConversationPanel = (config?: object) =>renderWithProviders(<RouterStub />, {preloadedState: {metrics: {diff --git a/frontend/__tests__/routes/home-screen.test.tsx b/frontend/__tests__/routes/home-screen.test.tsxindex 412de4798a..1779d362f7 100644--- a/frontend/__tests__/routes/home-screen.test.tsx+++ b/frontend/__tests__/routes/home-screen.test.tsx@@ -73,7 +73,7 @@ describe("HomeScreen", () => {screen.getByTestId("task-suggestions");});- it("should have responsive layout for mobile and desktop screens", async () => {+ it("should have responsive layout for mobile and desktop screens", () => {renderHomeScreen();const mainContainer = screendiff --git a/frontend/src/context/auth-context.tsx b/frontend/src/context/auth-context.tsxindex 8ec2a86c22..68e000a583 100644--- a/frontend/src/context/auth-context.tsx+++ b/frontend/src/context/auth-context.tsx@@ -6,6 +6,7 @@ interface AuthContextType {setProviderTokensSet: (tokens: Provider[]) => void;providersAreSet: boolean;setProvidersAreSet: (status: boolean) => void;+ clear: () => void;}interface AuthContextProps extends React.PropsWithChildren {@@ -23,19 +24,24 @@ function AuthProvider({const [providerTokensSet, setProviderTokensSet] = React.useState<Provider[]>(initialProviderTokens,);-const [providersAreSet, setProvidersAreSet] = React.useState<boolean>(initialProvidersAreSet,);+ const clear = React.useCallback(() => {+ setProviderTokensSet([]);+ setProvidersAreSet(false);+ }, []);+const value = React.useMemo(() => ({providerTokensSet,setProviderTokensSet,providersAreSet,setProvidersAreSet,+ clear,}),- [providerTokensSet],+ [providerTokensSet, providersAreSet, clear],);return <AuthContext value={value}>{children}</AuthContext>;diff --git a/frontend/src/entry.client.tsx b/frontend/src/entry.client.tsxindex b778bb733a..518efd3a6f 100644--- a/frontend/src/entry.client.tsx+++ b/frontend/src/entry.client.tsx@@ -11,10 +11,10 @@ import { hydrateRoot } from "react-dom/client";import { Provider } from "react-redux";import posthog from "posthog-js";import "./i18n";-import { QueryClient, QueryClientProvider } from "@tanstack/react-query";+import { QueryClientProvider } from "@tanstack/react-query";import store from "./store";import { AuthProvider } from "./context/auth-context";-import { queryClientConfig } from "./query-client-config";+import { queryClient } from "./query-client-config";import OpenHands from "./api/open-hands";import { displayErrorToast } from "./utils/custom-toast-handlers";@@ -59,8 +59,6 @@ async function prepareApp() {}}-export const queryClient = new QueryClient(queryClientConfig);-prepareApp().then(() =>startTransition(() => {hydrateRoot(diff --git a/frontend/src/hooks/query/use-is-authed.ts b/frontend/src/hooks/query/use-is-authed.tsindex a6a74f0871..cc21f516b0 100644--- a/frontend/src/hooks/query/use-is-authed.ts+++ b/frontend/src/hooks/query/use-is-authed.ts@@ -1,19 +1,16 @@import { useQuery } from "@tanstack/react-query";-import React from "react";import OpenHands from "#/api/open-hands";import { useConfig } from "./use-config";-import { useAuth } from "#/context/auth-context";import { useIsOnTosPage } from "#/hooks/use-is-on-tos-page";export const useIsAuthed = () => {- const { providersAreSet } = useAuth();const { data: config } = useConfig();const isOnTosPage = useIsOnTosPage();- const appMode = React.useMemo(() => config?.APP_MODE, [config]);+ const appMode = config?.APP_MODE;return useQuery({- queryKey: ["user", "authenticated", providersAreSet, appMode],+ queryKey: ["user", "authenticated", appMode],queryFn: () => OpenHands.authenticate(appMode!),enabled: !!appMode && !isOnTosPage,staleTime: 1000 * 60 * 5, // 5 minutesdiff --git a/frontend/src/hooks/use-auth-url.ts b/frontend/src/hooks/use-auth-url.tsindex a14218c023..1966911eb6 100644--- a/frontend/src/hooks/use-auth-url.ts+++ b/frontend/src/hooks/use-auth-url.ts@@ -1,29 +1,10 @@-import React from "react";import { generateAuthUrl } from "#/utils/generate-auth-url";import { GetConfigResponse } from "#/api/open-hands.types";-import { useAuth } from "#/context/auth-context";interface UseAuthUrlConfig {appMode: GetConfigResponse["APP_MODE"] | null;identityProvider: string;}-export const useAuthUrl = (config: UseAuthUrlConfig) => {- const { providersAreSet } = useAuth();-- return React.useMemo(() => {- if (config.appMode === "saas" && !providersAreSet) {- try {- return generateAuthUrl(- config.identityProvider,- new URL(window.location.href),- );- } catch (e) {- // In test environment, window.location.href might not be a valid URL- return null;- }- }-- return null;- }, [providersAreSet, config.appMode, config.identityProvider]);-};+export const useAuthUrl = (config: UseAuthUrlConfig) =>+ generateAuthUrl(config.identityProvider, new URL(window.location.href));diff --git a/frontend/src/query-client-config.ts b/frontend/src/query-client-config.tsindex 5da6e5feb2..b9c55adb6e 100644--- a/frontend/src/query-client-config.ts+++ b/frontend/src/query-client-config.ts@@ -1,17 +1,27 @@-import {- QueryClientConfig,- QueryCache,- MutationCache,-} from "@tanstack/react-query";+import { QueryCache, MutationCache, QueryClient } from "@tanstack/react-query";import i18next from "i18next";+import { AxiosError } from "axios";import { I18nKey } from "./i18n/declaration";import { retrieveAxiosErrorMessage } from "./utils/retrieve-axios-error-message";import { displayErrorToast } from "./utils/custom-toast-handlers";+const handle401Error = (error: AxiosError, queryClient: QueryClient) => {+ if (error?.response?.status === 401 || error?.status === 401) {+ queryClient.invalidateQueries({ queryKey: ["user", "authenticated"] });+ }+};+const shownErrors = new Set<string>();-export const queryClientConfig: QueryClientConfig = {++export const queryClient = new QueryClient({queryCache: new QueryCache({onError: (error, query) => {+ const isAuthQuery =+ query.queryKey[0] === "user" && query.queryKey[1] === "authenticated";+ if (!isAuthQuery) {+ handle401Error(error, queryClient);+ }+if (!query.meta?.disableToast) {const errorMessage = retrieveAxiosErrorMessage(error);@@ -28,10 +38,12 @@ export const queryClientConfig: QueryClientConfig = {}),mutationCache: new MutationCache({onError: (error, _, __, mutation) => {+ handle401Error(error, queryClient);+if (!mutation?.meta?.disableToast) {const message = retrieveAxiosErrorMessage(error);displayErrorToast(message || i18next.t(I18nKey.ERROR$GENERIC));}},}),-};+});diff --git a/frontend/src/routes/root-layout.tsx b/frontend/src/routes/root-layout.tsxindex 3c756afab7..48c9618afc 100644--- a/frontend/src/routes/root-layout.tsx+++ b/frontend/src/routes/root-layout.tsx@@ -21,6 +21,7 @@ import { useBalance } from "#/hooks/query/use-balance";import { SetupPaymentModal } from "#/components/features/payment/setup-payment-modal";import { displaySuccessToast } from "#/utils/custom-toast-handlers";import { useIsOnTosPage } from "#/hooks/use-is-on-tos-page";+import { useAuth } from "#/context/auth-context";export function ErrorBoundary() {const error = useRouteError();@@ -56,6 +57,7 @@ export function ErrorBoundary() {}export default function MainApp() {+ const { clear } = useAuth();const navigate = useNavigate();const { pathname } = useLocation();const tosPageStatus = useIsOnTosPage();@@ -71,6 +73,8 @@ export default function MainApp() {isError: authError,} = useIsAuthed();+ // When on TOS page, we don't make any API calls, so we need to handle this case+ const userIsAuthed = tosPageStatus ? false : !!isAuthed && !authError;// Always call the hook, but we'll only use the result when not on TOS pageconst gitHubAuthUrl = useGitHubAuthUrl({appMode: config.data?.APP_MODE || null,@@ -125,8 +129,11 @@ export default function MainApp() {}}, [error?.status, pathname, tosPageStatus]);- // When on TOS page, we don't make any API calls, so we need to handle this case- const userIsAuthed = tosPageStatus ? false : !!isAuthed && !authError;+ React.useEffect(() => {+ if (!userIsAuthed && !isFetchingAuth && authError) {+ clear();+ }+ }, [userIsAuthed, isFetchingAuth, authError, clear]);// Only show the auth modal if:// 1. User is not authenticated