Skip to content

Introduce database focus area, rename JavaScript focus area to JS & CSS, and phase out Site Health focus area #566

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
felixarntz merged 19 commits into from
Nov 7, 2022
Merged

Introduce database focus area, rename JavaScript focus area to JS & CSS, and phase out Site Health focus area #566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
4c754ff
Update latest focus areas
mukeshpanchal27 Oct 20, 2022
3596ca9
Update codeowners
mukeshpanchal27 Oct 21, 2022
8aa96b3
Remove Site Health from codeowners
mukeshpanchal27 Oct 21, 2022
f8ef434
Relocate existing modules
mukeshpanchal27 Oct 21, 2022
7a45a1b
Update focus areas
mukeshpanchal27 Oct 21, 2022
e2e42a5
Update unit tests
mukeshpanchal27 Oct 21, 2022
a0206c2
Update codeowners
mukeshpanchal27 Oct 21, 2022
0d8c71a
Remove Site Health
mukeshpanchal27 Oct 21, 2022
44ffdaa
Update legacy module code
mukeshpanchal27 Oct 21, 2022
7bdda84
Update default-enabled-modules.php
mukeshpanchal27 Oct 21, 2022
87b9162
Merge branch 'trunk' into fix/554-update-focus-areas-codebase
mukeshpanchal27 Nov 1, 2022
9e11a91
Update focus area to js-and-css
mukeshpanchal27 Nov 1, 2022
32a1ca3
Revert module name changes
mukeshpanchal27 Nov 1, 2022
dc1e048
Addressed code review
mukeshpanchal27 Nov 1, 2022
ce593f4
Add unit test
mukeshpanchal27 Nov 1, 2022
9a65537
Add docblock for data_legacy_modules()
mukeshpanchal27 Nov 2, 2022
3e48687
Correct indentation
mukeshpanchal27 Nov 2, 2022
e57024f
Update tests/load-tests.php
mukeshpanchal27 Nov 2, 2022
678a8a4
Merge branch 'trunk' into fix/554-update-focus-areas-codebase
mukeshpanchal27 Nov 7, 2022
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
35 changes: 15 additions & 20 deletions .github/CODEOWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,10 @@
/tests/modules/images @adamsilverstein @getsource
/tests/testdata/modules/images @adamsilverstein @getsource

# Focus: JavaScript
/modules/javascript @aristath @sgomes
/tests/modules/javascript @aristath @sgomes
/tests/testdata/modules/javascript @aristath @sgomes

# Focus: Site Health
/modules/site-health
/tests/modules/site-health
/tests/testdata/modules/site-health
# Focus: JS & CSS
/modules/js-and-css @aristath @sgomes
/tests/modules/js-and-css @aristath @sgomes
/tests/testdata/modules/js-and-css @aristath @sgomes

# Focus: Measurement
/modules/measurement
Expand All @@ -36,19 +31,19 @@
/tests/testdata/modules/images/webp-uploads @adamsilverstein @felixarntz @mitogh

# Module: WebP Support Health Check
/modules/site-health/webp-support @adamsilverstein @kirtangajjar @mitogh
/tests/modules/site-health/webp-support @adamsilverstein @kirtangajjar @mitogh
/tests/testdata/modules/site-health/webp-support @adamsilverstein @kirtangajjar @mitogh
/modules/images/webp-support @adamsilverstein @kirtangajjar @mitogh
/tests/modules/images/webp-support @adamsilverstein @kirtangajjar @mitogh
/tests/testdata/modules/images/webp-support @adamsilverstein @kirtangajjar @mitogh

# Module: Autoloaded Options Health Check
/modules/site-health/audit-autoloaded-options @manuelRod
/tests/modules/site-health/audit-autoloaded-options @manuelRod
/tests/testdata/modules/site-health/audit-autoloaded-options @manuelRod
/modules/database/audit-autoloaded-options @manuelRod
/tests/modules/database/audit-autoloaded-options @manuelRod
/tests/testdata/modules/database/audit-autoloaded-options @manuelRod

