Skip to content

Handle multipart request errors in optout service to return 400 instead of 500 #302

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
caroline-ttd wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Handle multipart request errors in optout service to return 400 instead of 500 #302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
29f33a2
Handle multipart request errors in optout service to return 400 inste…
caroline-ttd Jan 5, 2026
3bc4a86
Add general failure handler
caroline-ttd Jan 8, 2026
e760df2
Fix tests
caroline-ttd Jan 8, 2026
c768b00
[CI Pipeline] Released Snapshot version: 4.7.6-alpha-151-SNAPSHOT
Jan 8, 2026
5aac2e4
Just for test
caroline-ttd Jan 8, 2026
ed8f378
Merge branch 'ccm-UID2-6459-handle-multipart-errors-as-400' of github…
caroline-ttd Jan 8, 2026
1b1f05d
[CI Pipeline] Released Snapshot version: 4.7.7-alpha-152-SNAPSHOT
Jan 8, 2026
8ef7b65
Update
caroline-ttd Jan 8, 2026
9b3f07b
Merge branch 'ccm-UID2-6459-handle-multipart-errors-as-400' of github…
caroline-ttd Jan 8, 2026
1174679
[CI Pipeline] Released Snapshot version: 4.7.8-alpha-155-SNAPSHOT
Jan 8, 2026
7fc6e12
Remove vul testing
caroline-ttd Feb 3, 2026
60ab988
Merge branch 'main' into ccm-UID2-6459-handle-multipart-errors-as-400
caroline-ttd Feb 3, 2026
3d681ec
Merge branch 'ccm-UID2-6459-handle-multipart-errors-as-400' of github…
caroline-ttd Feb 3, 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
86 changes: 86 additions & 0 deletions src/main/java/com/uid2/optout/vertx/GenericFailureHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
package com.uid2.optout.vertx;

import io.vertx.core.Handler;
import io.vertx.core.http.HttpClosedException;
import io.vertx.core.http.HttpServerResponse;
import io.vertx.ext.web.RoutingContext;
import org.apache.http.impl.EnglishReasonPhraseCatalog;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class GenericFailureHandler implements Handler<RoutingContext> {
private static final Logger LOGGER = LoggerFactory.getLogger(GenericFailureHandler.class);

@Override
public void handle(RoutingContext ctx) {
int statusCode = ctx.statusCode();
HttpServerResponse response = ctx.response();
String url = ctx.normalizedPath();
Throwable t = ctx.failure();

// Handle case where failure() is null (e.g., when rc.fail(401) is called without exception)
// In this case, just use the status code that was set
if (t == null) {
int finalStatusCode = statusCode == -1 ? 500 : statusCode;
if (finalStatusCode >= 500 && finalStatusCode < 600) {
LOGGER.error("URL: [{}] - Error response code: [{}]", url, finalStatusCode);
} else if (finalStatusCode >= 400 && finalStatusCode < 500) {
LOGGER.warn("URL: [{}] - Error response code: [{}]", url, finalStatusCode);
}
if (!response.ended() && !response.closed()) {
response.setStatusCode(finalStatusCode)
.end(EnglishReasonPhraseCatalog.INSTANCE.getReason(finalStatusCode, null));
}
return;
}

String errorMsg = t.getMessage();
String className = t.getClass().getName();

// Handle multipart method mismatch (IllegalStateException)
if (t instanceof IllegalStateException &&
errorMsg != null &&
errorMsg.equalsIgnoreCase(
"Request method must be one of POST, PUT, PATCH or DELETE to decode a multipart request")) {
if (!response.ended() && !response.closed()) {
response.setStatusCode(400).end(errorMsg);
}
LOGGER.warn("URL: [{}] - Multipart method mismatch - Error:", url, t);
return;
}

// Handle TooManyFormFieldsException
if (className.contains("TooManyFormFieldsException")) {
if (!response.ended() && !response.closed()) {
response.setStatusCode(400)
.end("Bad Request: Too many form fields");
}
LOGGER.warn("URL: [{}] - Too many form fields - Error:", url, t);
return;
}

// Handle HttpClosedException - ignore as it's usually caused by users and has no impact
if (t instanceof HttpClosedException) {
LOGGER.warn("Ignoring exception - URL: [{}] - Error:", url, t);
if (!response.ended() && !response.closed()) {
response.end();
}
return;
}

// Handle other exceptions based on status code
// If no status code was set, default to 500
int finalStatusCode = statusCode == -1 ? 500 : statusCode;

if (finalStatusCode >= 500 && finalStatusCode < 600) { // 5xx is server error, so error
LOGGER.error("URL: [{}] - Error response code: [{}] - Error:", url, finalStatusCode, t);
} else if (finalStatusCode >= 400 && finalStatusCode < 500) { // 4xx is user error, so just warn
LOGGER.warn("URL: [{}] - Error response code: [{}] - Error:", url, finalStatusCode, t);
}

if (!response.ended() && !response.closed()) {
response.setStatusCode(finalStatusCode)
.end(EnglishReasonPhraseCatalog.INSTANCE.getReason(finalStatusCode, null));
}
}
}
2 changes: 2 additions & 0 deletions src/main/java/com/uid2/optout/vertx/OptOutServiceVerticle.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,8 @@ private Router createRouter() {
//// if enabled, this would add handler for exposing prometheus metrics
// router.route("/metrics").handler(PrometheusScrapingHandler.create());

router.route().failureHandler(new GenericFailureHandler());

return router;
}

Expand Down
Loading
Loading