root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Display original request URI in NoResourceFoundException message 

This commit ensures that the original request URI is displayed in
`NoResourceFoundException` error messages when logged. Without this
change, it can be confusing to see only the attempted resource path.
There are cases where the original request was not meant for resource
handling and we want to understand why this wasn't processed by another
handler.

The Problem Detail attribute has not been changed as the "instance"
attribute already displays the request path.

Closes gh-34553
This commit is contained in:
Brian Clozel 2025-07-25 15:04:59 +02:00
parent d06255214e
commit 444573d4b5
8 changed files with 98 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
spring-webflux/src/main/java/org/springframework/web/reactive/resource/NoResourceFoundException.java
View File

@ -16,6 +16,8 @@
package org.springframework.web.reactive.resource;
import java.net.URI;
import org.springframework.http.HttpStatus;
import org.springframework.web.server.ResponseStatusException;
@ -30,9 +32,9 @@ import org.springframework.web.server.ResponseStatusException;
public class NoResourceFoundException extends ResponseStatusException {
public NoResourceFoundException(String resourcePath) {
super(HttpStatus.NOT_FOUND, "No static resource " + resourcePath + ".");
setDetail(getReason());
public NoResourceFoundException(URI uri, String resourcePath) {
super(HttpStatus.NOT_FOUND, "No static resource " + resourcePath + " for request '" + uri + "'.");
setDetail("No static resource " + resourcePath + ".");
}
}

2
spring-webflux/src/main/java/org/springframework/web/reactive/resource/ResourceWebHandler.java
View File

@ -420,7 +420,7 @@ public class ResourceWebHandler implements WebHandler, InitializingBean {
if (logger.isDebugEnabled()) {
logger.debug(exchange.getLogPrefix() + "Resource not found");
}
return Mono.error(new NoResourceFoundException(getResourcePath(exchange)));
return Mono.error(new NoResourceFoundException(exchange.getRequest().getURI(), getResourcePath(exchange)));
}))
.flatMap(resource -> {
try {

43
spring-webflux/src/test/java/org/springframework/web/reactive/resource/NoResourceFoundExceptionTests.java Normal file
View File

@ -0,0 +1,43 @@
/*
* Copyright 2002-present the original author or authors.
*
* Licensed 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
*
* https://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.springframework.web.reactive.resource;
import java.net.URI;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link NoResourceFoundException}.
* @author Brian Clozel
*/
class NoResourceFoundExceptionTests {
@Test
void messageShouldContainRequestUriAndResourcePath() {
var noResourceFoundException = new NoResourceFoundException(URI.create("/context/resource"), "/resource");
assertThat(noResourceFoundException.getMessage()).isEqualTo("404 NOT_FOUND \"No static resource /resource for request '/context/resource'.\"");
}
@Test
void detailShouldContainResourcePath() {
var noResourceFoundException = new NoResourceFoundException(URI.create("/context/resource"), "/resource");
assertThat(noResourceFoundException.getBody().getDetail()).isEqualTo("No static resource /resource.");
}
}

6
spring-webmvc/src/main/java/org/springframework/web/servlet/resource/NoResourceFoundException.java
View File

@ -45,11 +45,11 @@ public class NoResourceFoundException extends ServletException implements ErrorR
/**
* Create an instance.
*/
public NoResourceFoundException(HttpMethod httpMethod, String resourcePath) {
super("No static resource " + resourcePath + ".");
public NoResourceFoundException(HttpMethod httpMethod, String requestUri, String resourcePath) {
super("No static resource " + resourcePath + " for request '" + requestUri + "'.");
this.httpMethod = httpMethod;
this.resourcePath = resourcePath;
this.body = ProblemDetail.forStatusAndDetail(getStatusCode(), getMessage());
this.body = ProblemDetail.forStatusAndDetail(getStatusCode(), "No static resource " + resourcePath + ".");
}

2
spring-webmvc/src/main/java/org/springframework/web/servlet/resource/ResourceHttpRequestHandler.java
View File

@ -524,7 +524,7 @@ public class ResourceHttpRequestHandler extends WebContentGenerator
Resource resource = getResource(request);
if (resource == null) {
logger.debug("Resource not found");
throw new NoResourceFoundException(HttpMethod.valueOf(request.getMethod()), getPath(request));
throw new NoResourceFoundException(HttpMethod.valueOf(request.getMethod()), request.getRequestURI(), getPath(request));
}
if (HttpMethod.OPTIONS.matches(request.getMethod())) {

2
spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/annotation/ResponseEntityExceptionHandlerTests.java
View File

@ -306,7 +306,7 @@ class ResponseEntityExceptionHandlerTests {
@Test
void noResourceFoundException() {
testException(new NoResourceFoundException(HttpMethod.GET, "/resource"));
testException(new NoResourceFoundException(HttpMethod.GET, "/context/resource", "/resource"));
}
@Test

2
spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/support/DefaultHandlerExceptionResolverTests.java
View File

@ -209,7 +209,7 @@ class DefaultHandlerExceptionResolverTests {
@Test
void handleNoResourceFoundException() {
NoResourceFoundException ex = new NoResourceFoundException(HttpMethod.GET, "/resource");
NoResourceFoundException ex = new NoResourceFoundException(HttpMethod.GET, "/context/resource", "/resource");
ModelAndView mav = exceptionResolver.resolveException(request, response, null, ex);
assertThat(mav).as("No ModelAndView returned").isNotNull();
assertThat(mav.isEmpty()).as("No Empty ModelAndView returned").isTrue();

43
spring-webmvc/src/test/java/org/springframework/web/servlet/resource/NoResourceFoundExceptionTests.java Normal file
View File

@ -0,0 +1,43 @@
/*
* Copyright 2002-present the original author or authors.
*
* Licensed 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
*
* https://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.springframework.web.servlet.resource;
import org.junit.jupiter.api.Test;
import org.springframework.http.HttpMethod;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link NoResourceFoundException}.
* @author Brian Clozel
*/
class NoResourceFoundExceptionTests {
@Test
void messageShouldContainRequestUriAndResourcePath() {
var noResourceFoundException = new NoResourceFoundException(HttpMethod.GET, "/context/resource", "/resource");
assertThat(noResourceFoundException.getMessage()).isEqualTo("No static resource /resource for request '/context/resource'.");
}
@Test
void detailShouldContainResourcePath() {
var noResourceFoundException = new NoResourceFoundException(HttpMethod.GET, "/context/resource", "/resource");
assertThat(noResourceFoundException.getBody().getDetail()).isEqualTo("No static resource /resource.");
}
}