-
Notifications
You must be signed in to change notification settings - Fork 3
Jackson Work in Progress
This page is a "living document" of on-going work, mostly by @cowtowncoder (Tatu), although other committers are welcome to update it as well.
Note that there is also a complementary set of things core developers may eventually work on but that may be better tackled by other contributors:
New Contributor Friendly Issues
Contents are divided in multiple sections, first in a few kinds of actionable (*) things:
- Things to evaluate -- haven't yet had a chance to fully grok
- Next up -- items to start work on (or being worked on)
- Urgent to fix -- security problems, correctness (corruption), reliability (threading/concurrency)
- Simple to fix -- low(er) hanging fruits that are likely relatively easily fixable (and important enough to include here)
- Important to fix -- things that important strategically, or highly "voted", but that are more involved to fix/implement.
and then one other theoretically-actionable category:
- Things to contemplate (not easy to fix and not even sure if behavior should change and/or if attempting to fix is worth the hassle or even possible), divided into
- May revisit
- Unlikely to revisit
as finally the "Recently Completed" addendum. Plus, I try to give "safe harbor" style guesstimate on timing of next minor (and in case of 3.0, major) releases.
Note that this page does NOT contain "Big Ideas" for Jackson 3.0: these are covered on separate JSTEP page.
(*) actionable meaning, in general, that progress is only/mostly limited by time available and not by inherent difficulty, or lack of design or ideas of how to tackle the need.
- 26-Apr-2020, tatu: Clean up after
2.11.0release - 26-Sep-2019, tatu:
2.10.0(final) released: clear up "recently completed" entries - 16-May-2019, tatu: Move now obsolete "recently completed" after 2.9.9 release, to make room
- 29-Oct-2018, tatu: Create the initial version
While patch releases occur somewhat frequently -- after initial minor version, usually once per month for 2 or 3, then 2-3 months after that -- minor versions have gone from "every 3 months" (with 1.x) to "every 6 months" (later 2.x) to "hard to say" (with 2.10 taking 2 years!). And with 2.x -> 3.0 work being ambitious, that is even less predictable.
But, currently I think that:
- 2.11.0 was released in April 202, 2.12 should be released by end of 2020
- 3.0 could get close to release candidates towards end of 2020.
- (databind) https://github.com/FasterXML/jackson-databind/issues/2715 -- Class loading deadlock,
PropertyNamingStrategy - (databind) https://github.com/FasterXML/jackson-databind/issues/2726 -- Gradle Module metadata
Jackson
- (databind Lenient deserialization
- (databind) https://github.com/FasterXML/jackson-databind/issues/1852: Case-insensitive Booleans
- (databind) https://github.com/FasterXML/jackson-databind/issues/2113:
CoercionConfig(coercions, leniency) - (databind) https://github.com/FasterXML/jackson-databind/issues/2066 -- Strict
java.lang.UUIDparsing (no "")
- (databind) https://github.com/FasterXML/jackson-databind/issues/2729 -- Bean naming convention, Scala
- (streaming) https://github.com/FasterXML/jackson-core/pull/235 -- output values with single quote
- (csv) https://github.com/FasterXML/jackson-dataformats-text/issues/198 -- Numbers as (quoted) Strings always
- (java 8 / databind) https://github.com/FasterXML/jackson-modules-java8/ -- Date/Time, allow timestamp
- (core / 3.0) https://github.com/FasterXML/jackson-core/issues/620 -- format read features to
ParserMinimalBase
Misc non-Jackson:
- (woodstox) https://github.com/FasterXML/woodstox/issues/91 -- Location, external subsets (test added via PR 98)
- (java 8 date/time) https://github.com/FasterXML/jackson-modules-java8/issues/175 -- TimeZone,
@JsonFormat - (yaml) https://github.com/FasterXML/jackson-dataformats-text/issues/173 -- yaml doc from empty input
- (Classmate) https://github.com/FasterXML/java-classmate/issues/50 -- Convenience method(s) ("implemented types")
- (streaming) https://github.com/FasterXML/jackson-core/issues/478 --
ByteBufferfor non-blocking - (streaming) https://github.com/FasterXML/jackson-core/pull/573 -- configurable filtering
- (streaming) https://github.com/FasterXML/jackson-core/issues/584 -- Type Ids, allow skipping
null - (streaming) https://github.com/FasterXML/jackson-core/issues/500: allow "optional padding" for base64 (not just required/not-allowed choices)
- Databind, important, "most wanted":
- (databind) https://github.com/FasterXML/jackson-databind/issues/1296 --
@JsonIncludeProperties - (databind) https://github.com/FasterXML/jackson-databind/issues/1498 -- Single-arg creator; properties/delegating
- (java 8) https://github.com/FasterXML/jackson-modules-java8/issues/50 -- Single-arg creator
- (databind) https://github.com/FasterXML/jackson-databind/issues/2045 --
@PreSerialize/@PostDeserializemethod annotations - (databind)
JsonNodeFeature? JSTEP-3
- (databind) https://github.com/FasterXML/jackson-databind/issues/1296 --
- Databind, important, other:
- (databind)
@JsonNamingon value class not applied to use via Builder -- Builder,@JsonNamingon value class
- (databind)
- Databind, simple: (many marked as "good first issue")
- (databind) https://github.com/FasterXML/jackson-databind/issues/2215 --
BigDecimalwithStdValueInstantiator - (databind) https://github.com/FasterXML/jackson-databind/issues/1281 --
@JsonIgnorePropertiesfor serialization via "any getter"
- (databind) https://github.com/FasterXML/jackson-databind/issues/2215 --
- Databind, other:
- (databind) https://github.com/FasterXML/jackson-databind/issues/2722 -- Allow construction of "format-bending"
ObjectMapper.Builders? - (databind) https://github.com/FasterXML/jackson-databind/issues/2438 -- Duplicate property value Creator vs field/setter
- (databind) https://github.com/FasterXML/jackson-databind/issues/1172 -- Json View not working with JsonCreator
- (databind) https://github.com/FasterXML/jackson-databind/issues/2678 --
@JacksonInject, overrides (skipprivatefields if constructor) - (databind) https://github.com/FasterXML/jackson-databind/issues/1770 -- BigDecimalNode (NaN due to
Doubletruncating) - (databind) https://github.com/FasterXML/jackson-databind/issues/2667 -- Enum naming strategy?
- (databind) https://github.com/FasterXML/jackson-databind/issues/2624 -- Config override for "with"-prefix (builders).
- (databind) https://github.com/FasterXML/jackson-databind/issues/2354 -- Builder, static builder creation method?
- (databind) https://github.com/FasterXML/jackson-databind/issues/2465 --
@JacksonInject,@JsonCreator - (databind) https://github.com/FasterXML/jackson-databind/issues/2536 -- Need a Feature like "READ_ENUM_KEYS_USING_INDEX" 0
- (databind) https://github.com/FasterXML/jackson-databind/issues/2563 -- Turkish I, part 2
- (databind) https://github.com/FasterXML/jackson-databind/issues/2692 -- Should never call
set()on setterless property during deserialization - (databind) https://github.com/FasterXML/jackson-databind/issues/2724 -- No Polymorphic Type Id for Object Ids, even if Default Typing enabled
- (databind) https://github.com/FasterXML/jackson-databind/issues/2722 -- Allow construction of "format-bending"
Easyish? (evaluate)
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/128 -- Using XmlAttribute for property with object type breaks serialization of next properties
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/185 -- Mixins, unwrapped List
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/256 -- deser, list?
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/269 -- Convert POJO which contains the xml of another unspecified POJO, but the result is not expected
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/304 -- Woodstox, no automatic empty elements?
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/306 -- Unmarshalling a @JacksonXmlText property fails if there is a all-args-constructor (even a private one)
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/390 -- Unexpected attribute at string fields causes extra objects to be created in parent list
Regression/Partial fixes
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/319 -- Empty List fail -- NOTE! Works in 3.x already
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/318 -- "Empty" POJO from "blank" (all-ws) -- works in 2.12 but NOT in 3.x (which forces
null)
Evaluated, other:
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/314 -- Deser, List
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/330 -- Deser, List, Kotlin, BigXML -- waiting for test case
Important
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/205 -- Untyped Object deser, repeated elements (entry -> array)?
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/150 -- Add DOCTYPE element
- similarly, different XML declaration (
standalone) -- closure/function of "write document beginning"
- similarly, different XML declaration (
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/75 -- Support
CharacterEscapesusing Stax (Woodstox/Aalto) functionality - (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/244 -- Map names invalid
Other
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/114 -- XML,
JsonParser.Feature.STRICT_DUPLICATE_DETECTIONnot implemented - (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/358 -- Skip
xsivalues - (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/254 --
@JsonCreator, delegating,int(from "String") - (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/324 -- use of
xsi:typefor writing - (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/356 -- Root name for Collection types
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/358 -- XSI namespace in general
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/360 -- write
xsi:nil(ToXmlGenerator.Feature.WRITE_NULLS_AS_XSI_NILadded, implementation not yet) - (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/374 -- DeserializationFeature.UNWRAP_ROOT_VALUE in XML
Deferred:
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/385 --
xsi:nil, multiple attributes- possibly invalid, weird semantics wrt
xsi:nil
- possibly invalid, weird semantics wrt
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/289 -- BigDecimal, type info
- Dataformats, binary
-
https://github.com/FasterXML/jackson-dataformats-binary/issues/73: (
protobuf) References to nested types
-
https://github.com/FasterXML/jackson-dataformats-binary/issues/73: (
- Avro
- (avro) https://github.com/FasterXML/jackson-dataformats-binary/issues/164 -- reader/writer schema, union
- CBOR
- (cbor) https://github.com/FasterXML/jackson-dataformats-binary/issues/186 -- Max lengths for things
- CSV
- (csv) https://github.com/FasterXML/jackson-dataformats-text/issues/176 -- Allow skipping first line of input file
- (csv) https://github.com/FasterXML/jackson-dataformats-text/issues/10 -- missing
nullvalues - (csv / PR) https://github.com/FasterXML/jackson-dataformats-text/pull/97 -- nested values (old PR)
- Databind
-
https://github.com/FasterXML/jackson-databind/issues/2253: support multiple properties with
@JsonRootName, unwap; -
https://github.com/FasterXML/jackson-databind/issues/1850: Enum,
@JsonValue,int/long
-
https://github.com/FasterXML/jackson-databind/issues/2253: support multiple properties with
- Avro
- (PR) (avro): https://github.com/FasterXML/jackson-dataformats-binary/pull/133 -- Logical types
- (avro) https://github.com/FasterXML/jackson-dataformats-binary/issues/165 -- missing default value for
Map
- (databind) https://github.com/FasterXML/jackson-databind/issues/2572:
JsonSetter, no-default-ctor -- not sure if bug or not; 2.9 vs 2.10 behavior - (CBOR) https://github.com/FasterXML/jackson-dataformats-binary/issues/166 -- feature to force use of length-prefix for all String values (waiting for possible PR)
- Finish partial rewrite of
JsonFormat.Shapehandling to support ALL changes (POJO to/from non-POJO), for types AND properties -
https://github.com/FasterXML/jackson-databind/issues/2550: Rewrite Enum introspection via
AnnotationIntrospector -
https://github.com/FasterXML/jackson-databind/issues/2246: "Iterable"
JavaTypeforStream,Iteratoretc -
https://github.com/FasterXML/jackson-core/issues/485: Add
vanillaversion for generators, to optimize handling- f.ex. one with no
PrettyPrinter, using standard quoting
- f.ex. one with no
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/359 -- Test fail wrt String
nullvs "" - (databind) Introspection callbacks ("json schema"): simplify String-type callbacks etc
- Annotations
-
https://github.com/FasterXML/jackson-annotations/pull/149: Use
@Repeatedon annotations likeJsonSubtypes.Type
-
https://github.com/FasterXML/jackson-annotations/pull/149: Use
- Streaming
- Remove mutability of
JsonGenerator: NOTE,CharacterEscapeshard (due to JSONP), max-non-escaped easy too? Features? - Remove
JsonParser.setSchema() - https://github.com/FasterXML/jackson-core/issues/507: Escape forward slash in Strings by default (but also allow change)
- Remove mutability of
- Databind
- https://github.com/FasterXML/jackson-databind/issues/2405: SQL date, default timezone
- https://github.com/FasterXML/jackson-databind/issues/1687: JsonView with JsonNode (convenience method)
-
https://github.com/FasterXML/jackson-databind/issues/2496: "null key" and "null value" serializers via
MapperBuilder, not module?
These entries have been evaluated but not solved (either worked without full solution, or deemed unlikely to be solved and no attempt made)
- Databind
- (databind) https://github.com/FasterXML/jackson-databind/issues/2686 --
@JsonBackReference, Builder -
https://github.com/FasterXML/jackson-databind/issues/1986:
Throwable, self-reference (NOTE: probably not really simple to solve, but need to evaluate) -
https://github.com/FasterXML/jackson-databind/issues/2382: Support
AutoClosable(NOTE: not as trivial to implement as I thought) -
https://github.com/FasterXML/jackson-databind/issues/2087: Performance improvement for
BigDecimal(see the end of comment section) - https://github.com/FasterXML/jackson-databind/issues/1196: Collect multiple errors
- (databind) https://github.com/FasterXML/jackson-databind/issues/2593 -- Java 9,
StackTraceElement
- (databind) https://github.com/FasterXML/jackson-databind/issues/2686 --
- Java 8:
- (datatypes) https://github.com/FasterXML/jackson-modules-java8/issues/86 --
Optional, polymorphic types -- bug it seems, but hard to reason about. - (date/time) https://github.com/FasterXML/jackson-modules-java8/issues/109:
Instant, integer/nanoseconds -- probably NOT a bug, but need to verify - (Java 8 optional) https://github.com/FasterXML/jackson-modules-java8/issues/154:
Optional<JsonNode>not working.- Not a bug per se, but could this be improved?
- (datatypes) https://github.com/FasterXML/jackson-modules-java8/issues/86 --
- Jackson-jr
-
https://github.com/FasterXML/jackson-jr/issues/62: Support
atwithJsonPointer(but what abstraction?JSONprobably, otherwise too many overloads) - problem, noObjectWriterequivalent for jackson-jr
-
https://github.com/FasterXML/jackson-jr/issues/62: Support
- JSON Schema: https://github.com/FasterXML/jackson-module-jsonSchema/issues/136 --
ClassDescriptionnot used? - Formats:
- (CSV) https://github.com/FasterXML/jackson-dataformats-text/issues/45 -- trailing linefeed
- (PR) ^^^ https://github.com/FasterXML/jackson-dataformats-text/pull/46 -- ideally rewrite
- (CSV) https://github.com/FasterXML/jackson-dataformats-text/issues/45 -- trailing linefeed
- (databind) https://github.com/FasterXML/jackson-databind/issues/2644 -- BigDecimal coercion due to buffering
- Would be great to resolve, perhaps by keeping numbers as Strings if coming from String source -- but not sure how to abstract that logic out, or, how to even link eventual decoding (validation has occurred already)
- At least 3 parts: (1) does it come from textual input, (2) has number been decoded already, (3) how to decode later on (buffer has no linkage to parser)
- Note: heuristic for using
BigDecimalfor certain length of decimal part might work... or maybe not. If not, probably worse than never working (more complicated, still not reliable)
- Databind
- https://github.com/FasterXML/jackson-databind/pull/2180 -- order of Constructor / Factory method lookup for KEY deserializers (change order from current)
-
https://github.com/FasterXML/jackson-databind/issues/2305: problem with
@JsonCreator, single string argument- Due to "all implicit" vs "all explicit": not sure if should change
- (databind) https://github.com/FasterXML/jackson-databind/issues/2461 --
@JsonUnwrapped, serializer caching- Would be good to fully understand, but may be fundamental problem with multi-level nesting
- (Java8) https://github.com/FasterXML/jackson-modules-java8/issues/111: Java8 module(s), serializability
-
java.time.format.DateTimeFormatterNOT beingjava.io.Serializable. Failing test added. - Unfortunately, while fixed for 3.0, difficult to fix for
2.10due to
-
Note: many Big Ideas now included on JSTEP page.
But a scratchpad for stuff can be retained...
- Add new
JsonTokentype for "Native Object Id Reference", mostly for YAML?
(NOTE: need to include in some better way, but for now just need a place to add ideas)
Another dimension of things to work is... documentation.
- https://github.com/FasterXML/jackson-dataformats-text/issues/133: (YAML) Document multi-doc use case, differences
- Rewrite
jackson-databindREADMEto make it plain that JSON is NOT the only supported format: add examples, links - Jackson 2.10 release documentation: (PolymorphicTypeValidator, JsonNode impr done)
- Jackson-jr improvements: read value sequences, custom
ValueReaders,ValueWriters
- Jackson-jr improvements: read value sequences, custom
- Write blog entries about:
- How does property introspection COMPLETELY work
- Simple "untyped" serialization with Guava ImmutableMap/ImmutableList
- Using "Config Overrides"
- How are
JsonSerializers located, initialized - How are
JsonDeserializers located, initialized - Null handling with XML (esp.
String,List/Map)
Here are things since April 26, 2020 (time of 2.11.0 release)
- (core) https://github.com/FasterXML/jackson-core/issues/616 -- Infinite loop with
ALLOW_MISSING_VALUE
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/393 --
MismatchedInputException: Cannot deserialize instance of java.lang.String out of START_OBJECT token (11-May-2020)
- (databind) https://github.com/FasterXML/jackson-databind/issues/921 -- Builder, generic types: backport 3.0 -> 2.12 (28-Apr-2020)
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/318 -- "Empty" POJO from "blank" (all-ws) (30-Apr-2020)
- (databind) https://github.com/FasterXML/jackson-databind/issues/2683 -- catch
java.time(de)ser access (05-May-2020) - (databind) https://github.com/FasterXML/jackson-databind/issues/2091 -- ReferenceType, TypeBindings, containedType(0) (05-May-2020)
- (databind) https://github.com/FasterXML/jackson-databind/issues/1919 -- Skip type ids of abstract types in exception message (05-May-2020)
- (databind) https://github.com/FasterXML/jackson-databind/issues/2675 --
Voidproperties (06-May-2020) - (databind) https://github.com/FasterXML/jackson-databind/issues/1886 -- Allow use of
@JsonFormat(with=JsonFormat.Feature.ACCEPT_CASE_INSENSITIVE_PROPERTIES)(07-May-2020) - (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/273: case-insensitive names (11-May-2020)
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/86 -- Can not deserialize unwrapped list when
@JacksonXmlPropertylocalName matches@JacksonXmlRootElementlocalName (12-May-2020) - (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/397 --
XmlReadContextdoes not keep track of array index (13-May-2020) - (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/377 -- Base64Variant (13-May-2020)
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/395 -- Namespace-repairing mode,
xmlURI (13-May-2020) - (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/399 -- Can not deserialize unwrapped list when
@JacksonXmlPropertylocalName matches parent localName (14-May-2020) - (csv) https://github.com/FasterXML/jackson-dataformats-text/issues/199 --
Listfrom empty String (16-May-2020) - (databind) https://github.com/FasterXML/jackson-databind/issues/2719 -- FAIL_ON_IGNORED_PROPERTIES does not throw on READONLY properties with an explicit name (16-May-2020)
- (databind) https://github.com/FasterXML/jackson-databind/issues/2118 --
JsonProperty.Access.READ_ONLYdoes not work with setterless Collections (16-May-2020) - RE-CONSIDER: (databind) https://github.com/FasterXML/jackson-databind/issues/2283: problem with
READ_ONLY,Lists (16-May-2020) - (databind) https://github.com/FasterXML/jackson-databind/issues/2725 -- Enum as Map key,
@JsonCreator(19-May-2020) - (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/403 -- Make
JsonNodeimplicitly createArrayNodes for repeated XML Elements (20-May-2020)- (databind) https://github.com/FasterXML/jackson-databind/issues/2732 --
JsonNode, XML, arrays
- (databind) https://github.com/FasterXML/jackson-databind/issues/2732 --
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/389 -- Polymorphic serialize with
ObjectWriter(21-May-2020) - (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/262 -- Make
ToXmlGeneratornot final (in 2.12) (21-May-2020)