Contrib.social

Cache issue with local actions

Open on Drupal.org →
Created on 6 February 2025, 3 months ago

Problem/Motivation

When I install the module the local actions cache is not revalidated correctly.
In this example I have two roles, "Content Basic" and "Content Admin".

  • Content Basic: You have the "Access the Content overview page" permission
  • Content Admin: Has the permission "Access the Content overview page" and "Basic page: Create new content"

If I create a new user and add the "Content Basic" role and navigate to the "/admin/content" page, he will be able to view it as expected.

Now I change the user's role to "Content Admin" and reload the "/admin/content" page.

The expected result would be that an "Add content" button would be added to the local actions, but I still don't have any local action.

Now if I clear the cache and reload the page the "Add content" button will appear as expected.

The opposite effect also happens, if you change the role to "Content Basic" and reload the page the "Add content" button will continue to appear, it will only be removed after clearing the cache.

Steps to reproduce

  1. Do a standard drupal installation.
  2. Install the micro_site module.
  3. Create two roles: "Content Basic" and "Content Admin"
  4. In the "Content Basic" role add the permissions: "Access the Content overview page", "View the administration theme"
  5. In the "Content Admin" role add the permissions: "Basic page: Create new content", "Access the Content overview page", "View the administration theme"
  6. Create a new user with the "Content Basic" role.
  7. Logging in with the created user.
  8. Navigate to the "/admin/content" page.
  9. Check that the "Add content" button (local action) is not present, as expected.
  10. Changing the user role from "Content Basic" to "Content Admin".
  11. Reload the "/admin/content" page and verify that the "Add Content" button is not appearing, even though the user now has permissions for the action.
  12. Clear the cache, reload the "/admin/content" page and check that the "Add Content" button now appears, as expected.

Proposed resolution

After investigating a bit it seems to me that the problem is being created by replacing the "router.route_provider" service in the src/MicroSiteServiceProvider.php file.

From some quick tests I did it seems the issue will be resolved if I add 'user.roles' as required_cache_contexts.

...
class MicroSiteServiceProvider extends ServiceProviderBase implements ServiceModifierInterface {

  /**
   * {@inheritdoc}
   */
  public function alter(ContainerBuilder $container) {
      ...
      // Permissions related to site context are based on user referenced by site.
      // We need so to add the user as a cache context.
      if (!in_array('user', $renderer_config['required_cache_contexts'])) {
        $renderer_config['required_cache_contexts'][] = 'user';
        $renderer_config['required_cache_contexts'][] = 'user.roles';
      }
      ...
  }
}

Remaining tasks

Check if this solution break any system in the module.

User interface changes

None.

API changes

None.

Data model changes

None.

🐛 Bug report
Status

Active

Version

1.0

Component

Code

Created by

🇵🇹Portugal lolgm

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @lolgm
  • Merge request !10Fix local actions cache → (Open) created by lolgm
  • Comment 3 months ago →
    🇵🇹Portugal lolgm

    MR !10 has the solution proposed in the issue.

  • Pipeline finished with Failed
    3 months ago
    Total: 167s
    #416824
  • Comment about 2 months ago →
    🇫🇷France flocondetoile Lyon

    I don't understand why micro_site is involved with the /admin/content page (it only provide site entity and related features, and don't change change the node behaviors). This module don't change this page, and don't change any permissions. You should have same bug without micro_site enabled ?

  • Comment about 1 month ago →
    🇵🇹Portugal lolgm

    The issue with the local actions cache occurs on all Drupal pages as soon as the micro_site module is activated.

    I used the "/admin/content" page as an example because it's included in the default Drupal installation, making it easier to demonstrate that the problem only arises after enabling the micro_site module. However, the same behavior can be reproduced on any other page containing local actions, following the same testing methodology.

    I've tested this on two clean, standard Drupal installations (versions 10.4.3 and 11.1.3) and observed consistent behavior in both scenarios: upon activating the micro_site module, the local actions caching problem appeared, and uninstalling the module resolved the issue immediately.

    Through my tests, I identified that the root cause is within the Drupal\micro_site\MicroSiteServiceProvider class, which makes sense since this class overrides Drupal core's router.route_provider service.

    Considering the above, I can confirm that the proposed solution resolves the issue in both Drupal versions tested (10.4.3 and 11.1.3).

  • Comment about 1 month ago →
    🇫🇷France flocondetoile Lyon

    This module should not altering this behavior. It's not its responsabilities to add the user.roles context for local action links. Your fix does the job, but doesn't fix the root cause I think. The best way would be (perhaps) to stop overriding route.route_provider and start using addExtraCacheKeyPart() (as domain did it see https://www.drupal.org/project/domain/issues/3359253 ✨ Use core route provider with addExtraCacheKeyPart for route caching? Needs review ).

    But is this override which is the root cause ? What happens if this module stop to override the Class of the router.route_provider service ?

  • Comment about 1 month ago →
    🇵🇹Portugal lolgm

    Based on my testing, the root cause seems to be the addition of the user as a cache context. Removing this line resolves the issue and provides the expected behavior. (See: MicroSiteServiceProvider.php#L36)

    I simulated the use of a micro site with "Users management" and several users but I was unable to notice any difference with the removal of the user as a cache context.

    @flocondetoile My knowledge regarding router.route_provider and cache contexts is somewhat limited. However, since adding the user cache context appears to be the root cause, do you think the solution implemented by the Domain module in #6 would still be applicable here?

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024