Add support for multiline query formatting in Query annotations by catturtle123 · Pull Request #1763 · spring-projects/spring-tools

catturtle123 · 2026-01-23T15:17:10Z

This PR addresses issue #1726

Summary

Default Data Query Style Change: Changed the default query generation style to compact (single line) to ensure broader compatibility across Java versions.
Architectural Refinement (Interface Separation): Decoupled the query formatting logic by introducing the QueryFormatter interface with dedicated implementations (JpqlQueryFormatter, MongoQueryFormatter). This allows for repository-specific formatting strategies.
Robust String Escaping & Formatting:
Integrated StringEscapeUtils.escapeJava() to safe-guard generated queries against syntax errors.
Multiline Indentation: Improved Text Block generation by adding proper indentation/alignment to ensure the generated query is visually consistent with the surrounding Java code.
Configuration & Fallback: Updated logic to use compact and multiline keywords from UserSettings. Implemented a fallback mechanism that defaults to compact and triggers a log.warn for invalid or null inputs.

Key Changes

Refactoring & Logic:
QueryFormatter.java, JpqlQueryFormatter.java, MongoQueryFormatter.java: Separated formatting logic into an interface-based structure.
BootJavaConfig.java: Updated style selection and added validation/fallback logic.
DataRepositoryAotMetadataCodeLensProvider.java: Refactored to prioritize safety and proper indentation.
Test Suite Updates:
QueryMethodCodeActionProviderJpaTest.java & QueryMethodCodeActionProviderMongoDbTest.java: Updated to verify the output specifically for the compact style.
DataRepositoryAotMetadataCodeLensProviderTest.java: Added comprehensive test cases for both compact and multiline styles, verifying correct indentation.

Resolved Issues

Fixed Syntax Errors: Resolved IndexOutOfBoundsException by properly escaping special characters.
Visual Alignment: Multiline queries now include appropriate leading spaces, improving the aesthetics of the generated code.
Error Resilience: Prevents IDE tool failure by falling back to a safe default when configuration is missing or malformed.

Discussion Points

Test Coverage Asymmetry: Currently, DataRepositoryAotMetadataCodeLensProviderTest provides full coverage for both styles. However, QueryMethodCodeActionProviderJpaTest and QueryMethodCodeActionProviderMongoDbTest are currently limited to verifying the compact style. Should I expand these two classes to include multiline test cases as well to maintain consistency?
Fallback Strategy: Is the use of log.warn followed by a fallback to compact an acceptable approach for handling unexpected user configuration values? (Silent fallback to compact for null cases (no log.warn).)

Test

Signed-off-by: Junhwan Kim <musoyou1085@gmail.com>

- Introduce QueryFormatter interface and implementations for JPQL and MongoDB queries - Add BootJavaConfig option to select query style (compact or multiline) - Update code lens and code action providers to use configurable query formatting - Enhance tests to verify multiline and compact query styles Signed-off-by: Junhwan Kim <musoyou1085@gmail.com>

…related tests - Remove extra indentation from multiline JPQL and Mongo query formatting - Adjust test assertions to match new formatting without leading spaces - Update text block generation to align closing triple quotes without indentation - Add configuration option for data query style in package.json - Enhance code action provider to include fix data for refactorings Signed-off-by: Junhwan Kim <musoyou1085@gmail.com>

martinlippert · 2026-02-05T13:03:41Z

I tried the latest version here and I do see the multiline preference working and slitting up the query statement nicely into multiple lines. But I do not see (yet) the correct formatting. Am I missing something?

catturtle123 · 2026-02-06T19:14:51Z

I tried the latest version here and I do see the multiline preference working and slitting up the query statement nicely into multiple lines. But I do not see (yet) the correct formatting. Am I missing something?

Thanks for trying it out! Yes, the multiline splitting itself is working — the query string gets broken into multiple lines correctly.

The formatting (indentation) issue is what I'm working on now. I actually got it working in VSCode first — the "Add Query" CodeAction triggers IDE auto-formatting, so the indentation comes out correctly there.

But then I realized this approach doesn't carry over to Eclipse. So I'm rethinking the approach — specifically how to handle formatting for the "Turn into Query" CodeLens path, since that uses workspace/applyEdit which doesn't automatically trigger IDE formatting on either side. I've got the Eclipse preference/settings wired up, but now I need to figure out how to trigger the IDE's formatter after the edit is applied so the indentation gets properly adjusted.

Working on it — will update once I have a solution that works for both VSCode and Eclipse.

BoykoAlex · 2026-02-06T21:21:42Z

