feat: java client APIC-160 #29

millotp · 2021-12-03T14:22:17Z

🧭 What and Why

🎟 JIRA Ticket: APIC-160

I needed the Java client to try the CTS generation, so here it is.
The code is way too complex for what we need, I'll try and simplify it in future PR.
The templates are already modified, I will add the init and retry in future PR to make it clearer.

Changes included:

Temporary edit the spec to remove oneOf using scripts
Load java template
Create java client

🧪 Test

Make sur you have java>=8

You need to install maven

brew install maven

Then create the jar

nvm use && yarn install && yarn generate:java:search
yarn client:build-java

And run the playground:

yarn playground:java

shortcuts · 2021-12-08T14:03:43Z

(just tested the auto tagging review :D)

shortcuts · 2021-12-09T14:54:50Z

So much better with the formatting! Should we review this PR anytime soon or will you iterate with stacked PRs?

millotp · 2021-12-09T14:58:17Z

I will do stack PR but I prefer to merge PR one by one, but this is still not working because of oneOf, and it doesn't look like OpenAPI is trying to improve it (although it's been two years since this issue), but it's in their short-term roadmap

sbellone

Modify the spec a bit to accommodate to java, I need to fix this

Can you point me on the file? I wanted to have a look but I'm not familiar with the repo and there are too many files in the review :)

clients/algoliasearch-client-java-2/README.md

templates/java/libraries/feign/ApiResponseDecoder.mustache

shortcuts

I don't know java so I did not checked the code in detail, but this looks cool overall!

TLDR:

Few comments are broken due to special chars
I think we can remove the licenseinfo on the classes, it will be stated globally already

shortcuts · 2021-12-14T09:51:02Z

scripts/post-gen/java.sh

@@ -0,0 +1,22 @@
+#!/bin/bash


Those scripts should've been in a stacked PR

Otherwise this wouldn't compile

Yep but you can base a PR on this one and merge it afterwards, it make the review easier

shortcuts · 2021-12-14T09:52:14Z

scripts/pre-gen/java.sh

+
+# Remove the oneOf in the spec until it's supported (https://github.com/OpenAPITools/openapi-generator/issues/10880).
+
+# Remove the oneOf and only keep the last $ref


How do we ensure that the last ref is always the one we want to generate?

Should we add a keyword in our naming until this is fixed?

I think this is very hackish and unique case, and must be repeated for every new situation, so we don't have to ensure any special syntax. Do you think we should generalize this ?

I can imagine a case where the last oneOf is the searchParamsAsString for example and the only typed/generated code is the one that is less used etc.

We should either make sure our last ref is always the best one or add a keyword that we can use in the regex

package.json

shortcuts · 2021-12-14T09:54:41Z

openapitools.json

@@ -56,9 +56,29 @@
          "npmName": "@algolia/client-personalization",
          "packageName": "@algolia/client-personalization",
          "npmVersion": "5.0.0",
-


The newline allow us to differentiate the custom variables than the generator ones, we will (sadly) have more and more with the upcoming PRs

vscode is autoformating and removing the newline, can we find another way to separate ? Like: customProps: true?

Weird, it does not do it on mine. It's not a big deal I guess, just makes it easier to read

It's because I have format on save checked.

templates/java/xmlAnnotation.mustache

...nts/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/OneOfintegerstring.java

shortcuts · 2021-12-14T11:37:40Z

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/MultipleQueries.java

