dev:template-hints:enable/disable commands ignore locked configuration

[lbajsarowicz]

Preconditions and environment

• Magento version: 2.4.x (confirmed on 2.4.7)
• The config path dev/debug/template_hints_storefront is locked in app/etc/env.php or app/etc/config.php

Example app/etc/env.php:

'system' => [
    'default' => [
        'dev' => [
            'debug' => [
                'template_hints_storefront' => '0'
            ]
        ]
    ]
]

Steps to reproduce

1. Lock the dev/debug/template_hints_storefront value in app/etc/env.php (as shown above)
2. Run bin/magento dev:template-hints:enable
3. Observe the output
4. Run bin/magento dev:template-hints:disable
5. Observe the output

Expected result

Both commands should detect that the configuration path is locked and report an error, consistent with how bin/magento config:set handles locked values:

The value you set has already been locked. To change the value, use the --lock-env option.

The commands should return a failure exit code without modifying the database.

Actual result

Both commands display a misleading success message regardless of the lock status:

$ bin/magento dev:template-hints:enable
Template hints enabled.

$ bin/magento dev:template-hints:disable
Template hints disabled. Refresh cache types

The commands write the value to the core_config_data database table, but the locked value in env.php / config.php takes precedence at runtime, so the change has no actual effect. The user receives false confirmation.

Additional information

Root cause:

Both TemplateHintsEnableCommand and TemplateHintsDisableCommand (vendor/magento/module-developer/Console/Command/) use ConfigInterface::saveConfig() directly without checking deployment config for locked values:

// TemplateHintsEnableCommand.php:56
$this->resourceConfig->saveConfig('dev/debug/template_hints_storefront', 1, 'default', 0);
$output->writeln("<info>". self::SUCCESS_MESSAGE . "</info>");

The config:set command already handles this correctly in Magento\Config\Console\Command\ConfigSet\DefaultProcessor::process() by calling isLocked() which checks DeploymentConfig::get() before attempting to save:

if ($this->isLocked($path, $scope, $scopeCode)) {
    throw new CouldNotSaveException(__(
        'The value you set has already been locked. To change the value, use the --%1 option.',
        ConfigSetCommand::OPTION_LOCK_ENV
    ));
}

The template hints commands should implement the same check using DeploymentConfig and ConfigPathResolver, or be refactored to use the existing ConfigSet\DefaultProcessor.

Release note

The dev:template-hints:enable and dev:template-hints:disable CLI commands now correctly detect when the configuration value is locked in app/etc/env.php or app/etc/config.php and report an error instead of displaying a false success message.

Triage and priority

• S3 - Affects non-critical data or functionality and does not force users to employ a workaround.

---

⭐ Support my work

Do you like my work? Remember to react with "👍🏻" to get it fixed faster,
Then Sponsor me on Github so I can spend more time on fixing issues like this one.

Learn more at https://github.com/sponsors/lbajsarowicz

[m2-assistant]

Hi @lbajsarowicz. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce.

• For more details, review the Magento Contributor Assistant documentation.
• Add a comment to assign the issue: @magento I am working on this
• To learn more about issue processing workflow, refer to the Code Contributions.

---

Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[m2-assistant]

Hi @engcom-Bravo. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
• 5. Add label Issue: Confirmed once verification is complete.
• 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-Bravo]

Hi @lbajsarowicz,

Thanks for your reporting and collaboration.

We have tried to reproduce the issue in Latest 2.4-develop instance and we are able to reproduce the issue.Kindly refer the screenshots.

Hence Confirming the issue.

Thanks.