refactor: some renaming and fixes

Signed-off-by: Joris Mancini <[email protected]>

Author: TheMaskedTurtle

src/components/spreadsheet-view/hooks/use-spreadsheet-nodes.ts renamed to src/components/spreadsheet-view/hooks/use-built-nodes-ids.ts

@@ -14,18 +14,19 @@ import { NodeType } from '../../graph/tree-node.type';
 import { isStatusBuilt } from '../../graph/util/model-functions';
 import type { NodeAlias } from '../types/node-alias.type';
 
-export function useSpreadsheetNodes(nodeAliases: NodeAlias[] | undefined) {
+export function useBuiltNodesIds(nodeAliases: NodeAlias[] | undefined) {
     const currentNode = useSelector((state: AppState) => state.currentTreeNode);
     const treeNodes = useSelector((state: AppState) => state.networkModificationTreeModel?.treeNodes);
 
-    const builtNodesIds = useStableComputedSet(() => {
-        const ids: Set<UUID> = new Set<UUID>();
-        if (currentNode?.id) {
-            ids.add(currentNode.id);
-        }
+    return useStableComputedSet(() => {
         const aliasedNodesIds = nodeAliases
             ?.filter((nodeAlias) => validAlias(nodeAlias))
             .map((nodeAlias) => nodeAlias.id);
+        if (currentNode?.id) {
+            aliasedNodesIds?.push(currentNode.id);
+        }
+
+        const ids = new Set<UUID>();
         if (aliasedNodesIds && aliasedNodesIds.length > 0) {
             treeNodes?.forEach((treeNode) => {
                 if (
@@ -38,6 +39,4 @@ export function useSpreadsheetNodes(nodeAliases: NodeAlias[] | undefined) {
         }
         return ids;
     }, [nodeAliases, treeNodes]);
-
-    return { builtNodesIds };
 }

src/components/spreadsheet-view/hooks/use-update-equipments-on-notification.ts

@@ -21,7 +21,7 @@ import { useDispatch, useSelector } from 'react-redux';
 import { AppState } from 'redux/reducer';
 import { NotificationsUrlKeys, useNotificationsListener } from '@gridsuite/commons-ui';
 import { NodeAlias } from '../types/node-alias.type';
-import { useSpreadsheetNodes } from './use-spreadsheet-nodes';
+import { useBuiltNodesIds } from './use-built-nodes-ids';
 
 const SPREADSHEET_EQUIPMENTS_LISTENER_ID = 'spreadsheet-equipments-listener';
 
@@ -31,7 +31,7 @@ export function useUpdateEquipmentsOnNotification(nodeAliases: NodeAlias[] | und
     const studyUuid = useSelector((state: AppState) => state.studyUuid);
     const currentRootNetworkUuid = useSelector((state: AppState) => state.currentRootNetworkUuid);
 
-    const { builtNodesIds } = useSpreadsheetNodes(nodeAliases);
+    const builtNodesIds = useBuiltNodesIds(nodeAliases);
 
     const updateEquipmentsLocal = useCallback(
         (
@@ -54,6 +54,7 @@ export function useUpdateEquipmentsOnNotification(nodeAliases: NodeAlias[] | und
                         resetEquipmentsByTypes(impactedSpreadsheetEquipmentsTypes.filter(isSpreadsheetEquipmentType))
                     );
                 }
+                return;
             }
 
             if (impactedSubstationsIds.length > 0 && studyUuid && currentRootNetworkUuid) {
@@ -104,15 +105,12 @@ export function useUpdateEquipmentsOnNotification(nodeAliases: NodeAlias[] | und
                     currentRootNetworkUuid === eventRootNetworkUuid &&
                     builtNodesIds.has(eventNodeUuid)
                 ) {
-                    const payload = JSON.parse(eventData.payload) as NetworkImpactsInfos;
-                    const impactedSubstationsIds = payload.impactedSubstationsIds;
-                    const deletedEquipments = payload.deletedEquipments;
-                    const impactedElementTypes = payload.impactedElementTypes ?? [];
+                    const networkImpacts = JSON.parse(eventData.payload) as NetworkImpactsInfos;
                     updateEquipmentsLocal(
                         eventNodeUuid,
-                        impactedSubstationsIds,
-                        deletedEquipments,
-                        impactedElementTypes
+                        networkImpacts.impactedSubstationsIds,
+                        networkImpacts.deletedEquipments,
+                        networkImpacts.impactedElementTypes ?? []
                     );
                 }
             }

src/components/spreadsheet-view/spreadsheet/spreadsheet-content/hooks/use-spreadsheet-equipments.ts

@@ -13,7 +13,7 @@ import type { NodeAlias } from '../../../types/node-alias.type';
 import { useOptionalLoadingParametersForEquipments } from './use-optional-loading-parameters-for-equipments';
 import { SpreadsheetEquipmentType } from '../../../types/spreadsheet.type';
 import { useFetchEquipment } from 'components/spreadsheet-view/hooks/use-fetch-equipment';
-import { useSpreadsheetNodes } from '../../../hooks/use-spreadsheet-nodes';
+import { useBuiltNodesIds } from '../../../hooks/use-built-nodes-ids';
 import { useStableComputedSet } from '../../../../../hooks/use-stable-computed-set';
 import type { UUID } from 'crypto';
 
@@ -27,7 +27,7 @@ export const useSpreadsheetEquipments = (
     const currentNode = useSelector((state: AppState) => state.currentTreeNode);
     const treeNodes = useSelector((state: AppState) => state.networkModificationTreeModel?.treeNodes);
     const equipments = useSelector((state: AppState) => state.spreadsheetNetwork[type]);
-    const nodesIds = useSelector((state: AppState) => state.spreadsheetNetwork[type].nodesId);
+    const loadedNodesIdsForType = useSelector((state: AppState) => state.spreadsheetNetwork[type].nodesId);
     const [isFetching, setIsFetching] = useState<boolean>(false);
     const { fetchNodesEquipmentData } = useFetchEquipment(type);
 
@@ -46,36 +46,26 @@ export const useSpreadsheetEquipments = (
         // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [shouldCleanOptionalLoadingParameters, type]);
 
-    const { builtNodesIds } = useSpreadsheetNodes(nodeAliases);
+    const builtNodesIds = useBuiltNodesIds(nodeAliases);
 
     const nodesIdsToRemove = useStableComputedSet(() => {
-        if (!currentNode?.id) {
-            return new Set<UUID>();
-        }
-        const currentNodeId = currentNode.id;
-        const unwantedFetchedNodes = new Set(nodesIds);
-        const usedNodesId = new Set(builtNodesIds);
-        usedNodesId.add(currentNodeId);
-        usedNodesId.forEach((nodeId) => unwantedFetchedNodes.delete(nodeId));
+        const unwantedFetchedNodes = new Set(loadedNodesIdsForType);
+        builtNodesIds.forEach((nodeId) => unwantedFetchedNodes.delete(nodeId));
         return unwantedFetchedNodes;
-    }, [currentNode?.id, builtNodesIds]);
+    }, [builtNodesIds]);
 
     const nodesIdsToFetch = useStableComputedSet(() => {
         if (shouldLoadOptionalLoadingParameters) {
-            return new Set<UUID>(builtNodesIds);
-        }
-        const nodesIdToFetch = new Set<UUID>();
-        for (const builtAliasNodeId of builtNodesIds) {
-            if (nodesIds.find((nodeId) => nodeId === builtAliasNodeId) === undefined) {
-                nodesIdToFetch.add(builtAliasNodeId);
-            }
+            return builtNodesIds;
         }
+        const nodesIdToFetch = new Set<UUID>(builtNodesIds);
+        loadedNodesIdsForType.forEach((nodeId) => nodesIdToFetch.delete(nodeId));
         return nodesIdToFetch;
-    }, [currentNode?.id, nodesIds, nodeAliases, treeNodes]);
+    }, [currentNode?.id, loadedNodesIdsForType, nodeAliases, treeNodes]);
 
     // effect to unload equipment data when we remove an alias or unbuild an aliased node
     useEffect(() => {
-        if (active && nodesIdsToRemove && nodesIdsToRemove.size !== 0) {
+        if (active && nodesIdsToRemove.size > 0) {
             dispatch(removeNodeData(Array.from(nodesIdsToRemove)));
         }
     }, [active, dispatch, nodesIdsToRemove]);

src/components/study-container.jsx

@@ -486,33 +486,6 @@ export function StudyContainer({ view, onChangeTab }) {
         }
     }, [studyUpdatedForce, dispatch]);
 
-    //handles map automatic mode network reload
-    useEffect(() => {
-        let previousCurrentNode = currentNodeRef.current;
-        currentNodeRef.current = currentNode;
-        let previousCurrentRootNetworkUuid = currentRootNetworkUuidRef.current;
-        // this is the last effect to compare currentRootNetworkUuid and currentRootNetworkUuidRef.current
-        // then we can update the currentRootNetworkUuidRef.current
-        currentRootNetworkUuidRef.current = currentRootNetworkUuid;
-        // if only node renaming, do not reload network
-        if (isNodeEdited(previousCurrentNode, currentNode)) {
-            return;
-        }
-        if (!isNodeBuilt(currentNode)) {
-            return;
-        }
-        // A modification has been added to the currentNode and this one has been built incrementally.
-        // No need to load the network because reloadImpactedSubstationsEquipments will be executed in the notification useEffect.
-        if (
-            previousCurrentRootNetworkUuid === currentRootNetworkUuid &&
-            isSameNode(previousCurrentNode, currentNode) &&
-            isNodeBuilt(previousCurrentNode)
-        ) {
-            return;
-        }
-        dispatch(resetEquipments());
-    }, [currentNode, currentRootNetworkUuid, dispatch]);
-
     useEffect(() => {
         if (studyUuid) {
             websocketExpectedCloseRef.current = false;

src/hooks/use-stable-computed-set.ts

@@ -5,9 +5,9 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
-import { useMemo, useRef } from 'react';
+import { DependencyList, useMemo, useRef } from 'react';
 
-export function useStableComputedSet<T>(compute: () => Iterable<T>, deps: React.DependencyList): Set<T> {
+export function useStableComputedSet<T>(compute: () => Iterable<T>, deps: DependencyList): Set<T> {
     const prevRef = useRef<Set<T>>(new Set());
 
     return useMemo(() => {
@@ -22,5 +22,6 @@ export function useStableComputedSet<T>(compute: () => Iterable<T>, deps: React.
         }
 
         return prevRef.current;
+        // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [deps]);
 }