Skip to content

issue-804: ADR for devui editor roundtrip test - #805

Open
domhanak wants to merge 7 commits into
quarkiverse:mainfrom
domhanak:issue-804-adr
Open

issue-804: ADR for devui editor roundtrip test#805
domhanak wants to merge 7 commits into
quarkiverse:mainfrom
domhanak:issue-804-adr

Conversation

@domhanak

@domhanak domhanak commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Description

This is an ADR for a test to validate Dev UI Workflow Editor Rendering Round-Trip

ADR for #804

Updated with:
Added PoC test suite with cases
Update the ADR based on PoC

Changes

Adds ADR for #804

Checklist

Before submitting this PR, please ensure:

  • I ran the full build with integration tests locally: ./mvnw clean install -DskipITs=false
  • Code follows the project's code conventions
  • Tests have been added/updated to cover the changes
  • Documentation has been updated (if user-facing changes)
  • Commit messages are clear and follow conventional commits style
  • I have read and followed the Contributing Guide
  • I have read and comply with the LLM Usage Policy (if applicable)

Additional Notes

@domhanak
domhanak requested a review from a team as a code owner July 29, 2026 08:03
@domhanak
domhanak requested review from afatnassi1a, fantonangeli and lornakelly and removed request for afatnassi1a July 29, 2026 08:03

@fantonangeli fantonangeli left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, for the parts which I can understand.
Thanks @domhanak

@lornakelly

lornakelly commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

@domhanak Thanks for the ADR, my knowledge of quarkus flow internals is limited but looks like a great start. Just one small comment:

EchoNameWorkflow covers a single flat set task but, from my understanding, each construct serialises to a different JSON shape from Java and the editor's own tests only cover hand-written YAML, so nothing checks that shape.

So can we run the same check across the other types:call, for, fork, tryCatch, listen, emit, raise, run, switch, wait? Happy to have this in a phase 2 section if we just want to get the simple example up and running first?

@domhanak

domhanak commented Jul 29, 2026

Copy link
Copy Markdown
Contributor Author

@lornakelly yea, so I initially did not include this when prompting, so it is not there. Wanted to keep the focus narrow to limit hallucinations and inaccuracies. So this ADR covers the MVP, the expansion to broader coverage can be done in multiple ways, but we need one where we reuse existing example workflows so it is a bit tricky.

I have since theorized a way to reuse what we have in docs cookbook and working on PoC locally.
Once I validate it is ok and works well, Ill update the PR with some extra analysis output from Bob tool.

Ultimately we could do one big workflow that has everything here, but that is something I did not think through yet.

@lornakelly

Copy link
Copy Markdown
Contributor

@lornakelly yea, so I initially did not include this when prompting, so it is not there. Wanted to keep the focus narrow to limit hallucinations and inaccuracies. So this ADR covers the MVP, the expansion to broader coverage can be done in multiple ways, but we need one where we reuse existing example workflows so it is a bit tricky.

I have since theorized a way to reuse what we have in docs cookbook and working on PoC locally. Once I validate it is ok and works well, Ill update the PR with some extra analysis output from Bob tool.

Sounds good, thanks

domhanak added 5 commits July 29, 2026 12:17
Wire docs/modules/ROOT/examples as an extra test source in
core/deployment/pom.xml via build-helper-maven-plugin + compiler excludes
dd a lightweight JSON-RPC companion test (no browser) that validates
JsonRPC roundtrip idempotency, semantic equivalency and registry
mutation
Verify the round-trip for a workflow loaded from a YAML resource file
using the same idempotency and semantic-equivalence assertions as in
Java fixture
Create the new Playwright-based round-trip IT that validates the full rendering pipeline for
**Java DSL workflows** from `docs/modules/ROOT/examples/org/acme/`

@lornakelly lornakelly left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment thread core/deployment/pom.xml
<!-- Requires LangChain4j dependencies -->
<exclude>org/acme/langchain4j/**</exclude>
<!-- Doc test classes — use their own QuarkusTest setup, not applicable here -->
<exclude>test/**</exclude>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these exclusions because of the inclusion of docs sources in builder-helper-maven-plugin? If so, can you please add a comment here explaining this?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I ll add comment explaining

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants