Replace IndexAlreadyExistsException with ResourceAlreadyExistsException #21494

dimitris-athanasiou · 2016-11-11T12:45:46Z

Similar to ResourceNotFoundException, a generic ResourceAlreadyExistsException will reduce the need to introduce an additional exception for each type of resource that can have that error.

At the moment, there is:

IndexAlreadyExistsException
IndexTemplateAlreadyExistsException
IndexShardAlreadyExistsException

This commit changes those to inherit ResourceAlreadyExistsException
as removing them would cause backwards compatibility problems.

dimitris-athanasiou · 2016-11-11T13:28:01Z

Note that in 6.0 we could decide to delete the Index*AlreadyExistsException classes. We'd still need to keep them in 5.x for backwards compatibility. Let me know what you think and I'll adjust the PR respectively.

nik9000 · 2016-11-11T14:17:19Z

core/src/main/java/org/elasticsearch/ResourceAlreadyExistsException.java

+    }
+
+    @Override
+    public RestStatus status() {


I wonder if it'd be more right to make this final.

With the implication that all not found exceptions are 400 errors and IndexShardAlreadyExistsException isn't really an ResourceAlreadyExistsException because it is an internal error.

That is how I had it originally. Then I had a brain split about whether IndexShardAlreadyExistsException is actually a ResourceAlreadyExistsException. I am happy to change this, but I'll wait a bit in case more opinions are voiced.

jasontedor · 2016-11-11T15:34:50Z

I think that @s1monw's thinking should be taken into consideration before this PR is integrated.

s1monw · 2016-11-11T21:13:50Z

I think this PR should remove all the exceptions and replace it by ResourceAlreadyExistsException. We can't add new exceptions in minors since it's basically a wire protocol break. What we can do is to rename an existing exception to ResourceAlreadyExistsException and deprecate all the other ones we have. In 6.0 we can remove them and for 5.x we rename IndexAlreadyExistsException to ResourceAlreadyExistsException and deprecate the usage of IndexShardAlreadyExistsException and IndexTemplateAlreadyExistsException. I really think we can replace most of them with a simple IllegalStateException or IllegalArgumentException? Ideally, we don't add a new one at all :)

dimitris-athanasiou · 2016-11-13T12:41:51Z

There are a few points here that I would like to understand better:

IndexShardAlreadyExistsException has a 500 HTTP status code. The other two have 400. As the one is server error and the other two user error, should we keep them separate? Or can we simply make ResourceAlreadyExistsException have a variable status code?
If we rename IndexAlreadyExistsException to ResourceNotFoundException in 5.x aren't we already breaking BWC? Should we consider keeping all the IndexXxxAlreadyExistsException for 5.x as they are and only remove them in 6.0?
Whatever decision we make for this one, should we also apply it for XxxNotFoundException? There is IndexNotFoundException, ShardNotFoundException, AliasesNotFoundException and ResourceNotFoundException.

…istsException` Both exception can be replaced with java built-in exception, IAE and ISE respectively. This should be backported partially to 5.x which the transport layer code should be preserved. Relates to elastic#21494

s1monw · 2016-11-14T14:25:07Z

Whatever decision we make for this one, should we also apply it for XxxNotFoundException? There is IndexNotFoundException, ShardNotFoundException, AliasesNotFoundException and ResourceNotFoundException.

lets not worry about this for now

IndexShardAlreadyExistsException has a 500 HTTP status code. The other two have 400. As the one is server error and the other two user error, should we keep them separate? Or can we simply make ResourceAlreadyExistsException have a variable status code?

I just looked into the code and replaced IndexShardAlreadyExistsException with IllegalStateException which maps to 500.. yet, I don't think this is important since it won't bubble up anyway. I also removed IndexTemplateAlreadyExistsException which is an IllegalArgumentException IMO. I can open up a PR soon for those two

If we rename IndexAlreadyExistsException to ResourceNotFoundException in 5.x aren't we already breaking BWC? Should we consider keeping all the IndexXxxAlreadyExistsException for 5.x as they are and only remove them in 6.0?

so on the wire protocol it will be just fine since we are not name-aware, we use an integer ID to deserialize. If you are thinking of REST layer we can just do something like this:

/*
 * 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.indices;

import org.elasticsearch.ElasticsearchException;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.index.Index;
import org.elasticsearch.rest.RestStatus;

import java.io.IOException;

public class ResourceAlreadyExistsException extends ElasticsearchException {

    public ResourceAlreadyExistsException(Index index, String message) {
        super(message);
        setIndex(index);
    }

    public ResourceAlreadyExistsException(StreamInput in) throws IOException{
        super(in);
    }

    @Override
    public RestStatus status() {
        return RestStatus.BAD_REQUEST;
    }

    @Override
    protected String getExceptionName() {
        if (getIndex() != null) {
            // this is only for BWC and can be removed in 6.0.0
            return "index_already_exists_exception";
        } else {
            return super.getExceptionName();
        }
    }
}

…istsException` (#21539) Both exception can be replaced with java built-in exception, IAE and ISE respectively. This should be back ported partially to 5.x which the transport layer code should be preserved. Relates to #21494

dimitris-athanasiou · 2016-11-14T16:12:35Z

Sounds good, I will update the PR.

I summarise the decision as I understand it:

6.0: Rename IndexAlreadyExistsException to ResourceAlreadyExistsException
5.x: Rename IndexAlreadyExistsException to ResourceAlreadyExistsException but maintain the exception name to index_already_exists_exception when an index is set.

…istsException` (#21539) Both exception can be replaced with java built-in exception, IAE and ISE respectively. This should be back ported partially to 5.x which the transport layer code should be preserved. Relates to #21494

s1monw · 2016-11-15T10:07:30Z

++ sounds good to me @jasontedor @nik9000 WDYT?

nik9000 · 2016-11-15T14:57:32Z

Makes sense to me.

jasontedor · 2016-11-15T21:42:49Z

++ sounds good to me @jasontedor @nik9000 WDYT?

Makes sense to me.

+1

dimitris-athanasiou · 2016-11-16T13:04:09Z

PR is now updated with latest plan.

s1monw

left one comment otherwise looks good

s1monw · 2016-11-16T13:25:10Z

core/src/test/java/org/elasticsearch/ExceptionSerializationTests.java

@@ -745,7 +745,7 @@ public void testIds() {
        ids.put(120, org.elasticsearch.repositories.RepositoryVerificationException.class);
        ids.put(121, org.elasticsearch.search.aggregations.InvalidAggregationPathException.class);
        ids.put(122, null);
-        ids.put(123, org.elasticsearch.indices.IndexAlreadyExistsException.class);


this doesn't work sorry... you can't add a new exception here it's a wire protocol break. Just reuse the 123 and add a comment that we renamed it

Good to know! Will change ASAP.

s1monw · 2016-11-16T16:35:38Z

for the backport I think we need to add a BWC layer here other than that this change LGTM...

dimitris-athanasiou · 2016-11-16T17:53:27Z

I opened a backport PR at #21601.

markgoddard · 2020-04-30T08:45:38Z

For those wondering how this turned out, yes it did break backwards compatibility for us as an ES API consumer.

https://review.opendev.org/#/c/724460

xiaojueguan · 2020-05-21T13:57:43Z

will rpm of version 6 with this change: a75320f soon be available in your yum repo

…_exception elastic/elasticsearch#21494

dimitris-athanasiou added :Exceptions >enhancement v5.1.1 v6.0.0-alpha1 labels Nov 11, 2016

nik9000 reviewed Nov 11, 2016

View reviewed changes

s1monw mentioned this pull request Nov 14, 2016

Remove IndexTemplateAlreadyExistsException and IndexShardAlreadyExistsException #21539

Merged

dimitris-athanasiou force-pushed the introduce-generic-already-exists-exception branch from 21edd06 to 0afd6ad Compare November 16, 2016 13:02

dimitris-athanasiou changed the title ~~Introduce ResourceAlreadyExistsException~~ Replace IndexAlreadyExistsException with ResourceAlreadyExistsException Nov 16, 2016

dimitris-athanasiou added the >breaking label Nov 16, 2016

s1monw suggested changes Nov 16, 2016

View reviewed changes

dimitris-athanasiou force-pushed the introduce-generic-already-exists-exception branch from 3ff0b48 to 06e2054 Compare November 16, 2016 15:44

dimitris-athanasiou mentioned this pull request Nov 16, 2016

Backport: Replace IndexAlreadyExistsException with ResourceAlreadyExistsException #21601

Merged

dimitris-athanasiou force-pushed the introduce-generic-already-exists-exception branch from 06e2054 to 1561ecd Compare November 16, 2016 17:53

Replace IndexAlreadyExistsException with ResourceAlreadyExistsException

c1f95f6

dimitris-athanasiou force-pushed the introduce-generic-already-exists-exception branch from 1561ecd to c1f95f6 Compare November 17, 2016 13:53

Fix BWC test

cd02da3

dimitris-athanasiou merged commit a75320f into elastic:master Nov 17, 2016

clintongormley removed the >enhancement label Nov 19, 2016

clintongormley added >breaking-java and removed >breaking labels Dec 8, 2016

cquon mentioned this pull request Apr 11, 2017

Conductor not compatible with Elasticsearch 5.3.0 Netflix/conductor#165

Closed

p365labs mentioned this pull request Aug 16, 2017

Replace IndexAlreadyExistsException with ResourceAlreadyExistsException ruflin/Elastica#1350

Merged

lcawl added :Core/Infra/Core Core issues without another label and removed :Exceptions labels Feb 13, 2018

dimitris-athanasiou deleted the introduce-generic-already-exists-exception branch April 30, 2020 08:49

AmitPhulera added a commit to dimagi/commcare-hq that referenced this pull request Nov 29, 2023

index_already_exists_exception was renamed to resource_already_exists…

34e3c99

…_exception elastic/elasticsearch#21494

AmitPhulera added a commit to dimagi/commcare-hq that referenced this pull request Sep 4, 2024

index_already_exists_exception was renamed to resource_already_exists…

4607d85

…_exception elastic/elasticsearch#21494

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace IndexAlreadyExistsException with ResourceAlreadyExistsException #21494

Replace IndexAlreadyExistsException with ResourceAlreadyExistsException #21494

dimitris-athanasiou commented Nov 11, 2016 •

edited

Loading

dimitris-athanasiou commented Nov 11, 2016

nik9000 Nov 11, 2016

nik9000 Nov 11, 2016

dimitris-athanasiou Nov 11, 2016

jasontedor commented Nov 11, 2016

s1monw commented Nov 11, 2016

dimitris-athanasiou commented Nov 13, 2016

s1monw commented Nov 14, 2016

dimitris-athanasiou commented Nov 14, 2016

s1monw commented Nov 15, 2016

nik9000 commented Nov 15, 2016

jasontedor commented Nov 15, 2016

dimitris-athanasiou commented Nov 16, 2016

s1monw left a comment

s1monw Nov 16, 2016

dimitris-athanasiou Nov 16, 2016

s1monw commented Nov 16, 2016

dimitris-athanasiou commented Nov 16, 2016

markgoddard commented Apr 30, 2020

xiaojueguan commented May 21, 2020

Replace IndexAlreadyExistsException with ResourceAlreadyExistsException #21494

Replace IndexAlreadyExistsException with ResourceAlreadyExistsException #21494

Conversation

dimitris-athanasiou commented Nov 11, 2016 • edited Loading

dimitris-athanasiou commented Nov 11, 2016

nik9000 Nov 11, 2016

Choose a reason for hiding this comment

nik9000 Nov 11, 2016

Choose a reason for hiding this comment

dimitris-athanasiou Nov 11, 2016

Choose a reason for hiding this comment

jasontedor commented Nov 11, 2016

s1monw commented Nov 11, 2016

dimitris-athanasiou commented Nov 13, 2016

s1monw commented Nov 14, 2016

dimitris-athanasiou commented Nov 14, 2016

s1monw commented Nov 15, 2016

nik9000 commented Nov 15, 2016

jasontedor commented Nov 15, 2016

dimitris-athanasiou commented Nov 16, 2016

s1monw left a comment

Choose a reason for hiding this comment

s1monw Nov 16, 2016

Choose a reason for hiding this comment

dimitris-athanasiou Nov 16, 2016

Choose a reason for hiding this comment

s1monw commented Nov 16, 2016

dimitris-athanasiou commented Nov 16, 2016

markgoddard commented Apr 30, 2020

xiaojueguan commented May 21, 2020

dimitris-athanasiou commented Nov 11, 2016 •

edited

Loading