Fix useOneBusShortcircuitAnalysisLoader which must consider rootNetwork used (#3399)

* fix(useOneBusShortcircuitAnalysisLoader): consider rootNetworkUuid to manage correctly the loader of the computation on diagram
* refactor(): Fix sonar issue :
This assertion is unnecessary since the receiver accepts the original type of the expression.
* refactor(useOneBusShortcircuitAnalysisLoader): Add `studyUuid` in context as discussed in review

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

Author: sBouzols

src/components/grid-layout/cards/diagrams/singleLineDiagram/hooks/use-one-bus-shortcircuit-analysis-loader.tsx

@@ -5,14 +5,13 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
-import type { UUID } from 'node:crypto';
 import { ReactElement, useCallback, useEffect, useMemo } from 'react';
 import { useIntl } from 'react-intl';
 import { useDispatch, useSelector } from 'react-redux';
 import { AppState } from 'redux/reducer';
 import { Chip, darken, lighten } from '@mui/material';
 import { type MuiStyles } from '@gridsuite/commons-ui';
-import { setOneBusShortcircuitAnalysisDiagram } from 'redux/actions';
+import { resetOneBusShortcircuitAnalysisDiagram, setOneBusShortcircuitAnalysisDiagram } from 'redux/actions';
 import { AppDispatch } from 'redux/store';
 import {
     isOneBusShortCircuitFailedNotification,
@@ -40,38 +39,54 @@ type oneBusShortcircuitAnalysisLoader = [ReactElement, boolean, () => void, () =
  * A hook that handles the logic behind the diagram one bus shortcircuit analysis loader
  *
  * @param {string} diagramId - Identifier for the diagram which launched the computation
- * @param {UUID} nodeId - Identifier for the node which launched the computation
- * @param rootNetworkUuid
  *
  * @returns {oneBusShortcircuitAnalysisLoader} array which contains the controls necessary for the one bus
  * shortcircuit analysis loader. It also comes with a boolean to check if the loader needs to be displayed
  * and the message to display for the UI
  */
-export function useOneBusShortcircuitAnalysisLoader(
-    diagramId: string,
-    nodeId: UUID,
-    rootNetworkUuid: UUID
-): oneBusShortcircuitAnalysisLoader {
+export function useOneBusShortcircuitAnalysisLoader(diagramId: string): oneBusShortcircuitAnalysisLoader {
+    const studyUuid = useSelector((state: AppState) => state.studyUuid);
+    const currentNode = useSelector((state: AppState) => state.currentTreeNode);
+    const rootNetworkUuid = useSelector((state: AppState) => state.currentRootNetworkUuid);
+
     const studyUpdatedForce = useSelector((state: AppState) => state.studyUpdated);
     const oneBusShortCircuitAnalysisDiagram = useSelector((state: AppState) => state.oneBusShortCircuitAnalysisDiagram);
 
     const dispatch = useDispatch<AppDispatch>();
     const intl = useIntl();
 
     const displayOneBusShortcircuitAnalysisLoader = useCallback(() => {
-        dispatch(setOneBusShortcircuitAnalysisDiagram(diagramId, nodeId));
-    }, [nodeId, diagramId, dispatch]);
+        if (!studyUuid || !currentNode?.id || !rootNetworkUuid) {
+            return;
+        }
+        dispatch(setOneBusShortcircuitAnalysisDiagram(diagramId, studyUuid, rootNetworkUuid, currentNode?.id));
+    }, [currentNode?.id, diagramId, dispatch, rootNetworkUuid, studyUuid]);
 
     const resetOneBusShortcircuitAnalysisLoader = useCallback(() => {
-        dispatch(setOneBusShortcircuitAnalysisDiagram(null));
+        dispatch(resetOneBusShortcircuitAnalysisDiagram());
     }, [dispatch]);
 
-    const isDiagramRunningOneBusShortcircuitAnalysis = useMemo(
-        () =>
+    const isDiagramRunningOneBusShortcircuitAnalysis = useMemo(() => {
+        if (!studyUuid || !currentNode?.id || !rootNetworkUuid) {
+            return false;
+        }
+
+        return (
             diagramId === oneBusShortCircuitAnalysisDiagram?.diagramId &&
-            nodeId === oneBusShortCircuitAnalysisDiagram?.nodeId,
-        [nodeId, diagramId, oneBusShortCircuitAnalysisDiagram]
-    );
+            studyUuid === oneBusShortCircuitAnalysisDiagram?.studyUuid &&
+            rootNetworkUuid === oneBusShortCircuitAnalysisDiagram?.rootNetworkUuid &&
+            currentNode?.id === oneBusShortCircuitAnalysisDiagram?.nodeId
+        );
+    }, [
+        currentNode?.id,
+        diagramId,
+        oneBusShortCircuitAnalysisDiagram?.diagramId,
+        oneBusShortCircuitAnalysisDiagram?.studyUuid,
+        oneBusShortCircuitAnalysisDiagram?.rootNetworkUuid,
+        oneBusShortCircuitAnalysisDiagram?.nodeId,
+        rootNetworkUuid,
+        studyUuid,
+    ]);
 
     const oneBusShortcircuitAnalysisLoaderMessage = useMemo<ReactElement>(() => {
         return (
@@ -90,6 +105,9 @@ export function useOneBusShortcircuitAnalysisLoader(
     }, [intl, isDiagramRunningOneBusShortcircuitAnalysis]);
 
     useEffect(() => {
+        if (!studyUuid || !currentNode?.id || !rootNetworkUuid) {
+            return;
+        }
         if (
             (studyUpdatedForce && isOneBusShortCircuitResultNotification(studyUpdatedForce.eventData)) ||
             isOneBusShortCircuitFailedNotification(studyUpdatedForce.eventData)
@@ -99,7 +117,7 @@ export function useOneBusShortcircuitAnalysisLoader(
             }
             resetOneBusShortcircuitAnalysisLoader();
         }
-    }, [resetOneBusShortcircuitAnalysisLoader, studyUpdatedForce, rootNetworkUuid]);
+    }, [resetOneBusShortcircuitAnalysisLoader, studyUpdatedForce, rootNetworkUuid, studyUuid, currentNode?.id]);
 
     return [
         oneBusShortcircuitAnalysisLoaderMessage,

src/components/grid-layout/cards/diagrams/singleLineDiagram/single-line-diagram-content.tsx

@@ -112,7 +112,7 @@ function SingleLineDiagramContent(props: SingleLineDiagramContentProps) {
         isDiagramRunningOneBusShortcircuitAnalysis,
         displayOneBusShortcircuitAnalysisLoader,
         resetOneBusShortcircuitAnalysisLoader,
-    ] = useOneBusShortcircuitAnalysisLoader(diagramParams.diagramUuid, currentNode?.id!, currentRootNetworkUuid!);
+    ] = useOneBusShortcircuitAnalysisLoader(diagramParams.diagramUuid);
 
     /**
      * DIAGRAM INTERACTIVITY

src/redux/actions.ts

@@ -125,6 +125,7 @@ export type AppActions =
     | SetRootNetworkIndexationStatusAction
     | SetOptionalServicesAction
     | SetOneBusShortcircuitAnalysisDiagramAction
+    | ResetOneBusShortcircuitAnalysisDiagramAction
     | AddToRecentGlobalFiltersAction
     | RemoveFromRecentGlobalFiltersAction
     | SetLastCompletedComputationAction
@@ -959,25 +960,32 @@ export const SET_ONE_BUS_SHORTCIRCUIT_ANALYSIS_DIAGRAM = 'SET_ONE_BUS_SHORTCIRCU
 export type SetOneBusShortcircuitAnalysisDiagramAction = Readonly<
     Action<typeof SET_ONE_BUS_SHORTCIRCUIT_ANALYSIS_DIAGRAM>
 > &
-    (OneBusShortCircuitAnalysisDiagram | { diagramId: null });
-
-export function setOneBusShortcircuitAnalysisDiagram(diagramId: null): SetOneBusShortcircuitAnalysisDiagramAction;
+    OneBusShortCircuitAnalysisDiagram;
 export function setOneBusShortcircuitAnalysisDiagram(
     diagramId: OneBusShortCircuitAnalysisDiagram['diagramId'],
+    studyUuid: OneBusShortCircuitAnalysisDiagram['studyUuid'],
+    rootNetworkUuid: OneBusShortCircuitAnalysisDiagram['rootNetworkUuid'],
     nodeId: OneBusShortCircuitAnalysisDiagram['nodeId']
-): SetOneBusShortcircuitAnalysisDiagramAction;
-export function setOneBusShortcircuitAnalysisDiagram(
-    diagramId: OneBusShortCircuitAnalysisDiagram['diagramId'] | null,
-    nodeId?: OneBusShortCircuitAnalysisDiagram['nodeId']
 ): SetOneBusShortcircuitAnalysisDiagramAction {
     return {
         type: SET_ONE_BUS_SHORTCIRCUIT_ANALYSIS_DIAGRAM,
         diagramId: diagramId,
-        // @ts-expect-error: function overload protect call
+        studyUuid: studyUuid,
+        rootNetworkUuid: rootNetworkUuid,
         nodeId: nodeId,
     };
 }
 
+export const RESET_ONE_BUS_SHORTCIRCUIT_ANALYSIS_DIAGRAM = 'RESET_ONE_BUS_SHORTCIRCUIT_ANALYSIS_DIAGRAM';
+export type ResetOneBusShortcircuitAnalysisDiagramAction = Readonly<
+    Action<typeof RESET_ONE_BUS_SHORTCIRCUIT_ANALYSIS_DIAGRAM>
+>;
+export function resetOneBusShortcircuitAnalysisDiagram(): ResetOneBusShortcircuitAnalysisDiagramAction {
+    return {
+        type: RESET_ONE_BUS_SHORTCIRCUIT_ANALYSIS_DIAGRAM,
+    };
+}
+
 export const ADD_TO_RECENT_GLOBAL_FILTERS = 'ADD_TO_RECENT_GLOBAL_FILTERS';
 export type AddToRecentGlobalFiltersAction = Readonly<Action<typeof ADD_TO_RECENT_GLOBAL_FILTERS>> & {
     globalFilters: GlobalFilter[];

src/redux/reducer.ts

@@ -177,6 +177,7 @@ import {
     SET_MODIFICATIONS_IN_PROGRESS,
     SET_MONO_ROOT_STUDY,
     SET_ONE_BUS_SHORTCIRCUIT_ANALYSIS_DIAGRAM,
+    RESET_ONE_BUS_SHORTCIRCUIT_ANALYSIS_DIAGRAM,
     SET_OPEN_MAP,
     SET_OPTIONAL_SERVICES,
     SET_PARAMS_LOADED,
@@ -199,6 +200,7 @@ import {
     type SetModificationsInProgressAction,
     type SetMonoRootStudyAction,
     type SetOneBusShortcircuitAnalysisDiagramAction,
+    type ResetOneBusShortcircuitAnalysisDiagramAction,
     type SetOpenMapAction,
     type SetOptionalServicesAction,
     type SetParamsLoadedAction,
@@ -429,6 +431,8 @@ export const DEFAULT_LOGS_PAGINATION: LogsPaginationConfig = {
 
 export interface OneBusShortCircuitAnalysisDiagram {
     diagramId: string;
+    studyUuid: UUID;
+    rootNetworkUuid: UUID;
     nodeId: UUID;
 }
 
@@ -1728,12 +1732,19 @@ export const reducer = createReducer(initialState, (builder) => {
     builder.addCase(
         SET_ONE_BUS_SHORTCIRCUIT_ANALYSIS_DIAGRAM,
         (state, action: SetOneBusShortcircuitAnalysisDiagramAction) => {
-            state.oneBusShortCircuitAnalysisDiagram = action.diagramId
-                ? {
-                      diagramId: action.diagramId,
-                      nodeId: action.nodeId,
-                  }
-                : null;
+            state.oneBusShortCircuitAnalysisDiagram = {
+                diagramId: action.diagramId,
+                studyUuid: action.studyUuid,
+                rootNetworkUuid: action.rootNetworkUuid,
+                nodeId: action.nodeId,
+            };
+        }
+    );
+
+    builder.addCase(
+        RESET_ONE_BUS_SHORTCIRCUIT_ANALYSIS_DIAGRAM,
+        (state, action: ResetOneBusShortcircuitAnalysisDiagramAction) => {
+            state.oneBusShortCircuitAnalysisDiagram = null;
         }
     );