Merge pull request #1609 from CMSgov/QPPA-11386

QPPA-11386: normalize 404 datadog logging issue

Author: chetanmunegowda

rest-api/src/main/java/gov/cms/qpp/conversion/api/exceptions/GlobalExceptionHandler.java

@@ -10,12 +10,15 @@
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.http.ResponseEntity;
+import org.springframework.web.context.request.WebRequest;
 import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.multipart.MultipartException;
 import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
+import org.springframework.web.servlet.resource.NoResourceFoundException;
 
 /**
  * Modify the controller to send back different responses for exceptions
@@ -69,6 +72,25 @@ ResponseEntity<AllErrors> handleQppValidationException(QppValidationException ex
 		return cope(exception);
 	}
 
+	/**
+	 * Handles {@link NoResourceFoundException} for requests to non-existent paths/resources.
+	 * Returns a clean 404 and logs at DEBUG/TRACE to avoid ERROR-level noise.
+	 */
+	@Override
+	protected ResponseEntity<Object> handleNoResourceFoundException(
+			NoResourceFoundException ex,
+			HttpHeaders headers,
+			HttpStatusCode status,
+			WebRequest request) {
+
+		API_LOG.debug("No resource found ({}): {}", status.value(), ex.getMessage());
+		API_LOG.trace("NoResourceFoundException details", ex);
+
+		return ResponseEntity.status(status)
+				.contentType(MediaType.TEXT_PLAIN)
+				.body("Not found");
+	}
+
 	/**
 	 * "Catch" the {@link NoFileInDatabaseException}.
 	 * Return the {@link AllErrors} with an HTTP status 404.

rest-api/src/test/java/gov/cms/qpp/conversion/api/exceptions/GlobalExceptionHandlerTest.java

@@ -27,11 +27,15 @@
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpMethod;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.MvcResult;
 import org.springframework.test.web.servlet.RequestBuilder;
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
 import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.context.request.WebRequest;
+import org.springframework.web.servlet.resource.NoResourceFoundException;
 
 import java.nio.file.Path;
 import java.util.UUID;
@@ -247,6 +251,32 @@ void testHandleInvalidPurposeExceptionResponseBodyDoesInterception() throws Exce
 				.isEqualTo("Given Purpose (header) is too large. Max length is 25, yours was " + purpose.length());
 	}
 
+	@Test
+	void testHandleNoResourceFoundExceptionReturnsPlain404() throws Exception {
+		NoResourceFoundException ex;
+		try {
+			ex = NoResourceFoundException.class
+					.getConstructor(HttpMethod.class, String.class)
+					.newInstance(HttpMethod.GET, "/test");
+		} catch (NoSuchMethodException ignore) {
+			ex = NoResourceFoundException.class
+					.getConstructor(HttpMethod.class, String.class, String.class)
+					.newInstance(HttpMethod.GET, "/test", "/test");
+		}
+
+		ResponseEntity<Object> response = objectUnderTest.handleNoResourceFoundException(
+				ex,
+				new HttpHeaders(),
+				HttpStatus.NOT_FOUND,
+				Mockito.mock(WebRequest.class)
+		);
+
+		Truth.assertThat(response.getStatusCodeValue()).isEqualTo(404);
+		Truth.assertThat(response.getHeaders().getContentType())
+				.isEquivalentAccordingToCompareTo(MediaType.TEXT_PLAIN);
+		Truth.assertThat(response.getBody()).isEqualTo("Not found");
+	}
+
 	@Override
 	public Class<?> getLoggerType() {
 		return GlobalExceptionHandler.class;