<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[51208] trunk: Block Editor: Move caching to endpoint for unique responses.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/51208">51208</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/51208","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-06-22 21:23:19 +0000 (Tue, 22 Jun 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/53435">#53435</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblockpatternsphp">trunk/src/wp-includes/block-patterns.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestpatterndirectorycontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestpatterndirectorycontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-pattern-directory-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblockpatternsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/block-patterns.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-patterns.php 2021-06-22 21:22:27 UTC (rev 51207)
+++ trunk/src/wp-includes/block-patterns.php 2021-06-22 21:23:19 UTC (rev 51208)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -45,7 +45,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Import patterns from wordpress.org/patterns.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Register Core's official patterns from wordpress.org/patterns.
+ *
+ * @since 5.8.0
+ *
+ * @param WP_Screen $current_screen The screen that the current request was triggered from.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _load_remote_block_patterns( $current_screen ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $current_screen->is_block_editor ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -64,18 +68,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $should_load_remote = apply_filters( 'should_load_remote_block_patterns', true );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $supports_core_patterns && $should_load_remote ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $patterns = get_transient( 'wp_remote_block_patterns' );
- if ( ! $patterns ) {
- $request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
- $core_keyword_id = 11; // 11 is the ID for "core".
- $request->set_param( 'keyword', $core_keyword_id );
- $response = rest_do_request( $request );
- if ( $response->is_error() ) {
- return;
- }
- $patterns = $response->get_data();
- set_transient( 'wp_remote_block_patterns', $patterns, HOUR_IN_SECONDS );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
+ $core_keyword_id = 11; // 11 is the ID for "core".
+ $request->set_param( 'keyword', $core_keyword_id );
+ $response = rest_do_request( $request );
+ if ( $response->is_error() ) {
+ return;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $patterns = $response->get_data();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $patterns as $settings ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $pattern_name = 'core/' . sanitize_title( $settings['title'] );
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestpatterndirectorycontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php 2021-06-22 21:22:27 UTC (rev 51207)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php 2021-06-22 21:23:19 UTC (rev 51208)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -111,38 +111,73 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $query_args['search'] = $search_term;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $api_url = add_query_arg(
- array_map( 'rawurlencode', $query_args ),
- 'http://api.wordpress.org/patterns/1.0/'
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * 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 ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( wp_http_supports( array( 'ssl' ) ) ) {
- $api_url = set_url_scheme( $api_url, 'https' );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * 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 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wporg_response = wp_remote_get( $api_url );
- $raw_patterns = json_decode( wp_remote_retrieve_body( $wporg_response ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $raw_patterns ) {
+ $api_url = add_query_arg(
+ array_map( 'rawurlencode', $query_args ),
+ 'http://api.wordpress.org/patterns/1.0/'
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_wp_error( $wporg_response ) ) {
- $wporg_response->add_data( array( 'status' => 500 ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( wp_http_supports( array( 'ssl' ) ) ) {
+ $api_url = set_url_scheme( $api_url, 'https' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $wporg_response;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * 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’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 );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 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’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 ),
- )
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_wp_error( $raw_patterns ) ) {
+ $raw_patterns->add_data( array( 'status' => 500 ) );
+
+ return $raw_patterns;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $response = array();
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestpatterndirectorycontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-pattern-directory-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-pattern-directory-controller.php 2021-06-22 21:22:27 UTC (rev 51207)
+++ trunk/tests/phpunit/tests/rest-api/rest-pattern-directory-controller.php 2021-06-22 21:23:19 UTC (rev 51208)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -260,6 +260,46 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertWPError( $response->as_error() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @covers WP_REST_Pattern_Directory_Controller::get_items
+ *
+ * @since 5.8.0
+ */
+ public function test_get_items_prepare_filter() {
+ wp_set_current_user( self::$contributor_id );
+ self::mock_successful_response( 'browse-all', true );
+
+ // Test that filter changes uncached values.
+ add_filter(
+ 'rest_prepare_block_pattern',
+ function( $response ) {
+ return 'initial value';
+ }
+ );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
+ $response = rest_do_request( $request );
+ $patterns = $response->get_data();
+
+ $this->assertSame( 'initial value', $patterns[0] );
+
+ // Test that filter changes cached values (the previous request primed the cache).
+ add_filter(
+ 'rest_prepare_block_pattern',
+ function( $response ) {
+ return 'modified the cache';
+ },
+ 11
+ );
+
+ // Test that the filter works against cached values.
+ $request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
+ $response = rest_do_request( $request );
+ $patterns = $response->get_data();
+
+ $this->assertSame( 'modified the cache', $patterns[0] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_item() {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->markTestSkipped( 'Controller does not have get_item route.' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>