Skip to content

HDDS-16189. Return application/xml for S3 error responses #11031

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.

Sign up for GitHub

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

Open
F64116045 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

HDDS-16189. Return application/xml for S3 error responses #11031

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ebc4ab
HDDS-16189. Return application/xml for S3 error responses
F64116045 Aug 17, 2026
650f0bf
HDDS-16189. Set XML media type on wrapped S3 errors
F64116045 Aug 17, 2026
e6a8164
HDDS-16189. Add S3 SDK integration coverage
F64116045 Aug 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...zone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/exception/OS3ExceptionMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
package org.apache.hadoop.ozone.s3.exception;

import javax.inject.Inject;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ExceptionMapper;
import javax.ws.rs.ext.Provider;
Expand Down Expand Up @@ -45,6 +46,7 @@ public Response toResponse(OS3Exception exception) {
}
exception.setRequestId(requestIdentifier.getRequestId());
return Response.status(exception.getHttpCode())
.type(MediaType.APPLICATION_XML_TYPE)

@chihsuan chihsuan Aug 17, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think the change is correct, but I noticed that the exact reproduction of HDDS-16189 follows the authentication-error path, which bypasses OS3ExceptionMapper. Should we also set MediaType.APPLICATION_XML_TYPE in S3Utils.wrapOS3Exception() and add a test for that?

ozone/hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/util/S3Utils.java

Lines 141 to 146 in 1a4486a

public static WebApplicationException wrapOS3Exception(OS3Exception ex) {
return new WebApplicationException(ex.getErrorMessage(), ex,
Response.status(ex.getHttpCode())
.entity(ex.toXml())
.build());
}

@F64116045 F64116045 Aug 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Oops, I missed that the curl request stops at AuthorizationFilter and never reaches OS3ExceptionMapper.
Thanks a lot for catching this!

@F64116045 F64116045 Aug 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks, updated S3Utils.wrapOS3Exception() and added a test.

.entity(exception.toXml()).build();
}
}
26 changes: 26 additions & 0 deletions ...ozone/s3gateway/src/test/java/org/apache/hadoop/ozone/s3/exception/TestOS3Exceptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,30 @@
package org.apache.hadoop.ozone.s3.exception;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.when;

import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.apache.hadoop.ozone.s3.RequestIdentifier;
import org.apache.hadoop.ozone.web.utils.OzoneUtils;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

/**
* This class tests OS3Exception class.

@chihsuan chihsuan Aug 17, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: This class now also tests OS3ExceptionMapper. Could we update the class Javadoc accordingly?

@F64116045 F64116045 Aug 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated, thanks.

*/
@ExtendWith(MockitoExtension.class)
public class TestOS3Exceptions {

@Mock
private RequestIdentifier requestIdentifier;

@InjectMocks
private OS3ExceptionMapper exceptionMapper;

@Test
public void testOS3Exceptions() {
OS3Exception ex = S3ErrorTable.newError(S3ErrorTable.ACCESS_DENIED, "bucket");
Expand All @@ -44,4 +59,15 @@ public void testOS3Exceptions() {
ex.getRequestId());
assertEquals(expected, val);
}

@Test
public void testResponseContentType() {
when(requestIdentifier.getRequestId()).thenReturn("request-id");
OS3Exception exception = S3ErrorTable.newError(
S3ErrorTable.ACCESS_DENIED, "bucket");

Response response = exceptionMapper.toResponse(exception);

assertEquals(MediaType.APPLICATION_XML_TYPE, response.getMediaType());
}
}