Merge pull request #192 from FasterXML/tatu/190-custom-null-filter-afterburner

cowtowncoder · web-flow · commit 1381e32493b0 · 2023-01-16T20:42:53.000-08:00
Fix #190: update Afterburner to use same logic as jackson-databind for custom filters
diff --git a/afterburner/src/main/java/com/fasterxml/jackson/module/afterburner/ser/ObjectFieldPropertyWriter.java b/afterburner/src/main/java/com/fasterxml/jackson/module/afterburner/ser/ObjectFieldPropertyWriter.java
@@ -49,12 +49,14 @@ public final void serializeAsField(Object bean, JsonGenerator gen, SerializerPro
         }
         // Null (etc) handling; copied from super-class impl
         if (value == null) {
+            // 20-Jun-2022, tatu: Defer checking of null, see [databind#3481]
+            if ((_suppressableValue != null)
+                    && prov.includeFilterSuppressNulls(_suppressableValue)) {
+                return;
+            }
             if (_nullSerializer != null) {
                 gen.writeFieldName(_fastName);
                 _nullSerializer.serialize(null, gen, prov);
-            } else if (!_suppressNulls) {
-                gen.writeFieldName(_fastName);
-                prov.defaultSerializeNull(gen);
             }
             return;
         }
diff --git a/afterburner/src/main/java/com/fasterxml/jackson/module/afterburner/ser/ObjectMethodPropertyWriter.java b/afterburner/src/main/java/com/fasterxml/jackson/module/afterburner/ser/ObjectMethodPropertyWriter.java
@@ -49,12 +49,14 @@ public final void serializeAsField(Object bean, JsonGenerator gen, SerializerPro
         }
         // Null (etc) handling; copied from super-class impl
         if (value == null) {
+            // 20-Jun-2022, tatu: Defer checking of null, see [databind#3481]
+            if ((_suppressableValue != null)
+                    && prov.includeFilterSuppressNulls(_suppressableValue)) {
+                return;
+            }
             if (_nullSerializer != null) {
                 gen.writeFieldName(_fastName);
                 _nullSerializer.serialize(null, gen, prov);
-            } else if (!_suppressNulls) {
-                gen.writeFieldName(_fastName);
-                prov.defaultSerializeNull(gen);
             }
             return;
         }
diff --git a/afterburner/src/main/java/com/fasterxml/jackson/module/afterburner/ser/StringFieldPropertyWriter.java b/afterburner/src/main/java/com/fasterxml/jackson/module/afterburner/ser/StringFieldPropertyWriter.java
@@ -48,12 +48,14 @@ public final void serializeAsField(Object bean, JsonGenerator gen, SerializerPro
         }
         // Null (etc) handling; copied from super-class impl
         if (value == null) {
+            // 20-Jun-2022, tatu: Defer checking of null, see [databind#3481]
+            if ((_suppressableValue != null)
+                    && prov.includeFilterSuppressNulls(_suppressableValue)) {
+                return;
+            }
             if (_nullSerializer != null) {
                 gen.writeFieldName(_fastName);
                 _nullSerializer.serialize(null, gen, prov);
-            } else if (!_suppressNulls) {
-                gen.writeFieldName(_fastName);
-                prov.defaultSerializeNull(gen);
             }
             return;
         }
diff --git a/afterburner/src/main/java/com/fasterxml/jackson/module/afterburner/ser/StringMethodPropertyWriter.java b/afterburner/src/main/java/com/fasterxml/jackson/module/afterburner/ser/StringMethodPropertyWriter.java
@@ -48,12 +48,14 @@ public final void serializeAsField(Object bean, JsonGenerator gen, SerializerPro
         }
         // Null (etc) handling; copied from super-class impl
         if (value == null) {
+            // 20-Jun-2022, tatu: Defer checking of null, see [databind#3481]
+            if ((_suppressableValue != null)
+                    && prov.includeFilterSuppressNulls(_suppressableValue)) {
+                return;
+            }
             if (_nullSerializer != null) {
                 gen.writeFieldName(_fastName);
                 _nullSerializer.serialize(null, gen, prov);
-            } else if (!_suppressNulls) {
-                gen.writeFieldName(_fastName);
-                prov.defaultSerializeNull(gen);
             }
             return;
         }
