feat!: add jackson annotations additionalProperties

[memdal]

• Adds @JsonAnySetter and @JsonAnyGetter annotations to additionalProperties

Description

Adds these annotations so that Jackson can marshall and unmarshall additional properties.

Checklist

• The code follows the project's coding standards and is properly linted (npm run lint).
• Tests have been added or updated to cover the changes.
• Documentation has been updated to reflect the changes.
• All tests pass successfully locally.(npm run test).

[netlify]

✅ Deploy Preview for modelina canceled.

Name	Link
🔨 Latest commit	fa2cccc
🔍 Latest deploy log	https://app.netlify.com/sites/modelina/deploys/6704dc742c7175000804c5d1

[jonaslagoni]

additionalProperties needs to be unwrapped, not simply serialized and deserialized 🙂

I dont think there is anything native in Jackson that supports that. Might be wrong though.

[memdal]

Hi, thanks for taking a look. What would unwrapped mean in this context?

In my tests any unknown key/value pair was given its own entry in the map, and any object value would become a map of its own.

[jonaslagoni]

serialized value {additionalProperties: {test: '123'}} should become {test: '123'}.

if it's not possible we should just ignore the property and add it to the documentation

[memdal]

In that case it does some wrapping/unwrapping. What happens is now (pseudocode):

Json to deserialize:

{
  "defined_property": "defined property value",
  "undefined_property": "undefined property value"
}

Java class to unmarshal the JSON into:

class JavaClassRepresentation {
// getters/setters/annotations and other methods omitted for brevity
  private String definedProperty = "defined property value";
  private Map<String, Object> additionalProperties = Map.of(
    Entry.of("undefined_property", "undefined property value")
  );
}

Json serialized from the Java class:

{
  "defined_property": "defined property value",
  "undefined_property": "undefined property value"
}

The one edge case I am uncertain about is if an additional property is actually named additionalProperties and has an object value. In that case it can either merge the maps and lose the wrapping/unwrapping, or it will have to lose data.

[memdal]

@jonaslagoni The @JsonAnyGetter annotation ensures that the properties from the additionalProperties map are unwrapped on serialization. Do you think this change could be added?

[jonaslagoni]

@memdal thats perfect yea: https://www.tutorialspoint.com/jackson_annotations/jackson_annotations_jsonanygetter.htm

My bad for not realizing it before ✌️ confused it with regular getter method..

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[jonaslagoni]

Nice 👍

[jonaslagoni]

@all-contributors please add @memdal for code, test

[allcontributors]

@jonaslagoni

I've put up a pull request to add @memdal! 🎉

[asyncapi-bot]

🎉 This PR is included in version 4.0.0-next.62 🎉

The release is available on:

• npm package (@next dist-tag)
• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