Add the list of filters ids to the exception when a cycle is detected (#93)

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

Author: benrejebmoh

src/main/java/org/gridsuite/filter/exception/FilterCycleException.java

@@ -0,0 +1,27 @@
+/*
+ * 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/.
+ */
+package org.gridsuite.filter.exception;
+
+import lombok.Getter;
+
+import java.util.List;
+import java.util.Objects;
+import java.util.UUID;
+
+/**
+ * @author Mohamed BENREJEB <mohamed.ben-rejeb at rte-france.com>
+ */
+@Getter
+public class FilterCycleException extends RuntimeException {
+
+    private final List<UUID> cycleFilterIds;
+
+    public FilterCycleException(String message, List<UUID> cycleFilterIds) {
+        super(Objects.requireNonNull(message, "message must not be null"));
+        this.cycleFilterIds = List.copyOf(Objects.requireNonNull(cycleFilterIds, "cycleFilterIds must not be null"));
+    }
+}

src/main/java/org/gridsuite/filter/exceptions/FilterCycleException.java

@@ -9,16 +9,13 @@
 
 import org.gridsuite.filter.AbstractFilter;
 import org.gridsuite.filter.FilterLoader;
-import org.gridsuite.filter.exceptions.FilterCycleException;
+import org.gridsuite.filter.exception.FilterCycleException;
 import org.gridsuite.filter.expertfilter.ExpertFilter;
 import org.gridsuite.filter.expertfilter.expertrule.AbstractExpertRule;
 import org.gridsuite.filter.expertfilter.expertrule.CombinatorExpertRule;
 import org.gridsuite.filter.expertfilter.expertrule.FilterUuidExpertRule;
 
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
-import java.util.UUID;
+import java.util.*;
 
 /**
  * @author Mohamed BENREJEB <mohamed.ben-rejeb at rte-france.com>
@@ -36,30 +33,32 @@ private FilterCycleDetector() {
      * @param filterLoader loader used to retrieve referenced filters
      */
     public static void checkNoCycle(AbstractFilter filter, FilterLoader filterLoader) {
-        checkNoCycle(filter, filterLoader, new HashSet<>());
+        checkNoCycle(filter, filterLoader, new ArrayList<>());
     }
 
     private static void checkNoCycle(AbstractFilter filter, FilterLoader loader,
-                                     Set<UUID> visiting) {
+                                     List<UUID> visiting) {
         UUID id = filter.getId();
         if (id != null) {
             if (visiting.contains(id)) {
-                throw new FilterCycleException("Cycle detected in filters");
+                visiting.addLast(id);
+                int startIndex = visiting.indexOf(id);
+                throw new FilterCycleException("Cycle detected in filters", visiting.subList(startIndex, visiting.size()));
             }
-            visiting.add(id);
+            visiting.addLast(id);
         }
 
         if (filter instanceof ExpertFilter expertFilter) {
             checkRule(expertFilter.getRules(), loader, visiting);
         }
 
-        if (id != null) {
-            visiting.remove(id);
+        if (id != null && !visiting.isEmpty()) {
+            visiting.removeLast();
         }
     }
 
     private static void checkRule(AbstractExpertRule rule, FilterLoader loader,
-                                  Set<UUID> visiting) {
+                                  List<UUID> visiting) {
         switch (rule) {
             case CombinatorExpertRule combinatorRule -> {
                 List<AbstractExpertRule> rules = combinatorRule.getRules();

src/main/java/org/gridsuite/filter/utils/expertfilter/FilterCycleDetector.java

@@ -8,7 +8,7 @@
 
 import org.gridsuite.filter.AbstractFilter;
 import org.gridsuite.filter.FilterLoader;
-import org.gridsuite.filter.exceptions.FilterCycleException;
+import org.gridsuite.filter.exception.FilterCycleException;
 import org.gridsuite.filter.expertfilter.ExpertFilter;
 import org.gridsuite.filter.expertfilter.expertrule.AbstractExpertRule;
 import org.gridsuite.filter.expertfilter.expertrule.CombinatorExpertRule;
@@ -21,6 +21,7 @@
 
 import java.util.*;
 
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.*;
 
 /**
@@ -60,6 +61,7 @@ void testDetectCycleBetweenExpertFilters() {
 
         FilterCycleException ex = assertThrows(FilterCycleException.class, () -> FilterCycleDetector.checkNoCycle(filterA, loader));
         assertEquals("Cycle detected in filters", ex.getMessage());
+        assertThat(ex.getCycleFilterIds()).containsExactly(filterIdA, filterIdB, filterIdA);
     }
 
     @Test