-
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-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 "I don't quite know". And with 2.x -> 3.0 work being ambitious, that is even less predictable.
But, currently I think that:
- Depending on scope of 2.11, first pre-release candidate could be out by end of 2019, with release in early 2020.
- 3.0 is UNLIKELY to be released BEFORE early 2020, but work on it will continue concurrently with 2.11 release.
- (databind) https://github.com/FasterXML/jackson-databind/issues/953 -- Localization, Turkish I
- (databind) https://github.com/FasterXML/jackson-databind/issues/2527 -- Add
MapperFeatureto support Kotlin's "is-getters" - (PR / 2.11) https://github.com/FasterXML/jackson-databind/pull/2533 -- prevent use of "unsafe" base class with PTV.
- (PR / 2.11 / rebase / CSV) https://github.com/FasterXML/jackson-dataformats-text/pull/97 -- nested values (old PR)
- (databind) https://github.com/FasterXML/jackson-databind/issues/2536 -- Need a Feature like "READ_ENUM_KEYS_USING_INDEX" 0
-
https://github.com/FasterXML/jackson-dataformats-text/issues/115: (CSV)
JsonProperty.indexis not honored byCsvSchemabuilder - https://github.com/FasterXML/jackson-databind/issues/2353 -- Both DELEGATING and PROPERTIES creator (should already work?)
- (XML) https://github.com/FasterXML/jackson-dataformat-xml/issues/324: use of
xsi:typefor writing - (jackson-jr) https://github.com/FasterXML/jackson-jr/issues/32: Support subset of Jackson annotations (
@JsonPropertyet al) - (cbor) https://github.com/FasterXML/jackson-dataformats-binary/issues/186 -- Max lengths for things
- (databind) https://github.com/FasterXML/jackson-databind/issues/2509 --
AnnotatedMethod.setValue(), exception unwrapping (need Test) - (databind) https://github.com/FasterXML/jackson-databind/issues/2486 -- Builder Deserialization with JsonCreator Value vs Array (Need Test)
- (Smile) https://github.com/FasterXML/jackson-dataformats-binary/issues/158 --
BigDecimal,NaN(need test case) - (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)
- (databind) https://github.com/FasterXML/jackson-databind/issues/2545 -- ClassCast via Spring, polymorphic typing -- need Test Case
- XML
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/pull/366 --
xsi:nilproblem with nesting - (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/318 -- "Empty" POJO from "blank" (all-ws)
- (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/356 -- Root name for Collection types
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/pull/366 --
- 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
- (CSV) https://github.com/FasterXML/jackson-dataformats-text/issues/10 -- missing
nullvalues - XML
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/319: Empty List fail
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/358 -- XSI namespace in general
- (xml) https://github.com/FasterXML/jackson-dataformat-xml/issues/219 -- String-argument constructor
- Lenient deserialization
- (databind) https://github.com/FasterXML/jackson-databind/issues/1852: Case-insensitive Booleans
- (databind) https://github.com/FasterXML/jackson-databind/issues/2113: Leniency vs scalars (Boolean)
- Databind
- (databind) https://github.com/FasterXML/jackson-databind/issues/2353 -- multiple
@JsonCreators - (databind) https://github.com/FasterXML/jackson-databind/issues/2465 --
@JacksonInject,@JsonCreator - https://github.com/FasterXML/jackson-databind/issues/2438 -- Duplicate property value Creator vs field/setter
- https://github.com/FasterXML/jackson-core/issues/500: allow "optional padding" for base64 (not just required/not-allowed choices)
- (databind) https://github.com/FasterXML/jackson-databind/issues/2353 -- multiple
- (UUID) https://github.com/cowtowncoder/java-uuid-generator/pull/33 -- switch to
slf4jAPI
-
https://github.com/FasterXML/jackson-databind/issues/2548: default
SubTypeValidatorin 3.0 for@JsonTypeInfo- and likely new annotation? (
@JsonSubTypeValidator?)
- and likely new annotation? (
- 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
Other
- (avro) https://github.com/FasterXML/jackson-dataformats-binary/issues/164 -- reader/writer schema, union
- 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?
- Databind
-
https://github.com/FasterXML/jackson-databind/issues/2253: support multiple properties with
@JsonRootName, unwap;
-
https://github.com/FasterXML/jackson-databind/issues/2253: support multiple properties with
- 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: (
These entries have been evaluated but not solved (either worked without full solution, or deemed unlikely to be solved and no attempt made)
- Databind
-
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
-
https://github.com/FasterXML/jackson-databind/issues/1986:
- (Java 8 / datatypes) https://github.com/FasterXML/jackson-modules-java8/issues/86 --
Optional, polymorphic types -- bug it seems, but hard to reason about. - (Java 8 date/time) https://github.com/FasterXML/jackson-modules-java8/issues/109:
Instant, integer/nanoseconds -- probably NOT a bug, but need to verify - (Kava 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?
- 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/2283: problem with
READ_ONLY,Lists- PR: https://github.com/FasterXML/jackson-databind/pull/2284 -- sizable changes, not sure what to think
- (avro) https://github.com/FasterXML/jackson-dataformats-binary/issues/167 -- Apache Avro lib 1.8/1.9 problem
- 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
Here are things since September 26, 2019 (time of 2.10.0 release)
- (databind) https://github.com/FasterXML/jackson-databind/issues/2478 -- CVE wrt
commons-dbcp(28-Sep-2019)
- (afterburner) https://github.com/FasterXML/jackson-modules-base/issues/82 -- Java 12 problem
- (databind) https://github.com/FasterXML/jackson-databind/issues/2457 -- Enum subtypes as Map keys (29-Sep-2019)
- (databind) https://github.com/FasterXML/jackson-databind/issues/2475 --
setCurrentValue(),StringCollectionSerializer(29-Sep-2019) - (databind) https://github.com/FasterXML/jackson-databind/issues/2473 -- error location reporting, custom String deserializer in
List(29-Sep-2019) - (streaming) https://github.com/FasterXML/jackson-core/issues/455 -- wrong location for EOF
- (joda) #108 --
JodaDateSerializerDiscards Shape Override Preference (05-Oct-2019) - (java 8 date/time) https://github.com/FasterXML/jackson-modules-java8/issues/127 -- ZonedDateTime in map keys ignores option to write Zone IDs (06-Oct-2019)
- (jax-rs) https://github.com/FasterXML/jackson-jaxrs-providers/issues/114 -- module-info
javax.ws.rs-api(06-Oct-2019) - (csv) https://github.com/FasterXML/jackson-dataformats-text/issues/15 -- Add a
CsvParser.Feature.SKIP_EMPTY_LINESto allow skipping empty rows (07-Oct-2019) - (kotlin) https://github.com/FasterXML/jackson-module-kotlin/issues/176 -- Android compatibility (14-Oct-2019)
- (databind) https://github.com/FasterXML/jackson-databind/issues/2513 --
BigDecimal, "as string" (19-Oct-2019) - (kotlin) https://github.com/FasterXML/jackson-module-kotlin/pull/244 -- singleton handling (21-Oct-2019)
- (databind) https://github.com/FasterXML/jackson-databind/issues/2519 --
BigDecimal"as-string" inList<Object>(23-Oct-2019) - (cbor) https://github.com/FasterXML/jackson-dataformats-binary/issues/185 -- possible DoS with nested tags (01-Nov-2019)
- (databind) https://github.com/FasterXML/jackson-databind/issues/2534 -- arrays,
PolymorphicTypeValidator(06-Nov-2019) - (databind) https://github.com/FasterXML/jackson-databind/issues/2535 --
byte[]toStringcoercion for String collection/array deserializers (07-Nov-2019)
- (streaming) https://github.com/FasterXML/jackson-core/issues/565 -- add missing
writeNumberField()overloads (04-Oct-2019) - (databind) https://github.com/FasterXML/jackson-databind/pull/2487 -- BeanDeserializerBuilder Protected Factory Method for Extension (04-Oct-2019)
- (joda) https://github.com/FasterXML/jackson-datatype-joda/pull/105 -- offset ignored for
Interval(05-Oct-2019) - (databind) https://github.com/FasterXML/jackson-databind/pull/2484 -- Test stability improvements (07-Oct-2019)
- (jax-rs) https://github.com/FasterXML/jackson-jaxrs-providers/pull/109 -- Security access for class load (07-Oct-2019)
- (Java 8 date/time) https://github.com/FasterXML/jackson-modules-java8/issues/58 -- Should not parse
LocalDates from number (timestamp) -- or at least should have an option preventing (08-Oct-2019) - (databind) https://github.com/FasterXML/jackson-databind/issues/2503 -- Support
@JsonSerialize(keyUsing)and@JsonDeserialize(keyUsing)on Key class itself (16-Oct-2019) - (csv) https://github.com/FasterXML/jackson-dataformats-text/issues/7: Support coercion of empty strings to null objects (21-Oct-2019)
- (databind) https://github.com/FasterXML/jackson-databind/pull/2049: TreeTraversingParser and UTF8StreamJsonParser create contexts differently (25-Oct-2019)
- (databind) https://github.com/FasterXML/jackson-databind/pull/2525: Incorrect
JsonStreamContextforTokenBufferandTreeTraversingParser(25-Oct-2019) - (kotlin) https://github.com/FasterXML/jackson-module-kotlin/issues/80: Boolean property handling (25-Oct-2019)
- (kotlin) https://github.com/FasterXML/jackson-module-kotlin/issues/130 -- Default parameter handling (25-Oct-2019)
- (databind) https://github.com/FasterXML/jackson-databind/issues/2529 --
@JsonSettertests forEnumSet/EnumMap(28-Oct-2019) - (databind) https://github.com/FasterXML/jackson-databind/issues/2526 -- CVE wrt
ehcache/JNDI (01-Nov-2019) - (databind) https://github.com/FasterXML/jackson-databind/issues/2515 -- multiple type ids (05-Nov-2019)
- (databind) https://github.com/FasterXML/jackson-databind/issues/2480 -- Fix
JavaType.isEnumType()to support sub-classes (13-Nov-2019) - (databind) https://github.com/FasterXML/jackson-databind/issues/2352 -- Aliases for Enums (24-Nov-2019)
- (2.11 / databind) https://github.com/FasterXML/jackson-databind/issues/2539 -- Add
Deserializer.hasDeserializerFor()(26-Nov-2019) - (avro) https://github.com/FasterXML/jackson-dataformats-binary/issues/179 --
canWriteBinaryNatively()(26-Nov-2019)
- "Jackson 2.10 features" (28-Sep-2019)
- (woodstox) https://github.com/FasterXML/woodstox/issues/84 -- test fail on Windows (28-Sep-2019)
- (woodstox) https://github.com/FasterXML/woodstox/pull/88 -- missing trailing quote? (01-Nov-2019)