Add Site Health test for Object Caching #1301

mkurdybanowski · 2024-06-13T13:42:02Z

Summary

Fixes #718

Relevant technical choices

github-actions · 2024-06-13T13:42:23Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: mkurdybanowski <[email protected]>
Co-authored-by: westonruter <[email protected]>
Co-authored-by: mukeshpanchal27 <[email protected]>
Co-authored-by: OllieJones <[email protected]>
Co-authored-by: tillkruss <[email protected]>
Co-authored-by: adamsilverstein <[email protected]>
Co-authored-by: spacedmonkey <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

westonruter · 2024-06-18T23:07:25Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+ * Helper functions used for Object Cache Support Info.
+ *
+ * @package performance-lab
+ * @since 2.1.0


Suggested change

* @since 2.1.0

* @since n.e.x.t

westonruter · 2024-06-18T23:07:38Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+ * Callback for Object Cache Info fields.
+ *
+ * @return array Fields.
+ * @since 3.3.0


Suggested change

* @since 3.3.0

* @since n.e.x.t

westonruter · 2024-06-18T23:08:18Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+			'value' => wp_cache_supports( 'get_multiple' ) ? 'Enabled' : 'Disabled',
+		),
+		'multiple_sets'    => array(
+			'label' => __( 'Multiple sets', 'performance-lab' ),
+			'value' => wp_cache_supports( 'set_multiple' ) ? 'Enabled' : 'Disabled',
+		),
+		'multiple_deletes' => array(
+			'label' => __( 'Multiple deletes', 'performance-lab' ),
+			'value' => wp_cache_supports( 'delete_multiple' ) ? 'Enabled' : 'Disabled',
+		),
+		'flush_group'      => array(
+			'label' => __( 'Flush group', 'performance-lab' ),
+			'value' => wp_cache_supports( 'flush_group' ) ? 'Enabled' : 'Disabled',


Shouldn't Enabled and Disabled be translated?

plugins/performance-lab/includes/site-health/object-cache/helper.php

westonruter · 2024-06-18T23:11:38Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+ * @return string
+ * @since 3.3.0
+ */
+function wp_get_cache_type() {


This will need a Performance Lab prefix.

westonruter · 2024-06-18T23:11:54Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+ * problems with this function's ability to determine which object cache is being used.
+ *
+ * @return string
+ * @since 3.3.0


Suggested change

* @since 3.3.0

* @since n.e.x.t

westonruter · 2024-06-18T23:12:10Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+ * @return array Fields.
+ * @since 3.3.0
+ */
+function object_cache_supported_fields() {


Function needs the Performance Lab prefix.

westonruter · 2024-06-18T23:12:56Z

plugins/performance-lab/includes/site-health/object-cache/hooks.php

+ *
+ * @param  array  $info  Site Health Info.
+ *
+ * @return array Amended Info.
+ * @since 3.3.0
+ *


Suggested change

*

* @param array $info Site Health Info.

*

* @return array Amended Info.

* @since 3.3.0

*

*

* @since n.e.x.t

*

* @param array<string, mixed> $info Site Health Info.

* @return array<string, mixed> Amended Info.

westonruter · 2024-06-18T23:13:55Z

plugins/performance-lab/includes/site-health/object-cache/hooks.php

+ * @since 3.3.0
+ *
+ */
+function object_cache_supported_info( array $info ): array {


Needs Performance Lab prefix.

westonruter · 2024-06-18T23:14:05Z

plugins/performance-lab/includes/site-health/object-cache/hooks.php

+ * Hook callbacks used for Site Health Info.
+ *
+ * @package performance-lab
+ * @since 2.1.0


Suggested change

* @since 2.1.0

* @since n.e.x.t

plugins/performance-lab/includes/site-health/object-cache/helper.php

westonruter · 2024-07-09T15:27:49Z

@mkurdybanowski Hi! Are you planning to pick this up again?

mkurdybanowski · 2024-07-12T06:09:05Z

Hi @westonruter, yes, should be able to work on it next week!

westonruter · 2024-07-30T17:35:17Z

plugins/performance-lab/includes/site-health/object-cache/hooks.php

+ * @param array{object_cache: array{label: string,description: string,fields: array<string, array{label: string,value: string}>}} $info Site Health Info.
+ *
+ * @return array{object_cache: array{label: string,description: string,fields: array<string, array{label: string,value: string}>}} Amended Info.
+ * @since n.e.x.t


The typing can be made a bit more generic.

Suggested change

* @param array{object_cache: array{label: string,description: string,fields: array<string, array{label: string,value: string}>}} $info Site Health Info.

*

* @return array{object_cache: array{label: string,description: string,fields: array<string, array{label: string,value: string}>}} Amended Info.

* @since n.e.x.t

* @since n.e.x.t

*

* @param array<string, array{label: string, description: string, fields: array<string, array{label: string, value: string}>}> $info Site Health Info.

* @return array<string, array{label: string, description: string, fields: array<string, array{label: string, value: string}>}> Amended Info.

*

westonruter · 2024-07-30T17:35:46Z

plugins/performance-lab/includes/site-health/object-cache/hooks.php

+/**
+ * Adds Object Cache module to Site Health Info.
+ *
+ * @param array{object_cache: array{label: string,description: string,fields: array<string, array{label: string,value: string}>}} $info Site Health Info.


The object_cache key wouldn't exist yet in the $info being passed in.

westonruter · 2024-07-30T17:36:25Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+			}
+
+			// Test for Xcache object cache (https://plugins.svn.wordpress.org/xcache/trunk/object-cache.php).
+		} elseif ( $wp_object_cache instanceof \XCache_Object_Cache ) { // @phpstan-ignore-line


What specifically is being ignored for PHPStan on this line? The specific error identifier should be used here to prevent ignoring something unintentionally.

Suggested change

} elseif ( $wp_object_cache instanceof \XCache_Object_Cache ) { // @phpstan-ignore-line

} elseif ( $wp_object_cache instanceof XCache_Object_Cache ) { // @phpstan-ignore-line

westonruter · 2024-07-30T17:36:32Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+		} elseif ( isset( $wp_object_cache->mc ) ) {
+			$is_memcache = true;
+			foreach ( $wp_object_cache->mc as $bucket ) {
+				if ( ! $bucket instanceof \Memcache && ! $bucket instanceof \Memcached ) {


Suggested change

if ( ! $bucket instanceof \Memcache && ! $bucket instanceof \Memcached ) {

if ( ! $bucket instanceof Memcache && ! $bucket instanceof Memcached ) {

westonruter · 2024-07-30T17:36:39Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+
+	if ( ! empty( $_wp_using_ext_object_cache ) ) {
+		// Test for Memcached PECL extension memcached object cache (https://github.com/tollmanz/wordpress-memcached-backend).
+		if ( isset( $wp_object_cache->m ) && $wp_object_cache->m instanceof \Memcached ) {


Since we're not using namespaces, the \ an be removed.

Suggested change

if ( isset( $wp_object_cache->m ) && $wp_object_cache->m instanceof \Memcached ) {

if ( isset( $wp_object_cache->m ) && $wp_object_cache->m instanceof Memcached ) {

westonruter · 2024-07-30T17:37:04Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+			$message = 'APC';
+
+			// Test for WP Redis (https://wordpress.org/plugins/wp-redis/).
+		} elseif ( isset( $wp_object_cache->redis ) && $wp_object_cache->redis instanceof \Redis ) {


Suggested change

} elseif ( isset( $wp_object_cache->redis ) && $wp_object_cache->redis instanceof \Redis ) {

} elseif ( isset( $wp_object_cache->redis ) && $wp_object_cache->redis instanceof Redis ) {

westonruter · 2024-07-30T17:38:08Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+			$message = 'Redis';
+
+			// Test for WP LCache Object cache (https://github.com/lcache/wp-lcache).
+		} elseif ( isset( $wp_object_cache->lcache ) && $wp_object_cache->lcache instanceof \LCache\Integrated ) { // @phpstan-ignore-line


What specifically is being ignored for PHPStan on this line? The specific error identifier should be used here to prevent ignoring something unintentionally.

Suggested change

} elseif ( isset( $wp_object_cache->lcache ) && $wp_object_cache->lcache instanceof \LCache\Integrated ) { // @phpstan-ignore-line

} elseif ( isset( $wp_object_cache->lcache ) && $wp_object_cache->lcache instanceof \Cache\Integrated ) { // @phpstan-ignore-line

westonruter · 2024-07-30T17:38:40Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+ *
+ * @return array<string, array{label: string, value: string}> Fields.
+ * @since n.e.x.t


Suggested change

*

* @return array<string, array{label: string, value: string}> Fields.

* @since n.e.x.t

*

* @since n.e.x.t

*

* @return array<string, array{label: string, value: string}> Fields.

westonruter · 2024-07-30T17:39:02Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+ *
+ * @link https://github.com/wp-cli/wp-cli/blob/0ca6d920123ac904c918d69181edc5071dc92c9d/php/utils-wp.php#L259-L331.
+ *
+ * @global bool $_wp_using_ext_object_cache Whether external object cache is being used.
+ * @global WP_Object_Cache $wp_object_cache Object cache global instance.
+ *
+ * @return string Object cache type.
+ * @since n.e.x.t


Typically the @since goes among the first tags.

Suggested change

*

* @link https://github.com/wp-cli/wp-cli/blob/0ca6d920123ac904c918d69181edc5071dc92c9d/php/utils-wp.php#L259-L331.

*

* @global bool $_wp_using_ext_object_cache Whether external object cache is being used.

* @global WP_Object_Cache $wp_object_cache Object cache global instance.

*

* @return string Object cache type.

* @since n.e.x.t

*

* @since n.e.x.t

* @link https://github.com/wp-cli/wp-cli/blob/0ca6d920123ac904c918d69181edc5071dc92c9d/php/utils-wp.php#L259-L331.

*

* @global WP_Object_Cache $wp_object_cache Object cache global instance.

*

* @return string Object cache type.

This also removes the $_wp_using_ext_object_cache per below.

westonruter · 2024-07-30T17:41:44Z

plugins/performance-lab/includes/site-health/object-cache/helper.php

+	global $_wp_using_ext_object_cache, $wp_object_cache;
+
+	$message = '';
+
+	if ( ! empty( $_wp_using_ext_object_cache ) ) {


Per #1219 let's avoid using empty() here. And it seems we can avoid using the $_wp_using_ext_object_cache private global by instead just using the wp_using_ext_object_cache() function:

Suggested change

global $_wp_using_ext_object_cache, $wp_object_cache;

$message = '';

if ( ! empty( $_wp_using_ext_object_cache ) ) {

global $wp_object_cache;

$message = '';

if ( wp_using_ext_object_cache() ) {

@westonruter will fix mentioned issues after 12 of August, as I just started holidays.

Great. Enjoy!

WordPress#718: object caching info

37fe48b

westonruter requested changes Jun 18, 2024

View reviewed changes

westonruter changed the title ~~#718: object caching info~~ Add Site Health test for Object Caching Jun 18, 2024

westonruter added the [Type] Feature A new feature within an existing module label Jun 18, 2024

westonruter added this to the performance-lab n.e.x.t milestone Jun 18, 2024

mukeshpanchal27 reviewed Jun 24, 2024

View reviewed changes

plugins/performance-lab/includes/site-health/object-cache/helper.php Show resolved Hide resolved

westonruter removed this from the performance-lab 3.3.0 milestone Jul 9, 2024

WordPress#718: Fix lint and phpstan errors

061657f

mkurdybanowski requested review from adamsilverstein, felixarntz, pbearne and spacedmonkey as code owners July 25, 2024 21:57

mkurdybanowski and others added 6 commits July 26, 2024 00:04

Merge branch 'trunk' into object-caching-info

ec2099d

WordPress#718: Fix CR issues

dd59b4c

WordPress#718: Fix prefix

d746d31

WordPress#718: Fix prefix

b2a3c87

WordPress#718: globals in docBlock

74897bb

Merge branch 'trunk' into object-caching-info

8f1c0b3

swissspidy added this to the performance-lab n.e.x.t milestone Jul 29, 2024

mkurdybanowski requested a review from westonruter July 29, 2024 11:27

westonruter requested changes Jul 30, 2024

View reviewed changes

westonruter modified the milestones: performance-lab 3.4.0, performance-lab n.e.x.t Aug 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Site Health test for Object Caching #1301

Add Site Health test for Object Caching #1301

mkurdybanowski commented Jun 13, 2024 •

edited by swissspidy

Loading

github-actions bot commented Jun 13, 2024 •

edited

Loading

westonruter Jun 18, 2024

mkurdybanowski Jul 25, 2024

westonruter Jun 18, 2024

mkurdybanowski Jul 25, 2024

westonruter Jun 18, 2024

mkurdybanowski Jul 25, 2024

westonruter Jun 18, 2024

mkurdybanowski Jul 25, 2024

westonruter Jun 18, 2024

mkurdybanowski Jul 25, 2024

westonruter Jun 18, 2024

mkurdybanowski Jul 25, 2024

westonruter Jun 18, 2024

mkurdybanowski Jul 25, 2024

westonruter Jun 18, 2024

mkurdybanowski Jul 25, 2024

westonruter Jun 18, 2024

mkurdybanowski Jul 25, 2024

westonruter commented Jul 9, 2024

mkurdybanowski commented Jul 12, 2024 •

edited

Loading

westonruter Jul 30, 2024

westonruter Jul 30, 2024

westonruter Jul 30, 2024

westonruter Jul 30, 2024

westonruter Jul 30, 2024

westonruter Jul 30, 2024

westonruter Jul 30, 2024

westonruter Jul 30, 2024

westonruter Jul 30, 2024

westonruter Jul 30, 2024

mkurdybanowski Jul 31, 2024

westonruter Jul 31, 2024

	} elseif ( $wp_object_cache instanceof \XCache_Object_Cache ) { // @phpstan-ignore-line
	} elseif ( $wp_object_cache instanceof XCache_Object_Cache ) { // @phpstan-ignore-line

	if ( ! $bucket instanceof \Memcache && ! $bucket instanceof \Memcached ) {
	if ( ! $bucket instanceof Memcache && ! $bucket instanceof Memcached ) {

	if ( isset( $wp_object_cache->m ) && $wp_object_cache->m instanceof \Memcached ) {
	if ( isset( $wp_object_cache->m ) && $wp_object_cache->m instanceof Memcached ) {

	} elseif ( isset( $wp_object_cache->redis ) && $wp_object_cache->redis instanceof \Redis ) {
	} elseif ( isset( $wp_object_cache->redis ) && $wp_object_cache->redis instanceof Redis ) {

	} elseif ( isset( $wp_object_cache->lcache ) && $wp_object_cache->lcache instanceof \LCache\Integrated ) { // @phpstan-ignore-line
	} elseif ( isset( $wp_object_cache->lcache ) && $wp_object_cache->lcache instanceof \Cache\Integrated ) { // @phpstan-ignore-line

Add Site Health test for Object Caching #1301

Are you sure you want to change the base?

Add Site Health test for Object Caching #1301

Conversation

mkurdybanowski commented Jun 13, 2024 • edited by swissspidy Loading

Summary

Relevant technical choices

github-actions bot commented Jun 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

westonruter commented Jul 9, 2024

mkurdybanowski commented Jul 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkurdybanowski commented Jun 13, 2024 •

edited by swissspidy

Loading

github-actions bot commented Jun 13, 2024 •

edited

Loading

mkurdybanowski commented Jul 12, 2024 •

edited

Loading