LUCENE-10381: Require users to provide FacetsConfig for SSDV faceting (#614)

Author: gsmiller

lucene/CHANGES.txt

@@ -32,6 +32,8 @@ API Changes
   a boolean indicating whether or not skipping should be enabled on the comparator. 
   (Alan Woodward)
 
+* LUCENE-10381: Require users to provide FacetsConfig for SSDV faceting. (Greg Miller)
+
 New Features
 ---------------------
 

lucene/demo/src/java/org/apache/lucene/demo/facet/SimpleSortedSetFacetsExample.java

@@ -88,7 +88,8 @@ private void index() throws IOException {
   private List<FacetResult> search() throws IOException {
     DirectoryReader indexReader = DirectoryReader.open(indexDir);
     IndexSearcher searcher = new IndexSearcher(indexReader);
-    SortedSetDocValuesReaderState state = new DefaultSortedSetDocValuesReaderState(indexReader);
+    SortedSetDocValuesReaderState state =
+        new DefaultSortedSetDocValuesReaderState(indexReader, config);
 
     // Aggregatses the facet counts
     FacetsCollector fc = new FacetsCollector();
@@ -113,7 +114,8 @@ private List<FacetResult> search() throws IOException {
   private FacetResult drillDown() throws IOException {
     DirectoryReader indexReader = DirectoryReader.open(indexDir);
     IndexSearcher searcher = new IndexSearcher(indexReader);
-    SortedSetDocValuesReaderState state = new DefaultSortedSetDocValuesReaderState(indexReader);
+    SortedSetDocValuesReaderState state =
+        new DefaultSortedSetDocValuesReaderState(indexReader, config);
 
     // Now user drills down on Publish Year/2010:
     DrillDownQuery q = new DrillDownQuery(config);

lucene/facet/src/java/org/apache/lucene/facet/sortedset/DefaultSortedSetDocValuesReaderState.java

@@ -74,12 +74,26 @@ public DefaultSortedSetDocValuesReaderState(IndexReader reader, FacetsConfig con
   /**
    * Creates this without a config, pulling doc values from the default {@link
    * FacetsConfig#DEFAULT_INDEX_FIELD_NAME}.
+   *
+   * @deprecated Users should explicitly provide facet configuration during instantiation. See
+   *     {@link #DefaultSortedSetDocValuesReaderState(IndexReader, FacetsConfig)}. To maintain all
+   *     existing behavior, a "default" facet configuration can be provided with {@link
+   *     FacetsConfig#FacetsConfig()}.
    */
+  @Deprecated
   public DefaultSortedSetDocValuesReaderState(IndexReader reader) throws IOException {
     this(reader, FacetsConfig.DEFAULT_INDEX_FIELD_NAME, null);
   }
 
-  /** Creates this without a config, pulling doc values from the specified field. */
+  /**
+   * Creates this without a config, pulling doc values from the specified field.
+   *
+   * @deprecated Users should explicitly provide facet configuration during instantiation. See
+   *     {@link #DefaultSortedSetDocValuesReaderState(IndexReader, String, FacetsConfig)}. To
+   *     maintain all existing behavior, a "default" facet configuration can be provided with {@link
+   *     FacetsConfig#FacetsConfig()}.
+   */
+  @Deprecated
   public DefaultSortedSetDocValuesReaderState(IndexReader reader, String field) throws IOException {
     this(reader, field, null);
   }

lucene/facet/src/test/org/apache/lucene/facet/TestDrillSideways.java

@@ -1068,7 +1068,7 @@ public void testRandom() throws Exception {
     IndexSearcher s = getNewSearcher(r);
 
     if (doUseDV) {
-      sortedSetDVState = new DefaultSortedSetDocValuesReaderState(s.getIndexReader());
+      sortedSetDVState = new DefaultSortedSetDocValuesReaderState(s.getIndexReader(), config);
     } else {
       sortedSetDVState = null;
     }

lucene/facet/src/test/org/apache/lucene/facet/sortedset/TestSortedSetDocValuesFacets.java

@@ -85,7 +85,7 @@ public void testBasic() throws Exception {
 
         // Per-top-reader state:
         SortedSetDocValuesReaderState state =
-            new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+            new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
 
         ExecutorService exec = randomExecutorServiceOrNull();
         try {
@@ -214,7 +214,7 @@ public void testCountAll() throws Exception {
 
         // Per-top-reader state:
         SortedSetDocValuesReaderState state =
-            new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+            new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
 
         Facets facets = new SortedSetDocValuesFacetCounts(state);
 
@@ -330,7 +330,7 @@ public void testBasicSingleValued() throws Exception {
 
         // Per-top-reader state:
         SortedSetDocValuesReaderState state =
-            new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+            new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
 
         ExecutorService exec = randomExecutorServiceOrNull();
         try {
@@ -641,7 +641,7 @@ public void testStaleState() throws Exception {
       writer.addDocument(config.build(doc));
 
       try (IndexReader r = writer.getReader()) {
-        SortedSetDocValuesReaderState state = new DefaultSortedSetDocValuesReaderState(r);
+        SortedSetDocValuesReaderState state = new DefaultSortedSetDocValuesReaderState(r, config);
 
         doc = new Document();
         doc.add(new SortedSetDocValuesFacetField("a", "bar"));
@@ -704,7 +704,7 @@ public void testSparseFacets() throws Exception {
 
         // Per-top-reader state:
         SortedSetDocValuesReaderState state =
-            new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+            new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
 
         ExecutorService exec = randomExecutorServiceOrNull();
         try {
@@ -832,7 +832,7 @@ public void testSomeSegmentsMissing() throws Exception {
 
         // Per-top-reader state:
         SortedSetDocValuesReaderState state =
-            new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+            new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
 
         ExecutorService exec = randomExecutorServiceOrNull();
         try {
@@ -936,7 +936,7 @@ public void testRandom() throws Exception {
 
           // Per-top-reader state:
           SortedSetDocValuesReaderState state =
-              new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+              new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
           ExecutorService exec = randomExecutorServiceOrNull();
           try {
             int iters = atLeast(100);
@@ -1297,7 +1297,7 @@ public void testNonExistentDimension() throws Exception {
         IndexSearcher searcher = newSearcher(r);
 
         SortedSetDocValuesReaderState state =
-            new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader());
+            new DefaultSortedSetDocValuesReaderState(searcher.getIndexReader(), config);
 
         ExecutorService exec = randomExecutorServiceOrNull();
         try {