docs: Implementation of Java DSL Cookbook by domhanak · Pull Request #394 · quarkiverse/quarkus-flow

domhanak · 2026-04-01T12:10:38Z

Closes #393

Based on https://docs.quarkiverse.io/quarkus-flow/dev/quarkus-flow-cookbook.html#

Here is the Java version of the cookbook.

@ricardozanini @mcruzdev @fjtirado Putting it up for first feedback round, in the meantime I will work on reviewing the test coverage for these examples.
Once done I will get back to you, right now looking for feedback if this is what is expected to be here.
Also please list out what other cases to add. 🙏

github-actions · 2026-04-01T12:13:24Z

😭 Deploy PR Preview failed.

ricardozanini

Nice write-up! Either for this cookbook and the YAML one, we must add tests within the docs module. So we guarantee we are not diverting our audience with wrong examples.

Feel free to also open issues on the points I made that are not working as it should.

domhanak · 2026-04-08T11:04:21Z

@ricardozanini okay, to update the status.

I working on updating the docs module so it also runs the tests. It seems it has an issue right now and that prevents the tests from being run properly. Also they are not run during the regular maven build.

The idea will be as follows:

I will add workflow classes for each of the Java DSL example.
These classes will be included in the Cookbook page via include
I will add a test class that will execute these workflow classes and assert expected output/behavior.

ricardozanini · 2026-04-08T22:31:24Z

@domhanak need help to figure it out the issue?

domhanak · 2026-04-10T06:18:31Z

@ricardozanini not sure I understand your question? Care to elaborate please?

ricardozanini · 2026-04-10T14:33:04Z

@ricardozanini not sure I understand your question? Care to elaborate please?

Just asking if you need any help to solve the issues you may have.

domhanak · 2026-04-12T16:24:18Z

@ricardozanini no worries so far, just need to finish it all the way so I know where we are at. :) Halfway there, working on for example and testing now. Also, I need to rebase and fix the build.

domhanak · 2026-04-13T11:29:49Z

@ricardozanini Let's say the first part is done, there are still some missing but they have a different approach and can't use import io.serverlessworkflow.fluent.func.FuncWorkflowBuilder; but need to use import static io.serverlessworkflow.fluent.spec.WorkflowBuilder.workflow; with DoTaskBuilder to show raise and tryCatch

Not sure if this is expected or these methoed should also be present in FuncDoTaskBuilder.

domhanak · 2026-04-13T11:33:00Z

4 Items missing:

Consolidation of the tests into one test suite. Having multiple small tests with @QuarkusTest annotation is probably not the best.
Configure the tests to run as part of mvn build.
Review the cookbook and add required properties that are relevant for the examples ( eventing, scheduler etc.)
Review the examples and figure out if they uncover bugs, or the implementation is wrong.

mcruzdev

Amazing pull request @domhanak, I left simple comments about the comments in the documentation.

ricardozanini · 2026-04-13T13:56:50Z

@ricardozanini Let's say the first part is done, there are still some missing but they have a different approach and can't use import io.serverlessworkflow.fluent.func.FuncWorkflowBuilder; but need to use import static io.serverlessworkflow.fluent.spec.WorkflowBuilder.workflow; with DoTaskBuilder to show raise and tryCatch

Not sure if this is expected or these methoed should also be present in FuncDoTaskBuilder.

Either WorkflowBuilder or FuncWorkflowBuilder will work, but the preferred approach is to use FuncWorkflowBuilder with FuncDSL.

domhanak · 2026-04-24T09:18:17Z

@ricardozanini @mcruzdev Imho we could proceed with merging this and work on next in new issue.

I reported the follow-up - #487

Note: the tests are not being executed right now - I am running the locally via IDE, I think it would be better to ensure that as separate issue once the cookbook is finished. Reported here - #488

Let me know if this is ok.

domhanak · 2026-04-24T09:26:10Z

One thing, that struck me now, is if we should add application.properties configurations to the examples where it is needed? Wdyt? @ricardozanini @mcruzdev

ricardozanini · 2026-04-24T17:52:01Z

One thing, that struck me now, is if we should add application.properties configurations to the examples where it is needed? Wdyt? @ricardozanini @mcruzdev

When an application.property is needed? If so, yes we should add an excerpt of it.

ricardozanini

That's outstanding work! Many thanks!

domhanak · 2026-05-11T07:21:31Z

@mcruzdev @ricardozanini updated with new addition to SDK, please squash if merging.

ricardozanini · 2026-05-11T16:00:21Z