+  }
+
+  /**
+   * The &#x60;facet&#x60; name.


Some special chars are broken

We still have some escaped quote in comments (not necessary), but it's in the js client too, this will be hard to fix

Yep definitely

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/StringUtil.java

clients/algoliasearch-client-java-2/README.md

shortcuts · 2021-12-14T11:40:25Z

clients/algoliasearch-client-java-2/README.md

@@ -0,0 +1,70 @@
+# algoliasearch-client-java-2


That's cool!

shortcuts

Good to go imo!

millotp self-assigned this Dec 3, 2021

millotp force-pushed the feat/java branch from 17b9366 to 0ffc8cf Compare December 7, 2021 13:37

millotp added 4 commits December 7, 2021 17:16

modify spec to fit the java client (should not be done)

d28c7f8

first draft of java client (a bit modified)

d67192e

fix ignore

797fff4

remove duplicate dependencyé

3be389d

millotp force-pushed the feat/java branch from 0ffc8cf to 3be389d Compare December 7, 2021 16:18

millotp added 2 commits December 8, 2021 11:31

use java 8

1b25194

add command

9ec11c7

shortcuts requested review from a team and damcou and removed request for a team December 8, 2021 14:03

millotp marked this pull request as ready for review December 8, 2021 14:04

millotp added 7 commits December 8, 2021 15:06

remove gradle from ignore

3e4ad7d

use post gen script to fix default type

877b318

format and fix oneOf

e45bd38

generate js

0c27904

fix spec

da90720

use feign library

d5daef3

use google formatter

f63bb8c

Merge branch 'main' into feat/java

f969a45

sbellone reviewed Dec 10, 2021

View reviewed changes

clients/algoliasearch-client-java-2/README.md Outdated Show resolved Hide resolved

templates/java/libraries/feign/ApiResponseDecoder.mustache Outdated Show resolved Hide resolved

millotp added 5 commits December 10, 2021 14:12

merge with main

7bbbe16

pre-gen script

6ca893d

appId and apiKey

5488d72

change readmed

3467913

merge with main

d21f4de

millotp added 3 commits December 14, 2021 10:53

fix yarn generate

b125c98

Merge branch 'main' into feat/java

61aac8b

generate synonyms

0b048d4

millotp requested a review from shortcuts December 14, 2021 10:30

shortcuts reviewed Dec 14, 2021

View reviewed changes

review

03b2703

millotp requested a review from shortcuts December 14, 2021 14:43

shortcuts approved these changes Dec 14, 2021

View reviewed changes

Merge branch 'main' into feat/java

d6e4e3e

millotp merged commit 206621c into main Dec 14, 2021

millotp deleted the feat/java branch December 14, 2021 15:46

shortcuts pushed a commit that referenced this pull request Apr 22, 2022

feat: java client APIC-160 (#29)

f08aace

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: java client APIC-160 #29

feat: java client APIC-160 #29

millotp commented Dec 3, 2021 •

edited

Loading

shortcuts commented Dec 8, 2021

shortcuts commented Dec 9, 2021

millotp commented Dec 9, 2021

sbellone left a comment

shortcuts left a comment

shortcuts Dec 14, 2021

millotp Dec 14, 2021

shortcuts Dec 14, 2021

shortcuts Dec 14, 2021

millotp Dec 14, 2021

shortcuts Dec 14, 2021

shortcuts Dec 14, 2021

millotp Dec 14, 2021

shortcuts Dec 14, 2021

millotp Dec 14, 2021

shortcuts Dec 14, 2021

millotp Dec 14, 2021 •

edited

Loading

shortcuts Dec 14, 2021

shortcuts Dec 14, 2021

shortcuts left a comment


		# Remove the oneOf in the spec until it's supported (https://github.com/OpenAPITools/openapi-generator/issues/10880).

		# Remove the oneOf and only keep the last $ref

feat: java client APIC-160 #29

feat: java client APIC-160 #29

Conversation

millotp commented Dec 3, 2021 • edited Loading

🧭 What and Why

Changes included:

🧪 Test

shortcuts commented Dec 8, 2021

shortcuts commented Dec 9, 2021

millotp commented Dec 9, 2021

sbellone left a comment

Choose a reason for hiding this comment

shortcuts left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

millotp Dec 14, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shortcuts left a comment

Choose a reason for hiding this comment

millotp commented Dec 3, 2021 •

edited

Loading

millotp Dec 14, 2021 •

edited

Loading