Deprecate types in update requests. #36181

jtibshirani · 2018-12-03T22:24:23Z

The following updates were made:

Add deprecation warnings to RestUpdateAction, plus a test in RestUpdateActionTests.
Deprecate relevant methods on the Java HLRC requests/ responses.
Update documentation (for both the REST API and Java HLRC).

Because of an earlier PR, the REST yml tests were already updated (one version without types, and another legacy version that retains types).

elasticmachine · 2018-12-03T22:24:38Z

Pinging @elastic/es-search

mayya-sharipova

Thanks Julie! Just a couple of small comments

mayya-sharipova · 2018-12-05T00:42:11Z

server/src/main/java/org/elasticsearch/rest/action/document/RestUpdateAction.java

 import org.elasticsearch.search.fetch.subphase.FetchSourceContext;

 import java.io.IOException;

 import static org.elasticsearch.rest.RestRequest.Method.POST;

 public class RestUpdateAction extends BaseRestHandler {
+    private static final DeprecationLogger deprecationLogger = new DeprecationLogger(LogManager.getLogger(RestSearchAction.class));


Should it be here RestUpdateAction instead of RestSearchAction?

Yes, thanks! I have been doing a lot of copy-paste.

mayya-sharipova · 2018-12-05T00:45:08Z

server/src/main/java/org/elasticsearch/rest/action/document/RestUpdateAction.java

-            request.param("id"));
+        UpdateRequest updateRequest;
+        if (request.hasParam("type")) {
+            deprecationLogger.deprecated(TYPES_DEPRECATION_MESSAGE);


Do we want to use deprecatedAndMaybeLog instead of deprecated not to log same deprecation warnings many times?

Thanks a lot, I hadn't seen this method. I think we should use it more generally for types deprecation -- I will go over and update some of our other logging statements as well.

mayya-sharipova · 2018-12-05T00:48:12Z

docs/java-rest/high-level/document/update.asciidoc

@@ -17,7 +17,6 @@ An +{request}+ requires the following arguments:
 include-tagged::{doc-tests-file}[{api}-request]
 --------------------------------------------------
 <1> Index
-<2> Type
 <3> Document id



<2> Document id instead of <3> Document id>?

markharwood · 2018-12-05T09:30:04Z

client/rest-high-level/src/test/java/org/elasticsearch/client/CrudIT.java

@@ -507,14 +507,14 @@ public void testUpdate() throws IOException {
            IndexResponse indexResponse = highLevelClient().index(indexRequest, RequestOptions.DEFAULT);
            assertEquals(RestStatus.CREATED, indexResponse.status());

-            UpdateRequest updateRequest = new UpdateRequest("index", "_doc", "id");
+            UpdateRequest updateRequest = new UpdateRequest("index", "id");


Is it worth keeping a deprecated example usage in this test?
I think there's some work to be done to make ESRestTestCase support assertWarnings checks first (currently have to use getStrictDeprecationMode=false to avoid test failures when making deprecated calls)

Will do, this shouldn't be hard now that we are able to check warnings in REST integration tests.

markharwood · 2018-12-05T09:36:27Z

...est-high-level/src/test/java/org/elasticsearch/client/documentation/CRUDDocumentationIT.java

@@ -358,7 +357,7 @@ public void testUpdate() throws Exception {
        }
        {
            //tag::update-request-with-doc-as-string
-            UpdateRequest request = new UpdateRequest("posts", "_doc", "1");
+            UpdateRequest request = new UpdateRequest("posts", "1");
            String jsonString = "{" +
                    "\"updated\":\"2017-01-01\"," +
                    "\"reason\":\"daily update\"" +


Also remove String type = updateResponse.getType(); example from line 377?

markharwood · 2018-12-05T09:41:22Z

...chives/integ-test-zip/src/test/java/org/elasticsearch/test/rest/CreatedLocationHeaderIT.java

@@ -46,7 +46,7 @@ public void testIndexWithoutId() throws IOException {
    }


^^ methods testCreate, testIndexWithId and testIndexWithoutId above still going with "test" doc type. Is this intentional?

It wasn't intentional. I switched them to _doc when deprecating get requests, so this should be fixed.

markharwood · 2018-12-05T09:47:22Z

qa/full-cluster-restart/src/test/java/org/elasticsearch/upgrades/FullClusterRestartIT.java

+        // use the deprecated path and disable strict deprecation checks.
+        return false;
+    }
+


I found I had to do this too and didn't like it. EsRestTestCase has a "fail or nothing" approach to testing responses.

Either the whole test fails (strictDeprecationMode is too strict) or in the alternative lax mode we blindly accept any warnings as ok - we can't check we got the expected warnings because ESRestTestCase does not work with the assertWarnings feature declared in base class ESTestCase. I'm going to look into adding that support to ESRestTestCase. Opened #36251

👍 thanks for this work, I'll avoid using getStrictDeprecationMode.

markharwood · 2018-12-05T09:56:40Z

server/src/test/java/org/elasticsearch/rest/action/document/RestUpdateActionTests.java

+            .build();
+        performRequest(deprecatedRequest);
+        assertWarnings(RestUpdateAction.TYPES_DEPRECATION_MESSAGE);
+    }


Test the undeprecated form too?

jtibshirani · 2018-12-12T00:03:29Z

Thanks @mayya-sharipova and @markharwood for the detailed reviews, and sorry I took so long to respond. I was juggling quite a few of these at once and decided it was best to focus on one at a time. I'm working on bringing the PR up to date and will try to address your comments.

jtibshirani · 2018-12-12T22:43:55Z

This should now be ready for another look.

mayya-sharipova · 2018-12-13T16:06:50Z

@jtibshirani thanks Julie, I had another look. Everything looks good to me. testUpdateWithTypes() and similar are very good, adopted them for my PR.

jtibshirani added :Search Foundations/Mapping Index mappings, including merging and defining field types >deprecation v7.0.0 labels Dec 3, 2018

jtibshirani requested review from jpountz and markharwood December 3, 2018 22:24

jtibshirani mentioned this pull request Dec 3, 2018

Implementation tracking for 7.0 types deprecation. #35190

Closed

48 tasks

jtibshirani force-pushed the deprecate-types-in-update branch 3 times, most recently from 71ce02f to faed06f Compare December 4, 2018 23:02

mayya-sharipova approved these changes Dec 5, 2018

View reviewed changes

markharwood reviewed Dec 5, 2018

View reviewed changes

jtibshirani added 4 commits December 12, 2018 14:36

Deprecate types in update requests.

f735cf1

Address review comments.

c333648

Add HLRC integration tests for the typed APIs.

36dca3c

Test conversion for both typed and typeless HLRC requests.

23aeeff

jtibshirani force-pushed the deprecate-types-in-update branch from faed06f to 23aeeff Compare December 12, 2018 22:40

Fix failing integration tests.

574b085

jtibshirani merged commit ccd1beb into elastic:master Dec 14, 2018

jtibshirani deleted the deprecate-types-in-update branch December 14, 2018 18:47

colings86 added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate types in update requests. #36181

Deprecate types in update requests. #36181

jtibshirani commented Dec 3, 2018 •

edited

Loading

elasticmachine commented Dec 3, 2018

mayya-sharipova left a comment

mayya-sharipova Dec 5, 2018

jtibshirani Dec 5, 2018

mayya-sharipova Dec 5, 2018

jtibshirani Dec 5, 2018

mayya-sharipova Dec 5, 2018

jtibshirani Dec 5, 2018

markharwood Dec 5, 2018 •

edited

Loading

jtibshirani Dec 12, 2018

markharwood Dec 5, 2018

jtibshirani Dec 12, 2018

markharwood Dec 5, 2018 •

edited

Loading

jtibshirani Dec 12, 2018

markharwood Dec 5, 2018 •

edited

Loading

jtibshirani Dec 12, 2018

markharwood Dec 5, 2018

jtibshirani Dec 12, 2018

jtibshirani commented Dec 12, 2018

jtibshirani commented Dec 12, 2018

mayya-sharipova commented Dec 13, 2018

		@@ -46,7 +46,7 @@ public void testIndexWithoutId() throws IOException {
		}

Deprecate types in update requests. #36181

Deprecate types in update requests. #36181

Conversation

jtibshirani commented Dec 3, 2018 • edited Loading

elasticmachine commented Dec 3, 2018

mayya-sharipova left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markharwood Dec 5, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markharwood Dec 5, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markharwood Dec 5, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtibshirani commented Dec 12, 2018

jtibshirani commented Dec 12, 2018

mayya-sharipova commented Dec 13, 2018

jtibshirani commented Dec 3, 2018 •

edited

Loading

markharwood Dec 5, 2018 •

edited

Loading

markharwood Dec 5, 2018 •

edited

Loading

markharwood Dec 5, 2018 •

edited

Loading