feat: add un/marshal JSON preset for Java

[ritik307]

Description

• Added un/marshalling in Java inside src/generators/java/presets/CommonPreset.ts

Related issue(s)

Fixed #488

[ritik307]

hi @jonaslagoni, Kindly look into my PR and let me know if I am heading in the right direction or not. 🙂

[ritik307]

@jonaslagoni I am currently facing errors while writing a test for un/marshalling in Java and not able to figure out what the error kindly look into them

[jonaslagoni]

Definitely in the right direction 👍 Just keep iterating 🙂

[ritik307]

@jonaslagoni I have implemented the changes you have mentioned. Kindly look at them and let me know if any more changes are required. :)

[jonaslagoni]

Have a couple of remarks 🙂

Remember your code smells from sonarcloud 🙂

[coveralls]

Pull Request Test Coverage Report for Build 1835217589

• 32 of 34 (94.12%) changed or added relevant lines in 1 file are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage decreased (-0.09%) to 93.452%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/generators/java/presets/CommonPreset.ts	32	34	94.12%

Totals
Change from base Build 1835216233:	-0.09%
Covered Lines:	2490
Relevant Lines:	2538

---

💛 - Coveralls

[ritik307]

@jonaslagoni everything is working now 😊. I ran npm run lint:fix and it was getting warning security/detect-object-injection. So as of now, I have added a command to skip this warning line as adding parseInt(prop,10) isn't helping and generating more errors.

[jonaslagoni]

Small changes requested, looking good! 💪

We need to enlighten the user of the new preset, so they can start using it!

We need to adapt our Java language documentation: https://github.com/asyncapi/modelina/blob/master/docs/languages/Java.md

Here you could add something along the lines of:

## Include JSON marshaling and unmarshaling methods
Sometimes you just want to convert your class to JSON without the use of annotations such as Jackson.

Check out this [example for a live demonstration](https://github.com/asyncapi/modelina/blob/master/examples/java-generate-marshal).

External dependencies
- Requires [org.json package](https://search.maven.org/artifact/org.json/json/20211205/bundle) to work

Next, we need to create an example to show exactly how a user can enable this option (as well as always ensuring it works). We do that by adding the following example: https://github.com/asyncapi/modelina/blob/master/examples/java-generate-marshal

You can copy this template for a good start: https://github.com/asyncapi/modelina/tree/master/examples/TEMPLATE

Read more about adding examples here: https://github.com/asyncapi/modelina/blob/master/docs/contributing.md#adding-examples

Let me know if you have any questions!

[jonaslagoni]

I am assuming these lines are the problems to eslint complaining?

Suggested change

	// eslint-disable-next-line
	const getType = `jsonObject.get${properties[prop].type?.toString().charAt(0).toUpperCase()}${properties[prop].type?.toString().slice(1)}`;
	const getType = `jsonObject.get${FormatHelpers.upperFirst(properties[prop].type?.toString())}`

Was it the optional chaining of properties[prop].type?, or the access of properties[prop]?

You could try the following:

const propModel = properties[String(prop)];
if(propModel.type === 'undefined') {
  Logger.error(`Could not render unmarshal for property ${prop}`);
  return; 
}

[ritik307]

hi @jonaslagoni , I have made changes but I am facing an error kindly look at them.

[jonaslagoni]

hi @jonaslagoni , I have made changes but I am facing an error kindly look at them.

That is indeed weird. Have you tried printing the content or debugging the test to see what is actually inside classModel.dependencies?

Is it just some hidden character not matching or?

[ritik307]

@jonaslagoni This error is actually occurring because I changed the code from

const shouldContainMarshal = options.marshal === undefined || options.marshal === true;

to

const shouldContainMarshal = options.marshal === true;

But if I remove the following imports the code works fine I think it is not able to process multiple imports.

expect(classModel.dependencies.includes('import java.util.stream;')).toEqual(true);
expect(classModel.dependencies.includes('import org.json.JSONObject;')).toEqual(true);

[jonaslagoni]

But if I remove the following imports the code works fine I think it is not able to process multiple imports.

It definitely should be 😄

Do you mind trying to print out what is inside the array console.log(classModel.dependencies)? 🙂

[jonaslagoni]

Here we are testing two dependencies:

modelina/test/generators/java/presets/JacksonPreset.spec.ts

Line 39 in 7b2a33f

const expectedDependencies = ['import java.util.Map;', 'import com.fasterxml.jackson.annotation.*;'];

[ritik307]

Do you mind trying to print out what is inside the array console.log(classModel.dependencies)?
@jonaslagoni Here is the screenshot

[jonaslagoni]

Small comments, nearly there, looking great 💪

[ritik307]

@jonaslagoni Added example for marshalling. Kindly review :)

[jonaslagoni]

LGTM, awesome @ritik307 🎉

[jonaslagoni]

/rtm

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[jonaslagoni]

@all-contributors please add @ritik307 for code, test, example

[asyncapi-bot]

🎉 This PR is included in version 0.48.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[allcontributors]

@jonaslagoni

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

[asyncapi-bot]

🎉 This PR is included in version 1.0.0-next.23 🎉

The release is available on:

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

Your semantic-release bot 📦🚀