If purge_queuer_coretags.settings config object is missing or null, purging does not happen

Created on 7 June 2018, about 6 years ago

Updated 28 September 2023, 9 months ago

This is caused by this line in \Drupal\purge_queuer_coretags\CacheTagsQueuer::initialize():

        $this->blacklistedTagPrefixes = $this->container
          ->get('config.factory')
          ->get('purge_queuer_coretags.settings')
          ->get('blacklist');

        // Make sure to disable ourselves during module installation.
        if (!is_array($this->blacklistedTagPrefixes)) {     ### HERE HERE HERE
          $this->queuer = FALSE;
          return FALSE;
        }

For an site where we did not have any configuration (not even an empty array) for the blacklist, this triggered the purging from not ever happening. So if you have this:

$ drush cget purge_queuer_coretags.settings
 [error]  Config purge_queuer_coretags.settings does not exist

... then purging won't work.

Going to /admin/config/development/performance/purge and adding a blacklist tag under "Core Tags queuer > Configure" then made purging work again.

So, perhaps this idea of "Make sure to disable ourselves during module installation" mentioned in the comment in the above piece of code, seems to be trying to use the "lack of configuration" as a sign "the module is not installed yet"... but is the very thing that needs fixing.

🐛 Bug report

Status

Fixed

Version

3.0

Component

Code

Created by

🇺🇸United States janusman

Live updates comments and jobs are added and updated live.

Incomplete comments

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

First commit to issue fork.
Comment 9 months ago →
🇺🇸United States japerry KVUO
Looking at the initialize code, it seems the problem is if blacklist is null instead of an array. By setting it to an empty array should fix this issue without causing a regression that this code initially solved (Line 94 of CacheTagsQueuer.php was throwing invalid key in certain situations)
Status changed to Needs review 9 months ago5:53pm 28 September 2023
Open in Jenkins → Open on Drupal.org →
Core: 9.5.5 + Environment: PHP 7.4 & MySQL 5.7
last update 9 months ago
610 pass
@japerry opened merge request.
Comment 9 months ago →
System Message

japerry → committed 3a6a46f7 on 8.x-3.x
Issue #2978195 by japerry: If purge_queuer_coretags.settings config...
Status changed to Fixed 9 months ago6:03pm 28 September 2023
Comment 9 months ago →
🇺🇸United States japerry KVUO
Comment 9 months ago →
System Message
Automatically closed - issue fixed for 2 weeks with no activity.

contrib.social Blog FAQ Discussions

Production build 0.69.0 2024