Problem

Given the following two script files in my web directory that I run with drush:

// In web/config-cache-test.php:
$storage = \Drupal::entityTypeManager()->getStorage('filter_format');
$ids = $storage->getQuery()->execute();
print_r($ids);

// This is important that this gets run in a separate process.
drush_invoke_process('@self', 'scr', ['config-create']);

// Attempt to reset the entity storage cache before querying again.
$storage->resetCache();

$ids = $storage->getQuery()->execute();
print_r($ids);

// In web/config-create.php:
$storage = \Drupal::entityTypeManager()->getStorage('filter_format');
$filter_format = $storage->create([
  'format' => 'test',
  'name' => 'Test',
]);
$filter_format->save();

Expected Results

➜  drush scr config-cache-test
Array
(
    [basic_html] => basic_html
    [full_html] => full_html
    [plain_text] => plain_text
    [restricted_html] => restricted_html
)
Array
(
    [basic_html] => basic_html
    [full_html] => full_html
    [plain_text] => plain_text
    [restricted_html] => restricted_html
    [test] => test
)

Actual Results

➜  drush scr config-cache-test
Array
(
    [basic_html] => basic_html
    [full_html] => full_html
    [plain_text] => plain_text
    [restricted_html] => restricted_html
)
Array
(
    [basic_html] => basic_html
    [full_html] => full_html
    [plain_text] => plain_text
    [restricted_html] => restricted_html
    // <--- Missing test ID here
)

But If I were to add \Drupal::configFactory()->reset(); in addition to the $storage->resetCache(); then it does work as expected.

Proposed Solution

Override \Drupal\Core\Config\Entity\ConfigEntityStorage::resetCache() and have it call $this->configFactory->reset() which should avoid needing to call two separate resets.

CommentFileSizeAuthor
#24 interdiff_22-24.txt3.17 KBvsujeetkumar
#24 2987978-24.patch4.91 KBvsujeetkumar
#22 2987978-22.patch1.59 KBAjeet Tiwari
#20 interdiff.txt256 byteszeeshan_khan
#20 2987978-7.patch789 byteszeeshan_khan
#6 2987978-config-storage-factory-not-reset.patch778 bytesdave reid
#4 2987978-config-storage-factory-not-reset.patch783 bytesdave reid

Issue fork drupal-2987978

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

Dave Reid created an issue. See original summary.

dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented
Issue summary: View changes
dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented
Title: ConfigEntityStorage::resetCache does not reset ConfigFactory cache; config entities cached twice » ConfigEntityStorage::resetCache() does not call ConfigFactory::reset()
dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented
Status: Active » Needs review
Issue tags: +Needs tests
StatusFileSize
new 2987978-config-storage-factory-not-reset.patch783 bytes

Status: Needs review » Needs work

The last submitted patch, 4: 2987978-config-storage-factory-not-reset.patch, failed testing. View results

dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented
Status: Needs work » Needs review
StatusFileSize
new 2987978-config-storage-factory-not-reset.patch778 bytes

Try that again...

Status: Needs review » Needs work

The last submitted patch, 6: 2987978-config-storage-factory-not-reset.patch, failed testing. View results

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented
Related issues: +#2635440: Document what cache clearing from ContentEntityStorageBase::resetCache() actually clears

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Issue tags: +Bug Smash Initiative, +Needs reroll, +Pittsburgh 2023

zeeshan_khan made their first commit to this issue’s fork.

zeeshan_khan’s picture

zeeshan_khan commented
StatusFileSize
new 2987978-7.patch789 bytes
new interdiff.txt256 bytes

Patch rerolled with 11.x

chrisdarke’s picture

chrisdarke commented
Issue tags: -Pittsburgh 2023 +Pittsburgh2023

Migrating Pittsburgh 2023 to Pittsburgh2023 tag for cleanup

Ajeet Tiwari’s picture

Ajeet Tiwari commented
Status: Needs work » Needs review
StatusFileSize
new 2987978-22.patch1.59 KB

Please review.

Status: Needs review » Needs work

The last submitted patch, 22: 2987978-22.patch, failed testing. View results

vsujeetkumar’s picture

vsujeetkumar commented
Status: Needs work » Needs review
Issue tags: -Needs tests, -Needs reroll
StatusFileSize
new 2987978-24.patch4.91 KB
new interdiff_22-24.txt3.17 KB

Test cases added, Removed tags, Please have a look.

smustgrave’s picture

smustgrave commented
Status: Needs review » Needs work

Think the tests need to be tweaked. Even without the fix

testDelete
testSaveChangedUuid
testSaveRename
testSaveInsert

Still passed.

Version: 11.x-dev » main

Drupal core is now using the main branch as the primary development branch. New developments and disruptive changes should now be targeted to the main branch.

Read more in the announcement.