Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

S3: Make eTag naming consistent #2741

Merged
merged 1 commit into from
Oct 4, 2021

Conversation

mdedetrich
Copy link
Contributor

@mdedetrich mdedetrich commented Oct 2, 2021

The intention of this PR is to make eTag/ETag consistent. This was done with internal private API but also the public API where MultipartUploadResult used etag/getEtag/getEtag where as every other public model used eTag/getETag/withETag. Since this is a public API I added deprecated methods so that people are warned when using the old inconsistent etag naming and to maintain binary compatibility.

There is one case where (I think) source compatibility is broken but NOT binary compatibility (see comments). Unfortunately I couldn't get mima running in Alpakka to verify this, I am getting the following error when I run s3 / mimaReportBinaryIssues

[error] (s3 / mimaReportBinaryIssues) java.lang.NoClassDefFoundError: Could not initialize class com.typesafe.tools.mima.core.Config$

@@ -89,13 +99,13 @@ object MultipartUploadResult {
location: Uri,
bucket: String,
key: String,
etag: String,
eTag: String,
Copy link
Contributor Author

@mdedetrich mdedetrich Oct 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK this can break source compatibility (i.e. if someone calls apply with named parameters specifically within Scala) but it doesn't break binary compatibility.

@@ -104,13 +114,13 @@ object MultipartUploadResult {
location: akka.http.javadsl.model.Uri,
bucket: String,
key: String,
etag: String,
eTag: String,
Copy link
Contributor Author

@mdedetrich mdedetrich Oct 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK this can break source compatibility (i.e. if someone calls create with named parameters specifically within Scala) but it doesn't break binary compatibility.

Copy link
Member

@ennru ennru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mima on Travis is happy with your changes https://app.travis-ci.com/github/akka/alpakka/jobs/540918111
LGTM.

@ennru ennru added this to the 3.0.4 milestone Oct 4, 2021
@ennru ennru changed the title Make eTag naming consistent S3: Make eTag naming consistent Oct 4, 2021
@ennru ennru merged commit 5f924a3 into akka:master Oct 4, 2021
@mdedetrich mdedetrich deleted the make-etag-naming-consistent branch October 4, 2021 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants