Compatible logic for Removes typed endpoint from search and related APIs #54572
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,53 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch 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.elasticsearch.compat; | ||
|
|
||
| import org.elasticsearch.common.Strings; | ||
| import org.elasticsearch.rest.RestRequest; | ||
|
|
||
| import java.util.Set; | ||
| import java.util.function.Function; | ||
|
|
||
| public class TypeConsumer implements Function<String, Boolean> { | ||
|
There was a problem hiding this comment. I think this class has a couple problems...
Can we separate this into two classes , a utility class and pure function class. If you need to hold to the state returned by the function, whoever calls that function can take that responsibility. Also, in tangent with my other comment on renaming the variable, I think the function class be be generalized as well There was a problem hiding this comment. Agree - the name is not right. The consumer was an initial idea but it ended up a function and I didn't change it accordingly. The KeyAllowed also feels right to me. I am not sure I understand how to refactor this. My idea was that the The I also agree that side effect is probably unexpected. The There was a problem hiding this comment. @jakelandis I think this is the main issue on that PR.
If we were to have a utility class it would have live within some common to all modules utility module. That would not be ideal I guess. Anyways I think I might be missing something in your idea of splitting this class into two. Can you please give more details? |
||
|
|
||
| private final RestRequest request; | ||
| private final Set<String> fieldNames; | ||
| private boolean foundTypeInBody = false; | ||
|
|
||
| public TypeConsumer(RestRequest request, String... fieldNames) { | ||
| this.request = request; | ||
| this.fieldNames = Set.of(fieldNames); | ||
| } | ||
|
|
||
| @Override | ||
| public Boolean apply(String fieldName) { | ||
| if (fieldNames.contains(fieldName)) { | ||
| foundTypeInBody = true; | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| public boolean hasTypes() { | ||
| // TODO can params be types too? or _types? | ||
| String[] types = Strings.splitStringByCommaToArray(request.param("type")); | ||
| return types.length > 0 || foundTypeInBody; | ||
| } | ||
| } | ||
This file contains hidden or 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,59 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch 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.elasticsearch.index.reindex; | ||
|
|
||
| import org.elasticsearch.Version; | ||
| import org.elasticsearch.client.node.NodeClient; | ||
| import org.elasticsearch.common.logging.DeprecationLogger; | ||
| import org.elasticsearch.rest.RestRequest; | ||
| import org.elasticsearch.rest.action.search.RestSearchActionV7; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
|
|
||
| import static org.elasticsearch.rest.RestRequest.Method.POST; | ||
|
|
||
| public class RestDeleteByQueryActionV7 extends RestDeleteByQueryAction { | ||
| private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestDeleteByQueryActionV7.class); | ||
|
|
||
| @Override | ||
| public List<Route> routes() { | ||
| return List.of(new Route(POST, "/{index}/{type}/_delete_by_query")); | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return super.getName() + "_v7"; | ||
| } | ||
|
|
||
| @Override | ||
| public Version compatibleWithVersion() { | ||
| return Version.V_7_0_0; | ||
| } | ||
|
|
||
| @Override | ||
| public RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException { | ||
| if (request.hasParam("type")) { | ||
| deprecationLogger.deprecate("search_with_types", RestSearchActionV7.TYPES_DEPRECATION_MESSAGE); | ||
| request.param("type"); | ||
| } | ||
| return super.prepareRequest(request, client); | ||
| } | ||
| } |
This file contains hidden or 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,60 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch 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.elasticsearch.index.reindex; | ||
|
|
||
| import org.elasticsearch.Version; | ||
| import org.elasticsearch.client.node.NodeClient; | ||
| import org.elasticsearch.common.logging.DeprecationLogger; | ||
| import org.elasticsearch.rest.RestRequest; | ||
| import org.elasticsearch.rest.action.search.RestSearchActionV7; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
|
|
||
| import static org.elasticsearch.rest.RestRequest.Method.POST; | ||
|
|
||
| public class RestUpdateByQueryActionV7 extends RestUpdateByQueryAction { | ||
|
|
||
| private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestUpdateByQueryActionV7.class); | ||
|
|
||
| @Override | ||
| public List<Route> routes() { | ||
| return List.of(new Route(POST, "/{index}/{type}/_update_by_query")); | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return super.getName() + "_v7"; | ||
| } | ||
|
|
||
| @Override | ||
| public Version compatibleWithVersion() { | ||
| return Version.V_7_0_0; | ||
| } | ||
|
|
||
| @Override | ||
| public RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException { | ||
| if (request.hasParam("type")) { | ||
| deprecationLogger.deprecate("search_with_types", RestSearchActionV7.TYPES_DEPRECATION_MESSAGE); | ||
| request.param("type"); | ||
| } | ||
| return super.prepareRequest(request, client); | ||
| } | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these two dependencies are to allow making compatible versions of Actions from these modules