Make the main bootstrap process in ms-settings.php testable

[jeremyfelt]

One of the harder things to test right now in multisite is the bootstrap behavior. We have a hobbled together process right now that sets up a new "request" and re-includes ms-settings.php before checking the status of $current_blog and $current_site. This works for many configurations, but isn't useful when catching a failed scenario that results in a redirect or ms_not_installed().

We can pull most of this code out into a new function, ms_bootstrap() or similar, that handles the domain and path and returns the possible actions. From my first pass, I've landed on true for when a site and network are found, false for when a site or network is not found, and URL string for when a request needs to be immediately redirected elsewhere.

I'm attaching an initial patch to start work on this. Once a version of it is in, we'll be able to better test a ticket like #17376.

[jeremyfelt]

Related #29684

[ericlewis]

This is cool. Maybe wp_setup_current_site_and_blog() for a more self-descriptive name?

[jeremyfelt]

Punting on this to handle it earlier in a release for more testing.

[jeremyfelt]

34941.2.diff​ is a refresh against trunk and uses wp_setup_current_site_and_blog() rather than ms_bootstrap(). I agree that's closer to what the function should be called, not sure if we're there yet.

Tests are still passing. I'll be trying to break this more over the next couple weeks. Would like some testing of this patch for sure. :)

[jeremyfelt]

In 37226:

Multisite: Make $current_site and $current_blog explicitly global.

See #34941.

[jeremyfelt]

34941.3.diff​ adjusts a few things:

• New function in ms-load.php is ms_load_current_site_and_network().
• Try to use discouraging language for use of this outside of core, also mark as @private.
• Add a $subdomain parameter so that we can test both subdomain and subdirectory configs with relative ease.
• Add bootstrap tests to account for subdirectory path segments of 2 vs the default of 1. This is marked as a todo in the current tests.
• Add bootstrap tests for subdomain configuration. :tada:

[jeremyfelt]

In 37234:

Tests: Share test fixtures in multisite bootstrap tests

• Remove unnecessary setUp and tearDown methods.
• Create networks and sites in wpSetupBeforeClass to share throughout.
• Destroy networks and sites in wpTearDownAfterClass to unpollute.

See #36566, #34941.

[jeremyfelt]

In 37236:

Tests: Use a data provider to test get_network_by_path()

See #36566, #34941.

[jeremyfelt]

In 37237:

Tests: Use a data provider in get_site_by_path() tests

See #36566, #34941.

[jeremyfelt]

34941.4.diff​ is refreshed against current trunk after the structural changes to the multisite bootstrap tests. The tests diff is a lot cleaner now. There are some more specific tests included in 34941.3.diff​ that are not yet part of the refresh.

[ocean90]

I've tested 34941.4.diff​ on w.org and haven't noticed any issues so far.

Some minor things for the patch itself:

• "Identify the network" should be "Identifies the network", see ​https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#documenting-tips
• The order of the @access and @since tag should be swapped.
• There shouldn't be an empty line between @param and @return tags.
• A description for @global wpdb $wpdb is missing: "WordPress database abstraction object."

[jeremyfelt]

In 37475:

Multisite: Wrap the main bootstrap process in a function

Introduce ms_load_current_site_and_network. This is used by core during the multisite bootstrap process to populate the $current_site and $current_blog globals based on a requested domain and path.

Return values from this function inform ms-settings.php as to whether a page view should continue, ms_not_installed() should fire, or a redirect to a new location should occur.

This was previously a procedural block in ms-settings.php. Wrapping this code and providing specific return values allows us to write tests that do not rely on the manual and repeated inclusion of ms-settings.php.

This should not be used by plugins or themes. Please.

See #34941.

[jeremyfelt]

Keeping this open for the sake of eyeballs at this point. I would like to expand tests for things like #17376, though that can always go on that ticket.

[jeremyfelt]

Things seem good here. We can use #36566 to focus on any bootstrap tests.