Provide some way to rebuild the persistent bundle field map

The Needs Review Queue Bot → tested this issue. It either no longer applies to Drupal core, or fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.

Adding a file patch in case anyone want to link. Identical to #38

If someone wanted to use the code in the patch:

function MYMODULE_update_10000(&$sandbox) {
  \Drupal::service('entity_field.manager')->rebuildBundleFieldMap();
}

Seems to be an open question in #34 could that be answered?

> Should I assert against an explicit expected bundle field map, or just test that it's the same before and after a rebuild. Normally I like to be really explicit in tests, but in this case I thought that would introduce additional brittleness, so I just test it's the same before and after.

I think testing it's the same before and after is potentially good, in that as you say it keeps the test simple.

And I see that the test is deleting the map -- so the intention is that we're checking that the rebuild actually can rebuild from scratch. However, we're not checking that after the deletion the map is empty!

> How complex a bundle field map should I be making for the test? I've kept it simple for the time being.

What are the different cases we should consider?

Also,

> public function rebuildBundleFieldMap() {

The other methods that work with the field map call it just 'field map', so the use of 'bundle' in this method name is confusing.

rebuildBundleFieldMap() should finish off by clearing the 'entity_field_map cache item, as otherwise it won't have any apparent effect.

Separate thought but: perhaps this can be leveraged to help with #3045509: EntityFieldManager::getFieldMap() doesn't show bundle fields → ?

I've opened a new MR against 11.x. Chose to cherry-pick the existing commits into a new MR because there were unrelated merge conflicts in the core branches between 9.3.x and 11.x. and I didn't want to force-push this old branch. Attaching a patch file for composer builds.

rebuildBundleFieldMap() should finish off by clearing the 'entity_field_map cache item, as otherwise it won't have any apparent effect.

I've added a final step to clear this cache item and updated tests to account for this. One thing I noticed is that these tests are implemented in a new Kernel test file - all of the existing EntityFieldManager tests seem to be unit tests. I'm not sure if that is a blocker for merging.

Thanks for the work on this! Gave it a whirl and seems to be working correctly for me:

• Changes in #45 seem to be addressed + match the way UseCacheBackendTrait does it
• Running drush php:eval "\Drupal::service('entity_field.manager')->rebuildBundleFieldMap()" to check works fine

nod_ → changed the visibility of the branch 9.3.x to hidden.

I left a question in the MR and some suggestions for the comments.

I ran this on a site with 31 entities and 1039 fields and it took 1.9 seconds on my local machine. I'm not sure this qualifies it as slow; it's certainly not slow compared to rebuilding node access as an example.