Changeset 51208 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php

Timestamp:

06/22/2021 09:23:19 PM (5 years ago)

Author:

iandunn

Message:

Block Editor: Move caching to endpoint for unique responses.

Now that the pattern API request includes the locale and version, the cache key needs to contain a hash of the query args.

Props ocean90, dd32, timothyblynjacobs
Fixes #53435

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php (modified) (1 diff)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php

@@ -112 +112 @@
                 }
 
-                $api_url = add_query_arg(
-                        array_map( 'rawurlencode', $query_args ),
-                        'http://api.wordpress.org/patterns/1.0/'
-                );
-
-                if ( wp_http_supports( array( 'ssl' ) ) ) {
-                        $api_url = set_url_scheme( $api_url, 'https' );
-                }
-
-                $wporg_response = wp_remote_get( $api_url );
-                $raw_patterns   = json_decode( wp_remote_retrieve_body( $wporg_response ) );
-
-                if ( is_wp_error( $wporg_response ) ) {
-                        $wporg_response->add_data( array( 'status' => 500 ) );
-
-                        return $wporg_response;
-                }
-
-                // Make sure w.org returned valid data.
-                if ( ! is_array( $raw_patterns ) ) {
-                        return new WP_Error(
-                                'pattern_api_failed',
-                                sprintf(
-                                /* translators: %s: Support forums URL. */
-                                        __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
-                                        __( 'https://wordpress.org/support/forums/' )
-                                ),
-                                array(
-                                        'status'   => 500,
-                                        'response' => wp_remote_retrieve_body( $wporg_response ),
-                                )
+                /*
+                 * Include a hash of the query args, so that different requests are stored in
+                 * separate caches.
+                 *
+                 * MD5 is chosen for its speed, low-collision rate, universal availability, and to stay
+                 * under the character limit for `_site_transient_timeout_{...}` keys.
+                 *
+                 * @link https://stackoverflow.com/questions/3665247/fastest-hash-for-non-cryptographic-uses
+                 */
+                $transient_key = 'wp_remote_block_patterns_' . md5( implode( '-', $query_args ) );
+
+                /*
+                 * Use network-wide transient to improve performance. The locale is the only site
+                 * configuration that affects the response, and it's included in the transient key.
+                 */
+                $raw_patterns = get_site_transient( $transient_key );
+
+                if ( ! $raw_patterns ) {
+                        $api_url = add_query_arg(
+                                array_map( 'rawurlencode', $query_args ),
+                                'http://api.wordpress.org/patterns/1.0/'
                         );
+
+                        if ( wp_http_supports( array( 'ssl' ) ) ) {
+                                $api_url = set_url_scheme( $api_url, 'https' );
+                        }
+
+                        /*
+                         * Default to a short TTL, to mitigate cache stampedes on high-traffic sites.
+                         * This assumes that most errors will be short-lived, e.g., packet loss that causes the
+                         * first request to fail, but a follow-up one will succeed. The value should be high
+                         * enough to avoid stampedes, but low enough to not interfere with users manually
+                         * re-trying a failed request.
+                         */
+                        $cache_ttl      = 5;
+                        $wporg_response = wp_remote_get( $api_url );
+                        $raw_patterns   = json_decode( wp_remote_retrieve_body( $wporg_response ) );
+
+                        if ( is_wp_error( $wporg_response ) ) {
+                                $raw_patterns = $wporg_response;
+
+                        } elseif ( ! is_array( $raw_patterns ) ) {
+                                // HTTP request succeeded, but response data is invalid.
+                                $raw_patterns = new WP_Error(
+                                        'pattern_api_failed',
+                                        sprintf(
+                                        /* translators: %s: Support forums URL. */
+                                                __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
+                                                __( 'https://wordpress.org/support/forums/' )
+                                        ),
+                                        array(
+                                                'response' => wp_remote_retrieve_body( $wporg_response ),
+                                        )
+                                );
+
+                        } else {
+                                // Response has valid data.
+                                $cache_ttl = HOUR_IN_SECONDS;
+                        }
+
+                        set_site_transient( $transient_key, $raw_patterns, $cache_ttl );
+                }
+
+                if ( is_wp_error( $raw_patterns ) ) {
+                        $raw_patterns->add_data( array( 'status' => 500 ) );
+
+                        return $raw_patterns;
                 }