Skip to content

Add module to warn about excessive amount of autoloaded options #124

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 14 commits into from
Mar 18, 2022
Merged

Add module to warn about excessive amount of autoloaded options #124

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
3528dd8
adding autoloaded options check to site health
manuelRod Jan 19, 2022
b5049c0
adding tests
manuelRod Jan 20, 2022
eac9521
moving file
manuelRod Jan 20, 2022
d3f7d52
Merge branch 'trunk' into add/sitehealth-autoloaded-options
manuelRod Jan 20, 2022
74932f8
Adding resource link to actions
manuelRod Jan 24, 2022
11dd3f3
simplify code
manuelRod Feb 8, 2022
be7b17d
some small refactor, + adding better documentation to filters
manuelRod Feb 15, 2022
814bb4a
nitpick
manuelRod Feb 28, 2022
a1ebb71
nitpicks
manuelRod Mar 11, 2022
389a0ff
moving mock response class to dataproviders.
manuelRod Mar 14, 2022
7c6a9f7
updating some comments
manuelRod Mar 15, 2022
b6a1949
simplifying test using wp_generate_password instead of custom random …
manuelRod Mar 16, 2022
f45fc53
Merge branch 'release/1.0.0-beta.2' into add/sitehealth-autoloaded-op…
manuelRod Mar 18, 2022
725bbd4
marking as experimental
manuelRod Mar 18, 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
Prev Previous commit
Next Next commit
moving mock response class to dataproviders.
  • Loading branch information
