Introduce QuarkusProject and Quarkus project zipping in codegen #9631

ia3andy · 2020-05-27T11:25:05Z

This is part of #8178

This is a good one :-), things starts to get nicer and cleaner (but not quite there yet ^^)..

Introduce QuarkusProject in codegen to reduce ProjectWriter & BuildTool coupling, it will slowly replace BuildFile and ProjectWriter.

I also uniformised the quarkus-cli (I am not sure if it's used) by giving the project folder instead of the pom.xml, it should now also work with Gradle.

Deleted ZipProjectWriter which is not used and will be replaced by a way to zip a Quarkus project folder.

ia3andy · 2020-05-27T11:45:53Z

Putting in WIP, I am going to introduce the new folder zipping as another commit.

devtools/maven/src/main/java/io/quarkus/maven/CreateProjectMojo.java

ia3andy · 2020-05-27T16:16:26Z

@aloubyansky there is a bug with the maven plugin due to ProjectWriter.close(), I'll figure it out tomorrow..

ia3andy · 2020-05-27T16:19:23Z

ok, found it, it's nothing, I'll push tomorrow..

aloubyansky · 2020-05-27T20:26:28Z

...projects/tools/common/src/main/java/io/quarkus/cli/commands/CreateProjectCommandHandler.java

-            throw new IllegalStateException("Project writer has not been provided");
-        }
+        final ProjectWriter projectWriter = new FileProjectWriter(
+                invocation.getQuarkusProject().getProjectFolderPath().toFile());


Just a note, previously a single invocation could have been passed to multiple handlers (e.g. create followed by add extensions) that would use the same project writer instance. It doesn't mean it has to stay that way.

I am not there yet, but to make it more consistent and simple, my intent is to go toward atomic operations (without having to deal with the writer close/save from outside):

create (directly with or without extensions)

add extension(s)

remove extension(s)

Using the same writer would make it more performant when doing multiple of those, but I guess there is no use case for it.

One good example of the risk of having this close/save handled externally is that (as I did without knowing) having multiple writer and closing the one without the modification after ending up with reseting the modification 😅

WDYT?

aloubyansky · 2020-05-27T20:36:56Z

One thing to keep in mind is the public API should be backward compatible. Our plugins are looking for the latest platform in a given version range. So, inside that range the API should stay compatible.
The issue you ran into with 1.4.2.Final is an example of what shouldn't happen to a user.
I am not going to insist on keeping the current API now. But you should keep this point in mind for the future.
BTW, the current version range for the platform is up to 2.0. We did consider changing it to a micro. E.g. [1.5.0, 1.6.a)

aloubyansky · 2020-05-27T20:37:36Z

The PR is marked as a WIP, so I am not approving it yet.

ia3andy · 2020-05-28T07:32:49Z

One thing to keep in mind is the public API should be backward compatible. Our plugins are looking for the latest platform in a given version range. So, inside that range the API should stay compatible.
The issue you ran into with 1.4.2.Final is an example of what shouldn't happen to a user.
I am not going to insist on keeping the current API now. But you should keep this point in mind for the future.
BTW, the current version range for the platform is up to 2.0. We did consider changing it to a micro. E.g. [1.5.0, 1.6.a)

Yeah, I was wondering... It would be good to be allowed to break it in one shot for this refactor? I am not sure if this part of the code is used externally by other than code.quarkus.io?

Once it's is clean, we can of course lock it..

ia3andy · 2020-05-28T09:01:25Z

@aloubyansky Ok I added the project zip compression utils f44f980 (inspired from code.quarkus.io with exec support for wrapper files)

And I fixed the BuildFile closing bug by removing the close in BuildFileMojoBase, the close has to be done by the underlying command handler.

…Tool coupling This is part of quarkusio#8178 This is a good one :-), things starts to get nicer and cleaner (but not quite there yet ^^)..

ia3andy · 2020-05-28T14:29:28Z

@aloubyansky CI is failing because quay seems to be down..

maxandersen · 2020-06-03T09:07:30Z

Yeah, I was wondering... It would be good to be allowed to break it in one shot for this refactor? I am not sure if this part of the code is used externally by other than code.quarkus.io?

this is something we should discuss the timing off. I fully agree it needs to happen - but want to try and make it happen in just one release if at all possible.

maxandersen · 2020-06-03T09:09:20Z

BTW, the current version range for the platform is up to 2.0. We did consider changing it to a micro. E.g. [1.5.0, 1.6.a)

