Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

fix(web): reset frontend session after logout (#43055)

Stephen Zhou4808976d0c22
diff --git a/oxlint-suppressions.json b/oxlint-suppressions.json
index dfea6b67a0a..7a735baa995 100644
--- a/oxlint-suppressions.json
+++ b/oxlint-suppressions.json
@@ -4342,11 +4342,6 @@
"count": 3
}
},
- "web/service/common.spec.ts": {
- "@tanstack/query/prefer-query-options": {
- "count": 2
- }
- },
"web/service/common.ts": {
"no-restricted-imports": {
"count": 1
@@ -4664,4 +4659,4 @@
"count": 2
}
}
-}
+}
\ No newline at end of file
diff --git a/web/app/account/(commonLayout)/account-page/__tests__/email-change-modal.spec.tsx b/web/app/account/(commonLayout)/account-page/__tests__/email-change-modal.spec.tsx
index f45a3b8e6cf..1a1f43c56b6 100644
--- a/web/app/account/(commonLayout)/account-page/__tests__/email-change-modal.spec.tsx
+++ b/web/app/account/(commonLayout)/account-page/__tests__/email-change-modal.spec.tsx
@@ -3,6 +3,8 @@ import userEvent from '@testing-library/user-event'
import { checkEmailExisted, resetEmail, sendVerifyCode, verifyEmail } from '@/service/common'
import EmailChangeModal from '../email-change-modal'
+const mockLogout = vi.fn()
+
vi.mock('@/service/common', () => ({
checkEmailExisted: vi.fn(),
resetEmail: vi.fn(),
@@ -11,11 +13,9 @@ vi.mock('@/service/common', () => ({
}))
vi.mock('@/service/use-common', () => ({
- useLogout: () => ({ mutateAsync: vi.fn() }),
+ useLogout: () => ({ mutateAsync: mockLogout }),
}))
-vi.mock('@/next/navigation', () => ({ useRouter: () => ({ push: vi.fn() }) }))
-
describe('EmailChangeModal', () => {
beforeEach(() => {
vi.clearAllMocks()
@@ -73,6 +73,7 @@ describe('EmailChangeModal', () => {
token: 'verified-token',
}),
)
+ expect(mockLogout).toHaveBeenCalledOnce()
})
it('associates an unavailable-email error and clears it when the user edits the address', async () => {
diff --git a/web/app/account/(commonLayout)/account-page/email-change-modal.tsx b/web/app/account/(commonLayout)/account-page/email-change-modal.tsx
index fcd82bf552b..653ffe8af13 100644
--- a/web/app/account/(commonLayout)/account-page/email-change-modal.tsx
+++ b/web/app/account/(commonLayout)/account-page/email-change-modal.tsx
@@ -9,7 +9,6 @@ import { useDebounceFn } from 'ahooks'
import { useCallback, useEffect, useRef, useState } from 'react'
import { Trans, useTranslation } from 'react-i18next'
import { toast } from '@/app/notifications'
-import { useRouter } from '@/next/navigation'
import { checkEmailExisted, resetEmail, sendVerifyCode, verifyEmail } from '@/service/common'
import { useLogout } from '@/service/use-common'
import { asyncRunSafe } from '@/utils'
@@ -53,7 +52,6 @@ function isFetchResponseError(error: unknown): error is FetchResponseError {
const EmailChangeModal = ({ onClose, email }: Props) => {
const { t } = useTranslation(['common', 'accountSettings'])
- const router = useRouter()
const [step, setStep] = useState<Step>(STEP.start)
const [code, setCode] = useState<string>('')
const [mail, setMail] = useState<string>('')
@@ -194,21 +192,13 @@ const EmailChangeModal = ({ onClose, email }: Props) => {
}
const { mutateAsync: logout } = useLogout()
- const handleLogout = async () => {
- await logout()
-
- // Tokens are now stored in cookies and cleared by backend
-
- router.push('/signin')
- }
-
const updateEmail = async (lastToken: string) => {
try {
await resetEmail({
new_email: mail.trim(),
token: lastToken,
})
- handleLogout()
+ await logout()
} catch (error) {
toast.error(`Error changing email: ${getErrorMessage(error)}`)
}
diff --git a/web/app/account/(commonLayout)/avatar.tsx b/web/app/account/(commonLayout)/avatar.tsx
index 4ec407c141c..6d14e67bd8e 100644
--- a/web/app/account/(commonLayout)/avatar.tsx
+++ b/web/app/account/(commonLayout)/avatar.tsx
@@ -9,15 +9,12 @@ import {
} from '@langgenius/dify-ui/dropdown-menu'
import { useQuery, useSuspenseQuery } from '@tanstack/react-query'
import { useTranslation } from 'react-i18next'
-import { resetUser } from '@/app/components/base/amplitude/utils'
import PremiumBadge from '@/app/components/base/premium-badge'
import { userProfileQueryOptions } from '@/features/account-profile/client'
-import { useRouter } from '@/next/navigation'
import { consoleQuery } from '@/service/console'
import { useLogout } from '@/service/use-common'
export default function AppSelector() {
- const router = useRouter()
const { t } = useTranslation(['common'])
// Cache is hydrated by CommonLayoutHydrationBoundary; this hits cache synchronously.
const { data: userProfileResp } = useSuspenseQuery(userProfileQueryOptions())
@@ -34,19 +31,10 @@ export default function AppSelector() {
}),
)
- const { mutateAsync: logout } = useLogout()
+ const { mutate: logout } = useLogout()
if (!userProfile) return null
- const handleLogout = async () => {
- await logout()
-
- resetUser()
- // Tokens are now stored in cookies and cleared by backend
-
- router.push('/signin')
- }
-
return (
<DropdownMenu modal={false}>
<DropdownMenuTrigger
@@ -83,7 +71,7 @@ export default function AppSelector() {
</div>
</div>
<div className="p-1">
- <DropdownMenuItem className="h-9 justify-start px-3" onClick={handleLogout}>
+ <DropdownMenuItem className="h-9 justify-start px-3" onClick={() => logout()}>
<span
aria-hidden="true"
className="mr-1 i-custom-vender-line-general-log-out-01 flex size-4 text-text-tertiary"
diff --git a/web/app/account/(commonLayout)/delete-account/components/__tests__/feed-back.spec.tsx b/web/app/account/(commonLayout)/delete-account/components/__tests__/feed-back.spec.tsx
index cb2ba95c48b..0e140bb194e 100644
--- a/web/app/account/(commonLayout)/delete-account/components/__tests__/feed-back.spec.tsx
+++ b/web/app/account/(commonLayout)/delete-account/components/__tests__/feed-back.spec.tsx
@@ -2,7 +2,7 @@ import { render, screen, waitFor } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import FeedBack from '../feed-back'
-const mockPush = vi.fn()
+const mockUseLogout = vi.fn()
const mockSendFeedback = vi.fn()
const mockLogout = vi.fn()
@@ -20,16 +20,8 @@ vi.mock('@tanstack/react-query', async (importOriginal) => {
}
})
-vi.mock('@/next/navigation', () => ({
- useRouter: () => ({ push: mockPush }),
-}))
-
vi.mock('@/service/use-common', () => ({
- useLogout: () => ({ mutateAsync: mockLogout }),
-}))
-
-vi.mock('@/app/notifications', () => ({
- toast: { info: vi.fn() },
+ useLogout: (...args: unknown[]) => mockUseLogout(...args),
}))
vi.mock('../../state', () => ({
@@ -44,6 +36,7 @@ describe('FeedBack', () => {
vi.clearAllMocks()
mockSendFeedback.mockResolvedValue(undefined)
mockLogout.mockResolvedValue(undefined)
+ mockUseLogout.mockReturnValue({ mutateAsync: mockLogout })
})
it('labels and submits the optional feedback field through the form', async () => {
@@ -64,6 +57,6 @@ describe('FeedBack', () => {
})
expect(onConfirm).toHaveBeenCalledOnce()
expect(mockLogout).toHaveBeenCalledOnce()
- expect(mockPush).toHaveBeenCalledWith('/signin')
+ expect(mockUseLogout).toHaveBeenCalledWith({ redirectTo: '/signin?account_deleted=true' })
})
})
diff --git a/web/app/account/(commonLayout)/delete-account/components/feed-back.tsx b/web/app/account/(commonLayout)/delete-account/components/feed-back.tsx
index 5cb357a169a..85321c08326 100644
--- a/web/app/account/(commonLayout)/delete-account/components/feed-back.tsx
+++ b/web/app/account/(commonLayout)/delete-account/components/feed-back.tsx
@@ -7,9 +7,7 @@ import { Textarea } from '@langgenius/dify-ui/textarea'
import { useSuspenseQuery } from '@tanstack/react-query'
import { useCallback } from 'react'
import { useTranslation } from 'react-i18next'
-import { toast } from '@/app/notifications'
import { userProfileQueryOptions } from '@/features/account-profile/client'
-import { useRouter } from '@/next/navigation'
import { useLogout } from '@/service/use-common'
import { useDeleteAccountFeedback } from '../state'
@@ -28,20 +26,16 @@ export default function FeedBack(props: DeleteAccountProps) {
...userProfileQueryOptions(),
select: (data) => data.profile.email,
})
- const router = useRouter()
const { isPending, mutateAsync: sendFeedback } = useDeleteAccountFeedback()
- const { mutateAsync: logout } = useLogout()
+ const { mutateAsync: logout } = useLogout({ redirectTo: '/signin?account_deleted=true' })
const handleSuccess = useCallback(async () => {
try {
await logout()
- // Tokens are now stored in cookies and cleared by backend
- router.push('/signin')
- toast.info(t(($) => $['account.deleteSuccessTip'], { ns: 'accountSettings' }))
} catch (error) {
console.error(error)
}
- }, [logout, router, t])
+ }, [logout])
const handleSubmit = useCallback(
async (feedback: string) => {
diff --git a/web/app/account/oauth/authorize/__tests__/page.spec.tsx b/web/app/account/oauth/authorize/__tests__/page.spec.tsx
index db5d2465f0d..24acf521a8b 100644
--- a/web/app/account/oauth/authorize/__tests__/page.spec.tsx
+++ b/web/app/account/oauth/authorize/__tests__/page.spec.tsx
@@ -7,6 +7,8 @@ import OAuthAuthorize from '../page'
const mocks = vi.hoisted(() => ({
profileLoggedIn: true,
+ logoutError: false,
+ replaceDocument: vi.fn(),
push: vi.fn(),
replace: vi.fn(),
request: vi.fn(),
@@ -64,6 +66,10 @@ function findRequest(path: string) {
function mockProviderResponses({ autoAuthorize }: { autoAuthorize: boolean }) {
mocks.request.mockImplementation(async (url: string) => {
+ if (url.endsWith('/logout')) {
+ if (mocks.logoutError) throw new Error('Logout failed')
+ return jsonResponse({ result: 'success' })
+ }
if (url.endsWith('/oauth/provider/authorize')) return jsonResponse({ code: 'oauth-code' })
if (url.endsWith('/oauth/provider')) {
return jsonResponse({
@@ -85,6 +91,7 @@ describe('OAuthAuthorize', () => {
beforeEach(() => {
vi.clearAllMocks()
mocks.profileLoggedIn = true
+ mocks.logoutError = false
mocks.searchParams = new URLSearchParams({
client_id: 'client-1',
redirect_uri: 'https://client.example.com/callback',
@@ -94,6 +101,7 @@ describe('OAuthAuthorize', () => {
vi.stubGlobal('location', {
href: 'https://dify.test/account/oauth/authorize',
origin: 'https://dify.test',
+ replace: mocks.replaceDocument,
})
})
@@ -101,6 +109,31 @@ describe('OAuthAuthorize', () => {
vi.unstubAllGlobals()
})
+ it('replaces the document when switching accounts and preserves the authorize URL', async () => {
+ const user = userEvent.setup()
+ renderPage()
+ await user.click(await screen.findByRole('button', { name: 'oauth.switchAccount' }))
+ await waitFor(() =>
+ expect(mocks.replaceDocument).toHaveBeenCalledExactlyOnceWith(
+ `/signin?redirect_url=${encodeURIComponent(`https://dify.test/account/oauth/authorize?${mocks.searchParams.toString()}`)}`,
+ ),
+ )
+ expect(findRequest('/logout')).toBeDefined()
+ expect(mocks.push).not.toHaveBeenCalled()
+ })
+
+ it('stays on the authorization page if switching accounts cannot log out', async () => {
+ const user = userEvent.setup()
+ mocks.logoutError = true
+ const error = vi.spyOn(console, 'error').mockImplementation(() => {})
+ renderPage()
+ await user.click(await screen.findByRole('button', { name: 'oauth.switchAccount' }))
+ await waitFor(() => expect(error).toHaveBeenCalled())
+ expect(mocks.replaceDocument).not.toHaveBeenCalled()
+ expect(mocks.push).not.toHaveBeenCalled()
+ error.mockRestore()
+ })
+
it('authorizes the displayed app and redirects with the returned code and state', async () => {
const user = userEvent.setup()
renderPage()
diff --git a/web/app/account/oauth/authorize/page.tsx b/web/app/account/oauth/authorize/page.tsx
index 65a9c186e91..080f1258f77 100644
--- a/web/app/account/oauth/authorize/page.tsx
+++ b/web/app/account/oauth/authorize/page.tsx
@@ -90,7 +90,9 @@ export default function OAuthAuthorize() {
const { mutateAsync: authorize, isPending: authorizing } = useMutation(
consoleQuery.oauth.provider.authorize.post.mutationOptions(),
)
- const { mutateAsync: logout } = useLogout()
+ const returnUrl = buildReturnUrl('/account/oauth/authorize', `?${searchParams.toString()}`)
+ const signInUrl = `/signin?redirect_url=${encodeURIComponent(returnUrl)}`
+ const { mutateAsync: logout } = useLogout({ redirectTo: signInUrl })
const { isAutoAuthorizing } = useSilentAuthorize({
authAppInfo,
authorize,
@@ -117,11 +119,10 @@ export default function OAuthAuthorize() {
const onLoginSwitchClick = async () => {
try {
- const returnUrl = buildReturnUrl('/account/oauth/authorize', `?${searchParams.toString()}`)
if (isLoggedIn) await logout()
- router.push(`/signin?redirect_url=${encodeURIComponent(returnUrl)}`)
+ else router.push(signInUrl)
} catch {
- router.push('/signin')
+ // The request layer reports logout failures; keep the current session on this page.
}
}
diff --git a/web/app/components/header/account-dropdown/__tests__/index.spec.tsx b/web/app/components/header/account-dropdown/__tests__/index.spec.tsx
index 50cec4eb742..f74c3068f76 100644
--- a/web/app/components/header/account-dropdown/__tests__/index.spec.tsx
+++ b/web/app/components/header/account-dropdown/__tests__/index.spec.tsx
@@ -1,22 +1,16 @@
-import { fireEvent, screen, waitFor } from '@testing-library/react'
+import { screen } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { renderToString } from 'react-dom/server'
-import { resetUser } from '@/app/components/base/amplitude/utils'
+import AccountAvatar from '@/app/account/(commonLayout)/avatar'
import AccountSection from '@/app/components/main-nav/components/account-section'
+import EducationUserInfo from '@/app/education/user-info'
import { useLogout } from '@/service/use-common'
import { createAccountProfileQueryClient } from '@/test/console/account-profile'
import { renderWithConsoleQuery } from '@/test/console/query-data'
import AccountDropdown from '../index'
-const { mockPush, mockResetUser, mockSetSettingsDestination, mockUseRouter } = vi.hoisted(() => ({
- mockPush: vi.fn(),
- mockResetUser: vi.fn(),
+const { mockSetSettingsDestination } = vi.hoisted(() => ({
mockSetSettingsDestination: vi.fn(),
- mockUseRouter: vi.fn(),
-}))
-
-vi.mock('@/app/components/base/amplitude/utils', () => ({
- resetUser: mockResetUser,
}))
vi.mock('@/service/use-common', async (importOriginal) => ({
@@ -24,14 +18,6 @@ vi.mock('@/service/use-common', async (importOriginal) => ({
useLogout: vi.fn(),
}))
-vi.mock('@/next/navigation', async (importOriginal) => {
- const actual = await importOriginal<typeof import('@/next/navigation')>()
- return {
- ...actual,
- useRouter: mockUseRouter,
- }
-})
-
vi.mock('nuqs', async (importOriginal) => {
const actual = await importOriginal<typeof import('nuqs')>()
return {
@@ -72,9 +58,8 @@ describe('AccountDropdown', () => {
beforeEach(() => {
vi.clearAllMocks()
- mockUseRouter.mockReturnValue({ push: mockPush })
vi.mocked(useLogout).mockReturnValue({
- mutateAsync: mockLogout,
+ mutate: mockLogout,
} as unknown as ReturnType<typeof useLogout>)
})
@@ -160,17 +145,35 @@ describe('AccountDropdown', () => {
expect(mockSetSettingsDestination).toHaveBeenCalledWith('preferences')
})
- it('logs out and redirects to sign in', async () => {
- mockLogout.mockResolvedValue({})
- renderAccountDropdown()
-
- fireEvent.click(screen.getByRole('button', { name: 'accountSettings.account.account' }))
- fireEvent.click(await screen.findByText('common.userProfile.logout'))
-
- await waitFor(() => {
- expect(mockLogout).toHaveBeenCalledOnce()
- expect(resetUser).toHaveBeenCalledOnce()
- expect(mockPush).toHaveBeenCalledWith('/signin')
- })
- })
+ it.each(['main navigation', 'account page', 'education'] as const)(
+ 'logs out through the shared session boundary from %s',
+ async (surface) => {
+ const user = userEvent.setup()
+ if (surface === 'main navigation') {
+ renderAccountDropdown()
+ } else {
+ renderWithConsoleQuery(
+ surface === 'account page' ? <AccountAvatar /> : <EducationUserInfo />,
+ {
+ queryClient: createAccountProfileQueryClient(userProfile),
+ features: { education: { enabled: false } },
+ },
+ )
+ }
+ if (surface !== 'education') {
+ await user.click(
+ screen.getByRole('button', {
+ name:
+ surface === 'main navigation' ? 'accountSettings.account.account' : 'Current User',
+ }),
+ )
+ }
+ await user.click(
+ await screen.findByRole(surface === 'education' ? 'button' : 'menuitem', {
+ name: 'common.userProfile.logout',
+ }),
+ )
+ expect(mockLogout).toHaveBeenCalledExactlyOnceWith()
+ },
+ )
})
diff --git a/web/app/components/header/account-dropdown/index.tsx b/web/app/components/header/account-dropdown/index.tsx
index ef5a657e4f3..81411c34163 100644
--- a/web/app/components/header/account-dropdown/index.tsx
+++ b/web/app/components/header/account-dropdown/index.tsx
@@ -8,8 +8,6 @@ import {
} from '@langgenius/dify-ui/dropdown-menu'
import { useSyncExternalStore } from 'react'
import { useTranslation } from 'react-i18next'
-import { resetUser } from '@/app/components/base/amplitude/utils'
-import { useRouter } from '@/next/navigation'
import { useLogout } from '@/service/use-common'
import { MainNavMenuContent } from './main-nav-menu-content'
@@ -25,7 +23,6 @@ const getHydrationSnapshot = () => false
const getServerHydrationSnapshot = () => true
export default function AccountDropdown({ trigger }: AccountDropdownProps) {
- const router = useRouter()
const isHydrating = useSyncExternalStore(
subscribeHydrationState,
getHydrationSnapshot,
@@ -33,15 +30,7 @@ export default function AccountDropdown({ trigger }: AccountDropdownProps) {
)
const { t } = useTranslation(['accountSettings'])
- const { mutateAsync: logout } = useLogout()
-
- const handleLogout = async () => {
- await logout()
- resetUser()
- // Tokens are now stored in cookies and cleared by backend
-
- router.push('/signin')
- }
+ const { mutate: logout } = useLogout()
return (
<div>
@@ -58,7 +47,7 @@ export default function AccountDropdown({ trigger }: AccountDropdownProps) {
alignOffset={4}
className={mainNavMenuPopupClassName}
>
- <MainNavMenuContent onLogout={handleLogout} />
+ <MainNavMenuContent onLogout={() => logout()} />
</DropdownMenuContent>
</DropdownMenu>
</div>
diff --git a/web/app/components/header/account-dropdown/main-nav-menu-content.tsx b/web/app/components/header/account-dropdown/main-nav-menu-content.tsx
index 82dc203d1e0..974215d6a99 100644
--- a/web/app/components/header/account-dropdown/main-nav-menu-content.tsx
+++ b/web/app/components/header/account-dropdown/main-nav-menu-content.tsx
@@ -114,7 +114,7 @@ function AppearanceSubmenu() {
}
type MainNavMenuContentProps = {
- onLogout: () => Promise<void>
+ onLogout: () => void
}
export function MainNavMenuContent({ onLogout }: MainNavMenuContentProps) {
@@ -197,7 +197,7 @@ export function MainNavMenuContent({ onLogout }: MainNavMenuContentProps) {
<DropdownMenuItem
className="mx-0 h-8 gap-1 px-3 py-1"
onClick={() => {
- void onLogout()
+ onLogout()
}}
>
<MenuItemContent
diff --git a/web/app/education/user-info.tsx b/web/app/education/user-info.tsx
index 7d81a85b6ec..4036212d3cc 100644
--- a/web/app/education/user-info.tsx
+++ b/web/app/education/user-info.tsx
@@ -3,22 +3,16 @@ import { Button } from '@langgenius/dify-ui/button'
import { useSuspenseQuery } from '@tanstack/react-query'
import { useTranslation } from 'react-i18next'
import { userProfileQueryOptions } from '@/features/account-profile/client'
-import { useRouter } from '@/next/navigation'
import { useLogout } from '@/service/use-common'
const UserInfo = () => {
- const router = useRouter()
const { t } = useTranslation(['common', 'education'])
const { data: userProfile } = useSuspenseQuery({
...userProfileQueryOptions(),
select: (data) => data.profile,
})
- const { mutateAsync: logout } = useLogout()
- const handleLogout = async () => {
- await logout()
- router.push('/signin')
- }
+ const { mutate: logout } = useLogout()
return (
<div className="relative flex items-center justify-between rounded-xl border-4 border-components-panel-on-panel-item-bg bg-linear-to-r from-background-gradient-bg-fill-chat-bg-2 to-background-gradient-bg-fill-chat-bg-1 pt-9 pr-8 pb-6 pl-6 shadow-shadow-shadow-5">
@@ -43,7 +37,7 @@ const UserInfo = () => {
<div className="system-sm-regular text-text-secondary">{userProfile.email}</div>
</div>
</div>
- <Button variant="secondary" onClick={handleLogout}>
+ <Button variant="secondary" onClick={() => logout()}>
{t(($) => $['userProfile.logout'], { ns: 'common' })}
</Button>
</div>
diff --git a/web/app/signin/__tests__/page.spec.tsx b/web/app/signin/__tests__/page.spec.tsx
index 7ca27214d30..e9ec3606b75 100644
--- a/web/app/signin/__tests__/page.spec.tsx
+++ b/web/app/signin/__tests__/page.spec.tsx
@@ -1,4 +1,5 @@
import { screen } from '@testing-library/react'
+import { toast } from '@/app/notifications'
import { renderWithConsoleQuery as render } from '@/test/console/query-data'
import SignInPage from '../sign-in-page'
@@ -21,6 +22,19 @@ vi.mock('../one-more-step', () => ({
describe('SignIn', () => {
beforeEach(() => {
navigationMocks.searchParams = new URLSearchParams()
+ window.history.replaceState({}, '', '/signin')
+ vi.restoreAllMocks()
+ })
+
+ it('shows account deletion feedback once after the document replacement', () => {
+ const info = vi.spyOn(toast, 'info').mockReturnValue('toast-id')
+ window.history.replaceState({}, '', '/signin?account_deleted=true&other=value')
+ const view = render(<SignInPage />)
+ expect(info).toHaveBeenCalledExactlyOnceWith('accountSettings.account.deleteSuccessTip')
+ expect(window.location.search).toBe('?other=value')
+ view.unmount()
+ render(<SignInPage />)
+ expect(info).toHaveBeenCalledOnce()
})
it('renders the sign-in form by default', () => {
diff --git a/web/app/signin/sign-in-page.tsx b/web/app/signin/sign-in-page.tsx
index 2635a7070f6..aabaa1655fd 100644
--- a/web/app/signin/sign-in-page.tsx
+++ b/web/app/signin/sign-in-page.tsx
@@ -1,10 +1,23 @@
'use client'
+import { useEffect } from 'react'
+import { useTranslation } from 'react-i18next'
+import { toast } from '@/app/notifications'
import { useSearchParams } from '@/next/navigation'
import NormalForm from './normal-form'
import OneMoreStep from './one-more-step'
const SignInPage = () => {
const searchParams = useSearchParams()
+ const { t } = useTranslation(['accountSettings'])
+
+ useEffect(() => {
+ const url = new URL(window.location.href)
+ if (url.searchParams.get('account_deleted') !== 'true') return
+
+ url.searchParams.delete('account_deleted')
+ window.history.replaceState(window.history.state, '', url)
+ toast.info(t(($) => $['account.deleteSuccessTip'], { ns: 'accountSettings' }))
+ }, [t])
if (searchParams.get('step') === 'next') return <OneMoreStep />
return <NormalForm />
diff --git a/web/context/__tests__/console-bootstrap.spec.tsx b/web/context/__tests__/console-bootstrap.spec.tsx
index 90848b6e48c..5e0ee0deace 100644
--- a/web/context/__tests__/console-bootstrap.spec.tsx
+++ b/web/context/__tests__/console-bootstrap.spec.tsx
@@ -2,7 +2,6 @@ import type { GetSystemFeaturesResponse } from '@dify/contracts/api/console/syst
import type { ReactNode } from 'react'
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { act, fireEvent, render, screen, waitFor } from '@testing-library/react'
-import userEvent from '@testing-library/user-event'
import { Provider as JotaiProvider, useAtomValue, useSetAtom } from 'jotai'
import { queryClientAtom } from 'jotai-tanstack-query'
import { useHydrateAtoms } from 'jotai/react/utils'
@@ -13,8 +12,6 @@ import { flushRegistrationSuccess } from '@/app/components/base/amplitude/regist
import { setAnalyticsConsent } from '@/app/components/base/analytics-consent/consent-store'
import { zendeskRuntime } from '@/app/components/base/zendesk/runtime'
import { ZENDESK_FIELD_IDS } from '@/config'
-import { consoleQuery } from '@/service/console'
-import { useLogout } from '@/service/use-common'
import { createSystemFeaturesFixture } from '@/test/console/system-features'
import { initialWorkspaceSummary } from '../app-context-defaults'
import {
@@ -32,7 +29,6 @@ import {
} from '../workspace-state'
const mockGetRequest = vi.hoisted(() => vi.fn())
-const mockPostRequest = vi.hoisted(() => vi.fn())
const mockGetPermissionKeys = vi.hoisted(() => vi.fn())
const mockPermissionKeysState = vi.hoisted(() => ({
datasetPermissionKeys: ['dataset.acl.edit'],
@@ -155,7 +151,6 @@ vi.mock('@/service/console', () => ({
rbac: {
myPermissions: {
get: {
- key: () => ['current-permissions'],
queryOptions: () => ({
queryKey: ['current-permissions'],
queryFn: mockGetPermissionKeys,
@@ -186,7 +181,7 @@ vi.mock('@/service/console', () => ({
vi.mock('@/service/base', () => ({
get: mockGetRequest,
- post: mockPostRequest,
+ post: vi.fn(),
}))
vi.mock('@/app/components/base/amplitude', () => ({
@@ -268,15 +263,6 @@ function ConsoleBootstrapProbe() {
)
}
-function LogoutButton() {
- const { isSuccess, mutateAsync: logout } = useLogout()
- return (
- <button type="button" onClick={() => void logout()}>
- {isSuccess ? 'Logged out' : 'Log out'}
- </button>
- )
-}
-
function TestQueryClientHydrator({
children,
queryClient,
@@ -379,52 +365,6 @@ describe('Console bootstrap', () => {
})
describe('Bootstrap atoms', () => {
- it('replaces account-scoped atom results after logout and the next account hydration', async () => {
- const user = userEvent.setup()
- const queryClient = new QueryClient({
- defaultOptions: { queries: { retry: false, staleTime: 5 * 60 * 1000 } },
- })
- const permissionQueryKey = consoleQuery.workspaces.current.rbac.myPermissions.get.key()
- const workspaceQueryKey = consoleQuery.workspaces.current.summary.get.key()
- queryClient.setQueryData(permissionQueryKey, {
- workspace: { permission_keys: ['agent.create'] },
- })
- queryClient.setQueryData(workspaceQueryKey, mockCurrentWorkspaceResponse)
- mockPostRequest.mockResolvedValueOnce({ result: 'success' })
- const tree = (showConsole: boolean) => (
- <JotaiProvider>
- <QueryClientProvider client={queryClient}>
- <TestQueryClientHydrator queryClient={queryClient}>
- <Suspense fallback={<span>loading</span>}>
- {showConsole && <ConsoleBootstrapProbe />}
- <LogoutButton />
- </Suspense>
- </TestQueryClientHydrator>
- </QueryClientProvider>
- </JotaiProvider>
- )
- const view = render(tree(true))
- expect(await screen.findByText('keys:agent.create')).toBeInTheDocument()
-
- await user.click(screen.getByRole('button', { name: 'Log out' }))
- await screen.findByRole('button', { name: 'Logged out' })
- view.rerender(tree(false))
- mockPermissionKeysState.permissionKeys = []
- act(() => {
- queryClient.setQueryData(permissionQueryKey, {
- workspace: { permission_keys: [] },
- })
- queryClient.setQueryData(workspaceQueryKey, {
- ...mockCurrentWorkspaceResponse,
- name: 'Next Workspace',
- })
- })
- view.rerender(tree(true))
-
- expect(await screen.findByText('keys:')).toBeInTheDocument()
- expect(await screen.findByText('workspace:Next Workspace')).toBeInTheDocument()
- })
-
it('should provide workspace, permissions, and loading state', async () => {
renderConsoleBootstrap()
diff --git a/web/context/auth-session-state.ts b/web/context/auth-session-state.ts
deleted file mode 100644
index 98d76d27f98..00000000000
--- a/web/context/auth-session-state.ts
+++ /dev/null
@@ -1,6 +0,0 @@
-'use client'
-
-import { atom } from 'jotai'
-
-// A QueryClient.clear() does not discard observers cached by atomWithQuery.
-export const authSessionRevisionAtom = atom(0)
diff --git a/web/context/permission-state.ts b/web/context/permission-state.ts
index ec42d88f843..011b608a5c8 100644
--- a/web/context/permission-state.ts
+++ b/web/context/permission-state.ts
@@ -4,10 +4,8 @@ import { atom } from 'jotai'
import { atomWithQuery } from 'jotai-tanstack-query'
import { consoleQuery } from '@/service/console'
import { emptyWorkspacePermissionKeys } from './app-context-normalizers'
-import { authSessionRevisionAtom } from './auth-session-state'
-const workspacePermissionKeysQueryAtom = atomWithQuery((get) => {
- get(authSessionRevisionAtom)
+const workspacePermissionKeysQueryAtom = atomWithQuery(() => {
return consoleQuery.workspaces.current.rbac.myPermissions.get.queryOptions()
})
diff --git a/web/context/workspace-state.ts b/web/context/workspace-state.ts
index ccd1db0dd52..bc66d1897ca 100644
--- a/web/context/workspace-state.ts
+++ b/web/context/workspace-state.ts
@@ -5,10 +5,8 @@ import { atomWithQuery } from 'jotai-tanstack-query'
import { consoleQuery } from '@/service/console'
import { initialWorkspaceSummary } from './app-context-defaults'
import { getWorkspaceRoleFlags, normalizeCurrentWorkspaceSummary } from './app-context-normalizers'
-import { authSessionRevisionAtom } from './auth-session-state'
-const currentWorkspaceQueryAtom = atomWithQuery((get) => {
- get(authSessionRevisionAtom)
+const currentWorkspaceQueryAtom = atomWithQuery(() => {
return consoleQuery.workspaces.current.summary.get.queryOptions({
select: normalizeCurrentWorkspaceSummary,
})
diff --git a/web/features/new-rag/__tests__/create-knowledge-page.spec.tsx b/web/features/new-rag/__tests__/create-knowledge-page.spec.tsx
index c4eb58bac5c..5f093d67446 100644
--- a/web/features/new-rag/__tests__/create-knowledge-page.spec.tsx
+++ b/web/features/new-rag/__tests__/create-knowledge-page.spec.tsx
@@ -2,6 +2,7 @@ import type { ReactNode } from 'react'
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { act, render, screen, waitFor, within } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
+import { confirmPageLeave } from '@/utils/page-leave-guard'
import { CreateKnowledgePage } from '../create-knowledge-page'
import { newKnowledgeSourceDraftStorageKey } from '../routes'
@@ -856,6 +857,11 @@ describe('CreateKnowledgePage', () => {
act(() => window.dispatchEvent(event))
expect(event.defaultPrevented).toBe(true)
+ const confirm = vi.fn().mockReturnValue(false)
+ vi.stubGlobal('confirm', confirm)
+ expect(confirmPageLeave()).toBe(false)
+ expect(confirm).toHaveBeenCalledWith('dataset.newKnowledge.discardDraftDescription')
+ vi.unstubAllGlobals()
})
it('asks before leaving an unsaved draft with browser Back', async () => {
diff --git a/web/features/new-rag/add-source-page.tsx b/web/features/new-rag/add-source-page.tsx
index e327eb0a6e8..be637d6bbdd 100644
--- a/web/features/new-rag/add-source-page.tsx
+++ b/web/features/new-rag/add-source-page.tsx
@@ -18,6 +18,7 @@ import { LoadingPlaceholder } from '@/app/components/base/loading-placeholder'
import { useRefWithInit } from '@/hooks/use-ref-with-init'
import { useRouter } from '@/next/navigation'
import { consoleClient, consoleQuery } from '@/service/console'
+import { registerPageLeaveGuard } from '@/utils/page-leave-guard'
import { PendingWebsiteSetup, UnavailableConnectedSourceSetup } from './add-source-placeholder'
import { AddSourceExitDialog } from './components/add-source-exit-dialog'
import {
@@ -885,13 +886,11 @@ export function AddSourcePage({
useEffect(() => {
if (!hasUnsavedChanges) return
- const handleBeforeUnload = (event: BeforeUnloadEvent) => {
- event.preventDefault()
- event.returnValue = ''
- }
- globalThis.addEventListener('beforeunload', handleBeforeUnload)
- return () => globalThis.removeEventListener('beforeunload', handleBeforeUnload)
- }, [hasUnsavedChanges])
+ return registerPageLeaveGuard({
+ message: t(($) => $['newKnowledge.discardSourceDraftDescription']),
+ shouldBlock: () => true,
+ })
+ }, [hasUnsavedChanges, t])
useEffect(() => {
if (!hasUnsavedChanges) return
diff --git a/web/features/new-rag/create-knowledge-page.tsx b/web/features/new-rag/create-knowledge-page.tsx
index 32d5bf88c80..8ffd3c4748d 100644
--- a/web/features/new-rag/create-knowledge-page.tsx
+++ b/web/features/new-rag/create-knowledge-page.tsx
@@ -36,6 +36,7 @@ import { workspacePermissionKeysAtom } from '@/context/permission-state'
import useDocumentTitle from '@/hooks/use-document-title'
import { useRouter, useSearchParams } from '@/next/navigation'
import { consoleClient, consoleQuery } from '@/service/console'
+import { registerPageLeaveGuard } from '@/utils/page-leave-guard'
import { DatasetACLPermission, hasPermission } from '@/utils/permission'
import { KnowledgeIllustration, StartMode } from './components/create-knowledge-dialog-parts'
import { CreateKnowledgeExitDialog } from './components/create-knowledge-exit-dialog'
@@ -199,15 +200,11 @@ export function CreateKnowledgePage() {
useEffect(() => {
if (!hasUnsavedChanges) return
-
- const handleBeforeUnload = (event: BeforeUnloadEvent) => {
- event.preventDefault()
- event.returnValue = ''
- }
-
- globalThis.addEventListener('beforeunload', handleBeforeUnload)
- return () => globalThis.removeEventListener('beforeunload', handleBeforeUnload)
- }, [hasUnsavedChanges])
+ return registerPageLeaveGuard({
+ message: t(($) => $['newKnowledge.discardDraftDescription']),
+ shouldBlock: () => true,
+ })
+ }, [hasUnsavedChanges, t])
const resetUnsubmittedError = () => {
if (!submissionLocked) createMutation.reset()
diff --git a/web/features/new-rag/website-crawl-preview.tsx b/web/features/new-rag/website-crawl-preview.tsx
index f283aba844e..b83226ff4f0 100644
--- a/web/features/new-rag/website-crawl-preview.tsx
+++ b/web/features/new-rag/website-crawl-preview.tsx
@@ -23,6 +23,7 @@ import { useTranslation } from 'react-i18next'
import { useRefWithInit } from '@/hooks/use-ref-with-init'
import { useRouter } from '@/next/navigation'
import { consoleClient } from '@/service/console'
+import { registerPageLeaveGuard } from '@/utils/page-leave-guard'
import { CrawlSelectionForm } from './crawl-selection-form'
import { createRequestId } from './request-id'
import {
@@ -420,14 +421,11 @@ export function WebsiteCrawlPreview({
useEffect(() => {
if (!dirty) return
- const preventUnsavedUnload = (event: BeforeUnloadEvent) => {
- if (submittedRef.current) return
- event.preventDefault()
- event.returnValue = ''
- }
- window.addEventListener('beforeunload', preventUnsavedUnload)
- return () => window.removeEventListener('beforeunload', preventUnsavedUnload)
- }, [dirty])
+ return registerPageLeaveGuard({
+ message: t(($) => $['newKnowledge.discardSourceChangesDescription']),
+ shouldBlock: () => !submittedRef.current,
+ })
+ }, [dirty, t])
useEffect(() => {
if ((!dirty && !historyGuardRef.current) || submittedRef.current) return
diff --git a/web/service/common.spec.ts b/web/service/common.spec.ts
index cfbf09ad331..97394bb2bd4 100644
--- a/web/service/common.spec.ts
+++ b/web/service/common.spec.ts
@@ -2,16 +2,20 @@ import type { ReactNode } from 'react'
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { act, renderHook } from '@testing-library/react'
import { createElement } from 'react'
-import { beforeEach, describe, expect, it, vi } from 'vite-plus/test'
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vite-plus/test'
import {
OAUTH_REGISTRATION_GA_SENT_KEY,
REGISTRATION_SUCCESS_STORAGE_KEY,
} from '@/app/components/base/amplitude/registration-session-state'
+import { clearPageLeaveGuards, registerPageLeaveGuard } from '@/utils/page-leave-guard'
import { emailLoginWithCode, sendEMailLoginCode } from './common'
import { useLogout } from './use-common'
const mocks = vi.hoisted(() => ({
post: vi.fn(),
+ request: vi.fn(),
+ resetUser: vi.fn(),
+ basePath: '',
}))
vi.mock('./base', () => ({
@@ -19,6 +23,15 @@ vi.mock('./base', () => ({
get: vi.fn(),
patch: vi.fn(),
post: mocks.post,
+ request: mocks.request,
+}))
+
+vi.mock('@/app/components/base/amplitude/utils', () => ({ resetUser: mocks.resetUser }))
+vi.mock('@/utils/var', async (importOriginal) => ({
+ ...(await importOriginal<typeof import('@/utils/var')>()),
+ get basePath() {
+ return mocks.basePath
+ },
}))
describe('sendEMailLoginCode', () => {
@@ -79,27 +92,143 @@ describe('emailLoginWithCode', () => {
})
describe('useLogout', () => {
+ const wrapper = ({ children }: { children: ReactNode }) =>
+ createElement(QueryClientProvider, { client: new QueryClient() }, children)
+
beforeEach(() => {
vi.clearAllMocks()
+ mocks.basePath = ''
window.sessionStorage.clear()
})
- it('discards registration delivery state after a successful logout', async () => {
- const queryClient = new QueryClient()
- queryClient.setQueryData(['account-profile'], { id: 'previous-user' })
+ afterEach(() => {
+ clearPageLeaveGuards()
+ vi.unstubAllGlobals()
+ vi.restoreAllMocks()
+ })
+
+ it.each(['', '/console'])(
+ 'clears persisted session identity and replaces the document with base path "%s"',
+ async (basePath) => {
+ mocks.basePath = basePath
+ const replace = vi.spyOn(window.location, 'replace').mockImplementation(() => {})
+ window.sessionStorage.setItem(REGISTRATION_SUCCESS_STORAGE_KEY, 'pending-marker')
+ window.sessionStorage.setItem(OAUTH_REGISTRATION_GA_SENT_KEY, 'true')
+ let finishLogout!: (response: Response) => void
+ mocks.request.mockReturnValue(
+ new Promise<Response>((resolve) => {
+ finishLogout = resolve
+ }),
+ )
+ const { result } = renderHook(() => useLogout(), { wrapper })
+ let logout!: Promise<unknown>
+ await act(async () => {
+ logout = result.current.mutateAsync()
+ })
+ expect(replace).not.toHaveBeenCalled()
+ expect(mocks.resetUser).not.toHaveBeenCalled()
+ expect(window.sessionStorage.getItem(REGISTRATION_SUCCESS_STORAGE_KEY)).toBe('pending-marker')
+
+ await act(async () => {
+ finishLogout(new Response(JSON.stringify({ result: 'success' }), { status: 200 }))
+ await logout
+ })
+
+ expect(window.sessionStorage.getItem(REGISTRATION_SUCCESS_STORAGE_KEY)).toBeNull()
+ expect(window.sessionStorage.getItem(OAUTH_REGISTRATION_GA_SENT_KEY)).toBeNull()
+ expect(mocks.resetUser).toHaveBeenCalledOnce()
+ expect(replace).toHaveBeenCalledExactlyOnceWith(`${basePath}/signin`)
+ },
+ )
+
+ it('does not end the session when the user keeps an unsaved draft', async () => {
+ registerPageLeaveGuard({ message: 'Discard draft?', shouldBlock: () => true })
+ const confirm = vi.fn().mockReturnValue(false)
+ vi.stubGlobal('confirm', confirm)
+ const replace = vi.spyOn(window.location, 'replace').mockImplementation(() => {})
window.sessionStorage.setItem(REGISTRATION_SUCCESS_STORAGE_KEY, 'pending-marker')
- window.sessionStorage.setItem(OAUTH_REGISTRATION_GA_SENT_KEY, 'true')
- mocks.post.mockResolvedValueOnce({ result: 'success' })
- const wrapper = ({ children }: { children: ReactNode }) =>
- createElement(QueryClientProvider, { client: queryClient }, children)
const { result } = renderHook(() => useLogout(), { wrapper })
+ await act(async () => {
+ await expect(result.current.mutateAsync()).rejects.toThrow('Logout cancelled')
+ })
+
+ expect(confirm).toHaveBeenCalledExactlyOnceWith('Discard draft?')
+ expect(mocks.request).not.toHaveBeenCalled()
+ expect(mocks.resetUser).not.toHaveBeenCalled()
+ expect(replace).not.toHaveBeenCalled()
+ expect(window.sessionStorage.getItem(REGISTRATION_SUCCESS_STORAGE_KEY)).toBe('pending-marker')
+ const unload = new Event('beforeunload', { cancelable: true })
+ window.dispatchEvent(unload)
+ expect(unload.defaultPrevented).toBe(true)
+ })
+
+ it('confirms before logout and releases the guard only after success', async () => {
+ registerPageLeaveGuard({ message: 'Discard draft?', shouldBlock: () => true })
+ const confirm = vi.fn().mockReturnValue(true)
+ vi.stubGlobal('confirm', confirm)
+ let finishLogout!: (response: Response) => void
+ mocks.request.mockImplementation(() => {
+ expect(confirm).toHaveBeenCalledOnce()
+ const unload = new Event('beforeunload', { cancelable: true })
+ window.dispatchEvent(unload)
+ expect(unload.defaultPrevented).toBe(true)
+ return new Promise<Response>((resolve) => {
+ finishLogout = resolve
+ })
+ })
+ const unloadListener = vi.fn()
+ window.addEventListener('beforeunload', unloadListener)
+ const replace = vi.spyOn(window.location, 'replace').mockImplementation(() => {
+ const unload = new Event('beforeunload', { cancelable: true })
+ window.dispatchEvent(unload)
+ expect(unload.defaultPrevented).toBe(false)
+ })
+ const { result } = renderHook(() => useLogout(), { wrapper })
+ let logout!: Promise<unknown>
+ await act(async () => {
+ logout = result.current.mutateAsync()
+ })
+ expect(replace).not.toHaveBeenCalled()
+ await act(async () => {
+ finishLogout(new Response(JSON.stringify({ result: 'success' }), { status: 200 }))
+ await logout
+ })
+ expect(replace).toHaveBeenCalledExactlyOnceWith('/signin')
+ // Autosave/lock-release listeners remain attached; only confirmation guards are removed.
+ expect(unloadListener).toHaveBeenCalledTimes(2)
+ window.removeEventListener('beforeunload', unloadListener)
+ })
+
+ it('preserves the OAuth return URL across the document replacement', async () => {
+ mocks.basePath = '/console'
+ mocks.request.mockResolvedValue(
+ new Response(JSON.stringify({ result: 'success' }), { status: 200 }),
+ )
+ const replace = vi.spyOn(window.location, 'replace').mockImplementation(() => {})
+ const redirectTo = `/signin?redirect_url=${encodeURIComponent('/console/account/oauth/authorize?client_id=app&state=value')}`
+ const { result } = renderHook(() => useLogout({ redirectTo }), { wrapper })
await act(async () => {
await result.current.mutateAsync()
})
+ expect(replace).toHaveBeenCalledExactlyOnceWith(`/console${redirectTo}`)
+ })
- expect(window.sessionStorage.getItem(REGISTRATION_SUCCESS_STORAGE_KEY)).toBeNull()
- expect(window.sessionStorage.getItem(OAUTH_REGISTRATION_GA_SENT_KEY)).toBeNull()
- expect(queryClient.getQueryData(['account-profile'])).toBeUndefined()
+ it('keeps the session identity and current document when logout fails', async () => {
+ registerPageLeaveGuard({ message: 'Discard draft?', shouldBlock: () => true })
+ vi.stubGlobal('confirm', vi.fn().mockReturnValue(true))
+ mocks.request.mockRejectedValue(new Error('Logout failed'))
+ window.sessionStorage.setItem(REGISTRATION_SUCCESS_STORAGE_KEY, 'pending-marker')
+ const replace = vi.spyOn(window.location, 'replace').mockImplementation(() => {})
+ const { result } = renderHook(() => useLogout(), { wrapper })
+ await act(async () => {
+ await expect(result.current.mutateAsync()).rejects.toThrow('Logout failed')
+ })
+ expect(replace).not.toHaveBeenCalled()
+ expect(mocks.resetUser).not.toHaveBeenCalled()
+ expect(window.sessionStorage.getItem(REGISTRATION_SUCCESS_STORAGE_KEY)).toBe('pending-marker')
+ const unload = new Event('beforeunload', { cancelable: true })
+ window.dispatchEvent(unload)
+ expect(unload.defaultPrevented).toBe(true)
})
})
diff --git a/web/service/use-common.ts b/web/service/use-common.ts
index 5f779ecd7c4..330584efcba 100644
--- a/web/service/use-common.ts
+++ b/web/service/use-common.ts
@@ -12,12 +12,14 @@ import type {
StructuredOutputRulesRequestBody,
StructuredOutputRulesResponse,
} from '@/models/common'
-import { queryOptions, useMutation, useQuery, useQueryClient } from '@tanstack/react-query'
-import { useSetAtom } from 'jotai'
+import { queryOptions, useMutation, useQuery } from '@tanstack/react-query'
import { discardRegistrationSessionState } from '@/app/components/base/amplitude/registration-session-state'
-import { authSessionRevisionAtom } from '@/context/auth-session-state'
+import { resetUser } from '@/app/components/base/amplitude/utils'
+import { clearPageLeaveGuards, confirmPageLeave } from '@/utils/page-leave-guard'
+import { basePath } from '@/utils/var'
// oxlint-disable-next-line no-restricted-imports
import { get, post } from './base'
+import { consoleQuery } from './console'
const NAME_SPACE = 'common'
@@ -146,26 +148,34 @@ export const useSchemaTypeDefinitions = () => {
})
}
-export const useLogout = () => {
- const queryClient = useQueryClient()
- const advanceAuthSession = useSetAtom(authSessionRevisionAtom)
- return useMutation({
- mutationKey: [NAME_SPACE, 'logout'],
- mutationFn: () => post('/logout'),
- onSuccess: () => {
- discardRegistrationSessionState()
- // Drop all cached queries so the post-logout /signin probe doesn't read
- // the previous user's profile (the userProfile queryKey is shared with
- // the (commonLayout) tree, which keeps observing it during React's
- // concurrent transition — gcTime: 0 is not enough on its own).
- // Nuclear over targeted: every new user-scoped query would otherwise
- // need to be remembered here. systemFeatures (user-agnostic) just
- // refetches once on the way to /signin, which is cheap.
- queryClient.clear()
- // Rebind account-scoped Jotai queries to the cleared cache.
- advanceAuthSession((revision) => revision + 1)
- },
- })
+export const useLogout = ({ redirectTo = '/signin' }: { redirectTo?: string } = {}) => {
+ return useMutation(
+ consoleQuery.logout.post.mutationOptions({
+ onMutate: () => {
+ // A cancelled native beforeunload prompt would otherwise leave this document
+ // alive after the server has logged out. Obtain consent before ending the session.
+ if (!confirmPageLeave()) throw new Error('Logout cancelled')
+ },
+ onSuccess: () => {
+ // Registration markers and Analytics identity can survive a page reload,
+ // so clear them explicitly after the server has ended the session.
+ discardRegistrationSessionState()
+ resetUser()
+ // Client-side navigation keeps root providers and account-scoped stores alive.
+ // QueryClient.clear() alone is insufficient: atomWithQuery caches observers
+ // that can remain attached to removed Query instances and expose old results
+ // when another account signs in with the same query keys (see #42809).
+ // Replace the document to recreate all stores and observers for the next
+ // session, without maintaining a reset dependency on every account-scoped atom.
+ // Native navigation needs the deployment base path added explicitly; redirectTo
+ // also preserves flow-specific sign-in parameters such as the OAuth return URL.
+ // Consent was obtained before the request. Keep guards on failure, but remove
+ // them on success so the browser cannot cancel the required document reset.
+ clearPageLeaveGuards()
+ window.location.replace(`${basePath}${redirectTo}`)
+ },
+ }),
+ )
}
type ForgotPasswordValidity = CommonResponse & { is_valid: boolean; email: string; token: string }
diff --git a/web/utils/page-leave-guard.ts b/web/utils/page-leave-guard.ts
new file mode 100644
index 00000000000..95e54005ad1
--- /dev/null
+++ b/web/utils/page-leave-guard.ts
@@ -0,0 +1,37 @@
+type PageLeaveGuard = {
+ message: string
+ shouldBlock: () => boolean
+}
+
+// Keep confirmation guards separate from beforeunload listeners that save drafts
+// or release locks. Probing them by dispatching beforeunload would run those effects.
+const guards = new Map<PageLeaveGuard, () => void>()
+
+export function registerPageLeaveGuard(guard: PageLeaveGuard) {
+ const handleBeforeUnload = (event: BeforeUnloadEvent) => {
+ if (!guard.shouldBlock()) return
+ event.preventDefault()
+ event.returnValue = ''
+ }
+ const unregister = () => {
+ window.removeEventListener('beforeunload', handleBeforeUnload)
+ guards.delete(guard)
+ }
+ guards.set(guard, unregister)
+ window.addEventListener('beforeunload', handleBeforeUnload)
+ return unregister
+}
+
+export function confirmPageLeave() {
+ const messages = [
+ ...new Set(
+ [...guards.keys()].filter((guard) => guard.shouldBlock()).map((guard) => guard.message),
+ ),
+ ]
+ // oxlint-disable-next-line eslint/no-alert -- Ask the browser's unsaved-changes confirmation before logout; beforeunload itself runs too late to cancel the server request.
+ return messages.length === 0 || window.confirm(messages.join('\n\n'))
+}
+
+export function clearPageLeaveGuards() {
+ for (const unregister of guards.values()) unregister()
+}