Skip to content

Migrate Site Health checks from being modules to becoming part of the plugin core #1042

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.

Sign up for GitHub

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

Merged
merged 18 commits into from
Mar 13, 2024
Merged

Migrate Site Health checks from being modules to becoming part of the plugin core #1042

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
0fdf37e
Move server-timing to top-level includes directory
thelovekesh Mar 9, 2024
6a3c9f9
Move site health tests from various focus areas to includes directory
thelovekesh Mar 9, 2024
4e739af
Add loader file for site health tests
thelovekesh Mar 9, 2024
3e27c87
Remove module based loading from site health tests
thelovekesh Mar 9, 2024
29e549b
Update phpstan.neon.dist
thelovekesh Mar 9, 2024
134cb63
Move server-timing and site health tests to tests/includes directory
thelovekesh Mar 9, 2024
71d4aeb
Remove ref for legacy module slugs from perflab_get_module_settings()
thelovekesh Mar 9, 2024
c303628
Fix webp support site health test name
thelovekesh Mar 9, 2024
2fb4e7a
Add site health tests to be loaded with plugin
thelovekesh Mar 9, 2024
d7c36a5
Update unit tests after removing site health tests from modules
thelovekesh Mar 9, 2024
8604b65
Update site health checks loader
thelovekesh Mar 11, 2024
80f8a0a
Fix namings for PL core APIs
thelovekesh Mar 11, 2024
a06213d
Remove failing module test cases from tests
thelovekesh Mar 11, 2024
6d8d231
Fix server-timing API path
thelovekesh Mar 11, 2024
29dfb4c
Update server-timing object-cache path and exclude pattern in phpcs.x…
thelovekesh Mar 11, 2024
7ef492a
Bump object cache drop-in from 2 to 3
thelovekesh Mar 12, 2024
686a8d9
Bump object cache drop-in plugin version from 2 to 3
thelovekesh Mar 12, 2024
86ff88b
Remove site health caps safeguard
thelovekesh Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update server-timing object-cache path and exclude pattern in phpcs.x… 
…ml.dist
  • Loading branch information
@thelovekesh
thelovekesh committed Mar 13, 2024
commit 29dfb4c2d040521af503010eb01c4ea7753599cd
12 changes: 6 additions & 6 deletions includes/server-timing/object-cache.copy.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,17 @@ function perflab_load_server_timing_api_from_dropin() {

$plugins_dir = defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins';
$plugin_dir = $plugins_dir . '/performance-lab/';
if ( ! file_exists( $plugin_dir . 'server-timing/load.php' ) ) {
if ( ! file_exists( $plugin_dir . 'includes/server-timing/load.php' ) ) {
$plugin_dir = $plugins_dir . '/performance/';
if ( ! file_exists( $plugin_dir . 'server-timing/load.php' ) ) {
if ( ! file_exists( $plugin_dir . 'includes/server-timing/load.php' ) ) {
return;
}
}

require_once $plugin_dir . 'server-timing/class-perflab-server-timing-metric.php';
require_once $plugin_dir . 'server-timing/class-perflab-server-timing.php';
require_once $plugin_dir . 'server-timing/load.php';
require_once $plugin_dir . 'server-timing/defaults.php';
require_once $plugin_dir . 'includes/server-timing/class-perflab-server-timing-metric.php';
require_once $plugin_dir . 'includes/server-timing/class-perflab-server-timing.php';
require_once $plugin_dir . 'includes/server-timing/load.php';
require_once $plugin_dir . 'includes/server-timing/defaults.php';
Comment on lines -61 to +71
Copy link
Member

@felixarntz felixarntz Mar 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thelovekesh Now that I see this change, moving the files for the Server-Timing API is tricky from a backward compatibility perspective. Here's why:

  • The wp-content/object-cache.php drop-in may already be placed on some sites, from an older Performance Lab version. As such, it would try to load the old paths, which wouldn't work. It wouldn't cause a fatal error because of the checks above, but it just wouldn't load the API.
  • In order to fix that, we'll have to enhance the logic that places that drop-in file (i.e. copies from object-cache.copy.php to the actual drop-in) so that it detects whether the current file is outdated.
  • I'm happy to open another PR for that. However, at a minimum, let's update the drop-in version number in this PR from 2 to 3 (in both the file header and constant).

Copy link
Member

@felixarntz felixarntz Mar 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thelovekesh I've opened #1047 for the purpose of updating an older version of the drop-in, please take a look. Depending which of the two PRs gets merged first, the other one will require a minor update (to sync the version numbers and file paths).

}
}
perflab_load_server_timing_api_from_dropin();
Expand Down
2 changes: 1 addition & 1 deletion phpcs.xml.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</rule>

<rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
<exclude-pattern>server-timing/object-cache.copy.php</exclude-pattern>
<exclude-pattern>includes/server-timing/object-cache.copy.php</exclude-pattern>
</rule>

<file>.</file>
Expand Down
2 changes: 1 addition & 1 deletion tests/load-tests.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ public function test_perflab_maybe_set_object_cache_dropin_no_conflict() {
// Run function to place drop-in and ensure it exists afterwards.
perflab_maybe_set_object_cache_dropin();
$this->assertTrue( $wp_filesystem->exists( WP_CONTENT_DIR . '/object-cache.php' ) );
$this->assertSame( file_get_contents( PERFLAB_PLUGIN_DIR_PATH . 'server-timing/object-cache.copy.php' ), $wp_filesystem->get_contents( WP_CONTENT_DIR . '/object-cache.php' ) );
$this->assertSame( file_get_contents( PERFLAB_PLUGIN_DIR_PATH . 'includes/server-timing/object-cache.copy.php' ), $wp_filesystem->get_contents( WP_CONTENT_DIR . '/object-cache.php' ) );
}

public function test_perflab_maybe_set_object_cache_dropin_no_conflict_but_failing() {
Expand Down