-
Notifications
You must be signed in to change notification settings - Fork 797
frontend: warn user before token expiry and auto-logout on session end #5371
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.
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
Open
prabindersinghh
wants to merge
8
commits into
kubernetes-sigs:main
Choose a base branch
from
prabindersinghh:fix/token-expiry-5112
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
188f75b
backend: auth: Expose token expiry time in /me response
prabindersinghh 9c26885
frontend: Add TokenExpiryNotification session expiry warning banner
prabindersinghh 4582eb6
frontend: Add Vitest test coverage for TokenExpiryNotification
prabindersinghh d9dbdde
frontend: i18n: Update translation files
prabindersinghh bed0c63
frontend: auth: Simplify ClusterMeResult discriminated union for corr…
prabindersinghh 1f45747
frontend: TokenExpiryNotification: Stop polling immediately on token …
prabindersinghh efb150d
frontend: auth: Mark fetchClusterMe as internal non-plugin API
prabindersinghh 122e781
frontend: TokenExpiryNotification: Fix ref sync and clamp setTimeout …
prabindersinghh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
123 changes: 123 additions & 0 deletions
123
frontend/src/components/App/TokenExpiryNotification.test.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| /* | ||
| * Copyright 2025 The Kubernetes Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import { render, screen, waitFor } from '@testing-library/react'; | ||
| import { beforeEach, describe, expect, it, vi } from 'vitest'; | ||
| import type { ClusterMeResult } from '../../lib/auth'; | ||
| import { TestContext } from '../../test'; | ||
| import { PureTokenExpiryNotification } from './TokenExpiryNotification'; | ||
|
|
||
|
prabindersinghh marked this conversation as resolved.
|
||
| vi.mock('react-i18next', () => ({ | ||
| useTranslation: () => ({ | ||
| t: (key: string) => key.split('|')[1] || key, | ||
| }), | ||
| })); | ||
|
|
||
| const { mockLogout, mockGetCluster } = vi.hoisted(() => ({ | ||
| mockLogout: vi.fn().mockResolvedValue(undefined), | ||
| mockGetCluster: vi.fn().mockReturnValue('test-cluster'), | ||
| })); | ||
|
|
||
| vi.mock('../../lib/auth', async () => ({ | ||
| ...(await vi.importActual<typeof import('../../lib/auth')>('../../lib/auth')), | ||
| logout: (...args: any[]) => mockLogout(...args), | ||
| })); | ||
|
|
||
| vi.mock('../../lib/cluster', () => ({ | ||
| getCluster: () => mockGetCluster(), | ||
| })); | ||
|
|
||
| vi.mock('../../lib/router/getRoute', () => ({ | ||
| getRoute: (name: string) => { | ||
| const routes: Record<string, { path: string }> = { | ||
| login: { path: '/login' }, | ||
| token: { path: '/token' }, | ||
| settingsCluster: { path: '/settings' }, | ||
| }; | ||
| return routes[name] ?? null; | ||
| }, | ||
| })); | ||
|
prabindersinghh marked this conversation as resolved.
|
||
|
|
||
| vi.mock('../../lib/router/getRoutePath', () => ({ | ||
| getRoutePath: (route: { path: string }) => route.path, | ||
| })); | ||
|
|
||
| function makeFetch(result: ClusterMeResult) { | ||
| return vi.fn().mockResolvedValue(result); | ||
| } | ||
|
|
||
| describe('PureTokenExpiryNotification', () => { | ||
| beforeEach(() => { | ||
| mockLogout.mockReset().mockResolvedValue(undefined); | ||
| mockGetCluster.mockReturnValue('test-cluster'); | ||
| }); | ||
|
|
||
| it('shows warning banner when token expiry is within 2 minutes', async () => { | ||
| const expiry = Math.floor(Date.now() / 1000) + 90; | ||
| render( | ||
| <TestContext> | ||
| <PureTokenExpiryNotification | ||
| fetchClusterMeFn={makeFetch({ tokenExpired: false, data: { tokenExpiry: expiry } })} | ||
| /> | ||
| </TestContext> | ||
| ); | ||
|
|
||
| await waitFor(() => { | ||
| expect(screen.getByText(/Session expires in/)).toBeInTheDocument(); | ||
| }); | ||
| }); | ||
|
|
||
| it('shows no warning when token expiry is more than 2 minutes away', async () => { | ||
| const expiry = Math.floor(Date.now() / 1000) + 3600; | ||
| const fetchFn = makeFetch({ tokenExpired: false, data: { tokenExpiry: expiry } }); | ||
| render( | ||
| <TestContext> | ||
| <PureTokenExpiryNotification fetchClusterMeFn={fetchFn} /> | ||
| </TestContext> | ||
| ); | ||
|
|
||
| await waitFor(() => expect(fetchFn).toHaveBeenCalled()); | ||
| expect(screen.queryByText(/Session expires in/)).not.toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('calls logout when the backend reports the token as expired', async () => { | ||
| render( | ||
| <TestContext> | ||
| <PureTokenExpiryNotification | ||
| fetchClusterMeFn={makeFetch({ tokenExpired: true, data: null })} | ||
| /> | ||
| </TestContext> | ||
| ); | ||
|
|
||
| await waitFor(() => { | ||
| expect(mockLogout).toHaveBeenCalledWith('test-cluster'); | ||
| }); | ||
| }); | ||
|
|
||
| it('suppresses the banner on excluded routes', async () => { | ||
| const expiry = Math.floor(Date.now() / 1000) + 90; | ||
| const fetchFn = makeFetch({ tokenExpired: false, data: { tokenExpiry: expiry } }); | ||
| render( | ||
| <TestContext urlPrefix="/login"> | ||
| <PureTokenExpiryNotification fetchClusterMeFn={fetchFn} /> | ||
| </TestContext> | ||
| ); | ||
|
|
||
| await waitFor(() => expect(fetchFn).toHaveBeenCalled()); | ||
| expect(screen.queryByText(/Session expires in/)).not.toBeInTheDocument(); | ||
| expect(screen.queryByText(/Session expired/)).not.toBeInTheDocument(); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.