-
Notifications
You must be signed in to change notification settings - Fork 6
Use a Managed Export CSV component that handles various states #1222
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
cd2342d
draft
khouadrired 0a2d0ba
use managed export button
khouadrired f7ec809
Merge branch 'main' into refactor-exportcsv-button
FranckLecuyer b487a09
fix sonar issue
khouadrired bf6111d
Merge branch 'main' into refactor-exportcsv-button
FranckLecuyer d333f66
Merge branch 'main' into refactor-exportcsv-button
FranckLecuyer 2537b0f
Merge branch 'main' into refactor-exportcsv-button
FranckLecuyer 6cab4fc
Merge branch 'main' into refactor-exportcsv-button
khouadrired 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
64 changes: 64 additions & 0 deletions
64
src/components/ui/csvDownloader/managed-export-csv-button.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,64 @@ | ||
| /* | ||
| * Copyright (c) 2025, RTE (http://www.rte-france.com) | ||
| * This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
| */ | ||
|
|
||
| import { useCallback, useEffect, useState } from 'react'; | ||
| import { ExportCsvButton } from './export-csv-button'; | ||
|
|
||
| export interface ManagedExportCsvButtonProps { | ||
| disabled?: boolean; | ||
| exportCsv: () => Promise<void>; | ||
| resetKey?: unknown; | ||
| onSuccess?: () => void; | ||
| onError?: (error: unknown) => void; | ||
| } | ||
|
|
||
| export function ManagedExportCsvButton({ | ||
| disabled = false, | ||
| exportCsv, | ||
| resetKey, | ||
| onSuccess, | ||
| onError, | ||
| }: ManagedExportCsvButtonProps) { | ||
|
Check warning on line 25 in src/components/ui/csvDownloader/managed-export-csv-button.tsx
|
||
| const [isLoading, setIsLoading] = useState(false); | ||
| const [isSuccessful, setIsSuccessful] = useState(false); | ||
|
|
||
| useEffect(() => { | ||
| setIsLoading(false); | ||
| setIsSuccessful(false); | ||
| }, [resetKey]); | ||
|
|
||
| useEffect(() => { | ||
| if (disabled) { | ||
| setIsSuccessful(false); | ||
| } | ||
| }, [disabled]); | ||
|
|
||
| const handleClick = useCallback(async () => { | ||
| setIsSuccessful(false); | ||
| setIsLoading(true); | ||
|
|
||
| try { | ||
| await exportCsv(); | ||
| setIsSuccessful(true); | ||
| onSuccess?.(); | ||
| } catch (error) { | ||
| setIsSuccessful(false); | ||
| onError?.(error); | ||
| } finally { | ||
| setIsLoading(false); | ||
| } | ||
| }, [exportCsv, onSuccess, onError]); | ||
|
|
||
| return ( | ||
| <ExportCsvButton | ||
| disabled={disabled || isLoading} | ||
| onClick={handleClick} | ||
| isDownloadLoading={isLoading} | ||
| isDownloadSuccessful={isSuccessful} | ||
| /> | ||
| ); | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🩺 Stability & Availability | 🟠 Major | ⚡ Quick win
Guard against state updates after unmount.
handleClickawaitsexportCsv()and then callssetIsSuccessful/setIsLoading/onSuccess/onErrorregardless of whether the component is still mounted. If the consumer unmounts while the export is in flight (e.g., navigating away mid-download), these calls will fire on an unmounted component, triggering React state-update warnings and potentially masking a stale closure overonSuccess/onError.🔧 Proposed fix using a mounted ref
📝 Committable suggestion
🤖 Prompt for AI Agents