dev/joomla#26 - Fix path derivation when CMS is rooted in a subdir

[totten]

Overview

CiviCRM is deployed inside a CMS. The CMS is usually deployed at the HTTP root (http://example.org), but it is sometimes deployed in a subdirectory (http://example.org/my-cms).

Some asset URLs are computed using the variables [civicrm.bower], [civicrm.packages], and [civicrm.vendor], which are derived from the value of [civicrm.root]. However, if the site is deployed in a subdirectory, then the computation of [civicrm.bower] (etc) can misbehave.

(The problem has been reported in 5.23. It may or may not have misbehaved in prior versions, but it was more obscure/less important in prior versions - in 5.23, it matters more.)

See: https://lab.civicrm.org/dev/joomla/issues/26#note_33465

Before

When the URL for [civicrm.bower] (or similar) is derived, and if the environment uses HTTP on the default port (80/443), then the URL goes through multiple filters - first, from absolute to relative, and then later from relative back to absolute. In the process, the base may be inadvertently changed.

In dev/joomla#26, this was observed to produce redundant URL elements.

After

When the URL for [civicrm.bower] (or similar) is derived, it is computed in absolute format - and simply kept that way.

Comments

Regarding test coverage, there are two relevant unit-tests. This PR only updates one.

• E2E\Core\PathUrlTest: This is a more concrete smoke test which demonstrates functional problems with variables like [civicrm.bower]. It should already catch problems like dev/joomla#26... but only if you run the E2E suite on a site where the CMS was deployed to a subdirectory. Currently, the list of build-types available in CI doesn't have such a site.
• Civi\Core\PathsTest: This is a more abstract, headless test to examine edge-cases in Civi\Core\Paths. It does not specifically check for [civicrm.bower] or similar variables (b/c the URL routing is ill-defined in a headless context). However, I've updated it to compare/contrast the working and non-working ways to derive variables.

My local dev environment doesn't support low-number ports (eg port 80), so I cannot reproduce or validate this issue precisely. It's particularly important to do some r-run during PR review.

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[andrewpthompson]

I've tested the PR (but not PathsTest.php) on Joomla on a site at top-level and in a subdirectory. No problems seen.
cli.php also works still.

As a bonus I think also this longstanding issue https://lab.civicrm.org/dev/joomla/-/issues/5 is resolved between this PR and the recent work elsewhere (maybe #16761 and/or 1143a78), which is a little bit exciting!

[kcristiano]

I've also given this an r-run on a WP Multi-site subdirectory installl and it solves the issue.

r-run on standard WP install works properly

I also added to my test site that has:

• wp in it's won directory
• wp-content moved

I did an r-run and it succeeded.

[totten]

Great! Thanks @andrewpthompson @kcristiano.

[seamuslee001]

Jenkins re test this please