Skip to content

feat(cache): Add ability for optional custom prefix for Redis/Memcached cache keys #58334

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

Closed
Earl0fPudding wants to merge 6 commits into from
Closed

feat(cache): Add ability for optional custom prefix for Redis/Memcached cache keys #58334

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8db48ac
Add memcache.customprefix to Cache.php
Earl0fPudding Feb 13, 2026
500bc06
Revert changes in Cache.php
Earl0fPudding Feb 17, 2026
b0b212e
Add ability to set custom cache prefix in Factory.php
Earl0fPudding Feb 17, 2026
ff93f53
Change customprefix integration to prepend the prefix hash in Factory…
Earl0fPudding Feb 18, 2026
488043d
Remove slash between hash and custom prefix in Factory.php
Earl0fPudding Feb 20, 2026
2f655e7
Add example config for memcache_customprefix in config.sample.php
Earl0fPudding Feb 26, 2026
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
51 changes: 32 additions & 19 deletions lib/private/Memcache/Factory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,23 +115,29 @@ public function __construct(
protected function getGlobalPrefix(): string {
if ($this->globalPrefix === null) {
$config = Server::get(SystemConfig::class);
$maintenanceMode = $config->getValue('maintenance', false);
$versions = [];
if ($config->getValue('installed', false) && !$maintenanceMode) {
$appConfig = Server::get(IAppConfig::class);
// only get the enabled apps to clear the cache in case an app is enabled or disabled (e.g. clear routes)
$versions = $appConfig->getAppInstalledVersions(true);
ksort($versions);
} else {
// if not installed or in maintenance mode, we should distinguish between both states.
$versions['core:maintenance'] = $maintenanceMode ? '1' : '0';
$customprefix = $config->getValue('memcache.customprefix', '');
Comment thread
Earl0fPudding marked this conversation as resolved.
Outdated
// use the value of memcache.customprefix setting as prefix if set
if ($customprefix != '') {
Comment thread
Earl0fPudding marked this conversation as resolved.
Outdated
$this->globalPrefix = $customprefix;
} else {
$maintenanceMode = $config->getValue('maintenance', false);
$versions = [];
if ($config->getValue('installed', false) && !$maintenanceMode) {
$appConfig = Server::get(IAppConfig::class);
// only get the enabled apps to clear the cache in case an app is enabled or disabled (e.g. clear routes)
$versions = $appConfig->getAppInstalledVersions(true);
ksort($versions);
} else {
// if not installed or in maintenance mode, we should distinguish between both states.
$versions['core:maintenance'] = $maintenanceMode ? '1' : '0';
}
$versions['core'] = implode('.', $this->serverVersion->getVersion());

// Include instanceid in the prefix, in case multiple instances use the same cache (e.g. same FPM pool)
$instanceid = $config->getValue('instanceid');
$installedApps = implode(',', array_keys($versions)) . implode(',', array_values($versions));
$this->globalPrefix = hash('xxh128', $instanceid . $installedApps);
}
$versions['core'] = implode('.', $this->serverVersion->getVersion());

// Include instanceid in the prefix, in case multiple instances use the same cache (e.g. same FPM pool)
$instanceid = $config->getValue('instanceid');
$installedApps = implode(',', array_keys($versions)) . implode(',', array_values($versions));
$this->globalPrefix = hash('xxh128', $instanceid . $installedApps);
}
return $this->globalPrefix;
}
Expand All @@ -145,9 +151,16 @@ protected function getGlobalPrefix(): string {
public function withServerVersionPrefix(\Closure $closure): void {
$backupPrefix = $this->globalPrefix;

// Include instanceid in the prefix, in case multiple instances use the same cache (e.g. same FPM pool)
$instanceid = Server::get(SystemConfig::class)->getValue('instanceid');
$this->globalPrefix = hash('xxh128', $instanceid . implode('.', $this->serverVersion->getVersion()));
$config = Server::get(SystemConfig::class);
$customprefix = $config->getValue('memcache.customprefix', '');
// use the value of memcache.customprefix setting as prefix if set
if ($customprefix != '') {
Comment thread
Earl0fPudding marked this conversation as resolved.
Outdated
$this->globalPrefix = $customprefix . '_v' . implode('.', $this->serverVersion->getVersion());
} else {
// Include instanceid in the prefix, in case multiple instances use the same cache (e.g. same FPM pool)
$instanceid = Server::get(SystemConfig::class)->getValue('instanceid');
$this->globalPrefix = hash('xxh128', $instanceid . implode('.', $this->serverVersion->getVersion()));
}
$closure($this);
$this->globalPrefix = $backupPrefix;
}
Expand Down