parameter of type com.querydsl.core.types.Predicate ignored when unique. Fixes #1522

Author: bnasslahsen

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/customisers/QuerydslPredicateOperationCustomizer.java

@@ -56,6 +56,7 @@
 import org.springframework.data.util.CastUtils;
 import org.springframework.data.util.ClassTypeInformation;
 import org.springframework.data.util.TypeInformation;
+import org.springframework.util.CollectionUtils;
 import org.springframework.web.method.HandlerMethod;
 
 /**
@@ -86,10 +87,6 @@ public QuerydslPredicateOperationCustomizer(QuerydslBindingsFactory querydslBind
 
 	@Override
 	public Operation customize(Operation operation, HandlerMethod handlerMethod) {
-		if (operation.getParameters() == null) {
-			return operation;
-		}
-
 		MethodParameter[] methodParameters = handlerMethod.getMethodParameters();
 
 		int parametersLength = methodParameters.length;
@@ -118,7 +115,7 @@ public Operation customize(Operation operation, HandlerMethod handlerMethod) {
 
 			// if only listed properties should be included, remove all other fields from fieldsToAdd
 			if (getFieldValueOfBoolean(bindings, "excludeUnlistedProperties")) {
-				fieldsToAdd.removeIf(s -> !whiteList.contains(s) && !aliases.contains(s) );
+				fieldsToAdd.removeIf(s -> !whiteList.contains(s) && !aliases.contains(s));
 			}
 
 			for (String fieldName : fieldsToAdd) {
@@ -129,7 +126,14 @@ public Operation customize(Operation operation, HandlerMethod handlerMethod) {
 				}
 			}
 		}
-		operation.getParameters().addAll(parametersToAddToOperation);
+
+		if(!CollectionUtils.isEmpty(parametersToAddToOperation)){
+			if (operation.getParameters() == null)
+				operation.setParameters(parametersToAddToOperation);
+			else
+				operation.getParameters().addAll(parametersToAddToOperation);
+		}
+
 		return operation;
 	}
 
@@ -246,7 +250,8 @@ private Type getFieldType(String fieldName, Map<String, Object> pathSpecMap, Cla
 			Field declaredField;
 			if (path.isPresent()) {
 				genericType = path.get().getType();
-			} else {
+			}
+			else {
 				declaredField = root.getDeclaredField(fieldName);
 				genericType = declaredField.getGenericType();
 			}
@@ -275,7 +280,7 @@ private io.swagger.v3.oas.models.parameters.Parameter buildParam(Type type, Stri
 		}
 
 		if (parameter.getSchema() == null) {
-			Schema<?> schema ;
+			Schema<?> schema;
 			PrimitiveType primitiveType = PrimitiveType.fromType(type);
 			if (primitiveType != null) {
 				schema = primitiveType.createProperty();

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app30/HelloController.java

@@ -0,0 +1,17 @@
+package test.org.springdoc.api.app30;
+
+import com.querydsl.core.types.Predicate;
+
+import org.springframework.data.querydsl.binding.QuerydslPredicate;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+
+@RestController
+public class HelloController {
+
+	@GetMapping("/")
+	public User testQueryDslAndSpringDoc(@QuerydslPredicate(root = User.class, bindings = UserPredicate.class) Predicate predicate) {
+		return null;
+	}
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app30/QUser.java

@@ -0,0 +1,44 @@
+package test.org.springdoc.api.app30;
+
+import com.querydsl.core.types.Path;
+import com.querydsl.core.types.PathMetadata;
+import com.querydsl.core.types.dsl.EntityPathBase;
+import com.querydsl.core.types.dsl.NumberPath;
+import com.querydsl.core.types.dsl.StringPath;
+
+import javax.annotation.Generated;
+
+import static com.querydsl.core.types.PathMetadataFactory.forVariable;
+
+
+/**
+ * QUser is a Querydsl query type for User
+ */
+@Generated("com.querydsl.codegen.EntitySerializer")
+public class QUser extends EntityPathBase<User> {
+
+	private static final long serialVersionUID = 222331676L;
+
+	public static final QUser user = new QUser("user");
+
+	public final StringPath email = createString("email");
+
+	public final StringPath firstName = createString("firstName");
+
+	public final NumberPath<Long> id = createNumber("id", Long.class);
+
+	public final StringPath lastName = createString("lastName");
+
+	public QUser(String variable) {
+		super(User.class, forVariable(variable));
+	}
+
+	public QUser(Path<? extends User> path) {
+		super(path.getType(), path.getMetadata());
+	}
+
+	public QUser(PathMetadata metadata) {
+		super(User.class, metadata);
+	}
+
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app30/SpringDocApp30Test.java

@@ -0,0 +1,35 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *  *
+ *  *  *  * 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
+ *  *  *  *
+ *  *  *  *      https://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 test.org.springdoc.api.app30;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+public class SpringDocApp30Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app30/User.java

@@ -0,0 +1,22 @@
+package test.org.springdoc.api.app30;
+
+
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Entity
+@Getter
+@Setter
+public class User {
+	@Id
+	@GeneratedValue(strategy = GenerationType.IDENTITY)
+	private Long id;
+	private String firstName;
+	private String lastName;
+	private String email;
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app30/UserPredicate.java

@@ -0,0 +1,16 @@
+package test.org.springdoc.api.app30;
+
+
+import org.springframework.data.querydsl.binding.QuerydslBinderCustomizer;
+import org.springframework.data.querydsl.binding.QuerydslBindings;
+
+public class UserPredicate implements QuerydslBinderCustomizer<QUser> {
+
+
+	@Override
+	public void customize(QuerydslBindings bindings, QUser user) {
+		bindings.excludeUnlistedProperties(true);
+		bindings.including(user.email);
+		bindings.bind(user.firstName).as("name").withDefaultBinding();
+	}
+}

springdoc-openapi-data-rest/src/test/resources/results/app30.json

@@ -0,0 +1,73 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "testQueryDslAndSpringDoc",
+        "parameters": [
+          {
+            "name": "name",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "email",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/hal+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/User"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "User": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "firstName": {
+            "type": "string"
+          },
+          "lastName": {
+            "type": "string"
+          },
+          "email": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}