feat: Add interfaces for CRUD services #20743

Artur- · 2024-12-18T10:04:23Z

These were previously in Hilla but are equally useful in Flow applications

github-actions · 2024-12-18T10:20:53Z

Test Results

1 162 files + 3 1 162 suites +3 1h 32m 47s ⏱️ +39s
7 618 tests +35 7 562 ✅ +35 56 💤 ±0 0 ❌ ±0
7 966 runs +43 7 901 ✅ +43 65 💤 ±0 0 ❌ ±0

Results for commit 961675c. ± Comparison against base commit 4688eb1.

♻️ This comment has been updated with latest results.

These were previously in Hilla but are equally useful in Flow applications

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/jpa/CrudRepositoryService.java

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/jpa/JpaFilterConverter.java

...-spring/src/main/java/com/vaadin/flow/spring/data/jpa/PropertyStringFilterSpecification.java

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/jpa/JpaFilterConverter.java

peholmst

Since this is a breaking change anyway, I took the liberty of being extra picky with the review.

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/FormService.java

peholmst · 2024-12-18T17:59:35Z

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/jpa/package-info.java

@@ -0,0 +1,2 @@
+@org.springframework.lang.NonNullApi
+package com.vaadin.flow.spring.data.jpa;


Maybe also add @NullMarked from JSpecify?

Why would we need both?

If removing @NonNullApi does not break anything, then by all means remove it.

On the contrary, Hilla only supports @NonNullApi

peholmst · 2024-12-18T17:59:52Z

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/package-info.java

@@ -0,0 +1,2 @@
+@org.springframework.lang.NonNullApi
+package com.vaadin.flow.spring.data;


Same thing here?

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/ListService.java

peholmst · 2024-12-18T18:04:15Z

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/filter/Filter.java

