HSEARCH-3784 Simplify the handling of tenant ID filters in Lucene

The previous approach was getting in the way of the next commits.

Author: yrodiere

backend/lucene/src/main/java/org/hibernate/search/backend/lucene/multitenancy/impl/DiscriminatorMultiTenancyStrategy.java

@@ -12,7 +12,7 @@
 import org.hibernate.search.backend.lucene.logging.impl.Log;
 import org.hibernate.search.backend.lucene.search.impl.LuceneQueries;
 import org.hibernate.search.backend.lucene.util.impl.LuceneFields;
-import org.hibernate.search.backend.lucene.work.impl.LuceneQueryBasedDeleteAllEntriesWork;
+import org.hibernate.search.backend.lucene.work.impl.LuceneQueryBasedDeleteWork;
 import org.hibernate.search.backend.lucene.work.impl.LuceneQueryBasedDeleteEntryWork;
 import org.hibernate.search.backend.lucene.work.impl.LuceneQueryBasedUpdateEntryWork;
 import org.hibernate.search.util.common.reporting.EventContext;
@@ -36,8 +36,8 @@ public void contributeToIndexedDocument(Document document, String tenantId) {
 	}
 
 	@Override
-	public Query decorateLuceneQuery(Query originalLuceneQuery, String tenantId) {
-		return LuceneQueries.wrapWithDiscriminatorTenantIdQuery( originalLuceneQuery, tenantId );
+	public Query getFilterOrNull(String tenantId) {
+		return LuceneQueries.tenantIdQuery( tenantId );
 	}
 
 	@Override
@@ -52,8 +52,8 @@ public LuceneQueryBasedDeleteEntryWork createDeleteEntryLuceneWork(String tenant
 	}
 
 	@Override
-	public LuceneQueryBasedDeleteAllEntriesWork createDeleteAllEntriesLuceneWork(String tenantId) {
-		return new LuceneQueryBasedDeleteAllEntriesWork( tenantId );
+	public LuceneQueryBasedDeleteWork createDeleteAllEntriesLuceneWork(String tenantId) {
+		return new LuceneQueryBasedDeleteWork( tenantId );
 	}
 
 	@Override

backend/lucene/src/main/java/org/hibernate/search/backend/lucene/multitenancy/impl/MultiTenancyStrategy.java

@@ -38,11 +38,10 @@ public interface MultiTenancyStrategy {
 	/**
 	 * Decorate the query with the tenant constraint.
 	 *
-	 * @param originalLuceneQuery The original Lucene query.
 	 * @param tenantId The tenant id.
 	 * @return The decorated query.
 	 */
-	Query decorateLuceneQuery(Query originalLuceneQuery, String tenantId);
+	Query getFilterOrNull(String tenantId);
 
 	/**
 	 * Check that the tenant id value is consistent with the strategy.

backend/lucene/src/main/java/org/hibernate/search/backend/lucene/multitenancy/impl/NoMultiTenancyStrategy.java

@@ -33,8 +33,8 @@ public void contributeToIndexedDocument(Document document, String tenantId) {
 	}
 
 	@Override
-	public Query decorateLuceneQuery(Query originalLuceneQuery, String tenantId) {
-		return originalLuceneQuery;
+	public Query getFilterOrNull(String tenantId) {
+		return null;
 	}
 
 	@Override

backend/lucene/src/main/java/org/hibernate/search/backend/lucene/search/impl/LuceneQueries.java

@@ -34,19 +34,14 @@ public static Query nestedDocumentPathQuery(String absoluteFieldPath) {
 		return new TermQuery( new Term( LuceneFields.nestedDocumentPathFieldName(), absoluteFieldPath ) );
 	}
 
-	public static Query discriminatorMultiTenancyDeleteDocumentQuery(String tenantId, String id) {
-		return wrapWithDiscriminatorTenantIdQuery( new TermQuery( new Term( LuceneFields.idFieldName(), id ) ), tenantId );
+	public static Query singleDocumentQuery(String tenantId, String id) {
+		BooleanQuery.Builder queryBuilder = new BooleanQuery.Builder();
+		queryBuilder.add( new TermQuery( new Term( LuceneFields.idFieldName(), id ) ), Occur.MUST );
+		queryBuilder.add( tenantIdQuery( tenantId ), Occur.FILTER );
+		return queryBuilder.build();
 	}
 
-	public static Query discriminatorMultiTenancyDeleteAllDocumentsQuery(String tenantId) {
+	public static Query tenantIdQuery(String tenantId) {
 		return new TermQuery( new Term( LuceneFields.tenantIdFieldName(), tenantId ) );
 	}
-
-	public static Query wrapWithDiscriminatorTenantIdQuery(Query originalLuceneQuery, String tenantId) {
-		BooleanQuery.Builder queryBuilder = new BooleanQuery.Builder();
-		queryBuilder.add( originalLuceneQuery, Occur.MUST );
-		queryBuilder.add( new TermQuery( new Term( LuceneFields.tenantIdFieldName(), tenantId ) ), Occur.FILTER );
-
-		return queryBuilder.build();
-	}
 }

backend/lucene/src/main/java/org/hibernate/search/backend/lucene/search/impl/LuceneSearchContext.java

@@ -72,8 +72,8 @@ public Set<? extends ReadIndexManagerContext> getIndexManagerContexts() {
 		return scopeModel.getIndexManagerContexts();
 	}
 
-	public Query decorateLuceneQuery(Query originalLuceneQuery, String tenantId) {
-		return multiTenancyStrategy.decorateLuceneQuery( originalLuceneQuery, tenantId );
+	public Query getFilterOrNull(String tenantId) {
+		return multiTenancyStrategy.getFilterOrNull( tenantId );
 	}
 
 	public TimeoutManager createTimeoutManager(Query definitiveLuceneQuery,

backend/lucene/src/main/java/org/hibernate/search/backend/lucene/search/query/impl/LuceneSearchQueryBuilder.java

@@ -37,6 +37,7 @@
 import org.hibernate.search.engine.search.query.spi.SearchQueryBuilder;
 import org.hibernate.search.util.common.logging.impl.LoggerFactory;
 
+import org.apache.lucene.search.BooleanClause;
 import org.apache.lucene.search.BooleanClause.Occur;
 import org.apache.lucene.search.BooleanQuery;
 import org.apache.lucene.search.Query;
@@ -168,15 +169,18 @@ public LuceneSearchQuery<H> build() {
 		luceneQueryBuilder.add( luceneQuery, Occur.MUST );
 		luceneQueryBuilder.add( LuceneQueries.mainDocumentQuery(), Occur.FILTER );
 
+		Query filter = searchContext.getFilterOrNull( sessionContext.getTenantIdentifier() );
+		if ( filter != null ) {
+			luceneQueryBuilder.add( filter, BooleanClause.Occur.FILTER );
+		}
+
+		Query definitiveLuceneQuery = luceneQueryBuilder.build();
+
 		Sort luceneSort = null;
 		if ( sortFields != null && !sortFields.isEmpty() ) {
 			luceneSort = new Sort( sortFields.toArray( new SortField[0] ) );
 		}
 
-		Query definitiveLuceneQuery = searchContext.decorateLuceneQuery(
-				luceneQueryBuilder.build(), sessionContext.getTenantIdentifier()
-		);
-
 		if ( nestedFieldSorts != null ) {
 			for ( LuceneFieldComparatorSource nestedField : nestedFieldSorts ) {
 				nestedField.setOriginalParentQuery( definitiveLuceneQuery );

backend/lucene/src/main/java/org/hibernate/search/backend/lucene/search/query/impl/LuceneSearchQueryImpl.java

@@ -154,16 +154,16 @@ private <T> T doSubmit(LuceneReadWork<T> work) {
 
 	private Explanation doExplain(String indexName, String id) {
 		timeoutManager.start();
-		Query explainedDocumentQuery = new BooleanQuery.Builder()
+		BooleanQuery.Builder explainedDocumentQueryBuilder = new BooleanQuery.Builder()
 				.add( new TermQuery( new Term( LuceneFields.indexFieldName(), indexName ) ), BooleanClause.Occur.MUST )
-				.add( new TermQuery( new Term( LuceneFields.idFieldName(), id ) ), BooleanClause.Occur.MUST )
-				.build();
-		explainedDocumentQuery = searchContext.decorateLuceneQuery(
-				explainedDocumentQuery, sessionContext.getTenantIdentifier()
-		);
+				.add( new TermQuery( new Term( LuceneFields.idFieldName(), id ) ), BooleanClause.Occur.MUST );
+		Query filter = searchContext.getFilterOrNull( sessionContext.getTenantIdentifier() );
+		if ( filter != null ) {
+			explainedDocumentQueryBuilder.add( filter, BooleanClause.Occur.FILTER );
+		}
 
 		LuceneReadWork<Explanation> work = workFactory.explain(
-				searcher, indexName, id, explainedDocumentQuery
+				searcher, indexName, id, explainedDocumentQueryBuilder.build()
 		);
 		Explanation explanation = doSubmit( work );
 		timeoutManager.stop();

backend/lucene/src/main/java/org/hibernate/search/backend/lucene/work/impl/LuceneQueryBasedDeleteEntryWork.java

@@ -21,7 +21,7 @@ public LuceneQueryBasedDeleteEntryWork(String tenantId, String id) {
 	@Override
 	protected long doDeleteDocuments(IndexWriterDelegator indexWriterDelegator, String tenantId, String id) throws IOException {
 		return indexWriterDelegator.deleteDocuments(
-				LuceneQueries.discriminatorMultiTenancyDeleteDocumentQuery( tenantId, id )
+				LuceneQueries.singleDocumentQuery( tenantId, id )
 		);
 	}
 }

backend/lucene/src/main/java/org/hibernate/search/backend/lucene/work/impl/LuceneQueryBasedDeleteAllEntriesWork.java renamed to backend/lucene/src/main/java/org/hibernate/search/backend/lucene/work/impl/LuceneQueryBasedDeleteWork.java

@@ -12,16 +12,16 @@
 import org.hibernate.search.backend.lucene.search.impl.LuceneQueries;
 
 
-public class LuceneQueryBasedDeleteAllEntriesWork extends AbstractLuceneDeleteAllEntriesWork {
+public class LuceneQueryBasedDeleteWork extends AbstractLuceneDeleteAllEntriesWork {
 
-	public LuceneQueryBasedDeleteAllEntriesWork(String tenantId) {
+	public LuceneQueryBasedDeleteWork(String tenantId) {
 		super( tenantId );
 	}
 
 	@Override
 	protected long doDeleteDocuments(IndexWriterDelegator indexWriterDelegator, String tenantId) throws IOException {
 		return indexWriterDelegator.deleteDocuments(
-				LuceneQueries.discriminatorMultiTenancyDeleteAllDocumentsQuery( tenantId )
+				LuceneQueries.tenantIdQuery( tenantId )
 		);
 	}
 }

backend/lucene/src/main/java/org/hibernate/search/backend/lucene/work/impl/LuceneQueryBasedUpdateEntryWork.java

@@ -22,7 +22,7 @@ public LuceneQueryBasedUpdateEntryWork(String tenantId, String id, LuceneIndexEn
 	@Override
 	protected long doUpdateEntry(IndexWriterDelegator indexWriterDelegator, String tenantId, String id,
 			LuceneIndexEntry indexEntry) throws IOException {
-		indexWriterDelegator.deleteDocuments( LuceneQueries.discriminatorMultiTenancyDeleteDocumentQuery( tenantId, id ) );
+		indexWriterDelegator.deleteDocuments( LuceneQueries.singleDocumentQuery( tenantId, id ) );
 		return indexWriterDelegator.addDocuments( indexEntry );
 	}
 }