Fix: keep Highlighting rules in order (#24347)

* using a list instead of a set to keep order intact

* add changelog

* fixing tests

Author: janheise

changelog/unreleased/pr-24347.toml

@@ -0,0 +1,4 @@
+type = "f"
+message = "Keep highlighting rules in saved searches in order."
+
+pulls = ["24347"]

graylog2-server/src/main/java/org/graylog/plugins/views/search/views/FormattingSettings.java

@@ -22,16 +22,15 @@
 import com.google.auto.value.AutoValue;
 import org.graylog.plugins.views.search.views.formatting.highlighting.HighlightingRule;
 
-import java.util.Collections;
-import java.util.Set;
+import java.util.List;
 
 @AutoValue
 @JsonDeserialize(builder = FormattingSettings.Builder.class)
 public abstract class FormattingSettings {
     static final String FIELD_HIGHLIGHTING = "highlighting";
 
     @JsonProperty(FIELD_HIGHLIGHTING)
-    public abstract Set<HighlightingRule> highlighting();
+    public abstract List<HighlightingRule> highlighting();
 
     public static Builder builder() {
         return Builder.create();
@@ -40,13 +39,13 @@ public static Builder builder() {
     @AutoValue.Builder
     public static abstract class Builder {
         @JsonProperty(FIELD_HIGHLIGHTING)
-        public abstract Builder highlighting(Set<HighlightingRule> highlightingRules);
+        public abstract Builder highlighting(List<HighlightingRule> highlightingRules);
 
         public abstract FormattingSettings build();
 
         @JsonCreator
         public static Builder create() {
-            return new AutoValue_FormattingSettings.Builder().highlighting(Collections.emptySet());
+            return new AutoValue_FormattingSettings.Builder().highlighting(List.of());
         }
     }
 }

graylog2-server/src/test/java/org/graylog2/contentpacks/ContentPackServiceTest.java

@@ -137,6 +137,7 @@
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
@@ -547,7 +548,7 @@ private EntityV1 createTestViewEntity() {
                 .widgets(ImmutableSet.of(widgetEntity))
                 .widgetMapping(ImmutableMap.of())
                 .widgetPositions(ImmutableMap.of())
-                .formatting(FormattingSettings.builder().highlighting(ImmutableSet.of()).build())
+                .formatting(FormattingSettings.builder().highlighting(List.of()).build())
                 .displayModeSettings(DisplayModeSettings.empty())
                 .build();
         final ViewEntity entity = ViewEntity.builder()

graylog2-server/src/test/java/org/graylog2/contentpacks/facades/ViewFacadeTest.java

@@ -316,7 +316,7 @@ private EntityV1 createViewEntity() throws Exception {
                 .widgets(Set.of())
                 .widgetMapping(Map.of())
                 .widgetPositions(Map.of())
-                .formatting(FormattingSettings.builder().highlighting(Set.of()).build())
+                .formatting(FormattingSettings.builder().highlighting(List.of()).build())
                 .displayModeSettings(DisplayModeSettings.empty())
                 .build();
         String newViewId = "5def958063303ae5f68edead";