Add mutiny support #189

wowselim · 2021-06-17T08:54:32Z

Motivation:

closes #188

This PR adds support for a mutiny project "Flavor". Since mutiny differs from other dependencies in that it provides a whole new set of artifacts, I decided to make this a flavor rather than a dependency.

update fork

Signed-off-by: Selim Dincer <wowselim@live.de>

wowselim · 2021-06-17T08:59:36Z

@tsegismont this could use some cleanup but it already generates valid (as in it compiles & runs) projects. It currently fails however, if for example RxJava is added to the dependencies, since mutiny does not provide this artifact.
So I'm not sure if I should add some validation (like we already have for junit4 and junit5) or simply add special handling for artifacts not provided by mutiny.
A cleaner alternative would be to disable the UI elements that would cause invalid projects but I think that's out of scope for this PR.

Signed-off-by: Selim Dincer <wowselim@live.de>

wowselim · 2021-06-20T14:27:12Z

I did a quick diff of the artifacts with mutiny and I found that the following are not included:

vertx-web-api-contract
vertx-web-templ-httl
vertx-web-sstore-cookie
vertx-web-sstore-redis
vertx-web-sstore-infinispan
vertx-rx-java
vertx-rx-java2
vertx-rx-java3
vertx-reactive-streams
vertx-sync
vertx-lang-kotlin-coroutines
vertx-amqp-bridge
vertx-jca
vertx-camel-bridge
vertx-dropwizard-metrics
vertx-health-check
vertx-zipkin
vertx-opentracing
vertx-opentelemetry
vertx-unit
vertx-hazelcast
vertx-infinispan
vertx-ignite
vertx-zookeeper
vertx-service-proxy
vertx-sockjs-service-proxy
vertx-grpc
vertx-service-factory
vertx-maven-service-factory
vertx-http-service-factory

So if a user selects any of these dependencies, they will be provided by vert.x instead of mutiny.

Signed-off-by: Selim Dincer <wowselim@live.de>

tsegismont · 2021-06-30T09:18:46Z

@wowselim sorry for the delay, we're working on getting 4.1.1 out, I haven't been able to find some time to review yet

jponge · 2021-07-05T07:24:28Z

I haven't tested but it looks good on a first pass

tsegismont

Thank you @wowselim and sorry again for the delay.

In addition to the inline comments:

we need an update of the verticle and test file templates; when the Mutiny flavor is selected, the Mutiny API should be used
as much as I like the flavor wording in discussion, I would prefer not to use it on the website; how about Vert.x API?

tsegismont · 2021-07-05T15:09:22Z

