Deprecate the _termvector endpoint. (#36098)

This commit is contained in:
Julie Tibshirani 2018-11-30 13:11:58 -08:00 committed by GitHub
parent df56f0734e
commit 98b290637d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 80 additions and 10 deletions

View File

@ -19,9 +19,11 @@
package org.elasticsearch.rest.action.document; package org.elasticsearch.rest.action.document;
import org.apache.logging.log4j.LogManager;
import org.elasticsearch.action.termvectors.TermVectorsRequest; import org.elasticsearch.action.termvectors.TermVectorsRequest;
import org.elasticsearch.client.node.NodeClient; import org.elasticsearch.client.node.NodeClient;
import org.elasticsearch.common.Strings; import org.elasticsearch.common.Strings;
import org.elasticsearch.common.logging.DeprecationLogger;
import org.elasticsearch.common.settings.Settings; import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.xcontent.XContentParser; import org.elasticsearch.common.xcontent.XContentParser;
import org.elasticsearch.index.VersionType; import org.elasticsearch.index.VersionType;
@ -43,18 +45,19 @@ import static org.elasticsearch.rest.RestRequest.Method.POST;
* TermVectorsRequest. * TermVectorsRequest.
*/ */
public class RestTermVectorsAction extends BaseRestHandler { public class RestTermVectorsAction extends BaseRestHandler {
private static final DeprecationLogger deprecationLogger = new DeprecationLogger(
LogManager.getLogger(RestTermVectorsAction.class));
public RestTermVectorsAction(Settings settings, RestController controller) { public RestTermVectorsAction(Settings settings, RestController controller) {
super(settings); super(settings);
controller.registerHandler(GET, "/{index}/{type}/_termvectors", this); controller.registerWithDeprecatedHandler(GET, "/{index}/{type}/_termvectors", this,
controller.registerHandler(POST, "/{index}/{type}/_termvectors", this); GET, "/{index}/{type}/_termvector", deprecationLogger);
controller.registerHandler(GET, "/{index}/{type}/{id}/_termvectors", this); controller.registerWithDeprecatedHandler(POST, "/{index}/{type}/_termvectors", this,
controller.registerHandler(POST, "/{index}/{type}/{id}/_termvectors", this); POST, "/{index}/{type}/_termvector", deprecationLogger);
controller.registerWithDeprecatedHandler(GET, "/{index}/{type}/{id}/_termvectors", this,
// we keep usage of _termvector as alias for now GET, "/{index}/{type}/{id}/_termvector", deprecationLogger);
controller.registerHandler(GET, "/{index}/{type}/_termvector", this); controller.registerWithDeprecatedHandler(POST, "/{index}/{type}/{id}/_termvectors", this,
controller.registerHandler(POST, "/{index}/{type}/_termvector", this); POST, "/{index}/{type}/{id}/_termvector", deprecationLogger);
controller.registerHandler(GET, "/{index}/{type}/{id}/_termvector", this);
controller.registerHandler(POST, "/{index}/{type}/{id}/_termvector", this);
} }
@Override @Override

View File

@ -0,0 +1,67 @@
/*
* 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.rest.action.document;
import org.elasticsearch.client.node.NodeClient;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.util.concurrent.ThreadContext;
import org.elasticsearch.indices.breaker.NoneCircuitBreakerService;
import org.elasticsearch.rest.RestChannel;
import org.elasticsearch.rest.RestController;
import org.elasticsearch.rest.RestRequest;
import org.elasticsearch.rest.RestRequest.Method;
import org.elasticsearch.test.ESTestCase;
import org.elasticsearch.test.rest.FakeRestChannel;
import org.elasticsearch.test.rest.FakeRestRequest;
import org.elasticsearch.usage.UsageService;
import java.util.Collections;
import static org.mockito.Mockito.mock;
public class RestTermVectorsActionTests extends ESTestCase {
private RestController controller;
public void setUp() throws Exception {
super.setUp();
controller = new RestController(Collections.emptySet(), null,
mock(NodeClient.class),
new NoneCircuitBreakerService(),
new UsageService());
new RestTermVectorsAction(Settings.EMPTY, controller);
}
public void testDeprecatedEndpoint() {
RestRequest request = new FakeRestRequest.Builder(xContentRegistry())
.withMethod(Method.POST)
.withPath("/some_index/some_type/some_id/_termvector")
.build();
performRequest(request);
assertWarnings("[POST /{index}/{type}/{id}/_termvector] is deprecated! Use" +
" [POST /{index}/{type}/{id}/_termvectors] instead.");
}
private void performRequest(RestRequest request) {
RestChannel channel = new FakeRestChannel(request, false, 1);
ThreadContext threadContext = new ThreadContext(Settings.EMPTY);
controller.dispatchRequest(request, channel, threadContext);
}
}