-
Notifications
You must be signed in to change notification settings - Fork 4
ECHOES-1357 Aggregate repeated same-text toasts of the same variety with a counter badge #693
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
david-cho-lerat-sonarsource
wants to merge
1
commit into
main
Choose a base branch
from
david/ECHOES-1357-aggregate-repeated-toasts
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| /* | ||
| * Echoes React | ||
| * Copyright (C) 2023-2025 SonarSource Sàrl | ||
| * mailto:info AT sonarsource DOT com | ||
| * | ||
| * This program is free software; you can redistribute it and/or | ||
| * modify it under the terms of the GNU Lesser General Public | ||
| * License as published by the Free Software Foundation; either | ||
| * version 3 of the License, or (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| * Lesser General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Lesser General Public License | ||
| * along with this program; if not, write to the Free Software Foundation, | ||
| * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||
| */ | ||
|
|
||
| import { act, screen, waitFor, waitForElementToBeRemoved } from '@testing-library/react'; | ||
| import { type ToastId } from '~common/components/Toast'; | ||
| import { render } from '~common/helpers/test-utils'; | ||
| import { toast, ToastDuration } from '..'; | ||
|
|
||
| const trackedToastIds = new Set<ToastId>(); | ||
|
|
||
| const uploadCompleteToast = { | ||
| description: 'File uploaded', | ||
| title: 'Upload complete', | ||
| } as const; | ||
|
|
||
| function trackToastId(toastId: ToastId) { | ||
| trackedToastIds.add(toastId); | ||
|
|
||
| return toastId; | ||
| } | ||
|
|
||
| function resetToastTestState() { | ||
| act(() => { | ||
| for (const toastId of trackedToastIds) { | ||
| toast.dismiss(toastId); | ||
| } | ||
| }); | ||
|
|
||
| trackedToastIds.clear(); | ||
| jest.useRealTimers(); | ||
| } | ||
|
|
||
| describe('toast utility - automatic aggregation', () => { | ||
| afterEach(resetToastTestState); | ||
|
|
||
| it('should aggregate repeated toasts with the same plain-text content and variety', async () => { | ||
| render(<div />); | ||
|
|
||
| trackToastId(toast.success(uploadCompleteToast)); | ||
|
|
||
| expect(await screen.findByText('File uploaded')).toBeInTheDocument(); | ||
|
|
||
| trackToastId(toast.success(uploadCompleteToast)); | ||
| trackToastId(toast.success(uploadCompleteToast)); | ||
|
|
||
| expect(await screen.findByText('Shown 3 times')).toBeInTheDocument(); | ||
| expect(screen.getAllByText('File uploaded')).toHaveLength(1); | ||
| expect(screen.getByText('Upload complete')).toBeInTheDocument(); | ||
| expect(screen.getByText('3')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('should cap the visible repetition counter at 99 plus', async () => { | ||
| render(<div />); | ||
|
|
||
| for (let i = 0; i < 100; i++) { | ||
| trackToastId(toast.success(uploadCompleteToast)); | ||
| } | ||
|
|
||
| expect(await screen.findByText('Shown 100 times')).toBeInTheDocument(); | ||
| expect(screen.getByText('99+')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('should reset the aggregation count after a UI dismiss', async () => { | ||
| const { user } = render(<div />); | ||
|
|
||
| trackToastId( | ||
| toast.success({ | ||
| ...uploadCompleteToast, | ||
| duration: ToastDuration.Infinite, | ||
| isDismissable: true, | ||
| }), | ||
| ); | ||
|
|
||
| trackToastId( | ||
| toast.success({ | ||
| ...uploadCompleteToast, | ||
| duration: ToastDuration.Infinite, | ||
| isDismissable: true, | ||
| }), | ||
| ); | ||
|
|
||
| expect(await screen.findByText('Shown 2 times')).toBeInTheDocument(); | ||
|
|
||
| await user.click(screen.getByRole('button', { name: 'Dismiss toast' })); | ||
| await waitForElementToBeRemoved(() => screen.queryByText('File uploaded')); | ||
|
|
||
| trackToastId(toast.success(uploadCompleteToast)); | ||
|
|
||
| expect(await screen.findByText('File uploaded')).toBeInTheDocument(); | ||
| expect(screen.getAllByText('File uploaded')).toHaveLength(1); | ||
| expect(screen.queryByText('Shown 2 times')).not.toBeInTheDocument(); | ||
| expect(screen.queryByText('2')).not.toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('should reset aggregation after the first occurrence auto-closes', async () => { | ||
| jest.useFakeTimers(); | ||
| render(<div />); | ||
|
|
||
| trackToastId( | ||
| toast.info({ | ||
| ...uploadCompleteToast, | ||
| duration: ToastDuration.Short, | ||
| }), | ||
| ); | ||
|
|
||
| expect(await screen.findByText('File uploaded')).toBeInTheDocument(); | ||
|
|
||
| act(() => { | ||
| jest.advanceTimersByTime(8000); | ||
| jest.runOnlyPendingTimers(); | ||
| }); | ||
|
|
||
| await waitFor(() => { | ||
| expect(screen.queryByText('File uploaded')).not.toBeInTheDocument(); | ||
| }); | ||
|
|
||
| trackToastId( | ||
| toast.info({ | ||
| ...uploadCompleteToast, | ||
| duration: ToastDuration.Short, | ||
| }), | ||
| ); | ||
|
|
||
| expect(await screen.findByText('File uploaded')).toBeInTheDocument(); | ||
| expect(screen.queryByText('Shown 2 times')).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.