<!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>[24749] trunk/wp-includes/js: Simplify heartbeat API.</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/24749">24749</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2013-07-19 01:39:48 +0000 (Fri, 19 Jul 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Simplify heartbeat API.
* Move to a method to check connection errors, a better framework for future changes.
* Remove start(), stop(), autostart.
props carldanley.
fixes <a href="http://core.trac.wordpress.org/ticket/23216">#23216</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesjsautosavejs">trunk/wp-includes/js/autosave.js</a></li>
<li><a href="#trunkwpincludesjsheartbeatjs">trunk/wp-includes/js/heartbeat.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesjsautosavejs"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/js/autosave.js (24748 => 24749)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/js/autosave.js 2013-07-19 00:58:51 UTC (rev 24748)
+++ trunk/wp-includes/js/autosave.js 2013-07-19 01:39:48 UTC (rev 24749)
</span><span class="lines">@@ -246,7 +246,7 @@
</span><span class="cx">
</span><span class="cx"> function autosave_enable_buttons() {
</span><span class="cx"> jQuery(document).trigger('autosave-enable-buttons');
</span><del>- if ( ! wp.heartbeat.connectionLost ) {
</del><ins>+ if ( ! wp.heartbeat.hasConnectionError() ) {
</ins><span class="cx"> // delay that a bit to avoid some rare collisions while the DOM is being updated.
</span><span class="cx"> setTimeout(function(){
</span><span class="cx"> var parent = jQuery('#submitpost');
</span></span></pre></div>
<a id="trunkwpincludesjsheartbeatjs"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/js/heartbeat.js (24748 => 24749)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/js/heartbeat.js 2013-07-19 00:58:51 UTC (rev 24748)
+++ trunk/wp-includes/js/heartbeat.js 2013-07-19 01:39:48 UTC (rev 24749)
</span><span class="lines">@@ -40,10 +40,18 @@
</span><span class="cx"> isUserActive,
</span><span class="cx"> userActiveEvents,
</span><span class="cx"> winBlurTimeout,
</span><del>- frameBlurTimeout = -1;
</del><ins>+ frameBlurTimeout = -1,
+ hasConnectionError = false;
</ins><span class="cx">
</span><del>- this.autostart = true;
- this.connectionLost = false;
</del><ins>+ /**
+ * Returns a boolean that's indicative of whether or not there is a connection error
+ *
+ * @returns boolean
+ * @private
+ */
+ this.hasConnectionError = function() {
+ return hasConnectionError;
+ };
</ins><span class="cx">
</span><span class="cx"> if ( typeof( window.heartbeatSettings ) == 'object' ) {
</span><span class="cx"> settings = $.extend( {}, window.heartbeatSettings );
</span><span class="lines">@@ -121,13 +129,13 @@
</span><span class="cx"> break;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if ( trigger && ! self.connectionLost ) {
- self.connectionLost = true;
</del><ins>+ if ( trigger && ! self.hasConnectionError() ) {
+ hasConnectionError = true;
</ins><span class="cx"> $(document).trigger( 'heartbeat-connection-lost', [error] );
</span><span class="cx"> }
</span><del>- } else if ( self.connectionLost ) {
</del><ins>+ } else if ( self.hasConnectionError() ) {
</ins><span class="cx"> errorcount = 0;
</span><del>- self.connectionLost = false;
</del><ins>+ hasConnectionError = false;
</ins><span class="cx"> $(document).trigger( 'heartbeat-connection-restored' );
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="lines">@@ -152,7 +160,7 @@
</span><span class="cx">
</span><span class="cx"> // If nothing to send (nothing is expecting a response),
</span><span class="cx"> // schedule the next tick and bail
</span><del>- if ( empty && ! self.connectionLost ) {
</del><ins>+ if ( empty && ! self.hasConnectionError() ) {
</ins><span class="cx"> connecting = false;
</span><span class="cx"> next();
</span><span class="cx"> return;
</span><span class="lines">@@ -179,7 +187,7 @@
</span><span class="cx"> return errorstate( 'empty' );
</span><span class="cx">
</span><span class="cx"> // Clear error state
</span><del>- if ( self.connectionLost )
</del><ins>+ if ( self.hasConnectionError() )
</ins><span class="cx"> errorstate();
</span><span class="cx">
</span><span class="cx"> if ( response.nonces_expired ) {
</span><span class="lines">@@ -205,7 +213,7 @@
</span><span class="cx"> errorstate( textStatus || 'unknown' );
</span><span class="cx"> self.error( jqXHR, textStatus, error );
</span><span class="cx"> });
</span><del>- };
</del><ins>+ }
</ins><span class="cx">
</span><span class="cx"> function next() {
</span><span class="cx"> var delta = time() - tick, t = interval;
</span><span class="lines">@@ -332,19 +340,16 @@
</span><span class="cx">
</span><span class="cx"> // Check for user activity every 30 seconds.
</span><span class="cx"> window.setInterval( function(){ checkUserActive(); }, 30000 );
</span><ins>+ $(document).ready( function() {
+ // Start one tick (15 sec) after DOM ready
+ running = true;
+ tick = time();
+ next();
+ });
</ins><span class="cx">
</span><del>- if ( this.autostart ) {
- $(document).ready( function() {
- // Start one tick (15 sec) after DOM ready
- running = true;
- tick = time();
- next();
- });
- }
-
</del><span class="cx"> this.hasFocus = function() {
</span><span class="cx"> return hasFocus;
</span><del>- }
</del><ins>+ };
</ins><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Get/Set the interval
</span><span class="lines">@@ -401,27 +406,6 @@
</span><span class="cx"> return tempInterval ? tempInterval / 1000 : interval / 1000;
</span><span class="cx"> };
</span><span class="cx">
</span><del>- // Start. Has no effect if heartbeat is already running
- this.start = function() {
- if ( running )
- return false;
-
- running = true;
- connect();
- return true;
- };
-
- // Stop. If a XHR is in progress, abort it
- this.stop = function() {
- if ( self.xhr && self.xhr.readyState != 4 )
- self.xhr.abort();
-
- // Reset the error state
- errorstate();
- running = false;
- return true;
- }
-
</del><span class="cx"> /**
</span><span class="cx"> * Enqueue data to send with the next XHR
</span><span class="cx"> *
</span><span class="lines">@@ -447,7 +431,7 @@
</span><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="cx"> return false;
</span><del>- }
</del><ins>+ };
</ins><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Check if data with a particular handle is queued
</span><span class="lines">@@ -457,8 +441,8 @@
</span><span class="cx"> */
</span><span class="cx"> this.isQueued = function( handle ) {
</span><span class="cx"> return queue[handle];
</span><del>- }
- }
</del><ins>+ };
+ };
</ins><span class="cx">
</span><span class="cx"> $.extend( Heartbeat.prototype, {
</span><span class="cx"> tick: function( data, textStatus, jqXHR ) {
</span></span></pre>
</div>
</div>
</body>
</html>