diff --git a/afterburner/src/test/java/com/fasterxml/jackson/module/afterburner/ser/filter/JsonIncludeCustomTest.java b/afterburner/src/test/java/com/fasterxml/jackson/module/afterburner/ser/filter/JsonIncludeCustomTest.java
@@ -0,0 +1,160 @@
+package com.fasterxml.jackson.module.afterburner.ser.filter;
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.concurrent.atomic.AtomicInteger;
+
+import com.fasterxml.jackson.annotation.*;
+
+import com.fasterxml.jackson.databind.JsonMappingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.module.afterburner.AfterburnerTestBase;
+
+// Tests for [databind#888]
+public class JsonIncludeCustomTest extends AfterburnerTestBase
+{
+    static class FooFilter {
+        @Override
+        public boolean equals(Object other) {
+            if (other == null) { // do NOT filter out nulls
+                return false;
+            }
+            // in fact, only filter out exact String "foo"
+            return "foo".equals(other);
+        }
+    }
+
+    // for testing prob with `equals(null)` which SHOULD be allowed
+    static class BrokenFilter {
+        @Override
+        public boolean equals(Object other) {
+            /*String str = */ other.toString();
+            return false;
+        }
+    }
+    
+    static class FooBean {
+        @JsonInclude(value=JsonInclude.Include.CUSTOM,
+                valueFilter=FooFilter.class)
+        public String value;
+
+        public FooBean(String v) { value = v; }
+    }
+
+    static class FooMapBean {
+        @JsonInclude(content=JsonInclude.Include.CUSTOM,
+                contentFilter=FooFilter.class)
+        public Map<String,String> stuff = new LinkedHashMap<String,String>();
+
+        public FooMapBean add(String key, String value) {
+            stuff.put(key, value);
+            return this;
+        }
+    }
+
+    static class BrokenBean {
+        @JsonInclude(value=JsonInclude.Include.CUSTOM,
+                valueFilter=BrokenFilter.class)
+        public String value;
+
+        public BrokenBean(String v) { value = v; }
+    }
+
+    static class BrokenBean2 {
+        @JsonInclude(value=JsonInclude.Include.CUSTOM,
+                valueFilter=BrokenFilter.class)
+        public Map<String, String> value;
+
+        public BrokenBean2(Map<String, String> v) { value = v; }
+    }
+
+    // [databind#3481]
+    static class CountingFooFilter {
+        public final static AtomicInteger counter = new AtomicInteger(0);
+
+        @Override
+        public boolean equals(Object other) {
+            counter.incrementAndGet();
+            return "foo".equals(other);
+        }
+    }
+
+    static class CountingFooBean {
+        @JsonInclude(value=JsonInclude.Include.CUSTOM,
+                valueFilter=CountingFooFilter.class)
+        public String value;
+
+        public CountingFooBean(String v) { value = v; }
+    }
+    
+    /*
+    /**********************************************************
+    /* Test methods, success
+    /**********************************************************
+     */
+
+    private final ObjectMapper MAPPER = newObjectMapper();
+
+    public void testSimpleCustomFilter() throws Exception
+    {
+        assertEquals(a2q("{'value':'x'}"), MAPPER.writeValueAsString(new FooBean("x")));
+        assertEquals("{}", MAPPER.writeValueAsString(new FooBean("foo")));
+    }
+
+    public void testCustomFilterWithMap() throws Exception
+    {
+        FooMapBean input = new FooMapBean()
+                .add("a", "1")
+                .add("b", "foo")
+                .add("c", "2");
+
+        assertEquals(a2q("{'stuff':{'a':'1','c':'2'}}"), MAPPER.writeValueAsString(input));
+    }
+
+    // [databind#3481]
+    public void testRepeatedCalls() throws Exception
+    {
+        CountingFooFilter.counter.set(0);
+
+        assertEquals(a2q("{'value':'x'}"),
+                MAPPER.writeValueAsString(new CountingFooBean("x")));
+        assertEquals(1, CountingFooFilter.counter.get());
+
+        assertEquals("{}", MAPPER.writeValueAsString(new CountingFooBean("foo")));
+        assertEquals(2, CountingFooFilter.counter.get());
+
+        // except filter will be called again for `null`s, as per [databind#3481]
+        assertEquals(a2q("{'value':null}"), MAPPER.writeValueAsString(new CountingFooBean(null)));
+        assertEquals(3, CountingFooFilter.counter.get());
+    }
+
+    /*
+    /**********************************************************
+    /* Test methods, fail handling
+    /**********************************************************
+     */
+
+    public void testBrokenFilterString() throws Exception
+    {
+        try {
+            String json = MAPPER.writeValueAsString(new BrokenBean(null));
+            fail("Should not pass, produced: "+json);
+        } catch (JsonMappingException e) {
+            // 20-Jun-2022, tatu: Actual message seems to vary across JDKs...
+            verifyException(e, "Problem determining whether filter");
+            verifyException(e, "should filter out `null` values");
+        }
+    }
+
+    public void testBrokenFilterMap() throws Exception
+    {
+        try {
+            String json = MAPPER.writeValueAsString(new BrokenBean2(null));
+            fail("Should not pass, produced: "+json);
+        } catch (JsonMappingException e) {
+            // 20-Jun-2022, tatu: Actual message seems to vary across JDKs...
+            verifyException(e, "Problem determining whether filter");
+            verifyException(e, "should filter out `null` values");
+        }
+    }
+}
diff --git a/blackbird/src/main/java/com/fasterxml/jackson/module/blackbird/ser/ObjectPropertyWriter.java b/blackbird/src/main/java/com/fasterxml/jackson/module/blackbird/ser/ObjectPropertyWriter.java
@@ -57,12 +57,14 @@ public final void serializeAsField(Object bean, JsonGenerator gen, SerializerPro
         }
         // Null (etc) handling; copied from super-class impl
         if (value == null) {
+            // 20-Jun-2022, tatu: Defer checking of null, see [databind#3481]
+            if ((_suppressableValue != null)
+                    && prov.includeFilterSuppressNulls(_suppressableValue)) {
+                return;
+            }
             if (_nullSerializer != null) {
                 gen.writeFieldName(_fastName);
                 _nullSerializer.serialize(null, gen, prov);
-            } else if (!_suppressNulls) {
-                gen.writeFieldName(_fastName);
-                prov.defaultSerializeNull(gen);
             }
             return;
         }
