Enhance shunt compensator comments and warnings for conflicting inputs (#3039)

Signed-off-by: achour94 <[email protected]>

Author: achour94

src/components/dialogs/network-modifications/tabular-creation/tabular-creation-form.tsx

@@ -8,7 +8,14 @@
 import { useCallback, useEffect, useMemo, useState } from 'react';
 import { FormattedMessage, useIntl } from 'react-intl';
 import { useFormContext, useWatch } from 'react-hook-form';
-import { AutocompleteInput, CustomAGGrid, ErrorInput, FieldErrorAlert, LANG_FRENCH } from '@gridsuite/commons-ui';
+import {
+    AutocompleteInput,
+    CustomAGGrid,
+    ErrorInput,
+    FieldErrorAlert,
+    LANG_FRENCH,
+    useSnackMessage,
+} from '@gridsuite/commons-ui';
 import { CREATIONS_TABLE, EQUIPMENT_ID, TYPE } from 'components/utils/field-constants';
 import { EQUIPMENT_TYPES } from 'components/utils/equipment-types';
 import CsvDownloader from 'react-csv-downloader';
@@ -38,12 +45,17 @@ export interface TabularCreationFormProps {
 
 export function TabularCreationForm({ dataFetching }: Readonly<TabularCreationFormProps>) {
     const intl = useIntl();
+    const { snackWarning } = useSnackMessage();
     const language = useSelector((state: AppState) => state.computedLanguage);
     const [isFetching, setIsFetching] = useState<boolean>(dataFetching);
     const { setValue, clearErrors, setError, getValues } = useFormContext();
 
     const getTypeLabel = useCallback((type: string) => intl.formatMessage({ id: type }), [intl]);
 
+    const equipmentType = useWatch({
+        name: TYPE,
+    });
+
     const handleComplete = useCallback(
         (results: Papa.ParseResult<any>) => {
             clearErrors(CREATIONS_TABLE);
@@ -112,6 +124,19 @@ export function TabularCreationForm({ dataFetching }: Readonly<TabularCreationFo
                     });
                 }
                 setIsFetching(false);
+                // For shunt compensators, display a warning message if maxSusceptance is set along with shuntCompensatorType or maxQAtNominalV
+                if (
+                    equipmentType === EQUIPMENT_TYPES.SHUNT_COMPENSATOR &&
+                    results.data.some(
+                        (creation) =>
+                            creation.maxSusceptance != null &&
+                            (creation.shuntCompensatorType || creation.maxQAtNominalV != null)
+                    )
+                ) {
+                    snackWarning({
+                        messageId: 'TabularCreationShuntWarning',
+                    });
+                }
                 setFieldTypeError(
                     fieldTypeInError,
                     expectedTypeForFieldInError,
@@ -124,13 +149,9 @@ export function TabularCreationForm({ dataFetching }: Readonly<TabularCreationFo
             setIsFetching(false);
             setValue(CREATIONS_TABLE, results.data, { shouldDirty: true });
         },
-        [clearErrors, setValue, getValues, setError, intl]
+        [clearErrors, setValue, getValues, equipmentType, setError, intl, snackWarning]
     );
 
-    const equipmentType = useWatch({
-        name: TYPE,
-    });
-
     const csvColumns = useMemo(() => {
         return TABULAR_CREATION_FIELDS[equipmentType]?.map((field: TabularCreationField) => {
             return field.id;

src/components/dialogs/network-modifications/tabular-modification/tabular-modification-form.tsx

@@ -51,6 +51,10 @@ export function TabularModificationForm({ dataFetching }: Readonly<TabularModifi
 
     const getTypeLabel = useCallback((type: string) => intl.formatMessage({ id: type }), [intl]);
 
+    const equipmentType = useWatch({
+        name: TYPE,
+    });
+
     const handleComplete = useCallback(
         (results: Papa.ParseResult<any>) => {
             clearErrors(MODIFICATIONS_TABLE);
@@ -87,22 +91,19 @@ export function TabularModificationForm({ dataFetching }: Readonly<TabularModifi
             setIsFetching(false);
             // For shunt compensators, display a warning message if maxSusceptance is modified along with shuntCompensatorType or maxQAtNominalV
             if (
+                equipmentType === EQUIPMENT_TYPES.SHUNT_COMPENSATOR &&
                 results.data.some(
                     (modification) =>
-                        modification.maxSusceptance &&
-                        (modification.shuntCompensatorType || modification.maxQAtNominalV)
+                        modification.maxSusceptance != null &&
+                        (modification.shuntCompensatorType || modification.maxQAtNominalV != null)
                 )
             ) {
                 snackWarning({ messageId: 'TabularModificationShuntWarning' });
             }
         },
-        [clearErrors, setValue, snackWarning, getValues, setError, intl]
+        [clearErrors, setValue, equipmentType, getValues, setError, intl, snackWarning]
     );
 
-    const equipmentType = useWatch({
-        name: TYPE,
-    });
-
     const csvColumns = useMemo(
         () => TABULAR_MODIFICATION_FIELDS[equipmentType]?.map((field: TabularModificationField) => field.id),
         [equipmentType]

src/translations/dynamic/csv-locale-en.ts

@@ -23,7 +23,7 @@ const csv_locale_en = {
     'TabularModificationSkeletonComment.SUBSTATION':
         '#,,2-letter code from ISO 3166-1 standard (FR ES PT IT CH DE BE LU NL GB ...)',
     'TabularCreationSkeletonComment.SHUNT_COMPENSATOR':
-        '#,,,,true | false,,TOP | BOTTOM,,,,REACTOR | CAPACITOR | required if maxQAtNominalV is set,,,',
+        '#For each shunt compensator it is possible to modify either the maximum reactive power (and the type) or the maximum susceptance. In case of conflicting input the maximum susceptance will be ignored.,,,,true | false,,TOP | BOTTOM,,,,REACTOR | CAPACITOR | required if maxQAtNominalV is set,,,',
     'TabularModificationSkeletonComment.SHUNT_COMPENSATOR':
         '#For each shunt compensator it is possible to modify either the maximum reactive power (and the type) or the maximum susceptance. In case of conflicting input the maximum susceptance will be ignored.,,true | false,,TOP | BOTTOM,,,,REACTOR | CAPACITOR,,',
 };

src/translations/dynamic/csv-locale-fr.ts

@@ -23,7 +23,7 @@ const csv_locale_fr = {
     'TabularModificationSkeletonComment.SUBSTATION':
         '#;;Code à 2 lettres de la norme ISO 3166-1 (FR ES PT IT CH DE BE LU NL GB ...)',
     'TabularCreationSkeletonComment.SHUNT_COMPENSATOR':
-        '#;;;;true | false;;TOP | BOTTOM;;;;REACTOR | CAPACITOR | requis si maxQAtNominalV est définit;;;',
+        '#Pour chaque MCS il est possible de modifier soit la puissance réactive installée (et le type) soit la susceptance installée. En cas de conflit la susceptance installée sera ignorée.;;;;true | false;;TOP | BOTTOM;;;;REACTOR | CAPACITOR | requis si maxQAtNominalV est définit;;;',
     'TabularModificationSkeletonComment.SHUNT_COMPENSATOR':
         '#Pour chaque MCS il est possible de modifier soit la puissance réactive installée (et le type) soit la susceptance installée. En cas de conflit la susceptance installée sera ignorée.;;true | false;;TOP | BOTTOM;;;;REACTOR | CAPACITOR;;',
 };

src/translations/en.json

@@ -583,6 +583,7 @@
     "ImportModifications": "Import modifications",
     "TabularModificationError": "Error while creating tabular modification",
     "TabularModificationShuntWarning": "Both maximum reactive power (and/or type) and maximum susceptance have been submitted for the same shunt compensator. Maximum susceptance will thus be ignored.",
+    "TabularCreationShuntWarning": "Both maximum reactive power (and/or type) and maximum susceptance have been submitted for the same shunt compensator. Maximum susceptance will thus be ignored.",
     "equipmentId": "ID",
     "substationName": "Substation name",
     "activePower": "p (MW)",

src/translations/fr.json

@@ -580,6 +580,7 @@
     "ImportModifications": "Importer des modifications",
     "TabularModificationError": "Erreur lors de la modification tabulaire",
     "TabularModificationShuntWarning": "La modification tabulaire contient des valeurs pour la puissance réactive installée (et/ou le type) et la susceptance installée d'un même MCS. La susceptance installée sera donc ignorée.",
+    "TabularCreationShuntWarning": "La création tabulaire contient des valeurs pour la puissance réactive installée (et/ou le type) et la susceptance installée d'un même MCS. La susceptance installée sera donc ignorée.",
     "equipmentId": "ID",
     "substationName": "Nom du site",
     "activePower": "p (MW)",