+@JsonSubTypes({ @Type(value = OrFilter.class, name = "or"),
+        @Type(value = AndFilter.class, name = "and"),
+        @Type(value = PropertyStringFilter.class, name = "propertyString") })
+public class Filter implements Serializable {


Are the Filter classes meant to mainly be created by Jackson, or is there a situation where a developer may want to create them in Java as well? Also why are the Filter classes mutable and not immutable?

I need to create some examples to show usage before this is merged. I think they should be public and ok to create by hand but they don't need to be mutable

Added convenience constructors. Some usage examples in https://github.com/Artur-/flow-crud-demo/tree/main/src/main/java/com/example/demo

peholmst · 2024-12-18T18:07:08Z

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/filter/package-info.java

@@ -0,0 +1,2 @@
+@org.springframework.lang.NonNullApi


Consider adding @NullMarked here.

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/jpa/CrudRepositoryService.java

...-spring/src/main/java/com/vaadin/flow/spring/data/jpa/PropertyStringFilterSpecification.java

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/CountService.java

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/FormService.java

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/filter/PropertyStringFilter.java

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/jpa/ListRepositoryService.java

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/jpa/JpaFilterConverter.java

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/CrudService.java

mshabarov · 2025-01-10T13:48:49Z

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/jpa/ListRepositoryService.java

+     * @return
+     */
+    @Override
+    public long count(@Nullable Filter filter) {


Can we have shorthand count() method ?

We could. Should we? :D

I think we should, minor thing but IMO makes the code reading a bit clearer when count has no null in the project.

However, now count and list works differently.
Also, it is impossible to do something like

grid.setItemsPageable(pageable -> productService.list(pageable, filter), pageable -> productService.count(filter));

Reverted count() again. Let's start without it and see?

Yes, okay 👍

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/filter/PropertyStringFilter.java

mshabarov · 2025-01-10T15:25:38Z

Made a quick example of how a CRUD service may look like with/without these classes vaadin/flow-crm-tutorial@crud-services...without-crud-services.
A big benefit for me is obviously a simpler filtering: no need to make my own query/criteria code for it.

mshabarov

Overall looks good and has many benefits of being available in Flow.
LGTM.

This reverts commit c16124f.

mshabarov · 2025-01-13T11:03:51Z

Fixes #20834.

sonarqubecloud · 2025-01-13T11:30:53Z

Quality Gate passed

Issues
27 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

vaadin-bot added the +0.1.0 label Dec 18, 2024

Artur- force-pushed the crud-interfaces branch from b433077 to 83ece96 Compare December 18, 2024 11:36

Artur- added 2 commits December 18, 2024 14:17

feat: Add interfaces for CRUD services

9f5c5ec

These were previously in Hilla but are equally useful in Flow applications

Move jpa related classes into separate package

8ebca25

Artur- force-pushed the crud-interfaces branch from 83ece96 to 8ebca25 Compare December 18, 2024 12:19

format

ffbdff0

peholmst reviewed Dec 18, 2024

View reviewed changes

Changes VS Code left unsaved

e840b56

Artur- mentioned this pull request Dec 18, 2024

chore: Register JpaFilterConverter in a way that can be overridden #20745

Closed

peholmst and others added 3 commits December 18, 2024 14:47

Make JpaFilterConverter work without the EntityManager.

a32c1ff

Leave out FilterTransformer as it is not used anywhere

7fd7590

Simplify as JpaFilterConverter now only has one helper method

2f7a5db

peholmst reviewed Dec 18, 2024

View reviewed changes

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/jpa/JpaFilterConverter.java Outdated Show resolved Hide resolved

Artur- and others added 9 commits December 18, 2024 15:38

Tests from Hilla

fcaf974

Add missing dependencies to make Spring Data tests work.

5a2d557

Change expected exception

14d7d87

fix test

94436bf

final

c1a9062

Use jspecify instead of custom annotations

b00f394

Util class not serializable

5163a3c

format

7645905

Merge branch 'main' into crud-interfaces

9d55027

Artur- requested a review from peholmst December 18, 2024 16:17

Artur- added 2 commits December 18, 2024 18:58

For Hilla compat

2b8b150

fix test

8a9f6b6

peholmst reviewed Dec 18, 2024

View reviewed changes

Artur- added 3 commits December 19, 2024 12:53

Tweak

230bbc5

Merge branch 'main' into crud-interfaces

463bffb

Remove nullable

10e9ead

mshabarov requested a review from caalador December 23, 2024 08:17

This was referenced Dec 30, 2024

chore: Expose methods from Flow crud classes to browser callables vaadin/hilla#3073

Merged

chore: Deprecate Hilla CRUD classes and recommend Flow ones vaadin/hilla#3048

Draft

Merge branch 'main' into crud-interfaces

5c83fcd

mshabarov requested changes Jan 10, 2025

View reviewed changes

mshabarov removed the request for review from caalador January 10, 2025 13:13

mshabarov reviewed Jan 10, 2025

View reviewed changes

vaadin-spring/src/main/java/com/vaadin/flow/spring/data/filter/PropertyStringFilter.java Show resolved Hide resolved

Artur- added 5 commits January 13, 2025 10:49

Merge branch 'main' into crud-interfaces

250212a

Add convenience constructors

c272a43

Improve javadoc

72f6548

Improve javadoc

9fa935e

javadoc

98bee66

mshabarov previously approved these changes Jan 13, 2025

View reviewed changes

Add count()

c16124f

Artur- dismissed mshabarov’s stale review via c16124f January 13, 2025 10:34

mshabarov previously approved these changes Jan 13, 2025

View reviewed changes

Revert "Add count()"

ce450df

This reverts commit c16124f.

Artur- dismissed mshabarov’s stale review via ce450df January 13, 2025 10:53

mshabarov previously approved these changes Jan 13, 2025

View reviewed changes

mshabarov mentioned this pull request Jan 13, 2025

Add services for easier CRUD operations with Spring-based repositories #20834

Closed

Artur- enabled auto-merge (squash) January 13, 2025 11:05

format

961675c

Artur- dismissed mshabarov’s stale review via 961675c January 13, 2025 11:21

mshabarov approved these changes Jan 13, 2025

View reviewed changes

Artur- merged commit c96213d into main Jan 13, 2025
26 checks passed

Artur- deleted the crud-interfaces branch January 13, 2025 12:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add interfaces for CRUD services #20743

feat: Add interfaces for CRUD services #20743

Artur- commented Dec 18, 2024

github-actions bot commented Dec 18, 2024 •

edited

Loading

peholmst left a comment

peholmst Dec 18, 2024

Artur- Dec 19, 2024

peholmst Dec 19, 2024

Artur- Dec 19, 2024

peholmst Dec 18, 2024

peholmst Dec 18, 2024

Artur- Dec 19, 2024

Artur- Jan 13, 2025

peholmst Dec 18, 2024

mshabarov Jan 10, 2025

Artur- Jan 13, 2025

mshabarov Jan 13, 2025

Artur- Jan 13, 2025

Artur- Jan 13, 2025

Artur- Jan 13, 2025

mshabarov Jan 13, 2025

mshabarov commented Jan 10, 2025

mshabarov left a comment •

edited

Loading

mshabarov commented Jan 13, 2025

sonarqubecloud bot commented Jan 13, 2025

		@@ -0,0 +1,2 @@
		@org.springframework.lang.NonNullApi
		package com.vaadin.flow.spring.data.jpa;

		@@ -0,0 +1,2 @@
		@org.springframework.lang.NonNullApi
		package com.vaadin.flow.spring.data;

feat: Add interfaces for CRUD services #20743

feat: Add interfaces for CRUD services #20743

Conversation

Artur- commented Dec 18, 2024

github-actions bot commented Dec 18, 2024 • edited Loading

Test Results

peholmst 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mshabarov commented Jan 10, 2025

mshabarov left a comment • edited Loading

Choose a reason for hiding this comment

mshabarov commented Jan 13, 2025

sonarqubecloud bot commented Jan 13, 2025

Quality Gate passed

github-actions bot commented Dec 18, 2024 •

edited

Loading

mshabarov left a comment •

edited

Loading