Skip to content

Update set_cache_prefix task of Magento 2 recipe to modify files directly on the server #4166

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

Open
flobeier wants to merge 2 commits into
base: master
Choose a base branch
from
+43 −31
Open

Update set_cache_prefix task of Magento 2 recipe to modify files directly on the server #4166

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
672ac67
Update magento2.php
flobeier Feb 17, 2026
3ca840e
Update magento2.php
flobeier Feb 18, 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
75 changes: 44 additions & 31 deletions recipe/magento2.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,39 +478,52 @@ function magentoDeployAssetsSplit(string $area)
**/
desc('Update cache id_prefix');
task('magento:set_cache_prefix', function () {
//download current env config
$tmpConfigFile = tempnam(sys_get_temp_dir(), 'deployer_config');
download('{{deploy_path}}/shared/' . ENV_CONFIG_FILE_PATH, $tmpConfigFile);
$envConfigArray = include($tmpConfigFile);
//set prefix to `alias_releasename_`
$prefixUpdate = get('alias') . '_' . get('release_name') . '_';

//check for preload keys and update
if (isset($envConfigArray['cache']['frontend']['default']['backend_options']['preload_keys'])) {
$oldPrefix = $envConfigArray['cache']['frontend']['default']['id_prefix'];
$preloadKeys = $envConfigArray['cache']['frontend']['default']['backend_options']['preload_keys'];
$newPreloadKeys = [];
foreach ($preloadKeys as $preloadKey) {
$newPreloadKeys[] = preg_replace('/^' . $oldPrefix . '/', $prefixUpdate, $preloadKey);
$envConfigFile = "{{deploy_path}}/shared" . '/' . ENV_CONFIG_FILE_PATH;
$tmpEnvConfigFile = "{{deploy_path}}/shared" . '/' . TMP_ENV_CONFIG_FILE_PATH;
$newPrefix = get('alias') . '_' . get('release_name') . '_';

$phpCode = <<<'PHP'
$envConfigFile = $argv[1];
$tmpEnvConfigFile = $argv[2];
$newPrefix = $argv[3];
$config = include $envConfigFile;

$defaultCache = &$config['cache']['frontend']['default'];
$pageCache = &$config['cache']['frontend']['page_cache'];

$oldPrefix = $defaultCache['id_prefix'] ?? '';

// Update preload_keys if they exist to match the new prefix
if (isset($defaultCache['backend_options']['preload_keys'])) {
foreach ($defaultCache['backend_options']['preload_keys'] as &$key) {
if ($oldPrefix !== '' && str_starts_with($key, $oldPrefix)) {
$key = $newPrefix . substr($key, strlen($oldPrefix));
}
}
}
$envConfigArray['cache']['frontend']['default']['backend_options']['preload_keys'] = $newPreloadKeys;
}

//update id_prefix to include release name
$envConfigArray['cache']['frontend']['default']['id_prefix'] = $prefixUpdate;
$envConfigArray['cache']['frontend']['page_cache']['id_prefix'] = $prefixUpdate;

//Generate configuration array as string
$envConfigStr = '<?php return ' . var_export($envConfigArray, true) . ';';
file_put_contents($tmpConfigFile, $envConfigStr);
//upload updated config to server
upload($tmpConfigFile, '{{deploy_path}}/shared/' . TMP_ENV_CONFIG_FILE_PATH);
//cleanup tmp file
unlink($tmpConfigFile);
//delete the symlink for env.php
run('rm {{release_or_current_path}}/' . ENV_CONFIG_FILE_PATH);
//link the env to the tmp version
run('{{bin/symlink}} {{deploy_path}}/shared/' . TMP_ENV_CONFIG_FILE_PATH . ' {{release_path}}/' . ENV_CONFIG_FILE_PATH);
// Apply the new prefix
$defaultCache['id_prefix'] = $newPrefix;
$pageCache['id_prefix'] = $newPrefix;

// Save with clean formatting
$content = "<?php\nreturn " . var_export($config, true) . ";\n";
file_put_contents($tmpEnvConfigFile, $content);
PHP;

// Run PHP code on server
run(sprintf(
Copy link
Copy Markdown
Member

@antonmedv antonmedv Feb 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is strange. Lets not do this way.

Copy link
Copy Markdown
Author

@flobeier flobeier Feb 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What alternative way do you suggest?

Copy link
Copy Markdown
Member

@antonmedv antonmedv Feb 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use deployer primitives.

Copy link
Copy Markdown
Author

@flobeier flobeier Feb 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the code to use {{bin/php}} and removed sprintf, is it better now?

'php -r %s %s %s %s',
escapeshellarg($phpCode),
escapeshellarg($envConfigFile),
escapeshellarg($tmpEnvConfigFile),
escapeshellarg($newPrefix)
));

// Remove symlink for env.php
run("rm {{release_or_current_path}}/" . ENV_CONFIG_FILE_PATH);
// Create symlink to tmp env file
run("{{bin/symlink}} $tmpEnvConfigFile {{release_path}}/" . ENV_CONFIG_FILE_PATH);
});

/**
Expand Down