shouldn't we just do this ? it would be [1.5.0,1.6.0)

other only alternative I can think of is the introduction of a separate file where we externalize the range we check so we can adjust it after release and be able to update it once we know incompatibility happens.

boring-cyborg bot added area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/gradle Gradle area/maven area/platform Issues related to definition and interaction with Quarkus Platform labels May 27, 2020

ia3andy requested a review from aloubyansky May 27, 2020 11:26

ia3andy force-pushed the introduce-quarkus-project branch from 3452ea3 to 1dc58e9 Compare May 27, 2020 11:41

ia3andy changed the title ~~Introduce QuarkusProject in codegen to reduce ProjectWriter & BuildTool coupling~~ [wip] Introduce QuarkusProject in codegen to reduce ProjectWriter & BuildTool coupling May 27, 2020

ia3andy changed the title ~~[wip] Introduce QuarkusProject in codegen to reduce ProjectWriter & BuildTool coupling~~ [wip] Introduce QuarkusProject and Quarkus project zipping in codegen May 27, 2020

ia3andy commented May 27, 2020

View reviewed changes

devtools/maven/src/main/java/io/quarkus/maven/CreateProjectMojo.java Show resolved Hide resolved

aloubyansky reviewed May 27, 2020

View reviewed changes

ia3andy changed the title ~~[wip] Introduce QuarkusProject and Quarkus project zipping in codegen~~ Introduce QuarkusProject and Quarkus project zipping in codegen May 28, 2020

ia3andy added 3 commits May 28, 2020 11:42

Introduce QuarkusProject in codegen to reduce ProjectWriter and Build…

555c7c7

…Tool coupling This is part of quarkusio#8178 This is a good one :-), things starts to get nicer and cleaner (but not quite there yet ^^)..

Clean package structure

6b30418

Fix multiple close overriding modification when adding extensions

658d730

ia3andy force-pushed the introduce-quarkus-project branch from f44f980 to d3b2456 Compare May 28, 2020 09:42

ia3andy added 2 commits May 28, 2020 15:41

Minor refactor in QuarkusProject

8a3c24d

Introduce QuarkusProjectCompress to zip QuarkusProject

2e7b78b

ia3andy force-pushed the introduce-quarkus-project branch from d3b2456 to 2e7b78b Compare May 28, 2020 13:41

aloubyansky approved these changes May 28, 2020

View reviewed changes

aloubyansky merged commit d5c94c1 into quarkusio:master May 28, 2020

ia3andy deleted the introduce-quarkus-project branch May 29, 2020 04:54

gsmet added this to the 1.6.0 - master milestone Jun 10, 2020

ia3andy mentioned this pull request Jun 15, 2020

Using ZipProjectWriter with CreateProject, Projects should be generated in a folder #3340

Closed

ia3andy mentioned this pull request Jul 1, 2020

Allow extensions to influence newly generated apps: codenamed "Codestarts" #8134

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce QuarkusProject and Quarkus project zipping in codegen #9631

Introduce QuarkusProject and Quarkus project zipping in codegen #9631

ia3andy commented May 27, 2020 •

edited

Loading

ia3andy commented May 27, 2020

ia3andy commented May 27, 2020

ia3andy commented May 27, 2020

aloubyansky May 27, 2020

ia3andy May 28, 2020

aloubyansky commented May 27, 2020

aloubyansky commented May 27, 2020

ia3andy commented May 28, 2020

ia3andy commented May 28, 2020 •

edited

Loading

ia3andy commented May 28, 2020

maxandersen commented Jun 3, 2020

maxandersen commented Jun 3, 2020

Introduce QuarkusProject and Quarkus project zipping in codegen #9631

Introduce QuarkusProject and Quarkus project zipping in codegen #9631

Conversation

ia3andy commented May 27, 2020 • edited Loading

ia3andy commented May 27, 2020

ia3andy commented May 27, 2020

ia3andy commented May 27, 2020

aloubyansky May 27, 2020

Choose a reason for hiding this comment

ia3andy May 28, 2020

Choose a reason for hiding this comment

aloubyansky commented May 27, 2020

aloubyansky commented May 27, 2020

ia3andy commented May 28, 2020

ia3andy commented May 28, 2020 • edited Loading

ia3andy commented May 28, 2020

maxandersen commented Jun 3, 2020

maxandersen commented Jun 3, 2020

ia3andy commented May 27, 2020 •

edited

Loading

ia3andy commented May 28, 2020 •

edited

Loading