Skip to content

Fix Export CSV Button success status for SA,SE,CC at context change #3272

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.

Sign up for GitHub

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
wants to merge 2 commits into
base: fix_export_csv_export_button_status
Choose a base branch
from
Open

Fix Export CSV Button success status for SA,SE,CC at context change #3272

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4dcdb8
fix(SA,SE,CC): reset `exportSuccessful` states when context like stud…
sBouzols Sep 15, 2025
22d8dc1
fix(SA, SE, CC): from review add `appTabIndex` trigger to reset expor…
sBouzols Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/components/results/securityanalysis/security-analysis-export-button.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export const SecurityAnalysisExportButton: FunctionComponent<SecurityAnalysisExp

useEffect(() => {
setIsCsvExportSuccessful(false);
}, [nodeUuid, resultType]);
}, [studyUuid, nodeUuid, rootNetworkUuid, resultType]);

useEffect(() => {
if (disabled) {
Expand Down
153 changes: 153 additions & 0 deletions src/components/results/sensitivity-analysis/sensitivity-analysis-export-button.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
/**
* 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 { FunctionComponent, useCallback, useEffect, useState } from 'react';
import { ExportButton } from '../../utils/export-button';
import { PARAM_LANGUAGE, useSnackMessage } from '@gridsuite/commons-ui';
import { downloadZipFile } from '../../../services/utils';
import { UUID } from 'crypto';
import { AppState } from 'redux/reducer';
import { useSelector } from 'react-redux';
import { useFilterSelector } from 'hooks/use-filter-selector';
import {
DATA_KEY_TO_FILTER_KEY_N,
DATA_KEY_TO_FILTER_KEY_NK,
DATA_KEY_TO_SORT_KEY,
FUNCTION_TYPES,
isSensiKind,
mappingTabs,
SensitivityResultTabs,
} from './sensitivity-analysis-result-utils';
import { exportSensitivityResultsAsCsv } from 'services/study/sensitivity-analysis';
import { SensiKind } from './sensitivity-analysis-result.type';
import { FilterType as AgGridFilterType, SortWay } from '../../../types/custom-aggrid-types';
import { SENSITIVITY_ANALYSIS_RESULT_SORT_STORE } from 'utils/store-sort-filter-fields';
import { GlobalFilters } from '../common/global-filter/global-filter-types';

interface SensitivityExportButtonProps {
studyUuid: UUID;
nodeUuid: UUID;
currentRootNetworkUuid: UUID;
csvHeaders: string[];
nOrNkIndex: number;
sensiKind: SensiKind;
globalFilters?: GlobalFilters;
disabled?: boolean;
}

export const SensitivityExportButton: FunctionComponent<SensitivityExportButtonProps> = (props) => {
const {
studyUuid,
nodeUuid,
currentRootNetworkUuid,
csvHeaders,
disabled = false,
nOrNkIndex,
sensiKind,
globalFilters,
} = props;
const { snackError } = useSnackMessage();

const [isCsvExportLoading, setIsCsvExportLoading] = useState(false);
const [isCsvExportSuccessful, setIsCsvExportSuccessful] = useState(false);

const language = useSelector((state: AppState) => state[PARAM_LANGUAGE]);
const { filters } = useFilterSelector(AgGridFilterType.SensitivityAnalysis, mappingTabs(sensiKind, nOrNkIndex));
const sortConfig = useSelector(
(state: AppState) => state.tableSort[SENSITIVITY_ANALYSIS_RESULT_SORT_STORE][mappingTabs(sensiKind, nOrNkIndex)]
);

useEffect(() => {
setIsCsvExportSuccessful(false);
}, [studyUuid, currentRootNetworkUuid, nodeUuid, nOrNkIndex, sensiKind, globalFilters]);

useEffect(() => {
if (disabled) {
// reinit the success state when the button is disabled,
// for example when the calcul status change or results change
setIsCsvExportSuccessful(false);
}
}, [disabled]);

const exportCsv = useCallback(() => {
setIsCsvExportLoading(true);
setIsCsvExportSuccessful(false);
const mappedFilters = filters?.map((elem) => {
const keyMap = nOrNkIndex === 0 ? DATA_KEY_TO_FILTER_KEY_N : DATA_KEY_TO_FILTER_KEY_NK;
const newColumn = keyMap[elem.column as keyof typeof keyMap];
return { ...elem, column: newColumn };
});
const sortSelector = sortConfig?.length
? {
sortKeysWithWeightAndDirection: Object.fromEntries(
sortConfig.map((value) => [
DATA_KEY_TO_SORT_KEY[value.colId as keyof typeof DATA_KEY_TO_SORT_KEY],
value.sort === SortWay.DESC ? -1 : 1,
])
),
}
: {};
const selector = {
tabSelection: SensitivityResultTabs[nOrNkIndex].id,
functionType: FUNCTION_TYPES[sensiKind],
offset: 0,
pageNumber: 0,
pageSize: -1, // meaning 'All'
...sortSelector,
};

exportSensitivityResultsAsCsv(
studyUuid,
nodeUuid,
currentRootNetworkUuid,
{
csvHeaders: csvHeaders,
resultTab: SensitivityResultTabs[nOrNkIndex].id,
sensitivityFunctionType: isSensiKind(sensiKind) ? FUNCTION_TYPES[sensiKind] : undefined,
language: language,
},
selector,
mappedFilters,
globalFilters
)
.then((response) => {
response.blob().then((blob: Blob) => {
downloadZipFile(blob, 'sensitivity_analyse_results.zip');
setIsCsvExportSuccessful(true);
});
})
.catch((error) => {
snackError({
messageTxt: error.message,
headerId: 'csvExportSensitivityResultError',
});
setIsCsvExportSuccessful(false);
})
.finally(() => setIsCsvExportLoading(false));
}, [
filters,
sortConfig,
nOrNkIndex,
sensiKind,
studyUuid,
nodeUuid,
currentRootNetworkUuid,
csvHeaders,
language,
globalFilters,
snackError,
]);

return (
<ExportButton
onClick={exportCsv}
disabled={disabled}
isDownloadLoading={isCsvExportLoading}
isDownloadSuccessful={isCsvExportSuccessful}
/>
);
};
136 changes: 13 additions & 123 deletions src/components/results/sensitivity-analysis/sensitivity-analysis-result-tab.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,20 @@
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/

import { SyntheticEvent, useCallback, useEffect, useMemo, useState } from 'react';
import { SyntheticEvent, useMemo, useState } from 'react';
import { Box, LinearProgress, Tab, Tabs } from '@mui/material';
import SensitivityAnalysisTabs from './sensitivity-analysis-tabs.js';
import PagedSensitivityAnalysisResult from './paged-sensitivity-analysis-result';
import {
DATA_KEY_TO_FILTER_KEY_N,
DATA_KEY_TO_FILTER_KEY_NK,
DATA_KEY_TO_SORT_KEY,
FUNCTION_TYPES,
isSensiKind,
mappingTabs,
SensitivityResultTabs,
} from './sensitivity-analysis-result-utils';
import { useSelector } from 'react-redux';
import { ComputationReportViewer } from '../common/computation-report-viewer';
import { RunningStatus } from '../../utils/running-status';
import { useOpenLoaderShortWait } from '../../dialogs/commons/handle-loader';
import { RESULTS_LOADING_DELAY } from '../../network/constants';
import { exportSensitivityResultsAsCsv } from '../../../services/study/sensitivity-analysis';
import { downloadZipFile } from '../../../services/utils';
import { ComputingType, PARAM_LANGUAGE, useSnackMessage } from '@gridsuite/commons-ui';
import { ExportButton } from '../../utils/export-button';
import { ComputingType } from '@gridsuite/commons-ui';
import { AppState } from '../../../redux/reducer';
import { UUID } from 'crypto';
import {
COMPUTATION_RESULTS_LOGS,
SensiKind,
SensiTab,
SENSITIVITY_AT_NODE,
SENSITIVITY_IN_DELTA_MW,
Expand All @@ -40,9 +27,8 @@ import useGlobalFilters from '../common/global-filter/use-global-filters';
import GlobalFilterSelector from '../common/global-filter/global-filter-selector';
import { EQUIPMENT_TYPES } from '../../utils/equipment-types';
import { useGlobalFilterOptions } from '../common/global-filter/use-global-filter-options';
import { useFilterSelector } from '../../../hooks/use-filter-selector';
import { FilterType as AgGridFilterType, SortWay } from '../../../types/custom-aggrid-types';
import { SENSITIVITY_ANALYSIS_RESULT_SORT_STORE } from '../../../utils/store-sort-filter-fields';
import { SensitivityExportButton } from './sensitivity-analysis-export-button.js';
import { isSensiKind, SensitivityResultTabs } from './sensitivity-analysis-result-utils.js';

export type SensitivityAnalysisResultTabProps = {
studyUuid: UUID;
Expand All @@ -55,38 +41,16 @@ function SensitivityAnalysisResultTab({
nodeUuid,
currentRootNetworkUuid,
}: Readonly<SensitivityAnalysisResultTabProps>) {
const { snackError } = useSnackMessage();
const [nOrNkIndex, setNOrNkIndex] = useState<number>(0);
const [sensiTab, setSensiTab] = useState<SensiTab>(SENSITIVITY_IN_DELTA_MW);
const [isCsvExportSuccessful, setIsCsvExportSuccessful] = useState<boolean>(false);
const [isCsvExportLoading, setIsCsvExportLoading] = useState<boolean>(false);
const sensitivityAnalysisStatus = useSelector(
(state: AppState) => state.computingStatus[ComputingType.SENSITIVITY_ANALYSIS]
);
const language = useSelector((state: AppState) => state[PARAM_LANGUAGE]);

const { globalFilters, handleGlobalFilterChange, getGlobalFilterParameter } = useGlobalFilters({});
const { countriesFilter, voltageLevelsFilter, propertiesFilter } = useGlobalFilterOptions();
const { filters } = useFilterSelector(
AgGridFilterType.SensitivityAnalysis,
mappingTabs(sensiTab as SensiKind, nOrNkIndex)
);
const sortConfig = useSelector(
(state: AppState) =>
state.tableSort[SENSITIVITY_ANALYSIS_RESULT_SORT_STORE][mappingTabs(sensiTab as SensiKind, nOrNkIndex)]
);

const initTable = () => {
setIsCsvExportSuccessful(false);
};

const handleSensiTabChange = (newSensiTab: SensiTab) => {
initTable();
setSensiTab(newSensiTab);
};

const handleSensiNOrNkIndexChange = (event: SyntheticEvent, newNOrNKIndex: number) => {
initTable();
setNOrNkIndex(newNOrNKIndex);
};

Expand All @@ -98,76 +62,6 @@ function SensitivityAnalysisResultTab({
const [csvHeaders, setCsvHeaders] = useState<string[]>([]);
const [isCsvButtonDisabled, setIsCsvButtonDisabled] = useState(true);

const handleExportResultAsCsv = useCallback(() => {
setIsCsvExportLoading(true);
setIsCsvExportSuccessful(false);
const mappedFilters = filters?.map((elem) => {
const keyMap = nOrNkIndex === 0 ? DATA_KEY_TO_FILTER_KEY_N : DATA_KEY_TO_FILTER_KEY_NK;
const newColumn = keyMap[elem.column as keyof typeof keyMap];
return { ...elem, column: newColumn };
});
const sortSelector = sortConfig?.length
? {
sortKeysWithWeightAndDirection: Object.fromEntries(
sortConfig.map((value) => [
DATA_KEY_TO_SORT_KEY[value.colId as keyof typeof DATA_KEY_TO_SORT_KEY],
value.sort === SortWay.DESC ? -1 : 1,
])
),
}
: {};
const selector = {
tabSelection: SensitivityResultTabs[nOrNkIndex].id,
functionType: FUNCTION_TYPES[sensiTab as SensiKind],
offset: 0,
pageNumber: 0,
pageSize: -1, // meaning 'All'
...sortSelector,
};

exportSensitivityResultsAsCsv(
studyUuid,
nodeUuid,
currentRootNetworkUuid,
{
csvHeaders: csvHeaders,
resultTab: SensitivityResultTabs[nOrNkIndex].id,
sensitivityFunctionType: isSensiKind(sensiTab) ? FUNCTION_TYPES[sensiTab] : undefined,
language: language,
},
selector,
mappedFilters,
getGlobalFilterParameter(globalFilters)
)
.then((response) => {
response.blob().then((blob: Blob) => {
downloadZipFile(blob, 'sensitivity_analyse_results.zip');
setIsCsvExportSuccessful(true);
});
})
.catch((error) => {
snackError({
messageTxt: error.message,
headerId: 'csvExportSensitivityResultError',
});
setIsCsvExportSuccessful(false);
})
.finally(() => setIsCsvExportLoading(false));
}, [
filters,
sortConfig,
nOrNkIndex,
sensiTab,
studyUuid,
nodeUuid,
currentRootNetworkUuid,
csvHeaders,
language,
getGlobalFilterParameter,
globalFilters,
snackError,
]);

const filterableEquipmentTypes: EQUIPMENT_TYPES[] = useMemo(() => {
return sensiTab === SENSITIVITY_AT_NODE ? [] : [EQUIPMENT_TYPES.TWO_WINDINGS_TRANSFORMER, EQUIPMENT_TYPES.LINE];
}, [sensiTab]);
Expand All @@ -177,17 +71,9 @@ function SensitivityAnalysisResultTab({
[voltageLevelsFilter, countriesFilter, propertiesFilter]
);

useEffect(() => {
if (isCsvButtonDisabled) {
// reinit the success state when the button is disabled,
// for example when the calcul status change or results change
setIsCsvExportSuccessful(false);
}
}, [isCsvButtonDisabled]);

return (
<>
<SensitivityAnalysisTabs sensiTab={sensiTab} setSensiTab={handleSensiTabChange} />
<SensitivityAnalysisTabs sensiTab={sensiTab} setSensiTab={setSensiTab} />
{isSensiKind(sensiTab) && (
<>
<Box
Expand All @@ -211,11 +97,15 @@ function SensitivityAnalysisResultTab({
disableGenericFilters={sensiTab === SENSITIVITY_AT_NODE}
/>
</Box>
<ExportButton
<SensitivityExportButton
studyUuid={studyUuid}
nodeUuid={nodeUuid}
currentRootNetworkUuid={currentRootNetworkUuid}
csvHeaders={csvHeaders}
nOrNkIndex={nOrNkIndex}
sensiKind={sensiTab}
globalFilters={getGlobalFilterParameter(globalFilters)}
disabled={isCsvButtonDisabled}
onClick={handleExportResultAsCsv}
isDownloadLoading={isCsvExportLoading}
isDownloadSuccessful={isCsvExportSuccessful}
/>
</Box>
<PagedSensitivityAnalysisResult
Expand Down
2 changes: 1 addition & 1 deletion src/components/results/shortcircuit/shortcircuit-analysis-export-button.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export const ShortCircuitExportButton: FunctionComponent<ShortCircuitExportButto

useEffect(() => {
setIsCsvExportSuccessful(false);
}, [nodeUuid, analysisType]);
}, [studyUuid, currentRootNetworkUuid, nodeUuid, analysisType]);

useEffect(() => {
if (disabled) {
Expand Down
Loading