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

Standalone System - bring default Civi::paths factories in line with installer defaults #31150

Merged
merged 2 commits into from
Oct 8, 2024

Conversation

ufundo
Copy link
Contributor

@ufundo ufundo commented Sep 20, 2024

Overview

#29960 updated the default Standalone directory structure in a somewhat brute force way - by setting path overrides in the installer, that are then written out into civicrm.settings.php

This returns to CRM_Utils_System_Standalone to bring the underlying defaults in line with the directory structure changes.

Before

civicrm.settings.php contains many path overrides
image

Even though they just reiterate our intended defaults, removing them will cause your system to crash because the underlying defaults are different.

After

The above overrides will all still be set by the installer.

But if you haven't diverged from the default, those lines can be safely removed.

This is a helpful step to reduce reliance on civicrm.settings.php in a portable context (e.g. Docker container).

Technical Details

In many cases having these paths fixed in your civicrm.settings.php makes sense: if the defaults ever change in the codebase, your folders will still be where they were at install time, so the "frozen" copy of the paths is helpful.

But we shouldn't rely on the settings file to provide defaults.

Some extraneous bootstap code in CRM_Utils_System_Standalone is removed which otherwise caused a crash by trying to read directly $civicrm_paths. The line is trying to reload the autoloader - which is always handled in Standalone context by civicrm.standalone.php.

Copy link

civibot bot commented Sep 20, 2024

🤖 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 Sep 20, 2024
@ufundo ufundo marked this pull request as ready for review September 20, 2024 17:34
@ufundo
Copy link
Contributor Author

ufundo commented Sep 20, 2024

There's some crossover between this and #31150

I will attempt to take the paths stuff out of that PR because this one is a more logical package 📦

@ufundo ufundo added the run-standalone Civibot should setup demos+tests for Standalone label Sep 20, 2024
@wmortada
Copy link
Contributor

wmortada commented Sep 20, 2024

There's some crossover between this and #31150

More than a little crossover. I'd say they are identical! 😉

@ufundo
Copy link
Contributor Author

ufundo commented Sep 20, 2024

(just to note the upgrade tests are failing for other reasons)

@ufundo
Copy link
Contributor Author

ufundo commented Sep 20, 2024

Oops, thanks @wmortada !

The PR with not as much crossover but some is #31127

I think it would preferable to merge this first, and rebase 31127 onto this.

@colemanw
Copy link
Member

colemanw commented Oct 8, 2024

Better to get rid of the cruft now than later.

@colemanw colemanw merged commit fea13e0 into civicrm:master Oct 8, 2024
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
master run-standalone Civibot should setup demos+tests for Standalone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants