Fix #4580: add MapperFeature.SORT_CREATOR_PROPERTIES_BY_DECLARATION_ORDER (#4587)

Author: cowtowncoder

release-notes/VERSION-2.x

@@ -48,6 +48,8 @@ Project: jackson-databind
   `@JsonProperty` and javac `-parameters`
  (reported by Alexandre J)
 #4570: Deprecate `ObjectMapper.canDeserialize()`/`ObjectMapper.canSerialize()`
+#4580: Add `MapperFeature.SORT_CREATOR_PROPERTIES_BY_DECLARATION_ORDER` to use
+  Creator properties' declaration order for sorting
 
 2.17.2 (not yet released)
 

src/main/java/com/fasterxml/jackson/databind/MapperFeature.java

@@ -417,6 +417,23 @@ public enum MapperFeature implements ConfigFeature
      */
     SORT_CREATOR_PROPERTIES_FIRST(true),
 
+    /**
+     * Feature that defines whether Creator properties (ones passed through
+     * constructor or static factory method) should be sorted in their declaration
+     * order if {@link #SORT_CREATOR_PROPERTIES_FIRST} is also enabled.
+     * This is usually used to prevent alphabetic sorting for
+     * Creator properties even if {@link #SORT_PROPERTIES_ALPHABETICALLY} is
+     * enabled for other types of properties.
+     *<p>
+     * NOTE: if {@link #SORT_CREATOR_PROPERTIES_FIRST} is disabled, this feature
+     * has no effect.
+     *<p>
+     * Feature is disabled by default (for backwards compatibility)
+     *
+     * @since 2.18
+     */
+    SORT_CREATOR_PROPERTIES_BY_DECLARATION_ORDER(false),
+
     /*
     /******************************************************
     /* Name-related features

src/main/java/com/fasterxml/jackson/databind/introspect/POJOPropertiesCollector.java

@@ -1560,7 +1560,11 @@ protected void _sortProperties(Map<String, POJOPropertyBuilder> props)
              * so creator properties still fully predate non-creator ones.
              */
             Collection<POJOPropertyBuilder> cr;
-            if (sortAlpha) {
+            // 18-Jun-2024, tatu: [databind#4580] We may want to retain declaration
+            //    order regardless
+            boolean sortCreatorPropsByAlpha = sortAlpha
+                    && !_config.isEnabled(MapperFeature.SORT_CREATOR_PROPERTIES_BY_DECLARATION_ORDER);
+            if (sortCreatorPropsByAlpha) {
                 TreeMap<String, POJOPropertyBuilder> sorted =
                         new TreeMap<String,POJOPropertyBuilder>();
                 for (POJOPropertyBuilder prop : _creatorProperties) {

src/test-jdk17/java/com/fasterxml/jackson/databind/jdk17/RecordPrivate4175Test.java renamed to src/test-jdk17/java/com/fasterxml/jackson/databind/records/RecordPrivate4175Test.java

@@ -1,4 +1,4 @@
-package com.fasterxml.jackson.databind.jdk17;
+package com.fasterxml.jackson.databind.records;
 
 import java.util.Collections;
 

src/test-jdk17/java/com/fasterxml/jackson/databind/records/RecordSerializationOrderTest.java

@@ -1,29 +1,33 @@
 package com.fasterxml.jackson.databind.records;
 
+import org.junit.jupiter.api.Test;
+
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+import com.fasterxml.jackson.databind.MapperFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.testutil.DatabindTestUtil;
-import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 public class RecordSerializationOrderTest extends DatabindTestUtil
 {
     record NestedRecordOne(String id, String email, NestedRecordTwo nestedRecordTwo) {}
     record NestedRecordOneWithJsonProperty(String id, String email,
-                                           @JsonProperty("nestedProperty") NestedRecordTwo nestedRecordTwo) {}
+            @JsonProperty("nestedProperty") NestedRecordTwo nestedRecordTwo) {}
     record NestedRecordOneWithJsonPropertyIndex(@JsonProperty(index = 2) String id,
-                                                @JsonProperty(index = 0) String email,
-                                                @JsonProperty(value = "nestedProperty", index = 1) NestedRecordTwo nestedRecordTwo) {}
+            @JsonProperty(index = 0) String email,
+            @JsonProperty(value = "nestedProperty", index = 1) NestedRecordTwo nestedRecordTwo) {}
 
     @JsonPropertyOrder({"email", "nestedProperty", "id"})
     record NestedRecordOneWithJsonPropertyOrder(String id,
-                                                String email,
-                                                @JsonProperty(value = "nestedProperty") NestedRecordTwo nestedRecordTwo) {}
+            String email,
+            @JsonProperty(value = "nestedProperty") NestedRecordTwo nestedRecordTwo) {}
 
     record NestedRecordTwo(String id, String passport) {}
 
+    record CABRecord(String c, String a, String b) {}
+
     private final ObjectMapper MAPPER = newJsonMapper();
 
     /*
@@ -70,4 +74,25 @@ public void testSerializationOrderWithJsonPropertyOrder() throws Exception {
         final String expected = "{\"email\":\"[email protected]\",\"nestedProperty\":{\"id\":\"2\",\"passport\":\"111110\"},\"id\":\"1\"}";
         assertEquals(expected, output);
     }
+
+    // [databind#4580]
+    @Test
+    public void testSerializationOrderWrtCreatorAlphabetic() throws Exception {
+        // By default, in Creator property order
+        assertEquals(a2q("{'c':'c','a':'a','b':'b'}"),
+                MAPPER.writeValueAsString(new CABRecord("c", "a", "b")));
+        // But alphabetic sorting affects Creator, without other settings
+        assertEquals(a2q("{'a':'a','b':'b','c':'c'}"),
+                jsonMapperBuilder()
+                    .enable(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY)
+                    .build()
+                    .writeValueAsString(new CABRecord("c", "a", "b")));
+        // Except if we tell it not to:
+        assertEquals(a2q("{'c':'c','a':'a','b':'b'}"),
+                jsonMapperBuilder()
+                .enable(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY)
+                .enable(MapperFeature.SORT_CREATOR_PROPERTIES_BY_DECLARATION_ORDER)
+                .build()
+                .writeValueAsString(new CABRecord("c", "a", "b")));
+    }
 }

src/test/java/com/fasterxml/jackson/databind/ser/SerializationOrderTest.java

@@ -205,8 +205,20 @@ public void testCreatorVsExplicitOrdering() throws Exception
     @Test
     public void testAlphaAndCreatorOrdering() throws Exception
     {
-        String json = ALPHA_MAPPER.writeValueAsString(new BeanForGH311(2, 1));
-        assertEquals("{\"a\":1,\"b\":2}", json);
+        assertEquals(a2q("{'a':1,'b':2}"),
+                ALPHA_MAPPER.writeValueAsString(new BeanForGH311(2, 1)));
+    }
+
+    // [databind#4580]
+    @Test
+    public void testAlphaAndCreatorDeclarationOrdering() throws Exception
+    {
+        final ObjectMapper mapper = jsonMapperBuilder()
+                .enable(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY)
+                .enable(MapperFeature.SORT_CREATOR_PROPERTIES_BY_DECLARATION_ORDER)
+                .build();
+        assertEquals(a2q("{'b':2,'a':1}"),
+                mapper.writeValueAsString(new BeanForGH311(2, 1)));
     }
 
     // [databind#2555]