forked from apache/solr
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[SOLR-10059] a new approach to tackle appended fq parameters
Problems with duplicate parameter appending was the inability to expand macros in shard requests. This fix will sanitize all macros from `fq` parameters in shard requests (as they should have been expanded on the coordinator)
- Loading branch information
Showing
5 changed files
with
233 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
solr/core/src/java/org/apache/solr/request/macro/MacroSanitizer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /* | ||
| * 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.solr.request.macro; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| public class MacroSanitizer { | ||
|
|
||
| /** | ||
| * Sanitizes macros for the given parameter in the given params set if present | ||
| * | ||
| * @param param the parameter whose values we should sanitzize | ||
| * @param params the parameter set | ||
| * @return the sanitized parameter set | ||
| */ | ||
| public static Map<String, String[]> sanitize(String param, Map<String, String[]> params) { | ||
| // quick peek into the values to check for macros | ||
| final boolean needsSanitizing = | ||
| params.containsKey(param) | ||
| && Arrays.stream(params.get(param)) | ||
| .anyMatch(s -> s.contains(MacroExpander.MACRO_START)); | ||
|
|
||
| if (needsSanitizing) { | ||
| final String[] fqs = params.get(param); | ||
| final List<String> sanitizedFqs = new ArrayList<>(fqs.length); | ||
|
|
||
| for (int i = 0; i < fqs.length; i++) { | ||
| if (!fqs[i].contains(MacroExpander.MACRO_START)) { | ||
| sanitizedFqs.add(fqs[i]); | ||
| } | ||
| } | ||
|
|
||
| params.put(param, sanitizedFqs.toArray(new String[] {})); | ||
| } | ||
|
|
||
| return params; | ||
| } | ||
| } |
107 changes: 107 additions & 0 deletions
107
...e/src/test/org/apache/solr/handler/component/SearchHandlerAppendsWithMacrosCloudTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /* | ||
| * 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.solr.handler.component; | ||
|
|
||
| import org.apache.solr.client.solrj.SolrQuery; | ||
| import org.apache.solr.client.solrj.request.CollectionAdminRequest; | ||
| import org.apache.solr.client.solrj.request.QueryRequest; | ||
| import org.apache.solr.client.solrj.request.UpdateRequest; | ||
| import org.apache.solr.client.solrj.response.QueryResponse; | ||
| import org.apache.solr.cloud.AbstractDistribZkTestBase; | ||
| import org.apache.solr.cloud.ConfigRequest; | ||
| import org.apache.solr.cloud.SolrCloudTestCase; | ||
| import org.apache.solr.common.cloud.ZkStateReader; | ||
| import org.apache.solr.common.params.CommonParams; | ||
| import org.junit.BeforeClass; | ||
| import org.junit.Test; | ||
|
|
||
| public class SearchHandlerAppendsWithMacrosCloudTest extends SolrCloudTestCase { | ||
|
|
||
| private static String COLLECTION; | ||
| private static int NUM_SHARDS; | ||
| private static int NUM_REPLICAS; | ||
|
|
||
| @BeforeClass | ||
| public static void setupCluster() throws Exception { | ||
|
|
||
| // decide collection name ... | ||
| COLLECTION = "collection" + (1 + random().nextInt(100)); | ||
| // ... and shard/replica/node numbers | ||
| NUM_SHARDS = (2 + random().nextInt(2)); // 0..2 | ||
| NUM_REPLICAS = (1 + random().nextInt(2)); // 0..2 | ||
|
|
||
| // create and configure cluster | ||
| configureCluster(NUM_SHARDS * NUM_REPLICAS /* nodeCount */) | ||
| .addConfig("conf", configset("cloud-dynamic")) | ||
| .configure(); | ||
|
|
||
| // create an empty collection | ||
| CollectionAdminRequest.createCollection(COLLECTION, "conf", NUM_SHARDS, NUM_REPLICAS) | ||
| .processAndWait(cluster.getSolrClient(), DEFAULT_TIMEOUT); | ||
| AbstractDistribZkTestBase.waitForRecoveriesToFinish( | ||
| COLLECTION, ZkStateReader.from(cluster.getSolrClient()), false, true, DEFAULT_TIMEOUT); | ||
| } | ||
|
|
||
| @Test | ||
| public void test() throws Exception { | ||
|
|
||
| // field names | ||
| final String id = "id"; | ||
| final String bee_si = "bee_sI"; | ||
| final String forage_t = "forage_t"; | ||
| final String handlerName = "/custom-select"; | ||
|
|
||
| // add custom handlers (the exact custom handler names should not matter) | ||
| cluster | ||
| .getSolrClient() | ||
| .request( | ||
| new ConfigRequest( | ||
| "{\n" | ||
| + " 'add-requesthandler': {\n" | ||
| + " 'name' : '" | ||
| + handlerName | ||
| + "',\n" | ||
| + " 'class' : 'org.apache.solr.handler.component.SearchHandler',\n" | ||
| + " 'appends' : { 'fq' : '{!collapse tag=collapsing field=" | ||
| + bee_si | ||
| + " sort=\"${collapseSort}\" }' }, \n" | ||
| + " }\n" | ||
| + "}"), | ||
| COLLECTION); | ||
|
|
||
| // add some documents | ||
| { | ||
| new UpdateRequest() | ||
| .add(sdoc(id, 1, bee_si, "bumble bee", forage_t, "nectar")) | ||
| .add(sdoc(id, 2, bee_si, "honey bee", forage_t, "propolis")) | ||
| .add(sdoc(id, 3, bee_si, "solitary bee", forage_t, "pollen")) | ||
| .commit(cluster.getSolrClient(), COLLECTION); | ||
| } | ||
|
|
||
| // compose the query | ||
| final SolrQuery solrQuery = new SolrQuery(bee_si + ":bee"); | ||
| solrQuery.setParam(CommonParams.QT, handlerName); | ||
| solrQuery.setParam(CommonParams.SORT, "id desc"); | ||
| solrQuery.setParam("collapseSort", "id asc"); | ||
|
|
||
| // make the query | ||
| // the query wouold break with macros in shard response | ||
| final QueryResponse queryResponse = | ||
| new QueryRequest(solrQuery).process(cluster.getSolrClient(), COLLECTION); | ||
| assertNotNull(queryResponse); | ||
| } | ||
| } |
62 changes: 62 additions & 0 deletions
62
solr/core/src/test/org/apache/solr/request/macro/MacroSanitizerTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| /* | ||
| * 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.solr.request.macro; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertSame; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import org.apache.solr.common.params.CommonParams; | ||
| import org.hamcrest.MatcherAssert; | ||
| import org.hamcrest.Matchers; | ||
| import org.junit.Test; | ||
|
|
||
| public class MacroSanitizerTest { | ||
|
|
||
| @Test | ||
| public void shouldReturnSameInstanceWhenNotSanitizing() { | ||
| // given | ||
| Map<String, String[]> params = new HashMap<>(); | ||
|
|
||
| // when | ||
| Map<String, String[]> sanitized = MacroSanitizer.sanitize(CommonParams.FQ, params); | ||
|
|
||
| // then | ||
| assertSame(params, sanitized); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldNotSanitizeNonMacros() { | ||
| // given | ||
| Map<String, String[]> params = new HashMap<>(); | ||
| params.put( | ||
| CommonParams.FQ, | ||
| new String[] { | ||
| "bee:up", "look:left", "{!collapse tag=collapsing field=bee sort=${collapseSort}}" | ||
| }); | ||
| params.put("q", new String[] {"bee:honey"}); | ||
|
|
||
| // when | ||
| Map<String, String[]> sanitized = MacroSanitizer.sanitize(CommonParams.FQ, params); | ||
|
|
||
| // then | ||
| assertEquals(2, sanitized.size()); | ||
| assertEquals(2, sanitized.get("fq").length); | ||
| MatcherAssert.assertThat(sanitized.get("fq"), Matchers.arrayContaining("bee:up", "look:left")); | ||
| } | ||
| } |