@manuelRod
manuelRod committed Mar 14, 2022
commit 389a0ff660ea27465d8f14a425a0e392088b8d08
117 changes: 97 additions & 20 deletions tests/modules/site-health/audit-autoloaded-options/audit-autoloaded-options-test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,44 +7,39 @@
class Audit_Autoloaded_Options_Tests extends WP_UnitTestCase {

const WARNING_AUTOLOADED_SIZE_LIMIT_IN_BYTES = 800000;
const AUTOLOADED_OPTION_KEY = 'test_set_autoloaded_option';

/**
* @dataProvider provider_added_test_info_site_health
*
* Tests perflab_aao_add_autoloaded_options_test()
*/
public function test_perflab_aao_add_autoloaded_options_test() {
$this->assertEqualSets( Autoloaded_Options_Mock_Responses::return_added_test_info_site_health(), perflab_aao_add_autoloaded_options_test( array() ) );
public function test_perflab_aao_add_autoloaded_options_test( $provider_added_test_info_site_health ) {
$this->assertEqualSets( $provider_added_test_info_site_health, perflab_aao_add_autoloaded_options_test( array() ) );
}

/**
* @dataProvider provider_autoloaded_options_less_than_limit
*
* Tests perflab_aao_autoloaded_options_test() when autoloaded options less than warning size.
*/
public function test_perflab_aao_autoloaded_options_test_no_warning() {
$autoloaded_options_size = perflab_aao_autoloaded_options_size();
$autoloaded_options_count = count( wp_load_alloptions() );

public function test_perflab_aao_autoloaded_options_test_no_warning( $provider_autoloaded_options_less_than_limit ) {
$this->assertEqualSets(
perflab_aao_autoloaded_options_test(),
Autoloaded_Options_Mock_Responses::return_perflab_aao_autoloaded_options_test_less_than_limit(
$autoloaded_options_size,
$autoloaded_options_count
)
$provider_autoloaded_options_less_than_limit
);
}

/**
* @dataProvider provider_autoloaded_options_bigger_than_limit
*
* Tests perflab_aao_autoloaded_options_test() when autoloaded options more than warning size.
*/
public function test_perflab_aao_autoloaded_options_test_warning() {
public function test_perflab_aao_autoloaded_options_test_warning( $provider_autoloaded_options_bigger_than_limit ) {
self::set_autoloaded_option( self::WARNING_AUTOLOADED_SIZE_LIMIT_IN_BYTES );
$autoloaded_options_size = perflab_aao_autoloaded_options_size();
$autoloaded_options_count = count( wp_load_alloptions() );

$this->assertEqualSets(
perflab_aao_autoloaded_options_test(),
Autoloaded_Options_Mock_Responses::return_perflab_aao_autoloaded_options_test_bigger_than_limit(
$autoloaded_options_size,
$autoloaded_options_count
)
$provider_autoloaded_options_bigger_than_limit
);
}

Expand All @@ -64,13 +59,20 @@ public function test_perflab_aao_autoloaded_options_size() {
}

/**
* Sets an autoloaded option.
* Sets a test autoloaded option.
*
* @param int $bytes bytes to load in options.
*/
public static function set_autoloaded_option( $bytes = 800000 ) {
$heavy_option_string = self::random_string_generator( $bytes );
add_option( 'test_set_autoloaded_option', $heavy_option_string );
add_option( self::AUTOLOADED_OPTION_KEY, $heavy_option_string );
}

/**
* Deletes test autoloaded option.
*/
public static function delete_autoloaded_option() {
delete_option( self::AUTOLOADED_OPTION_KEY );
}

/**
Expand All @@ -89,5 +91,80 @@ protected static function random_string_generator( $length ) {
return $string;
}

/**
* This is the information we are adding into site_status_tests hook.
*
* @return array
*/
function provider_added_test_info_site_health() {
$added_tests = array();
$added_tests['direct']['autoloaded_options'] = array(
'label' => esc_html__( 'Autoloaded options', 'performance-lab' ),
'test' => 'perflab_aao_autoloaded_options_test',
);
return array( array( $added_tests ) );
}

/**
* Data provider for perflab_aao_autoloaded_options_test if autoloaded options are less than the limit.
*
* @return array
*/
public function provider_autoloaded_options_less_than_limit() {
$autoloaded_options_size = perflab_aao_autoloaded_options_size();
$autoloaded_options_count = count( wp_load_alloptions() );

$result = array(
'label' => esc_html__( 'Autoloaded options', 'performance-lab' ),
'status' => 'good',
'badge' => array(
'label' => esc_html__( 'Performance', 'performance-lab' ),
'color' => 'blue',
),
'description' => sprintf(
/* translators: 1: Number of autoloaded options. 2.Autoloaded options size. */
'<p>' . esc_html__( 'The amount of %1$s autoloaded options (size: %2$s) in options table is acceptable.', 'performance-lab' ) . '</p>',
$autoloaded_options_count,
size_format( $autoloaded_options_size )
),
'actions' => '',
'test' => 'autoloaded_options',
);
return array( array( $result ) );
}

/**
* Data provider for perflab_aao_autoloaded_options_test if autoloaded options are more than the limit.
*
* @return array
*/
public function provider_autoloaded_options_bigger_than_limit() {
$result = perflab_aao_autoloaded_options_test();

self::set_autoloaded_option( self::WARNING_AUTOLOADED_SIZE_LIMIT_IN_BYTES );
$autoloaded_options_size = perflab_aao_autoloaded_options_size();
$autoloaded_options_count = count( wp_load_alloptions() );
self::delete_autoloaded_option();

$result['status'] = 'critical';
$result['badge']['color'] = 'red';
$result['description'] = sprintf(
/* translators: 1: Number of autoloaded options. 2.Autoloaded options size. */
'<p>' . esc_html__( 'Your website uses %1$s autoloaded options (size: %2$s). Try to reduce the number of autoloaded options or performance will be affected.', 'performance-lab' ) . '</p>',
$autoloaded_options_count,
size_format( $autoloaded_options_size )
);

$result['actions'] = sprintf(
/* translators: 1: HelpHub URL. 2: Link description. */
'<p><a target="_blank" href="%1$s">%2$s</a></p>',
esc_url( __( 'https://wordpress.org/support/article/optimization/', 'performance-lab' ) ),
esc_html__( 'More info about performance optimization', 'performance-lab' )
);

return array( array( $result ) );
}


}

91 changes: 0 additions & 91 deletions .../modules/site-health/audit-autoloaded-options/class-autoloaded-options-mock-responses.php
View file
Open in desktop

This file was deleted.