Only log status in ServletRequestHandledEvent

This commit updates the description of RequestHandledEvent to avoid
providing a misleading status as the absence of a failure logs OK which
can be inaccurate.

Closes gh-27595
This commit is contained in:
Stéphane Nicoll
2024-01-04 11:47:59 +01:00
parent be9ee9112c
commit 2784f6008e
4 changed files with 103 additions and 10 deletions

View File

@@ -0,0 +1,50 @@
/*
* Copyright 2002-2024 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.context.support;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link RequestHandledEvent}.
*
* @author Stephane Nicoll
*/
class RequestHandledEventTests {
@Test
void descriptionWithNullableFields() {
RequestHandledEvent event = new RequestHandledEvent(this, null, null, 400, null);
assertThat(event.getDescription()).isEqualTo("session=[null]; user=[null]; time=[400ms]");
}
@Test
void descriptionWithoutFailure() {
RequestHandledEvent event = new RequestHandledEvent(this, "123-456", "user", 400, null);
assertThat(event.getDescription()).isEqualTo("session=[123-456]; user=[user]; time=[400ms]");
}
@Test
void descriptionWithFailure() {
RequestHandledEvent event = new RequestHandledEvent(this, "123-456", "user", 400,
new IllegalStateException("Expected failure"));
assertThat(event.getDescription()).isEqualTo(
"session=[123-456]; user=[user]; time=[400ms]; failure=[java.lang.IllegalStateException: Expected failure]");
}
}

View File

@@ -0,0 +1,47 @@
/*
* Copyright 2002-2024 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.context.support;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link ServletRequestHandledEvent}.
*
* @author Stephane Nicoll
*/
class ServletRequestHandledEventTests {
@Test
void descriptionWithoutStatusCode() {
ServletRequestHandledEvent event = new ServletRequestHandledEvent(this,
"/", "example.com", "GET", "dispatcher", "123-456", "user", 400);
assertThat(event.getDescription()).contains("status=[-1]")
.doesNotContain("failure=[");
}
@Test
void descriptionWithFailure() {
ServletRequestHandledEvent event = new ServletRequestHandledEvent(this,
"/", "example.com", "GET", "dispatcher", "123-456", "user",
400, new IllegalStateException("Test"), 500);
assertThat(event.getDescription()).contains("status=[500]",
"failure=[java.lang.IllegalStateException: Test]");
}
}