Allow modules to add their own cache tags to a specific routing cache entry

This will need test coverage, typically with adding new parameters it has to be backwards compatible.

Issue summary appears to be missing sections, and this appears to be updating the API so that should be noted.

Probably will need subsystem maintainer sign off.

Patch rerolled for 10.3.

Hi guys, I have applied this patch temporary for my business requirements, could you please help me to find the right way to fix this? I was trying to add cacheContexts(), cacheTags() and even cacheMaxAge() but it doesn't help me, routing cache don't work correctly. Thanks!

@maksim_matuzka, can you clarify your goal more precisely?

Additionally, the patch you shared is a custom implementation addressing your specific business requirement rather than a general solution applicable to all users. Sharing it as a .patch file might mislead other developers searching for a fix.

Instead, consider sharing your code as a code block within your comment, making it clear that it's tailored to your use case.

I recommend deleting the patch file and instead posting a new comment that clearly explains your goal. This will help others better understand your specific requirement and provide more relevant guidance.

Hi @camilo.escobar,

How to disable cache for the specific route?

@maksim_matuzka, there are several ways to do this, depending on the origin of the route you want to modify.

If it’s a custom route

A) Modify the route definition

You can add the no_cache attribute to the route definition in yourmodule.routing.yml:

yourmodule.custom_route:
  path: '/my-custom-route'
  defaults:
    _controller: '\Drupal\yourmodule\Controller\CustomRoute::build'
    _title_callback: '\Drupal\yourmodule\Controller\CustomRoute::getTitle'
  requirements:
    _permission: 'access content'
  options:
    no_cache: 'TRUE'

B) Disable cache in the controller

You can also call the following function inside the controller handling the route:
\Drupal::service('page_cache_kill_switch')->trigger();

You can try A and B together for a more robust solution.

If the page is generated by a View

Explore the View cache options in the UI and disable caching.

If the page is a node

You can assign the node's render array ($build) a cache max-age<> of <code>0, inside a hook_node_view:

function mymodule_node_view(array &$build, NodeInterface $node, $display, $view_mode) {
  if ($node->getType() == 'yourtype' && YOUR_OTHER_CONDITIONS) {
    $build['#cache']['max-age'] = 0;
  }
}

I hope one of these methods works for you. However, patching Drupal Core is not the right approach for this issue. This issue and the patches provided here address a different purpose and should not be used as a solution in your case.

And again, please delete the patch you provided, as it could mislead other developers searching for a fix.