Skip to content

Include old error-message for backward compatibility#2797

Merged
dperny merged 1 commit intomoby:masterfrom
thaJeztah:change_error_message
Jan 2, 2019
Merged

Include old error-message for backward compatibility#2797
dperny merged 1 commit intomoby:masterfrom
thaJeztah:change_error_message

Conversation

@thaJeztah
Copy link
Member

@thaJeztah thaJeztah commented Dec 28, 2018

Commit 2061af7 (#2779) fixed the API returning incorrect status codes, but also changed the error message for conflicting service-names to be in line with other objects (secrets, configs); "service XX already exists".

Unfortunately, there are existing consumers of the API that perform string-matching, and changing the error-message resulted in a breaking change.

This patch prepends the ErrNameConflict error-message to the error-message, so that those consumers still find the original message, but preserves the enhancement made in 2061af7 (inclusion of the conflicting service name).

With this patch applied, the error message will look like this;

name conflicts with an existing object: service myservice already exists

- Description for the changelog

- Include old error-message for backward compatibility [docker/swarmkit#2797](https://github.com/docker/swarmkit/pull/2797)

Commit 2061af7 fixed the API
returning incorrect status-codes, but also changed the error
message for conflicting service-names to be in line with other
objects (secrets, configs); "service XX already exists".

Unfortunately, there are existing consumers of the API that
perform string-matching, and changing the error-message resulted
in a breaking change.

This patch prepends the `ErrNameConflict` error-message to the
error-message, so that those consumers still find the original
message, but preserves the enhancement made in 2061af7 (inclusion
of the conflicting service name).

With this patch applied, the error message will look like this;

    name conflicts with an existing object: service myservice already exists

Signed-off-by: Sebastiaan van Stijn <[email protected]>
@thaJeztah
Copy link
Member Author

ping @wsong @mavenugo @dperny PTAL

@codecov
Copy link

codecov bot commented Dec 28, 2018

Codecov Report

Merging #2797 into master will increase coverage by 0.06%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #2797      +/-   ##
==========================================
+ Coverage   61.93%   61.99%   +0.06%     
==========================================
  Files         137      137              
  Lines       22126    22126              
==========================================
+ Hits        13703    13717      +14     
+ Misses       6940     6927      -13     
+ Partials     1483     1482       -1

@dperny
Copy link
Collaborator

dperny commented Jan 2, 2019

Yeah, LGTM.

@dperny dperny merged commit 0091d92 into moby:master Jan 2, 2019
@thaJeztah thaJeztah deleted the change_error_message branch January 3, 2019 00:39
@anthonyleungdocker
Copy link

is this the end of this PR or do we plan to move forward to the new error-message again eventually? If we will move forward, what do we do to ensure it does not break anything when we are ready to move forward? Thank you :)

@thaJeztah
Copy link
Member Author

@anthonyleungdocker there's a test in place here to check it contains the expected error, but in the long run; this change will allow using the actual type of error instead of having to perform string-machine; moby/moby#38467

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants