<!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>[58134] trunk: Options, Meta APIs: Prime transient options prior to use.</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/58134">58134</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/58134","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-05-11 23:51:55 +0000 (Sat, 11 May 2024)</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'>Options, Meta APIs: Prime transient options prior to use.
Reduce the number of queries getting and setting transients on sites without a persistent cache.
Transients are stored in two options: one each for the transient value and timeout. Priming the cache reduces the database queries for getting a transient from two to one.
Props peterwilsoncc, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/61193">#61193</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesoptionphp">trunk/src/wp-includes/option.php</a></li>
<li><a href="#trunktestsphpunittestsoptiontransientphp">trunk/tests/phpunit/tests/option/transient.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesoptionphp"></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/option.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/option.php 2024-05-11 18:26:06 UTC (rev 58133)
+++ trunk/src/wp-includes/option.php 2024-05-11 23:51:55 UTC (rev 58134)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1330,7 +1330,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $alloptions[ $transient_option ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $transient_timeout = '_transient_timeout_' . $transient;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $timeout = get_option( $transient_timeout );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_prime_option_caches( array( $transient_option, $transient_timeout ) );
+ $timeout = get_option( $transient_timeout );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( false !== $timeout && $timeout < time() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> delete_option( $transient_option );
</span><span class="cx" style="display: block; padding: 0 10px"> delete_option( $transient_timeout );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1410,6 +1411,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $transient_timeout = '_transient_timeout_' . $transient;
</span><span class="cx" style="display: block; padding: 0 10px"> $transient_option = '_transient_' . $transient;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_prime_option_caches( array( $transient_option, $transient_timeout ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === get_option( $transient_option ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $autoload = 'on';
</span></span></pre></div>
<a id="trunktestsphpunittestsoptiontransientphp"></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/option/transient.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/option/transient.php 2024-05-11 18:26:06 UTC (rev 58133)
+++ trunk/tests/phpunit/tests/option/transient.php 2024-05-11 23:51:55 UTC (rev 58134)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -81,6 +81,87 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Ensure get_transient() makes a single database request.
+ *
+ * @ticket 61193
+ *
+ * @covers ::get_transient
+ */
+ public function test_get_transient_with_timeout_makes_a_single_database_call() {
+ global $wpdb;
+ $key = 'test_transient';
+ $value = 'test_value';
+ $timeout = 100;
+ $expected_query = "SELECT option_name, option_value FROM $wpdb->options WHERE option_name IN ('_transient_{$key}','_transient_timeout_{$key}')";
+ $unexpected_query_transient = "SELECT option_value FROM $wpdb->options WHERE option_name = '_transient_{$key}' LIMIT 1";
+ $unexpected_query_timeout = "SELECT option_value FROM $wpdb->options WHERE option_name = '_transient_timeout_{$key}' LIMIT 1";
+ $queries = array();
+
+ set_transient( $key, $value, $timeout );
+
+ // Clear the cache of both the transient and the timeout.
+ $option_names = array(
+ '_transient_' . $key,
+ '_transient_timeout_' . $key,
+ );
+ foreach ( $option_names as $option_name ) {
+ wp_cache_delete( $option_name, 'options' );
+ }
+
+ add_filter(
+ 'query',
+ function ( $query ) use ( &$queries ) {
+ $queries[] = $query;
+ return $query;
+ }
+ );
+
+ $before_queries = get_num_queries();
+ $this->assertSame( $value, get_transient( $key ) );
+ $transient_queries = get_num_queries() - $before_queries;
+ $this->assertSame( 1, $transient_queries, 'Expected a single database query to retrieve the transient.' );
+ $this->assertContains( $expected_query, $queries, 'Expected query to prime both transient options in a single call.' );
+ // Note: Some versions of PHPUnit and/or the test suite may report failures as asserting to contain rather than not to contain.
+ $this->assertNotContains( $unexpected_query_transient, $queries, 'Unexpected query of transient option individually.' );
+ $this->assertNotContains( $unexpected_query_timeout, $queries, 'Unexpected query of transient timeout option individually.' );
+ }
+
+ /**
+ * Ensure set_transient() primes the option cache checking for an existing transient.
+ *
+ * @ticket 61193
+ *
+ * @covers ::set_transient
+ */
+ public function test_set_transient_primes_option_cache() {
+ global $wpdb;
+ $key = 'test_transient';
+ $value = 'test_value';
+ $timeout = 100;
+ $expected_query = "SELECT option_name, option_value FROM $wpdb->options WHERE option_name IN ('_transient_{$key}','_transient_timeout_{$key}')";
+ $unexpected_query_transient = "SELECT option_value FROM $wpdb->options WHERE option_name = '_transient_{$key}' LIMIT 1";
+ $unexpected_query_timeout = "SELECT option_value FROM $wpdb->options WHERE option_name = '_transient_timeout_{$key}' LIMIT 1";
+ $queries = array();
+
+ add_filter(
+ 'query',
+ function ( $query ) use ( &$queries ) {
+ $queries[] = $query;
+ return $query;
+ }
+ );
+
+ $before_queries = get_num_queries();
+ $this->assertTrue( set_transient( $key, $value, $timeout ) );
+ $transient_queries = get_num_queries() - $before_queries;
+ $this->assertSame( 3, $transient_queries, 'Expected three database queries setting the transient.' );
+ $this->assertContains( $expected_query, $queries, 'Expected query to prime both transient options in a single call.' );
+ // Note: Some versions of PHPUnit and/or the test suite may report failures as asserting to contain rather than not to contain.
+ $this->assertNotContains( $unexpected_query_transient, $queries, 'Unexpected query of transient option individually.' );
+ $this->assertNotContains( $unexpected_query_timeout, $queries, 'Unexpected query of transient timeout option individually.' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 22807
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::set_transient
</span></span></pre>
</div>
</div>
</body>
</html>