Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions flow-server/src/main/java/com/vaadin/flow/Nonnull.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
* Copyright 2000-2022 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.flow;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* Annotation to mark either field, method, parameter or type parameter as
* non-nullable. It is used by Typescript Generator as a source of type
* nullability information.
*
* This annotation exists because the traditional `jakarta.annotation.Nonnull`
* annotation is not applicable to type parameters.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE_USE })
public @interface Nonnull {
}
36 changes: 36 additions & 0 deletions flow-server/src/main/java/com/vaadin/flow/Nullable.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
* Copyright 2000-2022 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.flow;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* Annotation to mark either field, method, parameter or type parameter as
* nullable. It is used by Typescript Generator as a source of type nullability
* information.
*
* This annotation exists because the traditional `jakarta.annotation.Nullable`
* annotation is not applicable to type parameters.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE_USE })
public @interface Nullable {
}
20 changes: 20 additions & 0 deletions vaadin-spring/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,26 @@
<artifactId>spring-data-commons</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-jpa</artifactId>
<scope>provided</scope>
<exclusions>
<exclusion>
<artifactId>aspectjrt</artifactId>
<groupId>org.aspectj</groupId>
</exclusion>
<exclusion>
<artifactId>jcl-over-slf4j</artifactId>
<groupId>org.slf4j</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>jakarta.persistence</groupId>
<artifactId>jakarta.persistence-api</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.vaadin</groupId>
<artifactId>flow-data</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
*/
package com.vaadin.flow.spring;

import jakarta.persistence.EntityManager;
import jakarta.servlet.MultipartConfigElement;

import java.util.HashMap;
import java.util.Map;

Expand All @@ -37,10 +40,9 @@

import com.vaadin.flow.server.Constants;
import com.vaadin.flow.server.VaadinServlet;
import com.vaadin.flow.spring.data.jpa.JpaFilterConverter;
import com.vaadin.flow.spring.springnative.VaadinBeanFactoryInitializationAotProcessor;

import jakarta.servlet.MultipartConfigElement;

/**
* Spring boot auto-configuration class for Flow.
*
Expand Down Expand Up @@ -142,4 +144,11 @@ public ServerEndpointExporter websocketEndpointDeployer() {
return new VaadinWebsocketEndpointExporter();
}

@Bean
@ConditionalOnMissingBean
@ConditionalOnClass(EntityManager.class)
public JpaFilterConverter jpaFilterConverter(EntityManager entityManager) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I would not want this Bean as flow user. Additionally it might be problematic for projects without JPA because of the EntityManager (so conditional on missing bean is not enough)

Copy link
Contributor

Choose a reason for hiding this comment

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

And wait.. is this the code that made "Hilla utterly broken with multiple Data sources"? I'm strict against this in flow!

Copy link
Member Author

Choose a reason for hiding this comment

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

Sounds like this is something personal. Can we discuss the merits of the code instead and what it is useful for

Copy link
Member Author

Choose a reason for hiding this comment

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

As you can see from the description, it is supposed to fix vaadin/hilla#2569, not introduce it to all Flow users

Copy link
Contributor

Choose a reason for hiding this comment

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

It's added to "SpringBootAutoConfiguration" which effects flow.

Copy link
Member Author

Choose a reason for hiding this comment

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

Indeed, that is the point of this PR. To add the features to Flow and not only restrict them to Hilla

Copy link
Contributor

Choose a reason for hiding this comment

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

Your last two comments are kinda conflicting?

But nevertheless back to code - this JPAFilter probably has to be added in a second AutoConfiguration class to ensure it's only loaded with JPA and Spring Data in use.. or does it have to be a bean at all? It looks just like some helper methods that need access to the EntityManager.. with the "move" to flow and re-creating of all classes.. it's binary incompatible anyway so perfect timing for breaking changes.

Just a quick note on the other code:

  • doing lowercasr on a database column by default might be a performance problem with big tables without proper indexes
  • the string concatenation for like looks un-sanitized

Copy link
Member Author

Choose a reason for hiding this comment

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

Let's see first where #20743 ends up. The original version in Hilla contained quite a bit of magic and this PR now contains way less of it

Copy link
Member Author

Choose a reason for hiding this comment

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

Your last two comments are kinda conflicting?

The point is to introduce the features to all Flow users but not to introduce the problem to all Flow users

return new JpaFilterConverter(entityManager);
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package com.vaadin.flow.spring.data;

import com.vaadin.flow.Nullable;

import com.vaadin.flow.spring.data.filter.Filter;

/**
* A service that can count the given type of objects with a given filter.
*/
public interface CountService {

/**
* Counts the number of entities that match the given filter.
*
* @param filter
* the filter, or {@code null} to use no filter
* @return
*/
public long count(@Nullable Filter filter);

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package com.vaadin.flow.spring.data;

/**
* A service that can create, read, update, and delete a given type of object.
*/
public interface CrudService<T, ID> extends ListService<T>, FormService<T, ID> {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package com.vaadin.flow.spring.data;

import com.vaadin.flow.Nullable;

/**
* A service that can create, update, and delete a given type of object.
*/
public interface FormService<T, ID> {

/**
* Saves the given object and returns the (potentially) updated object.
* <p>
* If you store the object in a SQL database, the returned object might have
* a new id or updated consistency version.
*
* @param value
* the object to save
* @return the fresh object or {@code null} if no object was found to update
*/
@Nullable
T save(T value);

/**
* Deletes the object with the given id.
*
* @param id
* the id of the object to delete
*/
void delete(ID id);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package com.vaadin.flow.spring.data;

import java.util.Optional;

/**
* A service that can fetch the given type of object.
*/
public interface GetService<T, ID> {

/**
* Gets the object with the given id.
*
* @param id
* the id of the object
* @return the object, or an empty optional if no object with the given id
*/
Optional<T> get(ID id);

/**
* Checks if an object with the given id exists.
*
* @param id
* the id of the object
* @return {@code true} if the object exists, {@code false} otherwise
*/
default boolean exists(ID id) {
return get(id).isPresent();
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
package com.vaadin.flow.spring.data;

import java.util.List;

import com.vaadin.flow.Nullable;
import com.vaadin.flow.Nonnull;

import com.vaadin.flow.spring.data.filter.Filter;
import org.springframework.data.domain.Pageable;

/**
* A service that can list the given type of object.
*/
public interface ListService<T> {
/**
* Lists objects of the given type using the paging, sorting and filtering
* options provided in the parameters.
*
* @param pageable
* contains information about paging and sorting
* @param filter
* the filter to apply or {@code null} to not filter
* @return a list of objects or an empty list if no objects were found
*/
@Nonnull
List<@Nonnull T> list(Pageable pageable, @Nullable Filter filter);

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package com.vaadin.flow.spring.data.filter;

import java.util.List;

/**
* A filter that requires all children to pass.
* <p>
* Custom filter implementations need to handle this filter by running all child
* filters and verifying that all of them pass.
*/
public class AndFilter extends Filter {
private List<Filter> children;

public List<Filter> getChildren() {
return children;
}

public void setChildren(List<Filter> children) {
this.children = children;
}

@Override
public String toString() {
return "AndFilter [children=" + children + "]";
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package com.vaadin.flow.spring.data.filter;

import java.io.Serializable;

import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonSubTypes.Type;
import com.fasterxml.jackson.annotation.JsonTypeInfo;

/**
* Superclass for all filters to be used with CRUD services. This specific class
* is never used, instead a filter instance will be one of the following types:
* <ul>
* <li>{@link AndFilter} - Contains a list of nested filters, all of which need
* to pass.</li>
* <li>{@link OrFilter} - Contains a list of nested filters, of which at least
* one needs to pass.</li>
* <li>{@link PropertyStringFilter} - Matches a specific property, or nested
* property path, against a filter value, using a specific operator.</li>
* </ul>
*/
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY)
@JsonSubTypes({ @Type(value = OrFilter.class, name = "or"),
@Type(value = AndFilter.class, name = "and"),
@Type(value = PropertyStringFilter.class, name = "propertyString") })
public class Filter implements Serializable {

}
Loading
Loading