diff --git a/blackbird/src/main/java/com/fasterxml/jackson/module/blackbird/ser/StringPropertyWriter.java b/blackbird/src/main/java/com/fasterxml/jackson/module/blackbird/ser/StringPropertyWriter.java
@@ -57,12 +57,14 @@ public final void serializeAsField(Object bean, JsonGenerator gen, SerializerPro
         }
         // Null (etc) handling; copied from super-class impl
         if (value == null) {
+            // 20-Jun-2022, tatu: Defer checking of null, see [databind#3481]
+            if ((_suppressableValue != null)
+                    && prov.includeFilterSuppressNulls(_suppressableValue)) {
+                return;
+            }
             if (_nullSerializer != null) {
                 gen.writeFieldName(_fastName);
                 _nullSerializer.serialize(null, gen, prov);
-            } else if (!_suppressNulls) {
-                gen.writeFieldName(_fastName);
-                prov.defaultSerializeNull(gen);
             }
             return;
         }
diff --git a/blackbird/src/test/java/com/fasterxml/jackson/module/blackbird/ser/filter/JsonIncludeCustomTest.java b/blackbird/src/test/java/com/fasterxml/jackson/module/blackbird/ser/filter/JsonIncludeCustomTest.java
diff --git a/release-notes/VERSION-2.x b/release-notes/VERSION-2.x

Original file line number	Diff line number	Diff line change
`@@ -49,12 +49,14 @@ public final void serializeAsField(Object bean, JsonGenerator gen, SerializerPro`
`49`	`49`	`}`
`50`	`50`	`// Null (etc) handling; copied from super-class impl`
`51`	`51`	`if (value == null) {`
	`52`	`+ // 20-Jun-2022, tatu: Defer checking of null, see [databind#3481]`
	`53`	`+ if ((_suppressableValue != null)`
	`54`	`+ && prov.includeFilterSuppressNulls(_suppressableValue)) {`
	`55`	`+ return;`
	`56`	`+ }`
`52`	`57`	`if (_nullSerializer != null) {`
`53`	`58`	`gen.writeFieldName(_fastName);`
`54`	`59`	`_nullSerializer.serialize(null, gen, prov);`
`55`		`- } else if (!_suppressNulls) {`
`56`		`- gen.writeFieldName(_fastName);`
`57`		`- prov.defaultSerializeNull(gen);`
`58`	`60`	`}`
`59`	`61`	`return;`
`60`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,12 +48,14 @@ public final void serializeAsField(Object bean, JsonGenerator gen, SerializerPro`
`48`	`48`	`}`
`49`	`49`	`// Null (etc) handling; copied from super-class impl`
`50`	`50`	`if (value == null) {`
	`51`	`+ // 20-Jun-2022, tatu: Defer checking of null, see [databind#3481]`
	`52`	`+ if ((_suppressableValue != null)`
	`53`	`+ && prov.includeFilterSuppressNulls(_suppressableValue)) {`
	`54`	`+ return;`
	`55`	`+ }`
`51`	`56`	`if (_nullSerializer != null) {`
`52`	`57`	`gen.writeFieldName(_fastName);`
`53`	`58`	`_nullSerializer.serialize(null, gen, prov);`
`54`		`- } else if (!_suppressNulls) {`
`55`		`- gen.writeFieldName(_fastName);`
`56`		`- prov.defaultSerializeNull(gen);`
`57`	`59`	`}`
`58`	`60`	`return;`
`59`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,12 +57,14 @@ public final void serializeAsField(Object bean, JsonGenerator gen, SerializerPro`
`57`	`57`	`}`
`58`	`58`	`// Null (etc) handling; copied from super-class impl`
`59`	`59`	`if (value == null) {`
	`60`	`+ // 20-Jun-2022, tatu: Defer checking of null, see [databind#3481]`
	`61`	`+ if ((_suppressableValue != null)`
	`62`	`+ && prov.includeFilterSuppressNulls(_suppressableValue)) {`
	`63`	`+ return;`
	`64`	`+ }`
`60`	`65`	`if (_nullSerializer != null) {`
`61`	`66`	`gen.writeFieldName(_fastName);`
`62`	`67`	`_nullSerializer.serialize(null, gen, prov);`
`63`		`- } else if (!_suppressNulls) {`
`64`		`- gen.writeFieldName(_fastName);`
`65`		`- prov.defaultSerializeNull(gen);`
`66`	`68`	`}`
`67`	`69`	`return;`
`68`	`70`	`}`