Move jackson-datatype-money module from zalando #48

sri-adarsh-kumar · 2024-10-18T14:02:12Z

Moves jackson-datatype-money module from zalando

Context

Related to #5 and zalando/jackson-datatype-money#224

From the above conversations, there is a consensus to move the zalando/jackson-datatype-money library as a sub-module of this repository.

In order to achieve this, I have moved the files almost 1:1 from the source repository.

Only major changes were related to tests. The source repo had Junit Jupiter tests with @ParameterizedTest. The destination library already had other tests using junitParams.Parameters, so this was adopted.

Review Suggestions

Please focus on

How to use correct License
How to attribute credits correctly
Package naming conventions

sri-adarsh-kumar · 2024-10-18T14:04:46Z

javax-money/src/main/resources/META-INF/LICENSE

@@ -0,0 +1,23 @@
+TODO What goes here? (This original one or another?)


Need some support with the License information

If this code happened to be licensed under Apache License 2, we could just use modified version of other modules' LICENSE, like:

This copy of Jackson Jakarta JSONP extension module is licensed under the Apache (Software) License, version 2.0 ("the License"). See the License for details about distribution rights, and the specific rights regarding derivative works. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0``` But as long as we know what the license used is (we can't change it), should modify above to refer to whatever license there is.

That is: we have to use the original license -- unless we have original author(s) permission to use some other license.

Ok so its MIT License instead. So... I guess we could just include full license like so, given it's copyright by Zalando. No changes needed.

But we do need to make sure <license> tag in pom.xml has MIT license (we might have parent pom defaulting to Apache 2)

sri-adarsh-kumar · 2024-10-18T14:05:04Z

javax-money/src/moditect/module-info.java

@@ -0,0 +1,13 @@
+//TODO how is this generated


I am not sure how this file is generated.
Is there some documentation for this?

I think it would be running

../mvnw moditect:generate-module-info

from new modules project dir. Let me try this on PR.

This provides the base, but must be modified; looking at other modules's module-info.java for inspiration.

Hmmh. Alas, that command throws NPE.

on-behalf-of: Zalando OSS Community Co-authored-by: Willi Schönborn <[email protected]> Co-authored-by: Philipp Hirch <[email protected]> Co-authored-by: Jörn Horstmann <[email protected]> Co-authored-by: Lauri at Zalando <[email protected]> Co-authored-by: msparer <[email protected]> Co-authored-by: Alexander Yastrebov <[email protected]> Co-authored-by: Alexey Venderov <[email protected]> Co-authored-by: Alexander Yastrebov <[email protected]> Co-authored-by: Arnaud BOIVIN <[email protected]> Co-authored-by: Bartosz Ocytko <[email protected]> Co-authored-by: Carlos Freund <[email protected]> Co-authored-by: Dario Seidl <[email protected]> Co-authored-by: Georgios Andrianakis <[email protected]> Co-authored-by: Lauri at Zalando <[email protected]> Co-authored-by: Martin Prebio <[email protected]> Co-authored-by: Sean Sullivan <[email protected]> Co-authored-by: Touko Vainio-Kaila <[email protected]> Co-authored-by: lukasniemeier-zalando <[email protected]>

sri-adarsh-kumar · 2024-10-24T13:31:59Z

@cowtowncoder Please review when you have time.

cowtowncoder · 2024-10-25T01:26:04Z

javax-money/pom.xml

+    </description>
+    <url>https://github.com/FasterXML/jackson-datatypes-misc</url>
+    <licenses>
+        <license>


Assuming MIT License as per notes further down, this needs to be changed.

cowtowncoder · 2024-10-25T01:27:25Z

javax-money/pom.xml

+    <name>Jackson datatype: javax-money</name>
+    <packaging>jar</packaging>
+    <version>2.19.0-SNAPSHOT</version>
+    <description>Support for datatypes of Javax Money library (https://javamoney.github.io/)


Maybe also mention Money API spec is from JSR 354 (can link to https://javamoney.github.io/api.html I suppose)

cowtowncoder · 2024-10-25T01:52:47Z

...x-money/src/test/java/com/fasterxml/jackson/datatype/money/CurrencyUnitDeserializerTest.java

+
+public final class CurrencyUnitDeserializerTest {
+
+    private final ObjectMapper unit = new ObjectMapper().findAndRegisterModules();


This is wrong: should specifically add just Money module and not whatever might happen to be in classpath. Ideally would use helper method in test base class or utility/helper class

cowtowncoder · 2024-10-25T01:53:34Z

...ney/src/test/java/com/fasterxml/jackson/datatype/money/CurrencyUnitSchemaSerializerTest.java

+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public final class CurrencyUnitSchemaSerializerTest {


We need to remove or rewrite this test: it must NOT include cross-module dependency for tests because this now introduces a build/release dependency between modules.

There are ways to test schema-generation aspects (to ensure that correct schema traversal methods are called), I'd need to find examples.
Well, jackson-databind has couple of tests under src/test/java/com/fasterxml/jackson/databind/jsonschema/which might be helpful.

cowtowncoder · 2024-10-25T01:57:12Z

...money/src/test/java/com/fasterxml/jackson/datatype/money/MonetaryAmountDeserializerTest.java

+
+        final String content = "{\"amount\":29.95}";
+
+        final JsonProcessingException exception = assertThrows(


While technically correct, use of JsonProcessingException is not optimal as we should check specific subtype that is being thrown, JPE is the most generic Jackson exception base class.

cowtowncoder · 2024-10-25T01:58:54Z

javax-money/pom.xml

+
+        <dependency>
+            <groupId>org.javamoney.moneta</groupId>
+            <artifactId>moneta-core</artifactId>


Is this test-only dependency? Or does module require specific Money API implementation?

cowtowncoder · 2024-10-25T02:01:07Z

javax-money/src/main/java/com/fasterxml/jackson/datatype/money/CurrencyUnitDeserializer.java

+import static org.apiguardian.api.API.Status.MAINTAINED;
+
+@API(status = MAINTAINED)
+public final class CurrencyUnitDeserializer extends JsonDeserializer<CurrencyUnit> {


Usually should extend either StdDeserializer or (if applicable) StdScalarDeserializer.

cowtowncoder · 2024-10-25T02:01:30Z

javax-money/src/main/java/com/fasterxml/jackson/datatype/money/CurrencyUnitSerializer.java

+import static org.apiguardian.api.API.Status.MAINTAINED;
+
+@API(status = MAINTAINED)
+public final class CurrencyUnitSerializer extends StdSerializer<CurrencyUnit> {


Possibly should use StdScalarSerializer.

cowtowncoder · 2024-10-25T02:03:37Z

javax-money/pom.xml

+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.module</groupId>


As per my earlier note, cannot have this dependency -- adds unwanted cross-module dependency for builds, release process.

cowtowncoder · 2024-10-25T02:04:36Z

javax-money/pom.xml

+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.kjetland</groupId>


This dependency OTOH is fine (as it's not part of Jackson module set -- and even if it had transitive dependencies to some Jackson components that'd be ok as it wouldn't complicate build/release process)

cowtowncoder · 2024-10-25T02:05:21Z

javax-money/src/main/java/com/fasterxml/jackson/datatype/money/MonetaryAmountDeserializer.java

+    }
+
+    @Override
+    public Object deserializeWithType(final JsonParser parser, final DeserializationContext context,


If extending StdDeserializer (or, StdScaralDeserializer), wouldn't need to implement this method, I think.

cowtowncoder · 2024-10-25T02:06:42Z

javax-money/src/main/java/com/fasterxml/jackson/datatype/money/MonetaryAmountDeserializer.java

+    private void checkPresent(final JsonParser parser, @Nullable final Object value, final String name)
+            throws JsonParseException {
+        if (value == null) {
+            throw new JsonParseException(parser, format("Missing property: '%s'", name));


Sub-optimal exception as it does not indicate value type that has the issue.
Should usually be passed DeserializationContext and call one of methods it provides for throwing more specific (semantic) exceptions.

cowtowncoder · 2024-10-25T02:07:41Z

javax-money/src/main/java/com/fasterxml/jackson/datatype/money/MonetaryAmountSerializer.java

+    public void serializeWithType(final MonetaryAmount value, final JsonGenerator generator,
+            final SerializerProvider provider, final TypeSerializer serializer) throws IOException {
+
+        // effectively assuming no type information at all


... which is basically wrong :-(

(meaning, won't work with @JsonTypeInfo)

cowtowncoder · 2024-10-25T02:12:02Z

javax-money/src/main/java/com/fasterxml/jackson/datatype/money/MoneyModule.java

+
+    @Override
+    @SuppressWarnings("deprecation")
+    public Version version() {


This is unnecessarily using VersionUtil instead of referencing generated PackageVersion and doing

public Version version() { return PackageVersion.VERSION; }

cowtowncoder · 2024-10-25T02:13:52Z

@sri-adarsh-kumar Ok, so technically I think this looks ok (although I have suggestions and concerns wrt code actually).
But one question I have is whether we need someone else's approval for contribution -- or are you the author? (I understand you work for Zalando from profile?).

I think we need one or more CLAs (from https://github.com/FasterXML/jackson/ either individual or Corporate CLA):

From you (wrt directly adding files here), regardless of authorship of code
Additional CLA(s) from whoever can contribute code itself (if not you).

It might be simplest to get CCLA from Zalando, although that is not a requirement if authors can give individual CLAs.

sri-adarsh-kumar commented Oct 18, 2024

View reviewed changes

sri-adarsh-kumar force-pushed the 2.19 branch from 1166e8e to f29f0e3 Compare October 22, 2024 14:26

sri-adarsh-kumar force-pushed the 2.19 branch from f29f0e3 to abaf36d Compare October 22, 2024 14:40

sri-adarsh-kumar marked this pull request as ready for review October 22, 2024 17:00

cowtowncoder reviewed Oct 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move jackson-datatype-money module from zalando #48

Move jackson-datatype-money module from zalando #48

sri-adarsh-kumar commented Oct 18, 2024 •

edited

Loading

sri-adarsh-kumar Oct 18, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

sri-adarsh-kumar Oct 18, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

sri-adarsh-kumar commented Oct 24, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024 •

edited

Loading

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024

cowtowncoder commented Oct 25, 2024

		@@ -0,0 +1,23 @@
		TODO What goes here? (This original one or another?)


		public final class CurrencyUnitDeserializerTest {

		private final ObjectMapper unit = new ObjectMapper().findAndRegisterModules();


		import static org.assertj.core.api.Assertions.assertThat;

		public final class CurrencyUnitSchemaSerializerTest {


		final String content = "{\"amount\":29.95}";

		final JsonProcessingException exception = assertThrows(

Move jackson-datatype-money module from zalando #48

Are you sure you want to change the base?

Move jackson-datatype-money module from zalando #48

Conversation

sri-adarsh-kumar commented Oct 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sri-adarsh-kumar commented Oct 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cowtowncoder Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cowtowncoder commented Oct 25, 2024

sri-adarsh-kumar commented Oct 18, 2024 •

edited

Loading

cowtowncoder Oct 25, 2024 •

edited

Loading