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

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

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.

javax-money/pom.xml

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.

Ok that works!

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)

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

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.

Changed License reference (WIP) Removed cross-module dependency to jsonSchema Testing specific Modules instead of findAndRegisterModules Assert subtypes of JSONProcessingException CurrencyUnitDeserializer extends StdScalarDeserializer CurrencyUnitSerializer extends StdScalarSerializer MonetaryAmountDeserializer throws semantic exceptions using DeserializationContext MoneyModule version uses PackageVersion

cowtowncoder · 2024-10-30T00:33:04Z

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

+
+
+@API(status = STABLE)
+public final class MoneyModule extends Module {


Should we actually rename this as JavaxMoneyModule?

... also, as a side-note, is there need for "Jakarta Money module"? (wrt javax licensing resulting in "forking" of javax APIs)

cowtowncoder · 2024-10-30T00:34:41Z

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

@@ -0,0 +1,13 @@
+//TODO how is this generated
+// Generated 27-Mar-2019 using Moditect maven plugin


Let's rewrite this comment with current date, something like "Hand-crafted 29-Oct-2024"

cowtowncoder · 2024-10-30T00:35:54Z

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

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


One minor request (apologies for forgetting to mention initially): let's use

JsonMapper.builder().addModule(new MoneyModule()).build();

the reason begin that ObjectMappers are immutable in Jackson 3.0, so merging this module is easier if we use builder pattern.

cowtowncoder · 2024-10-30T00:42:04Z

@sri-adarsh-kumar Thank you for updates, good job so far!

The other thing then has to do with CLAs, permissions -- see my earlier note.
If we can get that through, I should be able to merge this pr!
(getting it merged into master for 3.0 will have its challenges but one thing at a time :) )

sri-adarsh-kumar commented Oct 18, 2024

View reviewed changes

javax-money/src/main/resources/META-INF/LICENSE Outdated Show resolved Hide resolved

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

javax-money/pom.xml Show resolved Hide resolved

cowtowncoder reviewed Oct 25, 2024

View reviewed changes

javax-money/pom.xml Outdated Show resolved Hide resolved

cowtowncoder reviewed Oct 25, 2024

View reviewed changes

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

sri-adarsh-kumar added 2 commits October 29, 2024 13:01

Move Money.md in from source repo

487cbf9

sri-adarsh-kumar force-pushed the 2.19 branch from d44c71e to 487cbf9 Compare October 29, 2024 12:01

cowtowncoder reviewed Oct 30, 2024

View reviewed changes

cowtowncoder mentioned this pull request Oct 30, 2024

Add javax.money support (from zalando / jackson-datatype-money) #5

Open

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

sri-adarsh-kumar commented Oct 24, 2024

cowtowncoder Oct 25, 2024

cowtowncoder Oct 25, 2024 •

edited

Loading

cowtowncoder Oct 30, 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

cowtowncoder Oct 30, 2024

cowtowncoder Oct 30, 2024

cowtowncoder Oct 30, 2024

cowtowncoder commented Oct 30, 2024


		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(



		@API(status = STABLE)
		public final class MoneyModule extends Module {

		@@ -0,0 +1,13 @@
		//TODO how is this generated
		// Generated 27-Mar-2019 using Moditect maven plugin

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

sri-adarsh-kumar commented Oct 24, 2024

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cowtowncoder commented Oct 30, 2024

sri-adarsh-kumar commented Oct 18, 2024 •

edited

Loading

cowtowncoder Oct 25, 2024 •

edited

Loading