Undocumented API changes and suggested alternatives collection

[odrotbohm]

• ObjectMapper.setSerializationInclusion(…) -> JsonMapper.builder().changeDefaultPropertyInclusion(incl -> incl.withValueInclusion(…))
  • Remove ObjectMapper.setSerializationInclusion() from 3.0 (deprecate in 2.20) #5270
• ObjectMapper.getRegisteredModuleIds() -> ObjectMapper.getRegisteredModules()
  • Replace ObjectMapper.getRegisteredModuleIds() (2.x) with ObjectMapper.getRegisteredModules() (3.0) #5272
• Default ISO dates in UTC now render a trailing Z instead of a +00 as they did in 2.x

[pjfanning]

I'm commuting do hard to provide a full answer. Have a look at a 2.x test that uses this feature on then switch to branch 3.x. Correct the directory for 3.x - tools instead of com.fasterxml.
https://github.com/search?q=repo%3AFasterXML%2Fjackson-databind%20setSerializationInclusion&type=code

[odrotbohm]

Would it not make sense to keep that as documentation ticket? It's a breaking API (fine), which means that it would be nice if folks were able to find an alternative without rummaging through tests.

[pjfanning]

this is not the only change and yes, it would be nice to have a big migration guide

[pjfanning]

#1967 exists to track this

[pjfanning]

https://github.com/FasterXML/jackson-databind/blob/3.x/src/test/java/tools/jackson/databind/jsontype/Generic1128Test.java#L57-L59

New API is called changeDefaultPropertyInclusion and appears in JsonMapper.Builder.

[cowtowncoder]

All configuration in 3.x is via mapper builders (MapperBuilder base and sub-types like JsonMapper.Builder) and like @pjfanning mentioned it's changeDefaultPropertyInclusion():

https://github.com/FasterXML/jackson-databind/blob/3.x/src/main/java/tools/jackson/databind/cfg/MapperBuilder.java#L928

As to documenting changes; unfortunately I started creating issues only half-way through removals so some of explicit removal history is undocumented. None of JSTEPs is quite relevant either (https://github.com/FasterXML/jackson-future-ideas/wiki/JSTEP-1, https://github.com/FasterXML/jackson-future-ideas/wiki/JSTEP-2 and https://github.com/FasterXML/jackson-future-ideas/wiki/JSTEP-6 all bit overlapping).

But given the situation, what would be a good way to start collecting info on most commonly asked removals? (in practice we do not have resources to do it systematically)
This one is certainly one of more commonly asked about removals.

Some things to consider: it'd be good

1. Having a single document/wiki-page/discussion/issue to look for replacement choices
2. Be able to easily find that doc/wiki/etc (discoverability)

Another orthogonal thing would be to add forward-looking Javadocs in 2.x to indicate things that will be removed from 3.x,

[JooHyukKim]

Would this suffice for getRegisteredModuleIds() case? cc. @cowtowncoder

[cowtowncoder]

@JooHyukKim I don't think that works: there is no replacement for this method in 2.x, nor can there be -- it is a strict change in actual functionality. In 2.x only Ids are available (Mapper holds no ref to module). In 3.0 there is.

I think @Deprecated should normally only be added to something that can be fixed within same major version.
Otherwise users have no way to get rid of deprecation warnings for, say, 2.20.

Javadoc update tho is reasonable.

I will also re-create an issue here as I think getRegisteredModules() should return Stream<JacksonModule>, not Collection.

[cowtowncoder]

-> #5272

[cowtowncoder]

@odrotbohm We can deal with some of changes by actually creating post-change issues; did that for first 2 things.

I trust it that things you bump into have a good chance of being common enough cases. I agree tho that we are not going to file issues for every single change for, say, removal of ObjectMapper.setXxx() or JsonFactory.setXxx() methods.

[JooHyukKim]

Thank you @cowtowncoder !

[cowtowncoder]

As the "least thing I could do", filed and resolved #5270 (wrt setSerializationInclusion()).

Same for #5272 (wrt getRegisteredModuleIds())

[cowtowncoder]

There is #1967 that we could use instead. I will update that issue too.

How about this: @odrotbohm you can add cases you find here, and then work can be added, #1967 updated as appropriate.

[odrotbohm]

I've added a tiny thing regarding ISO times. The default rendering for UTC is now a trailing Z, not a +00 as it was before.

[cowtowncoder]

@odrotbohm Thanks! Will add a mention on https://github.com/FasterXML/jackson-future-ideas/wiki/JSTEP-2