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

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

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

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

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?

The module supports Money API implementations like moneta's FastMoney, Money and RoundedMoney.

Right: I was wondering if inclusion of specific implementation was problematic wrt using something else -- but I guess one would just use Maven dependency exclude, or some other mechanism.

Or put another way: I can see such dependency necessary for testing but wasn't sure it was really needed as regular ("compile") dependency. If you think it is needed that's fine: just double-checking.

Hi !
First, thanks for this jackson-datatype-money module to the Zalando team, we're using it for a long time and are really pleased that it's about to be more integrated to the Jackson ecosystem :)

Specifically on this thread :
I would say that if the module is about to be named javax-money, maybe it's worth reconsidering the support of the deserialization of org.javamoney.moneta.FastMoney, org.javamoney.moneta.Money, org.javamoney.moneta.RoundedMoney, 3 concrete classes belonging to Moneta, the only implementation of javax-money spec and support only the deserialization of javax.money.MonetaryAmount ?
Except for tests, the usage of the package org.javamoney is only located in MoneyModule.java so it seems quite straightforward to remove the support and get rid of moneta-core as a compile time dependency.
For us who use only javax.money.MonetaryAmount in our code, it would ease the dependency management since we won't have to fear to break this module if we update Moneta.
Maybe that would mean an additional module javax-money-moneta if deserializing those 3 classes is still needed by some ? This module could depend and reuse some code from the javax-money module though

@KeepItSimpleStupid Sounds like a good idea to me; modules should focus on doing one concrete thing well and just that (as general guideline).

If there was an CCLA, yes, but I haven't gotten one from Zalando. And based on discussions it sounded like there was hesitation to go with CLA. Either one is fine with me, but I do want this first inclusion to be covered by one or the other.

Based on this comment, I think we will make a CCLA following the merge.

@bocytko Is my assumption correct?

@cowtowncoder there is no hesitation on the CLA. Based on prior comments I thought that there is no dependency between the PR merge and CLA. All that matters is that abaf36d and 487cbf9 covering the OSS contribution do not require the CLA. Fine for the follow-on commits which accumulated in this PR :)

Time-wise, if bound to a printout+signature, I can get the CCLA signed and sent to you early next week.

Ok I may have been unclear here. I think every PR should be done under a CLA or CCLA -- but for the initial one I'd only need one that covers the submitter (and not everyone who collaborated on source repository).
And then from thereon the usual (C)CLA coverage for further PRs (that is, if there are new contributors not yet covered).

Timing is fine with me -- I will make sure this gets merge before 2.19.0 gets released.
I will be taking one week off in a week so there's no super hurry.

I hope this helps!

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

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.

javax-money/pom.xml

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)

Thanks for the review comment.
Do you see this as a blocker to merge this PR?

As this is not strictly related to moving the module from Zalando repo, I would prefer to treat this as a future improvement.

No, I don't think it is blocker: good point on "let's move it first, then improve".

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)

Let me check on this.

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

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

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 :) )

KeepItSimpleStupid

A few more comments

KeepItSimpleStupid · 2025-02-04T12:57:25Z

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

+        //Scan all registered MonetaryAmount types and add a default deserializer for them
+        for (Class c : Monetary.getAmountTypes()) {
+            deserializers.addDeserializer(c, new MonetaryAmountDeserializer<>((amount, currency) -> Monetary.getAmountFactory(c).setNumber(amount).setCurrency(currency).create(), names));
+        }


I see the intent here, but this for-loop completely by-passes the amountFactory field, making the module inconsistent because it doesn't let the user customize the way that these amountTypes would be deserialized.
=> I suggest that you remove this for-loop and let this JavaxMoneyModule focus on deserializing to MonetaryAmount fields only. Deserializing to fields of type org.javamoney.moneta.* (and customizing it) will be handled solely by the MonetaMoneyModule (as already implemented)

I have updated the code as requested.

