Fix #51

Author: cowtowncoder

csv/src/main/java/com/fasterxml/jackson/dataformat/csv/CsvGenerator.java

@@ -9,7 +9,6 @@
 import com.fasterxml.jackson.core.base.GeneratorBase;
 import com.fasterxml.jackson.core.json.JsonWriteContext;
 import com.fasterxml.jackson.core.io.IOContext;
-import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.dataformat.csv.impl.CsvEncoder;
 
 public class CsvGenerator extends GeneratorBase
@@ -454,17 +453,15 @@ public void close() throws IOException
     public final void writeStartArray() throws IOException
     {
         _verifyValueWrite("start an array");
-        /* Ok to create root-level array to contain Objects/Arrays, but
-         * can not nest arrays in objects
-         */
+        // Ok to create root-level array to contain Objects/Arrays, but
+        // can not nest arrays in objects
         if (_writeContext.inObject()) {
             if ((_skipWithin == null)
                     && _skipValue && isEnabled(JsonGenerator.Feature.IGNORE_UNKNOWN)) {
                 _skipWithin = _writeContext;
             } else if (!_skipValue) {
                 // First: column may have its own separator
                 String sep;
-                
                 if (_nextColumnByName >= 0) {
                     CsvSchema.Column col = _schema.column(_nextColumnByName);
                     sep = col.isArray() ? col.getArrayElementSeparator() : CsvSchema.NO_ARRAY_ELEMENT_SEPARATOR;
@@ -513,9 +510,8 @@ public final void writeEndArray() throws IOException
             _arraySeparator = CsvSchema.NO_ARRAY_ELEMENT_SEPARATOR;
             _writer.write(_columnIndex(), _arrayContents.toString());
         }
-        /* 20-Nov-2014, tatu: When doing "untyped"/"raw" output, this means that row
-         *    is now done. But not if writing such an array field, so:
-         */
+        // 20-Nov-2014, tatu: When doing "untyped"/"raw" output, this means that row
+        //    is now done. But not if writing such an array field, so:
         if (!_writeContext.inObject()) {
             finishRow();
         }
@@ -527,12 +523,14 @@ public final void writeStartObject() throws IOException
         _verifyValueWrite("start an object");
         // No nesting for objects; can write Objects inside logical root-level arrays.
         // 14-Dec-2015, tatu: ... except, should be fine if we are ignoring the property
-        if (_writeContext.inObject()) {
+        if (_writeContext.inObject() ||
+                // 07-Nov-2017, tatu: But we may actually be nested indirectly; so check
+                (_writeContext.inArray() && !_writeContext.getParent().inRoot())) {
             if (_skipWithin == null) { // new in 2.7
                 if (_skipValue && isEnabled(JsonGenerator.Feature.IGNORE_UNKNOWN)) {
                     _skipWithin = _writeContext;
                 } else {
-                    _reportMappingError("CSV generator does not support Object values for properties");
+                    _reportMappingError("CSV generator does not support Object values for properties (nested Objects)");
                 }
             }
         }
@@ -922,7 +920,7 @@ protected void _releaseBuffers() {
      * @since 2.7
      */
     protected void _reportMappingError(String msg) throws JsonProcessingException {
-        throw JsonMappingException.from(this, msg);
+        throw CsvMappingException.from(this, msg, _schema);
 //        throw new JsonGenerationException(msg, this);
     }
 

csv/src/main/java/com/fasterxml/jackson/dataformat/csv/CsvMappingException.java

@@ -19,10 +19,19 @@ public CsvMappingException(CsvParser p, String msg, CsvSchema schema) {
         _schema = schema;
     }
 
+    public CsvMappingException(CsvGenerator gen, String msg, CsvSchema schema) {
+        super(gen, msg);
+        _schema = schema;
+    }
+
     public static CsvMappingException from(CsvParser p, String msg, CsvSchema schema) {
         return new CsvMappingException(p, msg, schema);
     }
 
+    public static CsvMappingException from(CsvGenerator gen, String msg, CsvSchema schema) {
+        return new CsvMappingException(gen, msg, schema);
+    }
+
     public CsvSchema getSchema() {
         return _schema;
     }

csv/src/main/java/com/fasterxml/jackson/dataformat/csv/impl/CsvEncoder.java

@@ -154,7 +154,7 @@ public class CsvEncoder
      * stream writer.
      */
     protected int _charsWritten;
-    
+
     /*
     /**********************************************************
     /* Construction, (re)configuration

csv/src/test/java/com/fasterxml/jackson/dataformat/csv/failing/GeneratorIgnoreUnknown51Test.java renamed to csv/src/test/java/com/fasterxml/jackson/dataformat/csv/ser/GeneratorIgnoreUnknown51Test.java

@@ -1,16 +1,29 @@
-package com.fasterxml.jackson.dataformat.csv.failing;
+package com.fasterxml.jackson.dataformat.csv.ser;
 
+import java.io.StringWriter;
 import java.util.*;
 
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+import com.fasterxml.jackson.annotation.JsonValue;
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.dataformat.csv.CsvMapper;
+import com.fasterxml.jackson.dataformat.csv.CsvMappingException;
 import com.fasterxml.jackson.dataformat.csv.CsvSchema;
 import com.fasterxml.jackson.dataformat.csv.ModuleTestBase;
 
 public class GeneratorIgnoreUnknown51Test extends ModuleTestBase
 {
     // [dataformats-text#51]
+    @JsonPropertyOrder({ "address", "people", "phoneNumber" })
+    protected static class MyClass
+    {
+        public String address;
+        public Set<Person> people;
+        public String phoneNumber;
+
+        public MyClass() { }
+    }
+
     @JsonPropertyOrder({ "name", "surname" })
     protected static class Person
     {
@@ -23,16 +36,13 @@ public Person(String name, String surname)
             this.name = name;
             this.surname = surname;
         }
-    }
 
-    @JsonPropertyOrder({ "address", "people", "phoneNumber" })
-    protected static class MyClass
-    {
-        public String address;
-        public Set<Person> people;
-        public String phoneNumber;
 
-        public MyClass() { }
+        // 07-Nov-2017, tatu: This would be a work-around:
+        //@JsonValue
+        public String asString() {
+            return ""+name+" "+surname;
+        }
     }
 
     /*
@@ -47,8 +57,8 @@ public void testIgnoreEmbeddedObject() throws Exception
         CsvMapper mapper = mapperForCsv();
         mapper.configure( JsonGenerator.Feature.IGNORE_UNKNOWN, true );
         CsvSchema schema = CsvSchema.builder()
-                .addColumn("people") // here I'm skipping phoneNumber so I need to use IGNORE_UNKNOWN feature
                 .addColumn("address")
+                .addColumn("people") // here I'm skipping phoneNumber so I need to use IGNORE_UNKNOWN feature
                 .build()
                 .withHeader();
 
@@ -62,9 +72,13 @@ public void testIgnoreEmbeddedObject() throws Exception
         myClass.address = "AAA";
         myClass.phoneNumber = "123";
 
-        String result = mapper.writer( schema ).writeValueAsString( myClass );
-//System.err.println("REsult: "+result);
-        int numberOfLines = result.split( "\n" ).length;
-        assertEquals( 2, numberOfLines ); // header and data (here fails with 3)
+        StringWriter sw = new StringWriter();
+        try {
+            mapper.writer(schema).writeValue(sw, myClass);
+            fail("Should not pass");
+        } catch (CsvMappingException e) {
+            verifyException(e, "CSV generator does not support");
+            verifyException(e, "nested Objects");
+        }
     }
 }

release-notes/CREDITS

@@ -6,3 +6,7 @@ text dataformats project, version 2.x
 
 Tatu Saloranta, [email protected]: author
 
+Simone Locci (pimuzzo@github)
+
+* Reported #51 (csv): Set of custom objects with `IGNORE_UNKNOWN` brokes silently csv
+ (2.9.3)

release-notes/VERSION

@@ -8,6 +8,11 @@ Modules:
 === Releases ===
 ------------------------------------------------------------------------
 
+2.9.3 (not yet released)
+
+#51 (csv): Set of custom objects with `IGNORE_UNKNOWN` brokes silently csv
+ (reported by Simone L)
+
 2.9.2 (14-Oct-2017)
 
 No changes since 2.9.1