<!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>[29939] trunk: `wp_schedule_single_event()` should not prevent scheduling a future duplicate event.</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 { 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/29939">29939</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/29939","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-10-17 19:16:26 +0000 (Fri, 17 Oct 2014)</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'>`wp_schedule_single_event()` should not prevent scheduling a future duplicate event. It should only reject an event as a duplicate if there is already a similar event scheduled within 10 minutes of the given timestamp.
Adds unit tests, fixes existing cron test.
Props tellyworth.
See <a href="https://core.trac.wordpress.org/changeset/9181">[9181]</a>, <a href="https://core.trac.wordpress.org/ticket/6966">#6966</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/28213">#28213</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescronphp">trunk/src/wp-includes/cron.php</a></li>
<li><a href="#trunktestsphpunittestscronphp">trunk/tests/phpunit/tests/cron.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescronphp"></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/cron.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/cron.php 2014-10-17 03:50:29 UTC (rev 29938)
+++ trunk/src/wp-includes/cron.php 2014-10-17 19:16:26 UTC (rev 29939)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,10 +20,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. Arguments to pass to the hook's callback function.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_schedule_single_event( $timestamp, $hook, $args = array()) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // don't schedule a duplicate if there's already an identical event due in the next 10 minutes
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // don't schedule a duplicate if there's already an identical event due within 10 minutes of it
</ins><span class="cx" style="display: block; padding: 0 10px"> $next = wp_next_scheduled($hook, $args);
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $next && $next <= $timestamp + 10 * MINUTE_IN_SECONDS )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $next && abs( $next - $timestamp ) <= 10 * MINUTE_IN_SECONDS ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $crons = _get_cron_array();
</span><span class="cx" style="display: block; padding: 0 10px"> $event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args );
</span></span></pre></div>
<a id="trunktestsphpunittestscronphp"></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/cron.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/cron.php 2014-10-17 03:50:29 UTC (rev 29938)
+++ trunk/tests/phpunit/tests/cron.php 2014-10-17 19:16:26 UTC (rev 29939)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -214,20 +214,39 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function test_not_duplicate_event() {
</span><span class="cx" style="display: block; padding: 0 10px"> // duplicate events far apart should work normally
</span><span class="cx" style="display: block; padding: 0 10px"> $hook = rand_str();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $args = array(rand_str());
- $ts1 = strtotime('+30 minutes');
- $ts2 = strtotime('+3 minutes');
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = array( rand_str() );
+ $ts1 = strtotime( '+30 minutes' );
+ $ts2 = strtotime( '+3 minutes' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // first one works
</span><span class="cx" style="display: block; padding: 0 10px"> wp_schedule_single_event( $ts1, $hook, $args );
</span><span class="cx" style="display: block; padding: 0 10px"> // second works too
</span><span class="cx" style="display: block; padding: 0 10px"> wp_schedule_single_event( $ts2, $hook, $args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // the next event should be at +5 minutes, not +3
- $this->assertEquals( $ts2, wp_next_scheduled($hook, $args) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // the next event should be at +3 minutes, even though that one was scheduled second
+ $this->assertEquals( $ts2, wp_next_scheduled( $hook, $args ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_unschedule_event( $ts2, $hook, $args );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // following event at +30 minutes should be there too
+ $this->assertEquals( $ts1, wp_next_scheduled( $hook, $args ) );
+ }
+
+ function test_not_duplicate_event_reversed() {
+ // duplicate events far apart should work normally regardless of order
+ $hook = rand_str();
+ $args = array( rand_str() );
+ $ts1 = strtotime( '+3 minutes' );
+ $ts2 = strtotime( '+30 minutes' );
+
+ // first one works
+ wp_schedule_single_event( $ts1, $hook, $args );
+ // second works too
+ wp_schedule_single_event( $ts2, $hook, $args );
+
+ // the next event should be at +3 minutes
+ $this->assertEquals( $ts1, wp_next_scheduled( $hook, $args ) );
+ wp_unschedule_event( $ts1, $hook, $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> // following event should be there too
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( $ts1, wp_next_scheduled($hook, $args) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( $ts2, wp_next_scheduled( $hook, $args ) );
</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">
</span></span></pre>
</div>
</div>
</body>
</html>