HSEARCH-4167 Check param get by param method exists

hibernate · May 26, 2021 · 167be60 · 167be60
1 parent a8a90d8
commit 167be60
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 7 deletions.
diff --git a/...sticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/logging/impl/Log.java b/...sticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/logging/impl/Log.java
@@ -761,4 +761,7 @@ SearchException incompatibleElasticsearchVersionOnStart(ElasticsearchVersion ver
 					+ " but multi-tenancy strategy is set.")
 	SearchException multiTenancyNotRequiredButExplicitlyEnabledByTheBackend();
 
+	@Message(id = ID_OFFSET + 150, value = "Param with name '%1$s' has not been defined for the named predicate.")
+	SearchException paramNotDefined(String name);
+
 }
diff --git a/...rnate/search/backend/elasticsearch/search/predicate/impl/ElasticsearchNamedPredicate.java b/...rnate/search/backend/elasticsearch/search/predicate/impl/ElasticsearchNamedPredicate.java
@@ -130,7 +130,12 @@ public SearchPredicateFactory predicate() {
 		@Override
 		public Object param(String name) {
 			Contracts.assertNotNull( name, "name" );
-			return params.get( name );
+
+			Object value = params.get( name );
+			if ( value == null ) {
+				throw log.paramNotDefined( name );
+			}
+			return value;
 		}
 
 		@Override

diff --git a/backend/lucene/src/main/java/org/hibernate/search/backend/lucene/logging/impl/Log.java b/backend/lucene/src/main/java/org/hibernate/search/backend/lucene/logging/impl/Log.java
@@ -664,4 +664,7 @@ SearchException indexSchemaNamedPredicateNameConflict(String relativeFilterName,
 					+ " but multi-tenancy strategy is set.")
 	SearchException multiTenancyNotRequiredButExplicitlyEnabledByTheBackend();
 
+	@Message(id = ID_OFFSET + 150, value = "Param with name '%1$s' has not been defined for the named predicate.")
+	SearchException paramNotDefined(String name);
+
 }
diff --git a/.../java/org/hibernate/search/backend/lucene/search/predicate/impl/LuceneNamedPredicate.java b/.../java/org/hibernate/search/backend/lucene/search/predicate/impl/LuceneNamedPredicate.java
@@ -127,7 +127,12 @@ public SearchPredicateFactory predicate() {
 		@Override
 		public Object param(String name) {
 			Contracts.assertNotNull( name, "name" );
-			return params.get( name );
+
+			Object value = params.get( name );
+			if ( value == null ) {
+				throw log.paramNotDefined( name );
+			}
+			return value;
 		}
 
 		@Override

diff --git a/...org/hibernate/search/engine/search/predicate/factories/NamedPredicateProviderContext.java b/...org/hibernate/search/engine/search/predicate/factories/NamedPredicateProviderContext.java
@@ -10,6 +10,7 @@
 
 import org.hibernate.search.engine.search.predicate.dsl.NamedPredicateOptionsStep;
 import org.hibernate.search.engine.search.predicate.dsl.SearchPredicateFactory;
+import org.hibernate.search.util.common.SearchException;
 import org.hibernate.search.util.common.annotation.Incubating;
 
 /**
@@ -30,14 +31,16 @@ public interface NamedPredicateProviderContext {
 	/**
 	 * @param name The name of the parameter.
 	 * @return The value provided to {@link NamedPredicateOptionsStep#param(String, Object)} for this parameter.
-	 * @see NamedPredicateOptionsStep#param(java.lang.String, java.lang.Object)
+	 * @throws SearchException no value was provided for this parameter.
+	 * @see NamedPredicateOptionsStep#param(String, Object)
 	 */
 	Object param(String name);
 
 	/**
 	 * @param name The name of the parameter.
 	 * @return An optional containing the value provided to {@link NamedPredicateOptionsStep#param(String, Object)}
 	 * for this parameter, or {@code Optional.empty()} if no value was provided for this parameter.
+	 * @see NamedPredicateOptionsStep#param(String, Object)
 	 */
 	Optional<Object> paramOptional(String name);
 

diff --git a/.../search/integrationtest/backend/tck/search/predicate/NamedPredicateProviderContextIT.java b/.../search/integrationtest/backend/tck/search/predicate/NamedPredicateProviderContextIT.java
@@ -10,6 +10,8 @@
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.hibernate.search.util.impl.integrationtest.common.assertion.SearchResultAssert.assertThatQuery;
 
+import java.util.Optional;
+
 import org.hibernate.search.engine.backend.document.IndexObjectFieldReference;
 import org.hibernate.search.engine.backend.document.model.dsl.IndexSchemaElement;
 import org.hibernate.search.engine.backend.document.model.dsl.IndexSchemaObjectField;
@@ -47,7 +49,7 @@ public static void setup() {
 
 	@Test
 	public void param() {
-		Object[] givenParams = new Object[] { "string", new Object(), 5L, null };
+		Object[] givenParams = new Object[] { "string", new Object(), 5L, Optional.empty() };
 		Object[] receivedParams = new Object[givenParams.length];
 
 		assertThatQuery( index.query()
@@ -60,7 +62,7 @@ public void param() {
 							receivedParams[0] = context.param( "param1" );
 							receivedParams[1] = context.param( "param2" );
 							receivedParams[2] = context.param( "param3" );
-							receivedParams[3] = context.param( "param5" );
+							receivedParams[3] = context.paramOptional( "param5" );
 							return context.predicate().matchAll().toPredicate();
 						} ) ) )
 				.hasDocRefHitsAnyOrder( index.typeName(), DOCUMENT_1 );
@@ -70,13 +72,13 @@ public void param() {
 
 	@Test
 	public void param_absent() {
-		Object[] expectedParams = new Object[] { null };
+		Object[] expectedParams = new Object[] { Optional.empty() };
 		Object[] actualsParams = new Object[1];
 
 		assertThatQuery( index.query()
 				.where( f -> f.named( "stub-predicate" )
 						.param( "impl", (NamedPredicateProvider) context -> {
-							actualsParams[0] = context.param( "absent" );
+							actualsParams[0] = context.paramOptional( "absent" );
 							return context.predicate().matchAll().toPredicate();
 						} ) ) )
 				.hasDocRefHitsAnyOrder( index.typeName(), DOCUMENT_1 );