Skip to content

warn about unused UnifiedSolrHighlighter configuration #816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
cpoerschke wants to merge 1 commit into from
Closed

warn about unused UnifiedSolrHighlighter configuration #816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion solr/core/src/java/org/apache/solr/highlight/UnifiedSolrHighlighter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package org.apache.solr.highlight;

import java.io.IOException;
import java.lang.invoke.MethodHandles;
import java.text.BreakIterator;
import java.util.Collection;
import java.util.Collections;
Expand Down Expand Up @@ -53,6 +54,8 @@
import org.apache.solr.search.SolrReturnFields;
import org.apache.solr.util.RTimerTree;
import org.apache.solr.util.plugin.PluginInfoInitialized;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
* Highlighter impl that uses {@link UnifiedHighlighter}
Expand Down Expand Up @@ -132,10 +135,16 @@
*/
public class UnifiedSolrHighlighter extends SolrHighlighter implements PluginInfoInitialized {

private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

protected static final String SNIPPET_SEPARATOR = "\u0000";

@Override
public void init(PluginInfo info) {}
public void init(PluginInfo info) {
for (PluginInfo child : info.children) {
log.warn("unused configuration: {}", child);
}
}

@Override
public NamedList<Object> doHighlighting(
Expand Down
2 changes: 1 addition & 1 deletion solr/core/src/test-files/solr/collection1/conf/solrconfig-highlight.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<requestHandler name="/select" class="solr.SearchHandler"/>

<searchComponent class="solr.HighlightComponent" name="highlight">
<highlighting class="org.apache.solr.highlight.DummyHighlighter">
<highlighting class="${solr.highlighting:org.apache.solr.highlight.DummyHighlighter}">
<!-- Configure the standard fragmenter -->
<fragmenter name="gap" class="org.apache.solr.highlight.GapFragmenter" default="true">
<lst name="defaults">
Expand Down
15 changes: 15 additions & 0 deletions solr/core/src/test/org/apache/solr/highlight/HighlighterConfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,30 @@
import org.apache.solr.SolrTestCaseJ4;
import org.apache.solr.common.params.MapSolrParams;
import org.apache.solr.handler.component.HighlightComponent;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HighlighterConfigTest extends SolrTestCaseJ4 {

private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
private static boolean useUnified;

@BeforeClass
public static void beforeClass() throws Exception {
useUnified = random().nextBoolean();
if (useUnified) {
System.setProperty("solr.highlighting", UnifiedSolrHighlighter.class.getName());
}
initCore("solrconfig-highlight.xml", "schema.xml");
}

@AfterClass
public static void afterClass() throws Exception {
System.clearProperty("solr.highlighting");
}

@Override
public void setUp() throws Exception {
// if you override setUp or tearDown, you better call
Expand All @@ -53,6 +64,10 @@ public void testConfig() {
SolrHighlighter highlighter = getHighlighter();
log.info("highlighter");

if (useUnified) {
assertTrue(highlighter instanceof UnifiedSolrHighlighter);
return;
}
assertTrue(highlighter instanceof DummyHighlighter);

// check to see that doHighlight is called from the DummyHighlighter
Expand Down