Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Revise internals of LoggingCacheErrorHandler

Browse Source 
Since LoggingCacheErrorHandler was only recently introduced in 5.3.16,
we have decided to completely revise its internals (protected API) in
5.3.x while retaining the current public API.

Specifically, this commit:

- introduces protected getLogger() and isLogStackTraces() methods to
  improve extensibility

- revises logCacheError() to accept a Supplier<String> for lazy
  resolution of error messages

Closes gh-28672
See gh-28670, gh-28648
This commit is contained in:
Sam Brannen
2022-06-21 16:13:55 +02:00
parent 57208bf47a
commit 26df4580b3
2 changed files with 75 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
spring-context/src/test/java/org/springframework/cache/interceptor/LoggingCacheErrorHandlerTests.java vendored
View File

@@ -17,13 +17,14 @@
package org.springframework.cache.interceptor;
import org.apache.commons.logging.Log;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.cache.Cache;
import org.springframework.cache.support.NoOpCache;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
/**
@@ -32,48 +33,55 @@ import static org.mockito.Mockito.verify;
* @author Adam Ostrožlík
* @author Stephane Nicoll
* @author Vedran Pavic
* @author Sam Brannen
*/
@ExtendWith(MockitoExtension.class)
class LoggingCacheErrorHandlerTests {
@Mock
private Log logger;
private static final Cache CACHE = new NoOpCache("NOOP");
private static final String KEY = "enigma";
private final Log logger = mock(Log.class);
private LoggingCacheErrorHandler handler = new LoggingCacheErrorHandler(this.logger, false);
@BeforeEach
void setUp() {
given(this.logger.isWarnEnabled()).willReturn(true);
}
@Test
void handleGetCacheErrorLogsAppropriateMessage() {
LoggingCacheErrorHandler handler = new LoggingCacheErrorHandler(this.logger, false);
handler.handleCacheGetError(new RuntimeException(), new NoOpCache("NOOP"), "key");
verify(this.logger).warn("Cache 'NOOP' failed to get entry with key 'key'");
this.handler.handleCacheGetError(new RuntimeException(), CACHE, KEY);
verify(this.logger).warn("Cache 'NOOP' failed to get entry with key 'enigma'");
}
@Test
void handlePutCacheErrorLogsAppropriateMessage() {
LoggingCacheErrorHandler handler = new LoggingCacheErrorHandler(this.logger, false);
handler.handleCachePutError(new RuntimeException(), new NoOpCache("NOOP"), "key", new Object());
verify(this.logger).warn("Cache 'NOOP' failed to put entry with key 'key'");
this.handler.handleCachePutError(new RuntimeException(), CACHE, KEY, null);
verify(this.logger).warn("Cache 'NOOP' failed to put entry with key 'enigma'");
}
@Test
void handleEvictCacheErrorLogsAppropriateMessage() {
LoggingCacheErrorHandler handler = new LoggingCacheErrorHandler(this.logger, false);
handler.handleCacheEvictError(new RuntimeException(), new NoOpCache("NOOP"), "key");
verify(this.logger).warn("Cache 'NOOP' failed to evict entry with key 'key'");
this.handler.handleCacheEvictError(new RuntimeException(), CACHE, KEY);
verify(this.logger).warn("Cache 'NOOP' failed to evict entry with key 'enigma'");
}
@Test
void handleClearErrorLogsAppropriateMessage() {
LoggingCacheErrorHandler handler = new LoggingCacheErrorHandler(this.logger, false);
handler.handleCacheClearError(new RuntimeException(), new NoOpCache("NOOP"));
this.handler.handleCacheClearError(new RuntimeException(), CACHE);
verify(this.logger).warn("Cache 'NOOP' failed to clear entries");
}
@Test
void handleCacheErrorWithStacktrace() {
LoggingCacheErrorHandler handler = new LoggingCacheErrorHandler(this.logger, true);
void handleGetCacheErrorWithStackTraceLoggingEnabled() {
this.handler = new LoggingCacheErrorHandler(this.logger, true);
RuntimeException exception = new RuntimeException();
handler.handleCacheGetError(exception, new NoOpCache("NOOP"), "key");
verify(this.logger).warn("Cache 'NOOP' failed to get entry with key 'key'", exception);
this.handler.handleCacheGetError(exception, CACHE, KEY);
verify(this.logger).warn("Cache 'NOOP' failed to get entry with key 'enigma'", exception);
}
}