Provide a block for clearing caches from a dashboard

Are you a bot? Please refrain to act like that. Thanks.

sorry I will try to work on it.

There's nothing to work on this at the moment.

@elber You are definitely welcome to work on this. Really sorry if I looked annoyed, edited the previous comments.

I will take this issue as it has not had any feedback for a month.

Attached patch against core.

I will review it.

Hi I took a look on it.
Patch is good
Issue problem was fixed
route is also ok
Moving to RTBC

Hi!

Thank you for the patch.

Checked the code and I think that could be better to have an actual form instead of a link to clear the cache. In this way, we are exposing a URL to clear the cache remotely and that's not desirable, I think.
This is mitigated by the fact of the permission necessary to access to hat URL, but I think that a form is a better solution, like in /admin/config/development/performance.

Reusing Drupal\system\Form\ClearCacheForm could be a possibility as well.

Thanks @plopesc for the feedback!
I will work on this new form.

I've spent 2 hours debugging this but I cannot place this block. It just doesn't appear as an option nor in a dashboard nor in the general blocks page.
I've reviewed the code and didn't find anything wrong.

Oh the patch failed to apply and somehow didn't notice.

Solved the patching issue with -p2: https://github.com/penyaskito/dashboard-initiative/commit/6e3d13508f80bb...

+++ b/core/modules/system/src/Plugin/Block/ClearCacheBlock.php
@@ -0,0 +1,63 @@
+    return $this->formBuilder->getForm('Drupal\system\Form\ClearCacheForm');

The Clear cache form includes a collapsible details elements that make the dashboard look weird.

I think we should refactor the performance page controller so the details is out of the form itself.
We want to do the same on PerformanceForm for consistency.

Attached screenshot for clarity

Thanks @penyaskito for the fix!

As for the Cache block, I had the same feeling when I was working on this. So, I'm going to spend some time to refactor the performance page controller.

I have been checking the ClearCacheForm class in order to try to refactor the details element to get ride off it, but on my eyes this would be a "big" change in the look and feel of the config in Drupal.

The most of the config pages in Drupal are using this collapsible details element, also in the performance page, the performance form is using it, we could try to find a good alternative to change it only in the performance page, but I would say it should follow the same look and feel than the rest of the config pages in Drupal, so in this case I would try with two possible options here:

1. Create a new Clear cache form only with the submit button (I don't really like this option as we would be doing the same thing twice in a different way)
2. In the new Clear cache block which we are providing, once we get the Clear cache form in the build method, get ride off the details element.

Hi @gxleano

We could explore a 3rd option:

1. Remove the details wrapper from the ClearCacheForm definition, leaving there the button alone.
2. Add the details wrapper to the PerformanceController::build() method
3. Include the form within the wrapper created above

@plopesc proposal is what I tried to explain at #18, but he does better than me.

I'm fine with #17.2 if it works, and we can improve that when this is merged in core as a follow-up as a path to stable. Did you forget to attach the patch?

I like the option that @plopesc mention in #22 ✨ Provide a block for clearing caches from a dashboard Postponed , so I will attach the patch with this solution during the day.

Thanks to both!!

Fix patch #25 ✨ Provide a block for clearing caches from a dashboard Postponed

After applying the patch, everything works fine.

I've merge the usage of the patch in the gh repo. This looks good to me.
We need to decide yet if we are going to provide these blocks, or re-purpose this to get the patch in core.

plopesc → closed merge request !6

Created MR based on latest @gxleano's patch, including basic test coverage.

Tests are green, so let's get it reviewed!

Left a few small comments.

Also seems like will need a change record for the new block.

Thank you for your review @smustgrave

Added the missing type hints and created the Change Record draft ([#3414904])

Tested this on a standard install of 11.x
Applied the MR and cleared cache via drush
Went to the performance page and everything still appears the functional and the same.
Went to block layout and placed the new "Clear cache" block into the content region.
Confirmed it's there.
Clicking it appeared to clear the cache, same as performance page.

Issue summary + CR are present and appear completed.

Test coverage appears to cover the placement and usage.

+1 RTBC from me.

Block plugins should use attributes instead of annotations since 10.2.0.

You can also delete the annotation, we don't need both (or the duplicate class doc block).

Thanks for the quick review @longwave!

I though that it was removed in the MR.

Feedback appears to be addressed.

I'm triaging RTBC issues → . I read the IS, the comments and the CR. I didn't find any unanswered questions.

This is changing the UI and should be tagged Usability as well as provide screenshots, available from the issue summary. Not sure if this qualifies for a usability review.

The CR has all the data but it should put how to find the new block at the beginning instead of the end. Even a screenshot would help. It also has a error in tense, 'displayed name' should be 'display name'.

The issue summary explains that this feature is for the Dashboard initiative. The issue discussing that proposal is still active and therefor not approved. I am not aware that we make changes for unapproved plans. What other support is there for this feature?

Hi @quietone.

According to your last comment, I made the following changes:

• Merge 2 separated test methods into 1
• Add block screenshots to the IS
• Rephrase the CR and add block screenshot

As part of the dashboard initiative some blocks that could be useful for both the dashboard or administrator user in general were detected. In parallel, we are working in adding those blocks to core, so they would be already available when dashboard comes in, making dashboards more useful for admin users.

See ✨ Provide a block for running cron from a dashboard Needs work

Feedback appears to be addressed.

I use admin_toolbar to quickly clear cache but can imagine being able to place this feature somewhere could be useful.

Thank you for the updates, although I have not yet reviewed them all.

I asked about this issue in committer slack and this will need approval from the product managers, one of which is away until next week. I am adding tags, updating the remaining tasks and setting status to postponed.

Test Steps for Setting Up Drupal 11.x-dev

1. Setup Drupal 11.x-dev.
2. Apply the Merge Request (MR).
3. Navigate to:
   • Administration > Structure > Block layout
4. Place a Block:
   • Click the "Place block" button in the desired region.
   • Choose a block from the "Clear cache" section.
5. Check the Home Page:
   • Verify that the "Clear cache" block is displayed correctly.

Suggestion
I reviewed the code changes made in PerformanceController.php and ClearCacheForm.php, specifically regarding the removal of the wrapper for the "Clear Cache" block. I believe this is not an appropriate modification to the core functionality.
To test this, I completely removed the code from PerformanceController and ClearCacheForm, and observed that the "Clear Cache" block reverted to its default state.
I suggest that the necessary adjustments should be implemented within the plugin file itself, as a new block is created for the dashboard. This approach would be more suitable.
I have attached a screenshot → of the removed code for your review. Please take a look.

As a Drupal product manager, I think the feature makes sense as a directly working button.

Thanks @gabor

Believe this one is good then, all threads resolved on the MR. Test coverage appears to be there. Wasn't sure if we needed to add test to verify that cache is actually cleared but since the block is returning an existing form, ClearCacheForm, figured that's tested.