+    @Override
+    public Map<String, String> start() {
+        // Start WireMock on the fixed port expected by the example workflows
+        wireMockServer = new WireMockServer(8089);


Suggested change

wireMockServer = new WireMockServer(8089);

WireMockConfiguration config = WireMockConfiguration.wireMockConfig().dynamicPort();

wireMockServer = new WireMockServer(config);

And you will probably have to change how Quarkus reads this port like:

return Map.of("wiremock.port", String.valueOf(wireMockServer.port()));

Then use it in the endpoint:

.endpoint("http://localhost:${wiremock.port}/api/people")

We run tests in parallel in many instances.

Sure, however this is not really a problem now as docs module is skipping tests. I can update here or in the follow-up that specifically aims to make these updates.

ricardozanini · 2026-05-11T16:02:53Z

+    public Map<String, String> start() {
+        // 1. Enable WireMock's built-in verbose logging using ConsoleNotifier
+        WireMockConfiguration config = WireMockConfiguration.wireMockConfig()
+                .port(8090)


Suggested change

.port(8090)

..dynamicPort()

ricardozanini · 2026-05-11T16:04:02Z


    @Inject
-    @Identifier("flow:echo-name") // namespace:name from document section
+    @Identifier("company:echo-name") // namespace:name from document section


Has the YAML referenced by this bean also changed?

the YAML is fine, I just adapted the test so it works.

ricardozanini · 2026-05-11T16:05:42Z

+    WorkflowDefinition cronFlowDefinition;
+
+    @Test
+    void testCronWorkflow() {


Why not awaitability?

await().atMost(5, TimeUnit.SECONDS) .untilAsserted(() -> assertThat(cronFlowDefinition.scheduledInstances().size()).isGreaterThan(2) );

True, can do that.

domhanak commented Apr 1, 2026

View reviewed changes

Comment thread docs/modules/ROOT/pages/quarkus-flow-java-cookbook.adoc Outdated

domhanak commented Apr 1, 2026

View reviewed changes

Comment thread docs/modules/ROOT/pages/quarkus-flow-java-cookbook.adoc Outdated

ricardozanini reviewed Apr 6, 2026

View reviewed changes

domhanak force-pushed the issue-393 branch 2 times, most recently from 71aa47b to d5dcd6c Compare April 13, 2026 07:28

domhanak marked this pull request as ready for review April 13, 2026 11:17

domhanak requested a review from a team as a code owner April 13, 2026 11:17

mcruzdev reviewed Apr 13, 2026

View reviewed changes

Comment thread docs/modules/ROOT/examples/org/acme/CronWorkflow.java Outdated

mcruzdev reviewed Apr 13, 2026

View reviewed changes

Comment thread docs/modules/ROOT/examples/org/acme/ConditionalWorkflow.java

mcruzdev reviewed Apr 13, 2026

View reviewed changes

Comment thread docs/modules/ROOT/examples/org/acme/ForEachWorkflow.java Outdated

Comment thread docs/modules/ROOT/examples/org/acme/OpenApiWorkflow.java Outdated

domhanak force-pushed the issue-393 branch from 46fd237 to 0fbbb78 Compare April 24, 2026 07:10

ricardozanini reviewed Apr 24, 2026

View reviewed changes

mcruzdev mentioned this pull request May 4, 2026

feat: Feedback from my demo implementation #226

Closed

8 tasks

domhanak added 5 commits May 11, 2026 08:43

docs: Implementation of Java DSL Cookbook

5fe056b

Fix EchoWorkflowYamlTest

f33f2fe

Implement CronWorkflow exampland test

0b15f1c

Fix HttpWorkflow example & t, improve existing docs

8e7b5f7

Add OpenApiWorkflow example, adjust mock resource

1f82815

domhanak added 23 commits May 11, 2026 08:43

Add ConditionalWorkflow with tests

ae0ad8c

Add ForEachWorkflow with tests

f3c75d4

Fix scope ofmock dependency on docs module

227ec1c

Fix formatting, add property needed for test execution

aa41b12

Add ParallelWorkflow with test

aa0a327

Comment unfinished Java examples

ad4be07

Add ContextWorkflow ample with te cookbook entry

8be00a2

Fix formatting of ContextWorkflow

e8ee924

Improve Parall examples

5575d01

Fix formatting of time in CronWorkflow

c483859

Fix Condtional example to use Java Function

3b26d01

Reference issue in ForEachWorkflow example

9f6fb82

Fix OpenApiWorkflow

2e10731

Fix HttpWorkflow to utilize query()

2da2b78

Remove obsolete comments from OpenApiWorkflow

3128356

Fix HttpOauth2Workflow to use query()

67b3dc1

Sanitaze the cookbook adoc

7a723bf

Fix ContextWorkflow entry

7d8c6bc

Fix formatting

b496b0e

Update workflow starting, improve conWorkflow example

dc5b89b

Remove commented TODOsrom adoc page

7e46edf

Add TaskContextWorkflow example

76161be

Fix ParallelWorkflow example to use fork()

5c6c3d4

domhanak force-pushed the issue-393 branch from cb647ae to 5c6c3d4 Compare May 11, 2026 07:07

Fix forEach example to use OrdersPayload::orders

fc45b3e

domhanak added 2 commits May 11, 2026 11:51

Add example with Subflows and test

33177e9

Fix parentWorkflow test typos

c9f53f8

ricardozanini reviewed May 11, 2026

View reviewed changes

ricardozanini mentioned this pull request May 11, 2026

docs: add Java example for invoking subflows #432

Closed

10 tasks

	wireMockServer = new WireMockServer(8089);
	WireMockConfiguration config = WireMockConfiguration.wireMockConfig().dynamicPort();
	wireMockServer = new WireMockServer(config);

Conversation

domhanak commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

ricardozanini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

domhanak commented Apr 8, 2026

Uh oh!

ricardozanini commented Apr 8, 2026

Uh oh!

domhanak commented Apr 10, 2026

Uh oh!

ricardozanini commented Apr 10, 2026

Uh oh!

domhanak commented Apr 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

domhanak commented Apr 13, 2026

Uh oh!

domhanak commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mcruzdev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ricardozanini commented Apr 13, 2026

Uh oh!

domhanak commented Apr 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

domhanak commented Apr 24, 2026

Uh oh!

ricardozanini commented Apr 24, 2026

Uh oh!

ricardozanini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

domhanak commented May 11, 2026

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

domhanak commented Apr 1, 2026 •

edited

Loading

github-actions Bot commented Apr 1, 2026 •

edited

Loading

domhanak commented Apr 12, 2026 •

edited

Loading

domhanak commented Apr 13, 2026 •

edited

Loading

domhanak commented Apr 24, 2026 •

edited

Loading