# Module: Enqueued Assets Health Check
/modules/site-health/audit-enqueued-assets @manuelRod
/tests/modules/site-health/audit-enqueued-assets @manuelRod
/tests/testdata/modules/site-health/audit-enqueued-assets @manuelRod
/modules/js-and-css/audit-enqueued-assets @manuelRod
/tests/modules/js-and-css/audit-enqueued-assets @manuelRod
/tests/testdata/modules/js-and-css/audit-enqueued-assets @manuelRod

# Module: Persistent Object Cache Health Check
/modules/object-cache/persistent-object-cache-health-check @tillkruss @spacedmonkey
Expand All @@ -61,5 +56,5 @@
/tests/testdata/modules/images/dominant-color @pbearne @spacedmonkey

# Module: Full Page Cache Health Check
/modules/site-health/audit-full-page-cache @manuelRod @westonruter
/tests/modules/site-health/audit-full-page-cache @manuelRod @westonruter
/modules/object-cache/audit-full-page-cache @manuelRod @westonruter
/tests/modules/object-cache/audit-full-page-cache @manuelRod @westonruter
8 changes: 4 additions & 4 deletions admin/load.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,11 +184,11 @@ function perflab_get_focus_areas() {
'images' => array(
'name' => __( 'Images', 'performance-lab' ),
),
'javascript' => array(
'name' => __( 'JavaScript', 'performance-lab' ),
'js-and-css' => array(
'name' => __( 'JS & CSS', 'performance-lab' ),
),
'site-health' => array(
'name' => __( 'Site Health', 'performance-lab' ),
'database' => array(
'name' => __( 'Database', 'performance-lab' ),
),
'measurement' => array(
'name' => __( 'Measurement', 'performance-lab' ),
Expand Down
4 changes: 2 additions & 2 deletions bin/plugin/commands/common.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ const { log, formats } = require( '../lib/logger' );
*/
const FOCUS_AREAS = {
images: 10,
javascript: 20,
'site-health': 30,
'js-and-css': 20,
database: 30,
measurement: 40,
'object-cache': 50,
};
Expand Down
4 changes: 2 additions & 2 deletions default-enabled-modules.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
/* THIS IS A GENERATED FILE. DO NOT EDIT DIRECTLY. */
return array(
'images/dominant-color',
'images/webp-support',
'images/webp-uploads',
'site-health/audit-full-page-cache',
'site-health/webp-support',
'object-cache/audit-full-page-cache',
'object-cache/persistent-object-cache-health-check',
);
/* THIS IS THE END OF THE GENERATED FILE */
18 changes: 17 additions & 1 deletion load.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,23 @@ function perflab_get_module_settings() {
// Even though a default value is registered for this setting, the default must be explicitly
// passed here, to support scenarios where this function is called before the 'init' action,
// for example when loading the active modules.
return (array) get_option( PERFLAB_MODULES_SETTING, perflab_get_modules_setting_default() );
$module_settings = (array) get_option( PERFLAB_MODULES_SETTING, perflab_get_modules_setting_default() );

$legacy_module_slugs = array(
'site-health/audit-autoloaded-options' => 'database/audit-autoloaded-options',
'site-health/audit-enqueued-assets' => 'js-and-css/audit-enqueued-assets',
'site-health/audit-full-page-cache' => 'object-cache/audit-full-page-cache',
'site-health/webp-support' => 'images/webp-support',
);

foreach ( $legacy_module_slugs as $legacy_slug => $current_slug ) {
if ( isset( $module_settings[ $legacy_slug ] ) ) {
$module_settings[ $current_slug ] = $module_settings[ $legacy_slug ];
unset( $module_settings[ $legacy_slug ] );
}
}

return $module_settings;
}

/**
Expand Down
0 ...-health/audit-autoloaded-options/load.php → ...atabase/audit-autoloaded-options/load.php
View file
Open in desktop
File renamed without changes.
0 modules/site-health/webp-support/load.php → modules/images/webp-support/load.php
View file
Open in desktop
File renamed without changes.
0 ...e-health/audit-enqueued-assets/helper.php → ...-and-css/audit-enqueued-assets/helper.php
View file
Open in desktop
File renamed without changes.
0 ...ite-health/audit-enqueued-assets/load.php → ...js-and-css/audit-enqueued-assets/load.php
View file
Open in desktop
File renamed without changes.
0 ...health/audit-full-page-cache/can-load.php → ...-cache/audit-full-page-cache/can-load.php
View file
Open in desktop
File renamed without changes.
0 ...e-health/audit-full-page-cache/helper.php → ...ct-cache/audit-full-page-cache/helper.php
View file
Open in desktop
File renamed without changes.
0 ...ite-health/audit-full-page-cache/load.php → ...ject-cache/audit-full-page-cache/load.php
View file
Open in desktop
File renamed without changes.
30 changes: 15 additions & 15 deletions tests/admin/load-tests.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
class Admin_Load_Tests extends WP_UnitTestCase {

private static $demo_modules = array(
'javascript/demo-module-1' => array(
'js-and-css/demo-module-1' => array(
'name' => 'Demo Module 1',
'description' => 'This is the description for demo module 1.',
'experimental' => false,
'focus' => 'javascript',
'focus' => 'js-and-css',
'slug' => 'demo-module-1',
),
'something/demo-module-2' => array(
Expand All @@ -35,11 +35,11 @@ class Admin_Load_Tests extends WP_UnitTestCase {
'images' => array(
'name' => 'Images',
),
'javascript' => array(
'name' => 'JavaScript',
'js-and-css' => array(
'name' => 'js-and-css',
),
'site-health' => array(
'name' => 'Site Health',
'database' => array(
'name' => 'Database',
),
'measurement' => array(
'name' => 'Measurement',
Expand Down Expand Up @@ -118,9 +118,9 @@ public function test_perflab_load_modules_page() {
'after_section' => '',
'section_class' => '',
),
'javascript' => array(
'id' => 'javascript',
'title' => 'JavaScript',
'js-and-css' => array(
'id' => 'js-and-css',
'title' => 'js-and-css',
'callback' => null,
'before_section' => '',
'after_section' => '',
Expand All @@ -140,7 +140,7 @@ public function test_perflab_load_modules_page() {
$this->assertEqualSets(
array(
'images',
'javascript',
'js-and-css',
'other',
),
array_keys( $wp_settings_fields[ PERFLAB_MODULES_SCREEN ] )
Expand All @@ -150,8 +150,8 @@ public function test_perflab_load_modules_page() {
array_keys( $wp_settings_fields[ PERFLAB_MODULES_SCREEN ]['images'] )
);
$this->assertEqualSets(
array( 'javascript/demo-module-1' ),
array_keys( $wp_settings_fields[ PERFLAB_MODULES_SCREEN ]['javascript'] )
array( 'js-and-css/demo-module-1' ),
array_keys( $wp_settings_fields[ PERFLAB_MODULES_SCREEN ]['js-and-css'] )
);
$this->assertEqualSets(
array( 'something/demo-module-2' ),
Expand All @@ -168,7 +168,7 @@ public function test_perflab_render_modules_page() {
}

public function test_perflab_render_modules_page_field() {
$module_slug = 'javascript/demo-module-1';
$module_slug = 'js-and-css/demo-module-1';
$module_data = self::$demo_modules[ $module_slug ];
$module_settings = array( 'enabled' => false );

Expand Down Expand Up @@ -196,8 +196,8 @@ public function test_perflab_render_modules_page_field() {
public function test_perflab_get_focus_areas() {
$expected_focus_areas = array(
'images',
'javascript',
'site-health',
'js-and-css',
'database',
'measurement',
'object-cache',
);
Expand Down
35 changes: 33 additions & 2 deletions tests/load-tests.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,37 @@ function( $default, $option, $passed_default ) use ( &$has_passed_default ) {
$this->assertSame( $new_value, $settings );
}

/**
* @dataProvider data_legacy_modules
*/
public function test_legacy_module_for_perflab_get_module_settings( $legacy_module_slug, $current_module_slug ) {
$new_value = array( $legacy_module_slug => array( 'enabled' => true ) );
update_option( PERFLAB_MODULES_SETTING, $new_value );

$settings = perflab_get_module_settings();
$this->assertArrayNotHasKey( $legacy_module_slug, $settings, 'The settings do not contain the old legacy module slug in the database' );
$this->assertArrayHasKey( $current_module_slug, $settings, 'The settings contain an updated module slug in the database' );
Comment on lines +108 to +109
Copy link
Member Author

@mukeshpanchal27 mukeshpanchal27 Nov 1, 2022

Choose a reason for hiding this comment

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

As good habit like WP core,

Test methods with multiple assertions need a message parameter for each assertion, per Core Handbook - Writing PHPUnit Tests - Using Assertions.

}

/**
* Data provider for test_legacy_module_for_perflab_get_module_settings().
*
* @return array {
* @type array {
* @type string $legacy_module_slug The legacy module slug.
* @type string $current_module_slug The new/updated module slug.
* }
* }
*/
public function data_legacy_modules() {
return array(
array( 'site-health/audit-autoloaded-options', 'database/audit-autoloaded-options' ),
array( 'site-health/audit-enqueued-assets', 'js-and-css/audit-enqueued-assets' ),
array( 'site-health/audit-full-page-cache', 'object-cache/audit-full-page-cache' ),
array( 'site-health/webp-support', 'images/webp-support' ),
);
}

public function test_perflab_get_active_modules() {
// Assert that by default there are no active modules.
$active_modules = perflab_get_active_modules();
Expand Down Expand Up @@ -162,7 +193,7 @@ public function data_perflab_is_valid_module() {
return array(
array( '', false ),
array( '../tests/testdata/demo-modules/something/non-existing-module', false ),
array( '../tests/testdata/demo-modules/javascript/demo-module-1', false ),
array( '../tests/testdata/demo-modules/js-and-css/demo-module-1', false ),
array( '../tests/testdata/demo-modules/something/demo-module-2', true ),
array( '../tests/testdata/demo-modules/images/demo-module-3', true ),
);
Expand All @@ -177,7 +208,7 @@ public function test_perflab_can_load_module( $dummy_module, $expected_status )

public function data_perflab_can_load_module() {
return array(
array( '../tests/testdata/demo-modules/javascript/demo-module-1', false ),
array( '../tests/testdata/demo-modules/js-and-css/demo-module-1', false ),
array( '../tests/testdata/demo-modules/something/demo-module-2', true ),
array( '../tests/testdata/demo-modules/images/demo-module-3', true ),
);
Expand Down
0 ...options/audit-autoloaded-options-test.php → ...options/audit-autoloaded-options-test.php
View file
Open in desktop
File renamed without changes.
0 ...ets/audit-enqueued-assets-helper-test.php → ...ets/audit-enqueued-assets-helper-test.php
View file
Open in desktop
File renamed without changes.
0 ...ued-assets/audit-enqueued-assets-test.php → ...ued-assets/audit-enqueued-assets-test.php
View file
Open in desktop
File renamed without changes.
0 ...page-cache/audit-full-page-cache-test.php → ...page-cache/audit-full-page-cache-test.php
View file
Open in desktop
File renamed without changes.
0 ...les/javascript/demo-module-1/can-load.php → ...les/js-and-css/demo-module-1/can-load.php
View file
Open in desktop
File renamed without changes.
0 ...modules/javascript/demo-module-1/load.php → ...modules/js-and-css/demo-module-1/load.php
View file
Open in desktop
File renamed without changes.