KeepItSimpleStupid · 2025-02-04T13:32:10Z

...oney-moneta/src/main/java/com/fasterxml/jackson/datatype/money/moneta/MonetaMoneyModule.java

+public final class MonetaMoneyModule extends Module {
+
+    private final JavaxMoneyModule baseModule;
+    private final MonetaryAmountFactory<? extends MonetaryAmount> amountFactory;


I think this amountFactory field is never read so it can be removed ?

After the above requested change, this will be needed to support the appropriate amount factory for MonetaryAmount.

This will be Money by default, or FastMoney or others if configured as such.

KeepItSimpleStupid · 2025-02-04T16:17:38Z

...oney-moneta/src/main/java/com/fasterxml/jackson/datatype/money/moneta/MonetaMoneyModule.java

+        //Use provided amountFactory to deserialize a MonetaryAmount
+        deserializers.addDeserializer(MonetaryAmount.class, new MonetaryAmountDeserializer<>(amountFactory, names));


Thanks for the modifications :)

If the default constructor becomes

public MonetaMoneyModule() { this(new JavaxMoneyModule().withMonetaryAmountFactory(Money::of), FieldNames.defaults(), Money::of, FastMoney::of, Money::of, RoundedMoney::of); }

and the method withMonetaryAmountFactory becomes

private <T extends MonetaryAmount> MonetaMoneyModule withMonetaryAmountFactory(final MonetaryAmountFactory<T> amountFactory) { return new MonetaMoneyModule(baseModule.withMonetaryAmountFactory(amountFactory), names, amountFactory, fastMoneyFactory, moneyFactory, roundedMoneyFactory); }

I think you can get rid of both :

this extra deserializer for MonetaryAmount and rely only on the one defined in the baseModule

the amountFactory field of this MonetaMoneyModule class

You are correct. Changed now.

I had previously assumed that the deserializing logic in MonetaModule will overwrite the Base Module
But this appears not to be the case.

Thanks !
You can get rid of the extra dezerializer for CurrencyUnit as well ;)
And I think it will all look good to me after that !

D'oh, right again. Done.

cowtowncoder · 2025-03-17T20:55:49Z

CCLA received, hope to merge this RSN.

cowtowncoder · 2025-03-17T21:05:25Z

javax-money-moneta/README.md

@@ -0,0 +1,198 @@
+# Jackson Datatype Money


Should probably be "Jackson Datatype Moneta"?

Thanks. I have fixed it.

cowtowncoder · 2025-03-20T00:51:10Z

Hmmh. Ok, I did approve: but realized I do think module names should be tweak slightly.
Here's what I plan to change before merge:

Main javax.money module: change artifactId to jackson-datatype-javax-money (since we have jackson-datatype-joda-money) -- not just jackson-datatype-money
Moneta module: leave artifactId as jackson-datatype-moneta

…misc into sri-adarsh-kumar/2.19

cowtowncoder · 2025-04-10T16:57:46Z

@sri-adarsh-kumar Ok things look good with one exception: trying to do #57 for Jackson 3 (branch 3.x) and basically, as far as I know & with all the info I have, it looks like it may not be possible to support JPMS (module-info.java) with Lombok, as things are currently.

I was wondering if there is any chance to de-Lombokify javax-money and moneta modules?
It looks like number of classes that actually use it is quite small, and I think it is possible to use Lombok to just generate sources, check in?

Alternatively if someone did figure out a way to fix Maven build to work, that'd be great outcome too -- but based on googling, chatgpt'ing, I am bit pessimistic about that being doable.

sri-adarsh-kumar · 2025-04-11T06:09:10Z

@cowtowncoder I see from #59 and #60 you have done this already.

Pls let me know if there are any open tasks for me.

cowtowncoder · 2025-04-11T16:17:13Z

@sri-adarsh-kumar Yes, sorry, forgot to update here.

I think we are good -- thank you for the follow up!

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