Add support for async client Retrofit2 in Java Play Framework 2.6 by ignaciomolina · Pull Request #7664 · swagger-api/swagger-codegen

ignaciomolina · 2018-02-15T14:48:33Z

PR checklist

Read the contribution guidelines.
Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
Filed the PR against the correct branch: 3.0.0 branch for changes related to OpenAPI spec 3.0. Default: master.
Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

@bbdouglas @JFCote @sreeshas @jfiala @lukoyanov @cbornet @jeff9finger

Description of the PR

Add templates to support Play Framework version 2.6 with async clients using Retrofit2

tzimisce012 · 2018-02-15T15:28:00Z

Good Job there 👍

JFCote · 2018-02-15T18:09:05Z

I will have a look at this tomorrow. Thanks

JFCote

LGTM

JFCote · 2018-02-16T11:49:59Z

+        // authentications.put("{{name}}", new OAuth());{{/isOAuth}}{{/authMethods}}
+        // Prevent the authentications from being modified.
+        authentications = Collections.unmodifiableMap(authentications);
+


remove empty line

JFCote · 2018-02-16T11:53:05Z

+    public Play26CallAdapterFactory() {
+    }
+
+    public Play26CallAdapterFactory(


why is there a carriage return here?

JFCote · 2018-02-16T11:58:18Z

@ignaciomolina For my curiosity only, what is the use of this client and what is the "link" to play framework. I'm the main contributor to the Play Framework server stub codegen and to connect to it, we use java client, c# client, typescript client but I would like to know the advantage of using this one. Thanks :)

JFCote · 2018-02-16T12:05:41Z


-    public Play26CallAdapterFactory() {
-    }
+    public Play26CallAdapterFactory() { }


it wasn't that constructor, it was the one below with a parameter :)

tzimisce012 · 2018-02-16T12:06:59Z

Well, this client will allow us to use WSClient that is an asynchronous client. A regular java client will be blocking and we will have to set a specific thread pool just for him.

lukoyanov · 2018-02-16T13:19:14Z

For my curiosity only, what is the use of this client and what is the "link" to play framework.

@JFCote the only connection of ApiClient.java to play! framework is that internally adds callFactory & callAdapterFactory that uses WSClient to discatch api calls.

cbornet · 2018-02-19T20:29:13Z

        cliOptions.add(CliOption.newBoolean(USE_RX_JAVA2, "Whether to use the RxJava2 adapter with the retrofit2 library."));
        cliOptions.add(CliOption.newBoolean(PARCELABLE_MODEL, "Whether to generate models for Android that implement Parcelable with the okhttp-gson library."));
        cliOptions.add(CliOption.newBoolean(USE_PLAY_WS, "Use Play! Async HTTP client (Play WS API)"));
-        cliOptions.add(CliOption.newString(PLAY_VERSION, "Version of Play! Framework (possible values \"play24\", \"play25\")"));


Do we really have to support each and every version of Play ? This is getting really messy...

Since each change of version of play means that everything changes completly, it is so far necessary to keep all of them...

This is a retrofit generator, not a Play one. Also it seems to me that a lot of templates are just duplicated between 2.5 and 2.6

I am glad that the client generator for play is using retrofit.

There is a folder called common where all duplicated templates between versions 2.5 and 2.6 should be. If there is a duplicated template not located there, this PR should be rejected

I looked and it seems 2.6 is almost entirely duplicate of 2.5 (minor changes but that probably also work for 2.5)
I also think it should be possible to have common templates between 2.4 and 2.5 with minimal work which would greatly simplify the Java generator code.
And 2.5 seems to introduce adapters for CompletionStage (CompletableFuture) which are already part of retrofit-adapters so they could probably be replaced by the built in ones.

Eventually, wouldn't Play developers prefer to get scala.concurrent.Future rather than CompletionStage/CompletableFuture ?

Those minor changes don't work on play 2.5 (100% sure)

OK so they should be applied by mustache tags, not by duplicating the templates.

Meanwhile there are 2 different versions of Play (Scala and Java), we should have an autogenerated client for both versions.

I don't know what could be the reason to program play with java. Moreover, I don't know the reason to program on play at all 🍡

ok, I have merged the play version templates

👍 great work !

wing328 · 2018-02-22T14:11:46Z

I ran mvn test in the folder samples/client/petstore/java/retrofit2-play26 but got the following errors:

[ERROR] COMPILATION ERROR : 
[INFO] -------------------------------------------------------------
[ERROR] /private/tmp/swagger-codegen/samples/client/petstore/java/retrofit2-play26/src/main/java/io/swagger/client/PlayCallFactory.java:[141,56] cannot find symbol
  symbol:   method setRequestFilter(play.libs.ws.WSRequestFilter)
  location: variable wsRequest of type play.libs.ws.WSRequest
[ERROR] /private/tmp/swagger-codegen/samples/client/petstore/java/retrofit2-play26/src/main/java/io/swagger/client/PlayCallFactory.java:[178,36] cannot find symbol
  symbol:   method getSingleHeader(java.lang.String)
  location: variable r of type play.libs.ws.WSResponse

Did you get these errors when running mvn test locally in your machine?

ignaciomolina · 2018-03-07T19:59:46Z

Sorry @wing328, you were right, I already fix all the issues and now it compiles fine in Maven, Sbt and Gradle

ignaciomolina · 2018-04-30T08:20:36Z

@wing328 Do you think this is good to merge?

Add templates for async client Retrofit2 in Java Play Framework 2.6

cf26cd4

Add samples for retrofit2

f9eb376

JFCote approved these changes Feb 16, 2018

View reviewed changes

Fix style in java retrofit2 play26 templates

7af5a98

JFCote reviewed Feb 16, 2018

View reviewed changes

Fix carrot return in java retrofit2 play26 templates

a522f77

lukoyanov approved these changes Feb 17, 2018

View reviewed changes

tzimisce012 approved these changes Feb 17, 2018

View reviewed changes

cbornet reviewed Feb 19, 2018

View reviewed changes

Remove duplicated templates for client retrofit2-play

695019e

ignaciomolina changed the title ~~Add templates for async client Retrofit2 in Java Play Framework 2.6~~ Add support for async client Retrofit2 in Java Play Framework 2.6 Feb 20, 2018

wing328 added Client: Java Client: Retrofit labels Feb 22, 2018

wing328 added this to the v2.4.0 milestone Feb 22, 2018

wing328 added the Enhancement: Feature label Feb 22, 2018

ignaciomolina added 3 commits March 7, 2018 20:23

Fix a few bugs in java retrofit2 client for play mustaches

3735f46

regenerate samples for all java retrofit2 play versions

01fde98

Add validation library for java retrofit2 clients in sbt and gradle

a5128c4

ignaciomolina added 3 commits March 7, 2018 21:56

Merge branch 'master' into feature/play26AsyncClientWithRetrofit2

f66c454

Fix merge conflict

0f9dd0d

fix failing test in samples

234d809

frantuma added the Language: retrofit label Jun 27, 2018

frantuma force-pushed the master branch from 4ba5164 to 949f0e6 Compare May 20, 2025 09:13

Conversation

ignaciomolina commented Feb 15, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR checklist

Description of the PR

Uh oh!

tzimisce012 commented Feb 15, 2018

Uh oh!

JFCote commented Feb 15, 2018

Uh oh!

JFCote left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JFCote commented Feb 16, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tzimisce012 commented Feb 16, 2018

Uh oh!

lukoyanov commented Feb 16, 2018 • edited by wing328 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cbornet Feb 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wing328 commented Feb 22, 2018

Uh oh!

ignaciomolina commented Mar 7, 2018

Uh oh!

ignaciomolina commented Apr 30, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

ignaciomolina commented Feb 15, 2018 •

edited

Loading

lukoyanov commented Feb 16, 2018 •

edited by wing328

Loading

cbornet Feb 19, 2018 •

edited

Loading