Make Patternkit Pattern Entity Cache Invalidation Configurable

slucero → changed the visibility of the branch 3469294-make-patternkit-pattern to hidden.

After further testing, I've uncovered that the existing behavior (the currently proposed default) is not terribly helpful for several reasons:

• When patterns are used in the default layout for a content type, the cache tags present for it don't matter as much for invalidation during pattern updates since the related updates to the default layout invalidate a tag like config:core.entity_view_display.node.page.default which is present on every page of that content type using that display mode regardless whether it is overridden. Due to this, every page of that content type will be invalidated regardless.
• When used on overridden layouts, including the invalidation of the patternkit_pattern:<id> cache tags will result in all pages containing this pattern being invalidated when a single instance of the pattern is updated. These other blocks won't show any changes, however, since they still point to the prior revision of the pattern entity. The same behavior is true for pattern:<asset_id>cache tags which also get invalidated on update with this setting enabled.

Based on these findings, I'll be updating the default value for this new setting to FALSE which will represent a change in behavior for most sites already. This change should be for the better, however, by bringing cache invalidation more in line with visible changes to the content.

Steps to test

1. Install a site locally with the following modules enabled:
   • Patternkit
   • Patternkit Example
   • Layout Builder
2. Enable cache header output →
3. Configure the Basic Page content type to use layout builder with per-page overrides enabled
4. Configure the default layout for Basic Page and add an instance of "[Patternkit] Example"
5. Create 2 new Nodes of the Basic Page content type: Page 1, and Page 2
6. Edit the layout for Page 2, override the layout saving a change to the content of the example pattern block

1. As an administrator, navigate to the Patternkit settings page at /admin/config/user-interface/patternkit, enable the checkbox for "Entity cache tag invalidation" under "Advanced settings", and click the "Save configuration" button
2. In your local files, update the template file for the "[Patternkit] Example" pattern to trigger detection of a new update to the pattern being available
   1. Edit the file at modules/patternkit_example/lib/patternkit/src/atoms/example/src/example.twig in the Patternkit module directory
   2. Add some visible markup, such as <strong>UPDATED</strong>, into the template so it will be clearly visible when the new template is used
   3. Clear the Patternkit cache to discover the update: drush pkcc
   4. As an administrator, edit the layout for Page 2, edit the example block, and confirm the button to "Update pattern" is available at the top of the pattern form
3. As an anonymous user, view both pages confirming a successful cache response on each

Results : Both pages show the previous content (before template changes), indicating that the cache is serving old content due to a cache hit.

4. As an administrator, edit the layout for Page 2, edit the example block, click the "Update Pattern" button, and save the block. Expect to see the altered content from your template edits visible in the block preview and click "Save layout".
5. As an anonymous user, view both pages expecting to see a cache miss for each

• Results:

• Page 1: Shows a cache miss, displaying old content since Page 1 should not have been affected.
• Page 2: Shows the updated content and cache miss, confirming that the cache for Page 2 was correctly invalidated and updated.

1. Ensure all pattern instances are up to date by running drush pkbu
2. Clear all caches with drush cr
3. As an anonymous user, view each page twice ensuring the second view returns a cache hit for each

Results: Both pages return cache hit on second visit.

4. In your local files, update the template file for the "[Patternkit] Example" pattern to trigger detection of a new update to the pattern being available
   1. Edit the file at modules/patternkit_example/lib/patternkit/src/atoms/example/src/example.twig in the Patternkit module directory
   2. Add some visible markup, such as <strong>UPDATED AGAIN</strong>, into the template so it will be clearly visible when the new template is used
   3. Clear the Patternkit cache to discover the update: drush pkcc
   4. As an administrator, edit the layout for Page 2, edit the example block, and confirm the button to "Update pattern" is available at the top of the pattern form (Do not click the button yet)
5. As an anonymous user, view both pages confirming a successful cache response on each

Results: Both pages return cache hit

6. As an administrator, edit the layout for Page 2, edit the example block, click the "Update Pattern" button, and save the block. Expect to see the altered content from your template edits visible in the block preview and click "Save layout".
7. As an anonymous user, view all both noting the page cache result
   • Expect to see a cache hit on Page 1 with the content of the block showing the previous edits
   • Expect to see a cache miss on Page 2 with the content of the block showing the latest edits

• Results:

• Page 1: Shows the previous content (old template) with previous edits, confirming a cache hit.
• Page 2: Shows the latest content with new template changes, with cache miss

Merged for inclusion in the 1.0 release.

Automatically closed - issue fixed for 2 weeks with no activity.

@slucero, I re-opened this issue, because the latest update hook did not save the config entity. I'm proposing a fix in this MR: https://git.drupalcode.org/project/patternkit/-/merge_requests/144

Thank you.

@krisahil, good catch and thank you for opening up the MR to address it already! That looks good to me. Let's go ahead and get it merged in and I'll cut a new 1.0.1 release so it's available for anyone who hasn't started the process to upgrade to 1.0 yet.

Merged for inclusion in the 9.1.1 bug fix release.