README.md


 Full example:

 ```
 curl -X GET \
-  'http://start.vertx.io/starter.zip?artifactId=starter&buildTool=maven&groupId=io.vertx&language=java&vertxDependencies=&vertxVersion=4.1.1' \
+  'http://start.vertx.io/starter.zip?artifactId=starter&buildTool=maven&groupId=io.vertx&language=java&vertxDependencies=&vertxVersion=4.1.1&flavor=vert.x' \


Suggested change

'http://start.vertx.io/starter.zip?artifactId=starter&buildTool=maven&groupId=io.vertx&language=java&vertxDependencies=&vertxVersion=4.1.1&flavor=vert.x' \

'https://start.vertx.io/starter.zip?artifactId=starter&buildTool=maven&groupId=io.vertx&language=java&vertxDependencies=&vertxVersion=4.1.1' \

Let's keep the default for simple examples

removed in bdd8041

tsegismont · 2021-07-05T15:10:00Z

README.md

@@ -51,6 +52,7 @@ artitfactId==starter \
 language==java \
 buildTool==maven \
 vertxVersion==4.1.1 \
+flavor==vert.x \


Suggested change

flavor==vert.x \

Same here

removed in bdd8041

tsegismont · 2021-07-05T16:32:31Z

src/main/java/io/vertx/starter/config/ProjectConstants.java

@@ -29,4 +29,7 @@
  String ARCHIVE_FORMAT = "archiveFormat";
  String PACKAGE_NAME = "packageName";
  String JDK_VERSION = "jdkVersion";
+  String FLAVOR = "flavor";
+  String MUTINY_FLAVOR = "mutiny";


I don't believe this is necessary. It can be stored as an enum value.

addressed in e098a10

tsegismont · 2021-07-05T16:35:14Z

src/test/java/io/vertx/starter/service/GeneratorTest.java

+    List<Set<Dependency>> testDeps = Arrays.asList(
+      Collections.singleton(new Dependency().setArtifactId("vertx-unit")),
+      Collections.singleton(new Dependency().setArtifactId("vertx-junit5"))
+    );

    Stream.Builder<VertxProject> builder = Stream.builder();
    for (BuildTool buildTool : BuildTool.values()) {


We should test both flavors here.

added in fa9cb0a

tsegismont · 2021-07-05T16:41:58Z

src/main/resources/starter.json

@@ -47,81 +48,98 @@
      ]
    }
  ],
-  "stack": [
+  "vertxStack": [


It will be simpler to maintain this file if we:

keep a single stack definition

add a mutinyBindings boolean attribute to items

The attribute value would indicate if the module has Mutiny bindings.

done in 03b4d28.
I felt pretty dirty creating that abomination of a json document initially but I thought it would be nicer than adding the mutiny prefix in the java code later. In hindsight, I like your approach a lot more. Much cleaner 👍

tsegismont · 2021-07-05T16:43:40Z

src/main/resources/webroot/index.html

+          <label class="col-sm-4 col-form-label">Flavor</label>
+          <div class="col-sm-8">
+            <div class="btn-group">
+              <label class="btn btn-sm btn-default" ng-repeat="flavor in vm.flavors"


We need some logic to disable dependencies that don't have Mutiny bindings when the Mutiny flavor is selected.

Is there a practical reason why it shouldn't be allowed? What happens if a user wants to create a project with the mutiny flavor but wants to use the zipkin artifact too?

I added a similar message to that of the vertx-unit / junit5 combination in dc01e0c. WDYT?

Signed-off-by: Selim Dincer <wowselim@live.de>

wowselim · 2021-07-05T18:58:53Z

we need an update of the verticle and test file templates; when the Mutiny flavor is selected, the Mutiny API should be used

I can do this with freemarker conditionals or create new templates for the mutiny flavor. What do you think makes more sense @tsegismont?

And now I need to learn how to test with mutiny, huh? Great opportunity 😄

Signed-off-by: Selim Dincer <wowselim@live.de>

GavinRay97 · 2021-07-25T22:22:02Z

This is awesome!

wowselim and others added 4 commits May 3, 2021 15:31

Merge pull request #1 from vert-x3/master

54901cc

update fork

Merge branch 'vert-x3:master' into master

0c93937

Merge branch 'vert-x3:master' into master

6fafcbe

add support for mutiny projects

9d90949

Signed-off-by: Selim Dincer <wowselim@live.de>

add separate stack for mutiny

647c80f

Signed-off-by: Selim Dincer <wowselim@live.de>

wowselim added 5 commits June 20, 2021 16:38

fix wrong flavor name in templates

309f536

Signed-off-by: Selim Dincer <wowselim@live.de>

remove obsolete artifact id prefix

071c09f

Signed-off-by: Selim Dincer <wowselim@live.de>

add flavor option to README.md

75b2527

Signed-off-by: Selim Dincer <wowselim@live.de>

fix bug where mutiny dependencies were not checked

4e123d5

Signed-off-by: Selim Dincer <wowselim@live.de>

remove "default" text from flavor in README.md

2cd1c19

Signed-off-by: Selim Dincer <wowselim@live.de>

wowselim marked this pull request as ready for review June 20, 2021 15:22

wowselim added 5 commits June 20, 2021 23:46

fix bug with mixed mutiny & vertx deps

34c507d

Signed-off-by: Selim Dincer <wowselim@live.de>

fix version bug with mixed mutiny & vertx deps

9730547

Signed-off-by: Selim Dincer <wowselim@live.de>

ignore isVertxDependency in jackson

c86dfec

Signed-off-by: Selim Dincer <wowselim@live.de>

fix bug where groupId ends up wrong

b0b31e6

Signed-off-by: Selim Dincer <wowselim@live.de>

make sure flavor deps are handled correctly

3ca065d

Signed-off-by: Selim Dincer <wowselim@live.de>

Merge branch 'master' into add-mutiny-support

3575d46

tsegismont requested changes Jul 5, 2021

View reviewed changes

wowselim added 6 commits July 5, 2021 19:40

use Vert.x API instead of Flavor for website

b886b1d

Signed-off-by: Selim Dincer <wowselim@live.de>

remove flavor ids from project constants

e098a10

Signed-off-by: Selim Dincer <wowselim@live.de>

remove flavor from http request examples

bdd8041

Signed-off-by: Selim Dincer <wowselim@live.de>

bump mutiny version to 2.8.0

24a9001

Signed-off-by: Selim Dincer <wowselim@live.de>

switch from two stacks to boolean flag for mutiny bindings

03b4d28

Signed-off-by: Selim Dincer <wowselim@live.de>

add generator test for flavors

fa9cb0a

Signed-off-by: Selim Dincer <wowselim@live.de>

add info about default flavor to readme

90a3fb9

Signed-off-by: Selim Dincer <wowselim@live.de>

wowselim added 5 commits July 8, 2021 21:40

add error msg for unsatisfiable dependencies

dc01e0c

Signed-off-by: Selim Dincer <wowselim@live.de>

bump mutiny version to 2.9.0

b231d26

Signed-off-by: Selim Dincer <wowselim@live.de>

add verticle & test code for mutiny flavor

aceac49

Signed-off-by: Selim Dincer <wowselim@live.de>

set junit5 flag for mutiny projects

f9907d0

Signed-off-by: Selim Dincer <wowselim@live.de>

fix bug that failed mutiny projects

7a11188

Signed-off-by: Selim Dincer <wowselim@live.de>

wowselim requested a review from tsegismont July 8, 2021 21:20

wowselim added 2 commits July 9, 2021 12:55

include flavor in VertxProject#toString

9b85004

Signed-off-by: Selim Dincer <wowselim@live.de>

don't include vertx depchain for mutiny

37612ce

Signed-off-by: Selim Dincer <wowselim@live.de>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add mutiny support #189

Add mutiny support #189

wowselim commented Jun 17, 2021

wowselim commented Jun 17, 2021 •

edited

wowselim commented Jun 20, 2021

tsegismont commented Jun 30, 2021

jponge commented Jul 5, 2021

tsegismont left a comment

tsegismont Jul 5, 2021

wowselim Jul 5, 2021

tsegismont Jul 5, 2021

wowselim Jul 5, 2021

tsegismont Jul 5, 2021

wowselim Jul 5, 2021

tsegismont Jul 5, 2021

wowselim Jul 5, 2021

tsegismont Jul 5, 2021

wowselim Jul 5, 2021

tsegismont Jul 5, 2021

wowselim Jul 5, 2021

wowselim Jul 8, 2021

wowselim commented Jul 5, 2021

GavinRay97 commented Jul 25, 2021

	'http://start.vertx.io/starter.zip?artifactId=starter&buildTool=maven&groupId=io.vertx&language=java&vertxDependencies=&vertxVersion=4.1.1&flavor=vert.x' \
	'https://start.vertx.io/starter.zip?artifactId=starter&buildTool=maven&groupId=io.vertx&language=java&vertxDependencies=&vertxVersion=4.1.1' \

Add mutiny support #189

Are you sure you want to change the base?

Add mutiny support #189

Conversation

wowselim commented Jun 17, 2021

wowselim commented Jun 17, 2021 • edited

wowselim commented Jun 20, 2021

tsegismont commented Jun 30, 2021

jponge commented Jul 5, 2021

tsegismont 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wowselim commented Jul 5, 2021

GavinRay97 commented Jul 25, 2021

wowselim commented Jun 17, 2021 •

edited