From e8c7507418d72dfb4f8e682dcdef18f7a0bde358 Mon Sep 17 00:00:00 2001 From: Arturo Bernal Date: Tue, 17 Nov 2026 16:14:42 +0100 Subject: [PATCH] JSPWIKI-1371 Give each caching manager its own Ehcache cache manager The caching manager used the CacheManager singleton of Ehcache, so every engine of the same class loader shared the caches of the others, and shutting down one engine shut them down for all. A page saved by an engine that is still running, like the one in ImageTest, showed up in the search results of another engine, and this made SearchManagerTest and PageRenamerTest fail at random. Each caching manager now creates and shuts down a cache manager of its own. --- ChangeLog.md | 6 ++++++ .../java/org/apache/wiki/api/Release.java | 2 +- .../wiki/cache/EhcacheCachingManager.java | 12 ++++++++--- .../wiki/cache/EhcacheCachingManagerTest.java | 20 +++++++++++++++++++ .../wiki/providers/CachingProviderTest.java | 7 ------- 5 files changed, 36 insertions(+), 11 deletions(-) diff --git a/ChangeLog.md b/ChangeLog.md index 880da8f4df..6263612355 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -17,6 +17,12 @@ specific language governing permissions and limitations under the License. --> +**2026-11-17 Arturo Bernal (abernal AT apache DOT org)** + +* _3.0.1-git-10_ + +* Fix for [JSPWIKI-1371](https://issues.apache.org/jira/browse/JSPWIKI-1371): each caching manager uses its own Ehcache cache manager, so engines running in the same JVM no longer share the page caches nor shut them down for each other + **2026-11-14 Multiple authors** * _3.0.1-git-09 diff --git a/jspwiki-api/src/main/java/org/apache/wiki/api/Release.java b/jspwiki-api/src/main/java/org/apache/wiki/api/Release.java index 7128b9933e..a588475922 100644 --- a/jspwiki-api/src/main/java/org/apache/wiki/api/Release.java +++ b/jspwiki-api/src/main/java/org/apache/wiki/api/Release.java @@ -69,7 +69,7 @@ public final class Release { *

* If the build identifier is empty, it is not added. */ - public static final String BUILD = "9"; + public static final String BUILD = "10"; /** * This is the generic version string you should use when printing out the version. It is of diff --git a/jspwiki-cache/src/main/java/org/apache/wiki/cache/EhcacheCachingManager.java b/jspwiki-cache/src/main/java/org/apache/wiki/cache/EhcacheCachingManager.java index bdb566b187..0c7abab63c 100644 --- a/jspwiki-cache/src/main/java/org/apache/wiki/cache/EhcacheCachingManager.java +++ b/jspwiki-cache/src/main/java/org/apache/wiki/cache/EhcacheCachingManager.java @@ -22,6 +22,8 @@ Licensed to the Apache Software Foundation (ASF) under one import net.sf.ehcache.CacheManager; import net.sf.ehcache.Ehcache; import net.sf.ehcache.Element; +import net.sf.ehcache.config.Configuration; +import net.sf.ehcache.config.ConfigurationFactory; import net.sf.ehcache.event.CacheEventListenerAdapter; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; @@ -37,6 +39,7 @@ Licensed to the Apache Software Foundation (ASF) under one import java.util.List; import java.util.Map; import java.util.Properties; +import java.util.UUID; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.atomic.AtomicBoolean; @@ -57,8 +60,8 @@ public class EhcacheCachingManager implements CachingManager, Initializable { /** {@inheritDoc} */ @Override public void shutdown() { - if(!cacheMap.isEmpty()) { - CacheManager.getInstance().shutdown(); + if( !cacheMap.isEmpty() ) { + cacheManager.shutdown(); cacheMap.clear(); cacheStats.clear(); } @@ -79,7 +82,10 @@ public void initialize( final Engine engine, final Properties props ) throws Wik if (location == null ) { LOG.error( "The ehcache configuration file from classpath on {} could not be loaded. Check setting {}", val , PROP_CACHE_CONF_FILE); } - cacheManager = CacheManager.create( location ); + // The shared CacheManager would give every engine of the same class loader the caches of the others. + final Configuration configuration = ConfigurationFactory.parseConfiguration( location ); + configuration.setName( "jspwiki-" + UUID.randomUUID() ); + cacheManager = CacheManager.newInstance( configuration ); registerCache( CACHE_ATTACHMENTS ); registerCache( CACHE_ATTACHMENTS_COLLECTION ); registerCache( CACHE_ATTACHMENTS_DYNAMIC ); diff --git a/jspwiki-cache/src/test/java/org/apache/wiki/cache/EhcacheCachingManagerTest.java b/jspwiki-cache/src/test/java/org/apache/wiki/cache/EhcacheCachingManagerTest.java index 90441f5422..675690c71b 100644 --- a/jspwiki-cache/src/test/java/org/apache/wiki/cache/EhcacheCachingManagerTest.java +++ b/jspwiki-cache/src/test/java/org/apache/wiki/cache/EhcacheCachingManagerTest.java @@ -54,6 +54,26 @@ void testInitAndShutdown() throws Exception { Assertions.assertEquals( 0, ecm.cacheMap.size() ); } + @Test + void testManagersDoNotShareCaches() throws Exception { + final EhcacheCachingManager first = new EhcacheCachingManager(); + final EhcacheCachingManager second = new EhcacheCachingManager(); + first.initialize( null, new Properties() ); + second.initialize( null, new Properties() ); + try { + first.put( CachingManager.CACHE_PAGES, "OnlyInFirst", "content" ); + Assertions.assertNull( second.get( CachingManager.CACHE_PAGES, "OnlyInFirst", () -> null ) ); + Assertions.assertTrue( second.keys( CachingManager.CACHE_PAGES ).isEmpty() ); + + first.shutdown(); + second.put( CachingManager.CACHE_PAGES, "InSecond", "content" ); + Assertions.assertEquals( "content", second.get( CachingManager.CACHE_PAGES, "InSecond", () -> null ) ); + } finally { + first.shutdown(); + second.shutdown(); + } + } + @Test void testEnabled() { Assertions.assertTrue( ecm.enabled( CachingManager.CACHE_PAGES ) ); diff --git a/jspwiki-main/src/test/java/org/apache/wiki/providers/CachingProviderTest.java b/jspwiki-main/src/test/java/org/apache/wiki/providers/CachingProviderTest.java index 3ef6aabae9..227539658d 100644 --- a/jspwiki-main/src/test/java/org/apache/wiki/providers/CachingProviderTest.java +++ b/jspwiki-main/src/test/java/org/apache/wiki/providers/CachingProviderTest.java @@ -19,7 +19,6 @@ Licensed to the Apache Software Foundation (ASF) under one package org.apache.wiki.providers; -import net.sf.ehcache.CacheManager; import org.apache.wiki.TestEngine; import org.apache.wiki.api.core.Page; import org.apache.wiki.cache.CachingManager; @@ -28,7 +27,6 @@ Licensed to the Apache Software Foundation (ASF) under one import org.awaitility.Awaitility; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Assertions; -import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Test; import java.io.File; @@ -41,11 +39,6 @@ class CachingProviderTest { TestEngine engine; - @BeforeAll - static void ensureEhCacheFreshStart() { - CacheManager.getInstance().shutdown(); - } - @AfterEach void tearDown() { engine.stop();