@catturtle123 For the IDE formatting I'd chain another command to the code action: the first add a query and the second performs the formatting. See package org.springframework.tooling.ls.eclipse.commons.commands in the org.springframework.tooling.ls.eclipse.commons plugin project in the spring-tools. It has examples of commands we've introduced for the eclipse side that we can execute from the LS. The plugin.xml has contributions of these commands into eclipse command/handler framework. There is definitely a command to format selection in the editor in Eclipse that exists already... you'd haveto find a way to bridge to it properly.
Another way to solve this would be from the OpenRewrite recipe side. The AddAnnotationOverMethod has autoFormat call however it uses the default (intelij style) formatting. Instead it should use the same formatting as the file uses. I heard OpenRewrite is able to detect the formatting of the code base and have it as marker somewhere to use in autoFormat calls. The format detection bit is missing at the moment... (I'd like to have a look at why it is missing as well)

BoykoAlex · 2026-02-07T01:43:30Z

@catturtle123 I've tried formatting via OpenRewrite snippet auto-format (#1775) via the recipe used to add a query. Added styling markers to parsed sources. The version of Rewrite we used didn't format string block. I've upgraded to the latest version of OpenRewrite and there is block string formatting but it's somewhat unexpected.
Therefore the command for Eclipse remains to do... There seems to be org.eclipse.ui.edit.format command but it needs a selection in the editor... Formatting should be available on the via the eclipse SourceViewer class via operation API (but I'd have to refresh my memory on that) and that likely takes the range rather than the selection.

BoykoAlex · 2026-02-07T07:59:13Z

(Or maybe rebase and see how it looks. I can see the rationale behind rewrite's string block formatting)

BoykoAlex · 2026-02-08T01:44:35Z

@martinlippert @catturtle123 I think I like the Rewrite's formatting for block string literals. I think it is better than what JDT produces actually. Maybe we can stop here with query split into multiple lines as Rewrite's recipe would format the string block quite well. We can continue looking into the formatting on the client but it'd mean another command which means 2. commands to undo... The formatting on the client would make more sense once we drop Rewrite in favour of JDT for quick fixes which is not too far out actually... so not sure...

Signed-off-by: Junhwan Kim <musoyou1085@gmail.com>

catturtle123 · 2026-02-08T17:28:58Z

@BoykoAlex
Sounds good — I agree that OpenRewrite's formatting is sufficient for now, and it makes sense to defer client-side formatting until the JDT transition.

I'll rebase on main (which includes #1775) and verify how the query splitting looks with the updated OpenRewrite formatting.

catturtle123 · 2026-02-08T18:08:58Z

I've rebased on main (which includes #1775) and tested the multiline query formatting. (I haven't pushed it yet)

Results:

Query splitting into multiple lines works correctly on both VSCode and Eclipse.
However, the text block indentation only works properly in VSCode. In Eclipse, the query is split into multiple lines but the indentation is not applied.
MongoDB Repository turn into query error (only multiline)

VSCode:

Eclipse:

MongoDB:

It seems that VSCode applies additional formatting after the edit, while Eclipse does not. This aligns with what @BoykoAlex mentioned earlier about needing a format command on the Eclipse side.

Should I look into the Eclipse format command (org.eclipse.ui.edit.format or SourceViewer operation API), or is the current state acceptable for now?

BoykoAlex · 2026-02-08T18:46:28Z

@catturtle123 did you rebase your branch on the latest from main? Doesn't look like you did... if you rebase on the latest commits in main I'm pretty sure the text block in Eclipse would be formatted quite nicely.

BoykoAlex

I'm going to push the query formatters into jpql module with #1776. I've created those formatters using AI based on the ANTLR parse tree. There are tests for the formatters. I think it'd be great if we use these formatters for the query.
I'd simplify things for now and would just do a switch on the module in the code lens class where the module is the property of aot repo metadata, an enum which is either mongo or jpa or jdbc. I'd use PostgreSqlQueryFormatter for JDBC, HQL formatter for JPA and just inline the json things for Mongo DB.
I think we can get the decent formatting from OpenRewrite.
I'd use BooleanFieldEditor for the preference UI and use boolean for multiline query on/off. There are 2 options only: single or block, i.e. text block or not.
Please rebase your PR on the latest from the main branch

...rver/src/main/java/org/springframework/ide/vscode/boot/java/rewrite/RewriteRefactorings.java

BoykoAlex · 2026-02-08T18:59:42Z

...c/main/java/org/springframework/ide/vscode/boot/java/data/QueryMethodCodeActionProvider.java

 		CodeAction ca = new CodeAction();
-		ca.setCommand(refactorings.createFixCommand(TITLE, DataRepositoryAotMetadataCodeLensProvider.createFixDescriptor(mb, docUri.toASCIIString(), metadata.module(), method)));
+		FixDescriptor fixDescriptor = DataRepositoryAotMetadataCodeLensProvider.createFixDescriptor(mb, docUri.toASCIIString(), metadata.module(), method, config);
+		ca.setData(refactorings.createFixData(fixDescriptor));


I'd remove the setData(...) call - it's unnecessary.

…ext-blocks # Conflicts: # headless-services/spring-boot-language-server/src/test/java/org/springframework/ide/vscode/boot/java/data/test/QueryMethodCodeActionProviderJpaTest.java

Signed-off-by: Junhwan Kim <musoyou1085@gmail.com>

catturtle123 · 2026-02-09T17:14:10Z

@BoykoAlex
I've rebased my branch on the latest main and fully incorporated all your feedback. As you predicted, the text block formatting in Eclipse is now working beautifully after the rebase. I integrated the new formatters from the jpql module for JDBC, JPA, and MongoDB, and simplified the logic by switching on the module enum as suggested. I also updated the preference UI to a BooleanFieldEditor and cleaned up the unnecessary setData calls. Everything is working perfectly on my end now, so please take another look when you have a chance.

BoykoAlex · 2026-02-09T18:35:35Z

LGTM. Merging

martinlippert · 2026-02-10T08:40:26Z

Thanks a lot @catturtle123 for working on this, for submitting the PR, and for taking all the feedback into account. Very much appreciated. Great work.

catturtle123 · 2026-02-10T08:47:35Z

Thank you @BoykoAlex @martinlippert! Your detailed feedback helped me improve a lot through this PR. There were many areas where my code fell short, but thanks to your patient guidance, I was able to see it through. It was a great experience contributing to Spring Tools.

catturtle123 and others added 4 commits January 21, 2026 00:55

Use Java text blocks for query conversion in Java 15+

8a3e1c6

Signed-off-by: Junhwan Kim <musoyou1085@gmail.com>

refactor use Java text blocks when generating Query annotations

6b62d90

Signed-off-by: Junhwan Kim <musoyou1085@gmail.com>

Merge branch 'spring-projects:main' into main

4e57049

catturtle123 mentioned this pull request Jan 23, 2026

[aot repositories] use text block when converting spring data jdbc query strings #1726

Closed

Add preference for data query style with compact and multiline options

ad38058

Signed-off-by: Junhwan Kim <musoyou1085@gmail.com>

BoykoAlex requested changes Feb 9, 2026

View reviewed changes

catturtle123 added 2 commits February 10, 2026 00:19

Merge remote-tracking branch 'upstream/main' into feature/multiline-t…

b025169

…ext-blocks # Conflicts: # headless-services/spring-boot-language-server/src/test/java/org/springframework/ide/vscode/boot/java/data/test/QueryMethodCodeActionProviderJpaTest.java

Refactor data query style handling to support multiline text blocks

5795279

Signed-off-by: Junhwan Kim <musoyou1085@gmail.com>

BoykoAlex approved these changes Feb 9, 2026

View reviewed changes

BoykoAlex marked this pull request as ready for review February 9, 2026 18:35

BoykoAlex merged commit af24404 into spring-projects:main Feb 9, 2026
1 check passed

martinlippert added this to the 5.1.0.RELEASE milestone Feb 10, 2026

martinlippert added type: enhancement theme: spring-data-support labels Feb 10, 2026

Conversation

catturtle123 commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Key Changes

Resolved Issues

Discussion Points

Test

Uh oh!

martinlippert commented Feb 5, 2026

Uh oh!

catturtle123 commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BoykoAlex commented Feb 6, 2026

Uh oh!

BoykoAlex commented Feb 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BoykoAlex commented Feb 7, 2026

Uh oh!

BoykoAlex commented Feb 8, 2026

Uh oh!

catturtle123 commented Feb 8, 2026

Uh oh!

catturtle123 commented Feb 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BoykoAlex commented Feb 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BoykoAlex left a comment • 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!

Uh oh!

BoykoAlex Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

catturtle123 commented Feb 9, 2026

Uh oh!

Uh oh!

BoykoAlex commented Feb 9, 2026

Uh oh!

martinlippert commented Feb 10, 2026

Uh oh!

catturtle123 commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

catturtle123 commented Jan 23, 2026 •

edited

Loading

catturtle123 commented Feb 6, 2026 •

edited

Loading

BoykoAlex commented Feb 7, 2026 •

edited

Loading

catturtle123 commented Feb 8, 2026 •

edited

Loading

BoykoAlex commented Feb 8, 2026 •

edited

Loading

BoykoAlex left a comment •

edited

Loading

catturtle123 commented Feb 10, 2026 •

edited

Loading