Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrader - Ensure rebuildMenuAndCaches() runs with fresh container #32339

Merged
merged 1 commit into from
Mar 11, 2025

Conversation

totten
Copy link
Member

@totten totten commented Mar 11, 2025

Overview

Address a scenario wherein web-based upgrades on the wmff build-type encounter error "You have requested a non-existent service "afform_scanner".

(This may well affect other configurations -- but this is the scenario that could be tested/reproduced.)

Before

The upgrade-step doCoreFinish() is responsible for enabling extensions to run, and it calls rebuildMenuAndCaches().

However, during this transitional step, it still has a stale copy of Civi\Core\Container which was built without extensions. Thus, the live copy of Civi\Core\Container may be missing artifacts (such as afform_scanner) which are required by some extensions during rebuildMenuAndcaches()

After

The upgrade-step doCoreFinish() is responsible for enabling extensions to run. But it doesn't immediately call rebuildMenuAndCaches(). Instead, it defers to the next step.

This provides an opportunity to shutdown/restart the Civi\Core\Container.

Comments

I wonder what the upgrade-tests will think...

Copy link

civibot bot commented Mar 11, 2025

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
Quick links for reviewers...

➡️ Online demo of this PR 🔗

@civibot civibot bot added the master label Mar 11, 2025
@eileenmcnaughton
Copy link
Contributor

This worked - I got a different error of max execution time of 0 exceeded - but I've seen that already prior to this change so it's not caused by it (google suggests it might indicate a loop but I don't know at this stage - it's during the schema rebuild)

@eileenmcnaughton eileenmcnaughton merged commit c6c3618 into civicrm:master Mar 11, 2025
1 check passed
@totten totten deleted the master-split-dofinish branch March 11, 2025 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants