jpountz commented on code in PR #12816: URL: https://github.com/apache/lucene/pull/12816#discussion_r1397929325
########## lucene/misc/src/java/org/apache/lucene/misc/search/HumanReadableQuery.java: ########## @@ -0,0 +1,88 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.lucene.misc.search; + +import org.apache.lucene.search.IndexSearcher; +import org.apache.lucene.search.Query; +import org.apache.lucene.search.QueryVisitor; +import org.apache.lucene.search.ScoreMode; +import org.apache.lucene.search.Weight; + +/** + * A simple query wrapper for debug purposes. Behaves like the given query, but when printing to a + * string, it will prepend the description parameter to the query output. + */ +public final class HumanReadableQuery extends Query { + + private final Query in; + private final String description; + + /** + * Create a new HumanReadableQuery + * + * @param in the query to wrap + * @param description a human-readable description, used in toString() + */ + public HumanReadableQuery(Query in, String description) { + this.in = in; + this.description = description; + } + + /** + * @return the wrapped Query + */ + public Query getWrappedQuery() { + return in; + } + + /** + * @return the query description + */ + public String getDescription() { + return description; + } + + @Override + public Query rewrite(IndexSearcher indexSearcher) { + return in; + } + + @Override + public String toString(String field) { + return this.getDescription() + ":" + in.toString(field); + } + + @Override + public void visit(QueryVisitor visitor) { + in.visit(visitor); + } + + @Override + public boolean equals(Object other) { + return sameClassAs(other) && in.equals(((HumanReadableQuery) other).in); + } + + @Override + public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) { + throw new UnsupportedOperationException("HumanReadableQuery does not support #createWeight()"); + } + + @Override + public int hashCode() { + return in.hashCode(); Review Comment: Nit: Ideally a query and the same query wrapped in a `HumanReadableQuery` would have different hashcodes to avoid collisions. ```suggestion return 31 * classHash() + in.hashCode(); ``` ########## lucene/misc/src/test/org/apache/lucene/misc/search/TestHumanReadableQuery.java: ########## @@ -0,0 +1,132 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.lucene.misc.search; + +import org.apache.lucene.document.Document; +import org.apache.lucene.document.Field; +import org.apache.lucene.index.IndexReader; +import org.apache.lucene.index.Term; +import org.apache.lucene.search.BooleanClause; +import org.apache.lucene.search.BooleanQuery; +import org.apache.lucene.search.IndexSearcher; +import org.apache.lucene.search.KnnFloatVectorQuery; +import org.apache.lucene.search.PhraseQuery; +import org.apache.lucene.search.TermQuery; +import org.apache.lucene.store.Directory; +import org.apache.lucene.tests.analysis.MockAnalyzer; +import org.apache.lucene.tests.analysis.MockTokenizer; +import org.apache.lucene.tests.index.RandomIndexWriter; +import org.apache.lucene.tests.search.CheckHits; +import org.apache.lucene.tests.util.English; +import org.apache.lucene.tests.util.LuceneTestCase; +import org.apache.lucene.tests.util.TestUtil; +import org.junit.AfterClass; +import org.junit.BeforeClass; + +public class TestHumanReadableQuery extends LuceneTestCase { + private static IndexSearcher searcher; + private static IndexReader reader; + private static Directory directory; + private static final String field = "field"; + + @BeforeClass + public static void beforeClass() throws Exception { + directory = newDirectory(); + RandomIndexWriter writer = + new RandomIndexWriter( + random(), + directory, + newIndexWriterConfig(new MockAnalyzer(random(), MockTokenizer.SIMPLE, true)) + .setMaxBufferedDocs(TestUtil.nextInt(random(), 100, 1000)) + .setMergePolicy(newLogMergePolicy())); + // writer.infoStream = System.out; + for (int i = 0; i < 1000; i++) { + Document doc = new Document(); + doc.add(newTextField(field, English.intToEnglish(i), Field.Store.YES)); + writer.addDocument(doc); + } + reader = writer.getReader(); + searcher = newSearcher(reader); + writer.close(); + } + + @AfterClass + public static void afterClass() throws Exception { + reader.close(); + directory.close(); + searcher = null; + reader = null; + directory = null; + } + + public void testHitsEqualPhraseQuery() throws Exception { + PhraseQuery pQuery = new PhraseQuery(field, "seventy", "seven"); + CheckHits.checkHits( + random(), + pQuery, + field, + searcher, + new int[] {77, 177, 277, 377, 477, 577, 677, 777, 877, 977}); + + String description = "TestPhraseQuery"; + HumanReadableQuery hQuery = new HumanReadableQuery(pQuery, description); + CheckHits.checkHits( + random(), + hQuery, + field, + searcher, + new int[] {77, 177, 277, 377, 477, 577, 677, 777, 877, 977}); + assertEquals(hQuery.toString(), description + ":" + pQuery); Review Comment: Nit: `assertEquals` expects the expected value first and the actual second to generate proper failure messages, can you sway the order of the arguments here and in other places? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
