Skip to content

fix(cache): add triggering user to cache flush log messages (#36830) #36917

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dsilvam merged 1 commit into from
Aug 7, 2026
+48 −21
Merged

fix(cache): add triggering user to cache flush log messages (#36830) #36917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 22 additions & 18 deletions dotCMS/src/main/java/com/dotcms/rest/api/v1/system/cache/CacheResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import com.dotmarketing.util.MaintenanceUtil;
import com.dotmarketing.util.PortletID;
import com.google.common.annotations.VisibleForTesting;
import com.liferay.portal.model.User;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
Expand Down Expand Up @@ -295,15 +296,16 @@ public Response flushGroup(@Context final HttpServletRequest request,
@PathParam("provider") final String provider,
@PathParam("group") final String group) {

new WebResource.InitBuilder(webResource)
final User user = new WebResource.InitBuilder(webResource)
.requestAndResponse(request, response)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requiredPortlet(PortletID.MAINTENANCE.toString().toLowerCase())
.rejectWhenNoUser(true).init();
.rejectWhenNoUser(true).init().getUser();

Logger.debug(this, ()-> "Deletes objects on cache providers, group: " + group
+ ", provider = " + provider);
Logger.info(this, String.format(
"User '%s' is flushing cache group '%s' on provider '%s'",
user.getUserId(), group, provider));

this.getProvider(provider, group).remove(group);
return Response.ok(new ResponseEntityView("flushed")).build();
Expand All @@ -327,15 +329,16 @@ public Response flushObject(@Context final HttpServletRequest request,
@PathParam("group") final String group,
@PathParam("id") final String id) {

new WebResource.InitBuilder(webResource)
final User user = new WebResource.InitBuilder(webResource)
.requestAndResponse(request, response)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requiredPortlet(PortletID.MAINTENANCE.toString().toLowerCase())
.rejectWhenNoUser(true).init();
.rejectWhenNoUser(true).init().getUser();

Logger.debug(this, ()-> "Deletes object on cache providers, group: " + group
+ ", provider = " + provider);
Logger.info(this, String.format(
"User '%s' is flushing cache object '%s' from group '%s' on provider '%s'",
user.getUserId(), id, group, provider));

this.getProvider(provider, group).remove(group, id);
return Response.ok(new ResponseEntityView("flushed")).build();
Expand Down Expand Up @@ -369,14 +372,14 @@ public Response flushAll(@Context final HttpServletRequest request,
@Context final HttpServletResponse response,
@PathParam("provider") final String provider) {

new WebResource.InitBuilder(webResource)
final User user = new WebResource.InitBuilder(webResource)
.requestAndResponse(request, response)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requiredPortlet(PortletID.MAINTENANCE.toString().toLowerCase())
.rejectWhenNoUser(true).init();
.rejectWhenNoUser(true).init().getUser();

Logger.debug(this, ()-> "Deletes all objects on cache provider = " + provider);
Logger.info(this, String.format("User '%s' is flushing all caches", user.getUserId()));

cacheMaintenanceHelper.flushAllCaches();
return Response.ok(new ResponseEntityView("flushed all")).build();
Expand Down Expand Up @@ -505,21 +508,22 @@ public ResponseEntityStringView flushRegion(
required = true, example = "Permission")
@PathParam("regionName") final String regionName) {

new WebResource.InitBuilder(webResource)
final User user = new WebResource.InitBuilder(webResource)
.requestAndResponse(request, response)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requiredPortlet(PortletID.MAINTENANCE.toString().toLowerCase())
.rejectWhenNoUser(true).init();
.rejectWhenNoUser(true).init().getUser();

if ("all".equalsIgnoreCase(regionName)) {
Logger.info(this, "Flushing all caches");
Logger.info(this, String.format("User '%s' is flushing all caches", user.getUserId()));
cacheMaintenanceHelper.flushAllCaches();
return new ResponseEntityStringView("Flushed all caches");
}

final String canonical = cacheMaintenanceHelper.flushRegion(regionName);
Logger.info(this, "Flushed cache region: " + canonical);
Logger.info(this, String.format("User '%s' flushed cache region '%s'",
user.getUserId(), canonical));
return new ResponseEntityStringView("Flushed " + canonical);
}

Expand Down Expand Up @@ -605,14 +609,14 @@ private CacheStatsView buildCacheStatsView() {
public ResponseEntityStringView deleteMenuCache(@Context final HttpServletRequest request,
@Context final HttpServletResponse response) {

new WebResource.InitBuilder(webResource)
final User user = new WebResource.InitBuilder(webResource)
.requestAndResponse(request, response)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requiredPortlet(PortletID.MAINTENANCE.toString().toLowerCase())
.rejectWhenNoUser(true).init();
.rejectWhenNoUser(true).init().getUser();

Logger.debug(this, ()-> "Deleting menu cache");
Logger.info(this, String.format("User '%s' is flushing the menu cache", user.getUserId()));

MaintenanceUtil.deleteMenuCache();
return new ResponseEntityStringView("flushed menucache");
Expand Down
12 changes: 9 additions & 3 deletions ...c/main/java/com/dotmarketing/portlets/cmsmaintenance/action/ViewCMSMaintenanceAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
import com.dotmarketing.util.ZipUtil;
import com.dotmarketing.util.starter.ExportStarterUtil;
import com.google.common.collect.ImmutableList;
import com.liferay.portal.model.User;
import com.liferay.portlet.ActionResponseImpl;
import com.liferay.util.FileUtil;
import com.liferay.util.servlet.SessionMessages;
Expand Down Expand Up @@ -130,6 +131,8 @@ public void processAction(
//Manage all the cache Task
if(cmd.equals("cache")){

final User cacheUser = _getUser(req);
final String cacheUserId = null != cacheUser ? cacheUser.getUserId() : "unknown";
String cacheName = ccf.getCacheName();
if (cacheName.equals(com.dotmarketing.util.WebKeys.Cache.CACHE_CONTENTS_INDEX))
{
Expand Down Expand Up @@ -165,7 +168,7 @@ public void processAction(
}
} else if (cacheName.equals(com.dotmarketing.util.WebKeys.Cache.CACHE_MENU_FILES))
{
Logger.info(this, "Deleting Menu Files");
Logger.info(this, String.format("User '%s' is deleting Menu Files", cacheUserId));
_deleteMenusCache();
message = "message.cmsmaintenance.cache.flushmenucaches";
} else if (cacheName.equals("flushCache"))
Expand All @@ -177,7 +180,9 @@ public void processAction(
}catch (NullPointerException e) {
isAllCachesFlush = true;//is a NPE is returned means it's cleaning all the caches
}
final String msgLogger = isAllCachesFlush ? "Flushing All Caches" : "Flushing " + cacheToFlush +" Cache";
final String msgLogger = isAllCachesFlush
? String.format("User '%s' is flushing All Caches", cacheUserId)
: String.format("User '%s' is flushing %s Cache", cacheUserId, cacheToFlush);
Logger.info(this, msgLogger);
_flush(cacheToFlush);
//Reloads PushPublishing Filters if all cache or system cache is flushed
Expand All @@ -186,7 +191,8 @@ public void processAction(
}
message = isAllCachesFlush ? "message.cmsmaintenance.cache.flushallcache" : "message.cmsmaintenance.cache.flushcache";
} else {
Logger.info(this, "Flushing Live and Working File Cache");
Logger.info(this, String.format(
"User '%s' is flushing Live and Working File Cache", cacheUserId));
_deleteFiles(com.dotmarketing.util.WebKeys.Cache.CACHE_LIVE_FILES);
_deleteFiles(com.dotmarketing.util.WebKeys.Cache.CACHE_WORKING_FILES);

Expand Down
2 changes: 2 additions & 0 deletions dotcms-integration/src/test/java/com/dotcms/MainSuite3a.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import com.dotcms.rest.api.v1.drive.ContentDriveKeywordSearchTest;
import com.dotcms.rest.api.v1.drive.ContentDriveWorkflowArchiveStepTest;
import com.dotcms.rest.api.v1.drive.ContentDriveWorkflowFilterTest;
import com.dotcms.rest.api.v1.system.cache.CacheResourceIntegrationTest;
import com.dotcms.security.apps.AppsAPIImplTest;
import com.dotcms.telemetry.collectors.MetricTimeoutTest;
import com.dotcms.telemetry.collectors.experiment.CountPagesWithAllEndedExperimentsMetricTypeTest;
Expand Down Expand Up @@ -98,6 +99,7 @@
TreeFactoryTest.class,
PublisherQueueJobTest.class,
ContentToStringUtilTest.class,
CacheResourceIntegrationTest.class,
})

public class MainSuite3a {
Expand Down
15 changes: 15 additions & 0 deletions ...ation/src/test/java/com/dotcms/rest/api/v1/system/cache/CacheResourceIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,21 @@ public void test_flushAll_existing_endpoint_returns_success() {
assertEquals(200, result.getStatus());
}

/**
* Given: Authenticated admin user
* When: deleteMenuCache is called
* Then: Returns success — covers the newly added user dereference on this path
*/
@Test
public void test_deleteMenuCache_returns_success() {

final ResponseEntityStringView result =
cacheResource.deleteMenuCache(mockAuthenticatedRequest(), mockResponse);

assertNotNull(result);
assertEquals("flushed menucache", result.getEntity());
}

// =========================================================================
// Helper
// =========================================================================
Expand Down
Loading