Heartbeat: clean up code style, better naming, better code structure. Props carldanley, props evansolomon.

Changes:
- Add connectNow() public method to trigger a connection immediately.
- Remove the "skipping" when no data to send.
- Change the default interval to 60 sec.
- Fix resetting the next connection time when changing the interval.
See #25073.
Built from https://develop.svn.wordpress.org/trunk@26169


git-svn-id: http://core.svn.wordpress.org/trunk@26078 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-admin/includes/post.php

@@ -1185,7 +1185,7 @@ function wp_check_post_lock( $post_id ) {
 	$time = $lock[0];
 	$user = isset( $lock[1] ) ? $lock[1] : get_post_meta( $post->ID, '_edit_last', true );
 
-	$time_window = apply_filters( 'wp_check_post_lock_window', 120 );
+	$time_window = apply_filters( 'wp_check_post_lock_window', 150 );
 
 	if ( $time && $time > time() - $time_window && $user != get_current_user_id() )
 		return $user;

wp-admin/js/inline-edit-post.js

@@ -325,6 +325,11 @@ $( document ).on( 'heartbeat-tick.wp-check-locked-posts', function( e, data ) {
 
 	if ( check.length )
 		data['wp-check-locked-posts'] = check;
+}).ready( function() {
+	// Set the heartbeat interval to 15 sec.
+	if ( typeof wp !== 'undefined' && wp.heartbeat ) {
+		wp.heartbeat.setInterval( 15 );
+	}
 });
 
 }(jQuery));

wp-admin/js/post.js

@@ -370,6 +370,11 @@ jQuery(document).ready( function($) {
 			e.preventDefault();
 		}
 	}).filter(':visible').find('.wp-tab-first').focus();
+	
+	// Set the heartbeat interval to 15 sec. if post lock dialogs are enabled
+	if ( typeof wp !== 'undefined' && wp.heartbeat && $('#post-lock-dialog').length ) {
+		wp.heartbeat.setInterval( 15 );
+	}
 
 	// multi-taxonomies
 	if ( $('#tagsdiv-post_tag').length ) {

wp-includes/js/heartbeat.js

@@ -6,11 +6,11 @@
  * to use it, please follow the development closely.
  *
  * Heartbeat is a simple server polling API that sends XHR requests to
- * the server every 15 seconds and triggers events (or callbacks) upon
+ * the server every 15 - 60 seconds and triggers events (or callbacks) upon
  * receiving data. Currently these 'ticks' handle transports for post locking,
  * login-expiration warnings, and related tasks while a user is logged in.
  *
- * Available filters in ajax-actions.php:
+ * Available PHP filters (in ajax-actions.php):
  * - heartbeat_received
  * - heartbeat_send
  * - heartbeat_tick
@@ -19,96 +19,195 @@
  * - heartbeat_nopriv_tick
  * @see wp_ajax_nopriv_heartbeat(), wp_ajax_heartbeat()
  *
+ * Custom jQuery events:
+ * - heartbeat-send
+ * - heartbeat-tick
+ * - heartbeat-error
+ * - heartbeat-connection-lost
+ * - heartbeat-connection-restored
+ * - heartbeat-nonces-expired
+ *
  * @since 3.6.0
  */
 
- // Ensure the global `wp` object exists.
+( function( $, window, undefined ) {
-window.wp = window.wp || {};
-
-(function($){
 	var Heartbeat = function() {
-		var self = this,
+		var $document = $(document),
-			running,
+			settings = {
-			beat,
+				// Used to stop the "beat"
-			screenId = typeof pagenow != 'undefined' ? pagenow : '',
+				isRunning: true,
-			url = typeof ajaxurl != 'undefined' ? ajaxurl : '',
+
-			settings,
+				// Current screen id, defaults to the JS global 'pagenow' when present (in the admin) or 'front'
-			tick = 0,
+				screenId: '',
-			queue = {},
+
-			interval,
+				// XHR request URL, defaults to the JS global 'ajaxurl' when present
-			connecting,
+				url: '',
-			countdown = 0,
+
-			errorcount = 0,
+				// Timestamp, start of the last connection request
-			tempInterval,
+				lastTick: 0,
-			hasFocus = true,
+
-			isUserActive,
+				// Container for the enqueued items
-			userActiveEvents,
+				queue: {},
-			winBlurTimeout,
+
-			frameBlurTimeout = -1,
+				// Connect interval (in seconds)
-			hasConnectionError = null;
+				mainInterval: 60,
+
+				// Used when the interval is set to 5 sec. temporarily
+				tempInterval: 0,
+
+				// Used when the interval is reset
+				originalInterval: 0,
+
+				// Used together with tempInterval
+				countdown: 0,
+
+				// Whether a connection is currently in progress
+				connecting: false,
+
+				// Whether a connection error occured
+				connectionError: false,
+
+				// Used to track non-critical errors
+				errorcount: 0,
+
+				// Whether at least one connection has completed successfully
+				hasConnected: false,
+
+				// Whether the current browser window is in focus and the user is active
+				hasFocus: true,
+
+				// Timestamp, last time the user was active. Checked every 30 sec.
+				userActivity: 0,
+
+				// Flags whether events tracking user activity were set
+				userActivityEvents: false,
+
+				// References to various timeouts
+				beatTimer: 0,
+				winBlurTimer: 0,
+				frameBlurTimer: 0
+			};
 
 		/**
-		 * Returns a boolean that's indicative of whether or not there is a connection error
+		 * Set local vars and events, then start
 		 *
-		 * @returns boolean
+		 * @access private
+		 *
+		 * @return void
 		 */
-		this.hasConnectionError = function() {
+		function initialize() {
-			return !! hasConnectionError;
+			if ( typeof window.pagenow === 'string' ) {
-		};
+				settings.screenId = window.pagenow;
+			}
 
-		if ( typeof( window.heartbeatSettings ) == 'object' ) {
+			if ( typeof window.ajaxurl === 'string' ) {
-			settings = $.extend( {}, window.heartbeatSettings );
+				settings.url = window.ajaxurl;
+			}
 
-			// Add private vars
+			// Pull in options passed from PHP
-			url = settings.ajaxurl || url;
+			if ( typeof window.heartbeatSettings === 'object' ) {
-			delete settings.ajaxurl;
+				var options = window.heartbeatSettings;
-			delete settings.nonce;
 
-			interval = settings.interval || 15; // default interval
+				// The XHR URL can be passed as option when window.ajaxurl is not set
-			delete settings.interval;
+				if ( ! settings.url && options.ajaxurl ) {
-			// The interval can be from 15 to 60 sec. and can be set temporarily to 5 sec.
+					settings.url = options.ajaxurl;
-			if ( interval < 15 )
+				}
-				interval = 15;
-			else if ( interval > 60 )
-				interval = 60;
 
-			interval = interval * 1000;
+				// The interval can be from 15 to 60 sec. and can be set temporarily to 5 sec.
+				if ( options.interval ) {
+					settings.mainInterval = options.interval;
 
-			// 'screenId' can be added from settings on the front-end where the JS global 'pagenow' is not set
+					if ( settings.mainInterval < 15 ) {
-			screenId = screenId || settings.screenId || 'front';
+						settings.mainInterval = 15;
-			delete settings.screenId;
+					} else if ( settings.mainInterval > 60 ) {
+						settings.mainInterval = 60;
+					}
+				}
 
-			// Add or overwrite public vars
+				// 'screenId' can be added from settings on the front-end where the JS global 'pagenow' is not set
-			$.extend( this, settings );
+				if ( ! settings.screenId ) {
+					settings.screenId = options.screenId || 'front';
+				}
+			}
+
+			// Convert to milliseconds
+			settings.mainInterval = settings.mainInterval * 1000;
+			settings.originalInterval = settings.mainInterval;
+
+			// Set focus/blur events on the window
+			$(window).on( 'blur.wp-heartbeat-focus', function() {
+				setFrameFocusEvents();
+				// We don't know why the 'blur' was fired. Either the user clicked in an iframe or outside the browser.
+				// Running blurred() after some timeout lets us cancel it if the user clicked in an iframe.
+				settings.winBlurTimer = window.setTimeout( function(){ blurred(); }, 500 );
+			}).on( 'focus.wp-heartbeat-focus', function() {
+				removeFrameFocusEvents();
+				focused();
+			}).on( 'unload.wp-heartbeat', function() {
+				// Don't connect any more
+				settings.isRunning = false;
+			});
+
+			// Check for user activity every 30 seconds.
+			window.setInterval( function(){ checkUserActivity(); }, 30000 );
+
+			// Start one tick after DOM ready
+			$document.ready( function() {
+				settings.lastTick = time();
+				scheduleNextTick();
+			});
 		}
 
-		function time(s) {
+		/**
-			if ( s )
+		 * Return the current time according to the browser
-				return parseInt( (new Date()).getTime() / 1000 );
+		 *
-
+		 * @access private
+		 *
+		 * @return int
+		 */
+		function time() {
 			return (new Date()).getTime();
 		}
 
+		/**
+		 * Check if the iframe is from the same origin
+		 *
+		 * @access private
+		 *
+		 * @return bool
+		 */
 		function isLocalFrame( frame ) {
 			var origin, src = frame.src;
 
+			// Need to compare strings as WebKit doesn't throw JS errors when iframes have different origin.
+			// It throws uncatchable exceptions.
 			if ( src && /^https?:\/\//.test( src ) ) {
 				origin = window.location.origin ? window.location.origin : window.location.protocol + '//' + window.location.host;
 
-				if ( src.indexOf( origin ) !== 0 )
+				if ( src.indexOf( origin ) !== 0 ) {
 					return false;
+				}
 			}
 
 			try {
-				if ( frame.contentWindow.document )
+				if ( frame.contentWindow.document ) {
 					return true;
+				}
 			} catch(e) {}
 
 			return false;
 		}
 
-		// Set error state and fire an event on XHR errors or timeout
+		/**
-		function errorstate( error, status ) {
+		 * Set error state and fire an event on XHR errors or timeout
+		 *
+		 * @access private
+		 *
+		 * @param string error The error type passed from the XHR
+		 * @param int status The HTTP status code passed from jqXHR (200, 404, 500, etc.)
+		 * @return void
+		 */
+		function setErrorState( error, status ) {
 			var trigger;
 
 			if ( error ) {
@@ -120,203 +219,273 @@ window.wp = window.wp || {};
 						// no response for 30 sec.
 						trigger = true;
 						break;
-					case 'parsererror':
 					case 'error':
+						if ( 503 === status && settings.hasConnected ) {
+							trigger = true;
+							break;
+						}
+						// Pass through other error statuses
+					case 'parsererror':
 					case 'empty':
 					case 'unknown':
-						errorcount++;
+						settings.errorcount++;
 
-						if ( errorcount > 2 )
+						if ( settings.errorcount > 2 && settings.hasConnected ) {
 							trigger = true;
+						}
 
 						break;
 				}
 
-				if ( 503 == status && false === hasConnectionError ) {
+				if ( trigger && ! hasConnectionError() ) {
-					trigger = true;
+					settings.connectionError = true;
-				}
-
-				if ( trigger && ! self.hasConnectionError() ) {
-					hasConnectionError = true;
 					$(document).trigger( 'heartbeat-connection-lost', [error, status] );
 				}
-			} else if ( self.hasConnectionError() ) {
-				errorcount = 0;
-				hasConnectionError = false;
-				$(document).trigger( 'heartbeat-connection-restored' );
-			} else if ( null === hasConnectionError ) {
-				hasConnectionError = false;
 			}
 		}
 
-		function connect() {
+		/**
-			var send = {}, data, i, empty = true,
+		 * Clear the error state and fire an event
-			nonce = typeof window.heartbeatSettings == 'object' ? window.heartbeatSettings.nonce : '';
+		 *
-			tick = time();
+		 * @access private
+		 *
+		 * @return void
+		 */
+		function clearErrorState() {
+			// Has connected successfully
+			settings.hasConnected = true;
 
-			data = $.extend( {}, queue );
+			if ( hasConnectionError() ) {
-			// Clear the data queue, anything added after this point will be send on the next tick
+				settings.errorcount = 0;
-			queue = {};
+				settings.connectionError = false;
-
+				$document.trigger( 'heartbeat-connection-restored' );
-			$(document).trigger( 'heartbeat-send', [data] );
-
-			for ( i in data ) {
-				if ( data.hasOwnProperty( i ) ) {
-					empty = false;
-					break;
-				}
 			}
+		}
 
-			// If nothing to send (nothing is expecting a response),
+		/**
-			// schedule the next tick and bail
+		 * Gather the data and connect to the server
-			if ( empty && ! self.hasConnectionError() ) {
+		 *
-				connecting = false;
+		 * @access private
-				next();
+		 *
+		 * @return void
+		 */
+		function connect() {
+			var ajaxData, heartbeatData;
+
+			// If the connection to the server is slower than the interval,
+			// heartbeat connects as soon as the previous connection's response is received.
+			if ( settings.connecting ) {
 				return;
 			}
 
-			send.data = data;
+			settings.lastTick = time();
-			send.interval = interval / 1000;
-			send._nonce = nonce;
-			send.action = 'heartbeat';
-			send.screen_id = screenId;
-			send.has_focus = hasFocus;
 
-			connecting = true;
+			heartbeatData = $.extend( {}, settings.queue );
-			self.xhr = $.ajax({
+			// Clear the data queue, anything added after this point will be send on the next tick
-				url: url,
+			settings.queue = {};
+
+			$document.trigger( 'heartbeat-send', [ heartbeatData ] );
+
+			ajaxData = {
+				data: heartbeatData,
+				interval: settings.tempInterval ? settings.tempInterval / 1000 : settings.mainInterval / 1000,
+				_nonce: typeof window.heartbeatSettings === 'object' ? window.heartbeatSettings.nonce : '',
+				action: 'heartbeat',
+				screen_id: settings.screenId,
+				has_focus: settings.hasFocus
+			};
+
+			settings.connecting = true;
+			settings.xhr = $.ajax({
+				url: settings.url,
 				type: 'post',
 				timeout: 30000, // throw an error if not completed after 30 sec.
-				data: send,
+				data: ajaxData,
 				dataType: 'json'
+			}).always( function() {
+				settings.connecting = false;
+				scheduleNextTick();
 			}).done( function( response, textStatus, jqXHR ) {
-				var new_interval;
+				var newInterval;
 
-				if ( ! response )
+				if ( ! response ) {
-					return errorstate( 'empty' );
+					setErrorState( 'empty' );
+					return;
+				}
 
-				// Clear error state
+				clearErrorState();
-				if ( self.hasConnectionError() )
-					errorstate();
 
 				if ( response.nonces_expired ) {
-					$(document).trigger( 'heartbeat-nonces-expired' );
+					$document.trigger( 'heartbeat-nonces-expired' );
 					return;
 				}
 
 				// Change the interval from PHP
 				if ( response.heartbeat_interval ) {
-					new_interval = response.heartbeat_interval;
+					newInterval = response.heartbeat_interval;
 					delete response.heartbeat_interval;
 				}
 
-				self.tick( response, textStatus, jqXHR );
+				$document.trigger( 'heartbeat-tick', [response, textStatus, jqXHR] );
 
-				// do this last, can trigger the next XHR if connection time > 5 sec. and new_interval == 'fast'
+				// Do this last, can trigger the next XHR if connection time > 5 sec. and newInterval == 'fast'
-				if ( new_interval )
+				if ( newInterval ) {
-					self.interval.call( self, new_interval );
+					setInterval( newInterval );
-			}).always( function() {
+				}
-				connecting = false;
-				next();
 			}).fail( function( jqXHR, textStatus, error ) {
-				errorstate( textStatus || 'unknown', jqXHR.status );
+				setErrorState( textStatus || 'unknown', jqXHR.status );
-				self.error( jqXHR, textStatus, error );
+				$document.trigger( 'heartbeat-error', [jqXHR, textStatus, error] );
 			});
 		}
 
-		function next() {
+		/**
-			var delta = time() - tick, t = interval;
+		 * Schedule the next connection
+		 *
+		 * Fires immediately if the connection time is longer than the interval.
+		 *
+		 * @access private
+		 *
+		 * @return void
+		 */
+		function scheduleNextTick() {
+			var delta = time() - settings.lastTick,
+				interval = settings.mainInterval;
 
-			if ( ! running )
+			if ( ! settings.isRunning ) {
 				return;
-
-			if ( ! hasFocus ) {
-				t = 100000; // 100 sec. Post locks expire after 120 sec.
-			} else if ( countdown > 0 && tempInterval ) {
-				t = tempInterval;
-				countdown--;
 			}
 
-			window.clearTimeout(beat);
+			if ( ! settings.hasFocus ) {
+				interval = 120000; // 120 sec. Post locks expire after 150 sec.
+			} else if ( settings.countdown > 0 && settings.tempInterval ) {
+				interval = settings.tempInterval;
+				settings.countdown--;
 
-			if ( delta < t ) {
+				if ( settings.countdown < 1 ) {
-				beat = window.setTimeout(
+					settings.tempInterval = 0;
-					function(){
+				}
-						if ( running )
+			}
+
+			window.clearTimeout( settings.beatTimer );
+
+			if ( delta < interval ) {
+				settings.beatTimer = window.setTimeout(
+					function() {
 							connect();
 					},
-					t - delta
+					interval - delta
 				);
 			} else {
 				connect();
 			}
 		}
 
+		/**
+		 * Set the internal state when the browser window looses focus
+		 *
+		 * @access private
+		 *
+		 * @return void
+		 */
 		function blurred() {
-			window.clearTimeout(winBlurTimeout);
+			clearFocusTimers();
-			window.clearTimeout(frameBlurTimeout);
+			settings.hasFocus = false;
-			winBlurTimeout = frameBlurTimeout = 0;
-
-			hasFocus = false;
 		}
 
+		/**
+		 * Set the internal state when the browser window is focused
+		 *
+		 * @access private
+		 *
+		 * @return void
+		 */
 		function focused() {
-			window.clearTimeout(winBlurTimeout);
+			clearFocusTimers();
-			window.clearTimeout(frameBlurTimeout);
+			settings.userActivity = time();
-			winBlurTimeout = frameBlurTimeout = 0;
 
-			isUserActive = time();
+			if ( ! settings.hasFocus ) {
-
+				settings.hasFocus = true;
-			if ( hasFocus )
+				scheduleNextTick();
-				return;
+			}
-
-			hasFocus = true;
-			window.clearTimeout(beat);
-
-			if ( ! connecting )
-				next();
 		}
 
-		function setFrameEvents() {
+		/**
-			$('iframe').each( function( i, frame ){
+		 * Add focus/blur events to all local iframes
-				if ( ! isLocalFrame( frame ) )
+		 *
+		 * Used to detect when focus is moved from the main window to an iframe
+		 *
+		 * @access private
+		 *
+		 * @return void
+		 */
+		function setFrameFocusEvents() {
+			$('iframe').each( function( i, frame ) {
+				if ( ! isLocalFrame( frame ) ) {
 					return;
+				}
 
-				if ( $.data( frame, 'wp-heartbeat-focus' ) )
+				if ( $.data( frame, 'wp-heartbeat-focus' ) ) {
 					return;
+				}
 
 				$.data( frame, 'wp-heartbeat-focus', 1 );
 
-				$( frame.contentWindow ).on( 'focus.wp-heartbeat-focus', function(e) {
+				$( frame.contentWindow ).on( 'focus.wp-heartbeat-focus', function() {
 					focused();
-				}).on('blur.wp-heartbeat-focus', function(e) {
+				}).on('blur.wp-heartbeat-focus', function() {
-					setFrameEvents();
+					setFrameFocusEvents();
-					frameBlurTimeout = window.setTimeout( function(){ blurred(); }, 500 );
+					// We don't know why 'blur' was fired. Either the user clicked in the main window or outside the browser.
+					// Running blurred() after some timeout lets us cancel it if the user clicked in the main window.
+					settings.frameBlurTimer = window.setTimeout( function(){ blurred(); }, 500 );
 				});
 			});
 		}
 
-		$(window).on( 'blur.wp-heartbeat-focus', function(e) {
+		/**
-			setFrameEvents();
+		 * Remove the focus/blur events to all local iframes
-			winBlurTimeout = window.setTimeout( function(){ blurred(); }, 500 );
+		 *
-		}).on( 'focus.wp-heartbeat-focus', function() {
+		 * @access private
+		 *
+		 * @return void
+		 */
+		function removeFrameFocusEvents() {
 			$('iframe').each( function( i, frame ) {
-				if ( !isLocalFrame( frame ) )
+				if ( ! isLocalFrame( frame ) ) {
 					return;
+				}
 
 				$.removeData( frame, 'wp-heartbeat-focus' );
 				$( frame.contentWindow ).off( '.wp-heartbeat-focus' );
 			});
+		}
 
-			focused();
+		/**
-		});
+		 * Clear the reset timers for focus/blur events on the window and iframes
+		 *
+		 * @access private
+		 *
+		 * @return void
+		 */
+		function clearFocusTimers() {
+			window.clearTimeout( settings.winBlurTimer );
+			window.clearTimeout( settings.frameBlurTimer );
+		}
 
+		/**
+		 * Runs when the user becomes active after a period of inactivity
+		 *
+		 * @access private
+		 *
+		 * @return void
+		 */
 		function userIsActive() {
-			userActiveEvents = false;
+			settings.userActivityEvents = false;
-			$(document).off( '.wp-heartbeat-active' );
+			$document.off( '.wp-heartbeat-active' );
+
 			$('iframe').each( function( i, frame ) {
-				if ( ! isLocalFrame( frame ) )
+				if ( ! isLocalFrame( frame ) ) {
 					return;
+				}
 
 				$( frame.contentWindow ).off( '.wp-heartbeat-active' );
 			});
@@ -324,101 +493,139 @@ window.wp = window.wp || {};
 			focused();
 		}
 
-		// Set 'hasFocus = true' if user is active and the window is in the background.
+		/**
-		// Set 'hasFocus = false' if the user has been inactive (no mouse or keyboard activity) for 5 min. even when the window has focus.
+		 * Check for user activity
-		function checkUserActive() {
+		 *
-			var lastActive = isUserActive ? time() - isUserActive : 0;
+		 * Runs every 30 sec.
+		 * Sets 'hasFocus = true' if user is active and the window is in the background.
+		 * Set 'hasFocus = false' if the user has been inactive (no mouse or keyboard activity)
+		 * for 5 min. even when the window has focus.
+		 *
+		 * @access private
+		 *
+		 * @return void
+		 */
+		function checkUserActivity() {
+			var lastActive = settings.userActivity ? time() - settings.userActivity : 0;
 
-			// Throttle down when no mouse or keyboard activity for 5 min
+			if ( lastActive > 300000 && settings.hasFocus ) {
-			if ( lastActive > 300000 && hasFocus )
+				// Throttle down when no mouse or keyboard activity for 5 min
-				 blurred();
+				blurred();
+			}
 
-			if ( ! userActiveEvents ) {
+			if ( ! settings.userActivityEvents ) {
-				$(document).on( 'mouseover.wp-heartbeat-active keyup.wp-heartbeat-active', function(){ userIsActive(); } );
+				$document.on( 'mouseover.wp-heartbeat-active keyup.wp-heartbeat-active', function(){ userIsActive(); } );
 
 				$('iframe').each( function( i, frame ) {
-					if ( ! isLocalFrame( frame ) )
+					if ( ! isLocalFrame( frame ) ) {
 						return;
+					}
 
 					$( frame.contentWindow ).on( 'mouseover.wp-heartbeat-active keyup.wp-heartbeat-active', function(){ userIsActive(); } );
 				});
 
-				userActiveEvents = true;
+				settings.userActivityEvents = true;
 			}
 		}
 
-		// Check for user activity every 30 seconds.
+		// Public methods
-		window.setInterval( function(){ checkUserActive(); }, 30000 );
-		$(document).ready( function() {
-			// Start one tick (15 sec) after DOM ready
-			running = true;
-			tick = time();
-			next();
-		});
 
-		this.hasFocus = function() {
+		/**
-			return hasFocus;
+		 * Whether the window (or any local iframe in it) has focus, or the user is active
-		};
+		 *
+		 * @return bool
+		 */
+		function hasFocus() {
+			return settings.hasFocus;
+		}
+
+		/**
+		 * Whether there is a connection error
+		 *
+		 * @return bool
+		 */
+		function hasConnectionError() {
+			return settings.connectionError;
+		}
+
+		/**
+		 * Connect asap regardless of 'hasFocus'
+		 *
+		 * Will not open two concurrent connections. If a connection is in progress,
+		 * will connect again immediately after the current connection completes.
+		 *
+		 * @return void
+		 */
+		function connectNow() {
+			settings.lastTick = 0;
+			scheduleNextTick();
+		}
 
 		/**
 		 * Get/Set the interval
 		 *
-		 * When setting to 'fast', the interval is 5 sec. for the next 30 ticks (for 2 min and 30 sec).
+		 * When setting to 'fast' or 5, by default interval is 5 sec. for the next 30 ticks (for 2 min and 30 sec).
+		 * In this case the number of 'ticks' can be passed as second argument.
 		 * If the window doesn't have focus, the interval slows down to 2 min.
 		 *
-		 * @param string speed Interval speed: 'fast' (5sec), 'standard' (15sec) default, 'slow' (60sec)
+		 * @param mixed speed Interval: 'fast' or 5, 15, 30, 60
-		 * @param string ticks Used with speed = 'fast', how many ticks before the speed reverts back
+		 * @param string ticks Used with speed = 'fast' or 5, how many ticks before the interval reverts back
 		 * @return int Current interval in seconds
 		 */
-		this.interval = function( speed, ticks ) {
+		function setInterval( speed, ticks ) {
-			var reset, seconds;
+			var interval, oldInerval = settings.tempInterval ? settings.tempInterval : settings.mainInterval;
-			ticks = parseInt( ticks, 10 ) || 30;
-			ticks = ticks < 1 || ticks > 30 ? 30 : ticks;
 
 			if ( speed ) {
 				switch ( speed ) {
 					case 'fast':
-						seconds = 5;
+					case 5:
-						countdown = ticks;
+						interval = 5000;
 						break;
-					case 'slow':
+					case 15:
-						seconds = 60;
+						interval = 15000;
-						countdown = 0;
+						break;
+					case 30:
+						interval = 30000;
+						break;
+					case 60:
+						interval = 60000;
 						break;
 					case 'long-polling':
 						// Allow long polling, (experimental)
-						interval = 0;
+						settings.mainInterval = 0;
 						return 0;
 						break;
 					default:
-						seconds = 15;
+						interval = settings.originalInterval;
-						countdown = 0;
 				}
 
-				// Reset when the new interval value is lower than the current one
+				if ( 5000 === interval ) {
-				reset = seconds * 1000 < interval;
+					ticks = parseInt( ticks, 10 ) || 30;
+					ticks = ticks < 1 || ticks > 30 ? 30 : ticks;
 
-				if ( countdown > 0 ) {
+					settings.countdown = ticks;
-					tempInterval = seconds * 1000;
+					settings.tempInterval = interval;
 				} else {
-					interval = seconds * 1000;
+					settings.countdown = 0;
-					tempInterval = 0;
+					settings.tempInterval = 0;
+					settings.mainInterval = interval;
 				}
 
-				if ( reset )
+				// Change the next connection time if new interval has been set.
-					next();
+				// Will connect immediately if the time since the last connection
+				// is greater than the new interval.
+				if ( interval !== oldInerval ) {
+					scheduleNextTick();
+				}
 			}
 
-			if ( ! hasFocus )
+			return settings.tempInterval ? settings.tempInterval / 1000 : settings.mainInterval / 1000;
-				return 120;
+		}
-
-			return tempInterval ? tempInterval / 1000 : interval / 1000;
-		};
 
 		/**
 		 * Enqueue data to send with the next XHR
 		 *
-		 * As the data is sent later, this function doesn't return the XHR response.
+		 * As the data is send asynchronously, this function doesn't return the XHR response.
 		 * To see the response, use the custom jQuery event 'heartbeat-tick' on the document, example:
 		 *		$(document).on( 'heartbeat-tick.myname', function( event, data, textStatus, jqXHR ) {
 		 *			// code
@@ -428,19 +635,20 @@ window.wp = window.wp || {};
 		 *
 		 * $param string handle Unique handle for the data. The handle is used in PHP to receive the data.
 		 * $param mixed data The data to send.
-		 * $param bool dont_overwrite Whether to overwrite existing data in the queue.
+		 * $param bool noOverwrite Whether to overwrite existing data in the queue.
 		 * $return bool Whether the data was queued or not.
 		 */
-		this.enqueue = function( handle, data, dont_overwrite ) {
+		function enqueue( handle, data, noOverwrite ) {
 			if ( handle ) {
-				if ( dont_overwrite && this.isQueued( handle ) )
+				if ( noOverwrite && this.isQueued( handle ) ) {
 					return false;
+				}
 
-				queue[handle] = data;
+				settings.queue[handle] = data;
 				return true;
 			}
 			return false;
-		};
+		}
 
 		/**
 		 * Check if data with a particular handle is queued
@@ -448,10 +656,11 @@ window.wp = window.wp || {};
 		 * $param string handle The handle for the data
 		 * $return bool Whether some data is queued with this handle
 		 */
-		this.isQueued = function( handle ) {
+		function isQueued( handle ) {
-			if ( handle )
+			if ( handle ) {
-				return queue.hasOwnProperty( handle );
+				return settings.queue.hasOwnProperty( handle );
-		};
+			}
+		}
 
 		/**
 		 * Remove data with a particular handle from the queue
@@ -459,10 +668,11 @@ window.wp = window.wp || {};
 		 * $param string handle The handle for the data
 		 * $return void
 		 */
-		this.dequeue = function( handle ) {
+		function dequeue( handle ) {
-			if ( handle )
+			if ( handle ) {
-				delete queue[handle];
+				delete settings.queue[handle];
-		};
+			}
+		}
 
 		/**
 		 * Get data that was enqueued with a particular handle
@@ -470,21 +680,29 @@ window.wp = window.wp || {};
 		 * $param string handle The handle for the data
 		 * $return mixed The data or undefined
 		 */
-		this.getQueuedItem = function( handle ) {
+		function getQueuedItem( handle ) {
-			if ( handle )
+			if ( handle ) {
-				return this.isQueued( handle ) ? queue[handle] : undefined;
+				return this.isQueued( handle ) ? settings.queue[handle] : undefined;
+			}
+		}
+
+		initialize();
+
+		// Expose public methods
+		return {
+			hasFocus: hasFocus,
+			connectNow: connectNow,
+			setInterval: setInterval,
+			hasConnectionError: hasConnectionError,
+			enqueue: enqueue,
+			dequeue: dequeue,
+			isQueued: isQueued,
+			getQueuedItem: getQueuedItem
 		};
 	};
 
-	$.extend( Heartbeat.prototype, {
+	// Ensure the global `wp` object exists.
-		tick: function( data, textStatus, jqXHR ) {
+	window.wp = window.wp || {};
-			$(document).trigger( 'heartbeat-tick', [data, textStatus, jqXHR] );
+	window.wp.heartbeat = new Heartbeat();
-		},
-		error: function( jqXHR, textStatus, error ) {
-			$(document).trigger( 'heartbeat-error', [jqXHR, textStatus, error] );
-		}
-	});
 
-	wp.heartbeat = new Heartbeat();
+}( jQuery, window ));
-
-}(jQuery));

wp-includes/js/heartbeat.min.js

@@ -1 +1 @@
-window.wp=window.wp||{},function(a){var b=function(){function b(a){return a?parseInt((new Date).getTime()/1e3):(new Date).getTime()}function c(a){var b,c=a.src;if(c&&/^https?:\/\//.test(c)&&(b=window.location.origin?window.location.origin:window.location.protocol+"//"+window.location.host,0!==c.indexOf(b)))return!1;try{if(a.contentWindow.document)return!0}catch(d){}return!1}function d(b,c){var d;if(b){switch(b){case"abort":break;case"timeout":d=!0;break;case"parsererror":case"error":case"empty":case"unknown":A++,A>2&&(d=!0)}503==c&&!1===D&&(d=!0),d&&!u.hasConnectionError()&&(D=!0,a(document).trigger("heartbeat-connection-lost",[b,c]))}else u.hasConnectionError()?(A=0,D=!1,a(document).trigger("heartbeat-connection-restored")):null===D&&(D=!1)}function e(){var c,e,g={},h=!0,i="object"==typeof window.heartbeatSettings?window.heartbeatSettings.nonce:"";x=b(),c=a.extend({},y),y={},a(document).trigger("heartbeat-send",[c]);for(e in c)if(c.hasOwnProperty(e)){h=!1;break}return h&&!u.hasConnectionError()?(p=!1,f(),void 0):(g.data=c,g.interval=o/1e3,g._nonce=i,g.action="heartbeat",g.screen_id=v,g.has_focus=B,p=!0,u.xhr=a.ajax({url:w,type:"post",timeout:3e4,data:g,dataType:"json"}).done(function(b,c,e){var f;return b?(u.hasConnectionError()&&d(),b.nonces_expired?(a(document).trigger("heartbeat-nonces-expired"),void 0):(b.heartbeat_interval&&(f=b.heartbeat_interval,delete b.heartbeat_interval),u.tick(b,c,e),f&&u.interval.call(u,f),void 0)):d("empty")}).always(function(){p=!1,f()}).fail(function(a,b,c){d(b||"unknown",a.status),u.error(a,b,c)}),void 0)}function f(){var a=b()-x,c=o;l&&(B?z>0&&q&&(c=q,z--):c=1e5,window.clearTimeout(m),c>a?m=window.setTimeout(function(){l&&e()},c-a):e())}function g(){window.clearTimeout(t),window.clearTimeout(C),t=C=0,B=!1}function h(){window.clearTimeout(t),window.clearTimeout(C),t=C=0,r=b(),B||(B=!0,window.clearTimeout(m),p||f())}function i(){a("iframe").each(function(b,d){c(d)&&(a.data(d,"wp-heartbeat-focus")||(a.data(d,"wp-heartbeat-focus",1),a(d.contentWindow).on("focus.wp-heartbeat-focus",function(){h()}).on("blur.wp-heartbeat-focus",function(){i(),C=window.setTimeout(function(){g()},500)})))})}function j(){s=!1,a(document).off(".wp-heartbeat-active"),a("iframe").each(function(b,d){c(d)&&a(d.contentWindow).off(".wp-heartbeat-active")}),h()}function k(){var d=r?b()-r:0;d>3e5&&B&&g(),s||(a(document).on("mouseover.wp-heartbeat-active keyup.wp-heartbeat-active",function(){j()}),a("iframe").each(function(b,d){c(d)&&a(d.contentWindow).on("mouseover.wp-heartbeat-active keyup.wp-heartbeat-active",function(){j()})}),s=!0)}var l,m,n,o,p,q,r,s,t,u=this,v="undefined"!=typeof pagenow?pagenow:"",w="undefined"!=typeof ajaxurl?ajaxurl:"",x=0,y={},z=0,A=0,B=!0,C=-1,D=null;this.hasConnectionError=function(){return!!D},"object"==typeof window.heartbeatSettings&&(n=a.extend({},window.heartbeatSettings),w=n.ajaxurl||w,delete n.ajaxurl,delete n.nonce,o=n.interval||15,delete n.interval,15>o?o=15:o>60&&(o=60),o=1e3*o,v=v||n.screenId||"front",delete n.screenId,a.extend(this,n)),a(window).on("blur.wp-heartbeat-focus",function(){i(),t=window.setTimeout(function(){g()},500)}).on("focus.wp-heartbeat-focus",function(){a("iframe").each(function(b,d){c(d)&&(a.removeData(d,"wp-heartbeat-focus"),a(d.contentWindow).off(".wp-heartbeat-focus"))}),h()}),window.setInterval(function(){k()},3e4),a(document).ready(function(){l=!0,x=b(),f()}),this.hasFocus=function(){return B},this.interval=function(a,b){var c,d;if(b=parseInt(b,10)||30,b=1>b||b>30?30:b,a){switch(a){case"fast":d=5,z=b;break;case"slow":d=60,z=0;break;case"long-polling":return o=0,0;default:d=15,z=0}c=o>1e3*d,z>0?q=1e3*d:(o=1e3*d,q=0),c&&f()}return B?q?q/1e3:o/1e3:120},this.enqueue=function(a,b,c){return a?c&&this.isQueued(a)?!1:(y[a]=b,!0):!1},this.isQueued=function(a){return a?y.hasOwnProperty(a):void 0},this.dequeue=function(a){a&&delete y[a]},this.getQueuedItem=function(a){return a?this.isQueued(a)?y[a]:void 0:void 0}};a.extend(b.prototype,{tick:function(b,c,d){a(document).trigger("heartbeat-tick",[b,c,d])},error:function(b,c,d){a(document).trigger("heartbeat-error",[b,c,d])}}),wp.heartbeat=new b}(jQuery);
+!function(a,b,c){var d=function(){function d(){if("string"==typeof b.pagenow&&(A.screenId=b.pagenow),"string"==typeof b.ajaxurl&&(A.url=b.ajaxurl),"object"==typeof b.heartbeatSettings){var c=b.heartbeatSettings;!A.url&&c.ajaxurl&&(A.url=c.ajaxurl),c.interval&&(A.mainInterval=c.interval,A.mainInterval<15?A.mainInterval=15:A.mainInterval>60&&(A.mainInterval=60)),A.screenId||(A.screenId=c.screenId||"front")}A.mainInterval=1e3*A.mainInterval,A.originalInterval=A.mainInterval,a(b).on("blur.wp-heartbeat-focus",function(){m(),A.winBlurTimer=b.setTimeout(function(){k()},500)}).on("focus.wp-heartbeat-focus",function(){n(),l()}).on("unload.wp-heartbeat",function(){A.isRunning=!1}),b.setInterval(function(){q()},3e4),z.ready(function(){A.lastTick=e(),j()})}function e(){return(new Date).getTime()}function f(a){var c,d=a.src;if(d&&/^https?:\/\//.test(d)&&(c=b.location.origin?b.location.origin:b.location.protocol+"//"+b.location.host,0!==d.indexOf(c)))return!1;try{if(a.contentWindow.document)return!0}catch(e){}return!1}function g(b,c){var d;if(b){switch(b){case"abort":break;case"timeout":d=!0;break;case"error":if(503===c&&A.hasConnected){d=!0;break}case"parsererror":case"empty":case"unknown":A.errorcount++,A.errorcount>2&&A.hasConnected&&(d=!0)}d&&!s()&&(A.connectionError=!0,a(document).trigger("heartbeat-connection-lost",[b,c]))}}function h(){A.hasConnected=!0,s()&&(A.errorcount=0,A.connectionError=!1,z.trigger("heartbeat-connection-restored"))}function i(){var c,d;A.connecting||(A.lastTick=e(),d=a.extend({},A.queue),A.queue={},z.trigger("heartbeat-send",[d]),c={data:d,interval:A.tempInterval?A.tempInterval/1e3:A.mainInterval/1e3,_nonce:"object"==typeof b.heartbeatSettings?b.heartbeatSettings.nonce:"",action:"heartbeat",screen_id:A.screenId,has_focus:A.hasFocus},A.connecting=!0,A.xhr=a.ajax({url:A.url,type:"post",timeout:3e4,data:c,dataType:"json"}).always(function(){A.connecting=!1,j()}).done(function(a,b,c){var d;return a?(h(),a.nonces_expired?(z.trigger("heartbeat-nonces-expired"),void 0):(a.heartbeat_interval&&(d=a.heartbeat_interval,delete a.heartbeat_interval),z.trigger("heartbeat-tick",[a,b,c]),d&&u(d),void 0)):(g("empty"),void 0)}).fail(function(a,b,c){g(b||"unknown",a.status),z.trigger("heartbeat-error",[a,b,c])}))}function j(){var a=e()-A.lastTick,c=A.mainInterval;A.isRunning&&(A.hasFocus?A.countdown>0&&A.tempInterval&&(c=A.tempInterval,A.countdown--,A.countdown<1&&(A.tempInterval=0)):c=12e4,b.clearTimeout(A.beatTimer),c>a?A.beatTimer=b.setTimeout(function(){i()},c-a):i())}function k(){o(),A.hasFocus=!1}function l(){o(),A.userActivity=e(),A.hasFocus||(A.hasFocus=!0,j())}function m(){a("iframe").each(function(c,d){f(d)&&(a.data(d,"wp-heartbeat-focus")||(a.data(d,"wp-heartbeat-focus",1),a(d.contentWindow).on("focus.wp-heartbeat-focus",function(){l()}).on("blur.wp-heartbeat-focus",function(){m(),A.frameBlurTimer=b.setTimeout(function(){k()},500)})))})}function n(){a("iframe").each(function(b,c){f(c)&&(a.removeData(c,"wp-heartbeat-focus"),a(c.contentWindow).off(".wp-heartbeat-focus"))})}function o(){b.clearTimeout(A.winBlurTimer),b.clearTimeout(A.frameBlurTimer)}function p(){A.userActivityEvents=!1,z.off(".wp-heartbeat-active"),a("iframe").each(function(b,c){f(c)&&a(c.contentWindow).off(".wp-heartbeat-active")}),l()}function q(){var b=A.userActivity?e()-A.userActivity:0;b>3e5&&A.hasFocus&&k(),A.userActivityEvents||(z.on("mouseover.wp-heartbeat-active keyup.wp-heartbeat-active",function(){p()}),a("iframe").each(function(b,c){f(c)&&a(c.contentWindow).on("mouseover.wp-heartbeat-active keyup.wp-heartbeat-active",function(){p()})}),A.userActivityEvents=!0)}function r(){return A.hasFocus}function s(){return A.connectionError}function t(){A.lastTick=0,j()}function u(a,b){var c,d=A.tempInterval?A.tempInterval:A.mainInterval;if(a){switch(a){case"fast":case 5:c=5e3;break;case 15:c=15e3;break;case 30:c=3e4;break;case 60:c=6e4;break;case"long-polling":return A.mainInterval=0,0;default:c=A.originalInterval}5e3===c?(b=parseInt(b,10)||30,b=1>b||b>30?30:b,A.countdown=b,A.tempInterval=c):(A.countdown=0,A.tempInterval=0,A.mainInterval=c),c!==d&&j()}return A.tempInterval?A.tempInterval/1e3:A.mainInterval/1e3}function v(a,b,c){return a?c&&this.isQueued(a)?!1:(A.queue[a]=b,!0):!1}function w(a){return a?A.queue.hasOwnProperty(a):void 0}function x(a){a&&delete A.queue[a]}function y(a){return a?this.isQueued(a)?A.queue[a]:c:void 0}var z=a(document),A={isRunning:!0,screenId:"",url:"",lastTick:0,queue:{},mainInterval:60,tempInterval:0,originalInterval:0,countdown:0,connecting:!1,connectionError:!1,errorcount:0,hasConnected:!1,hasFocus:!0,userActivity:0,userActivityEvents:!1,beatTimer:0,winBlurTimer:0,frameBlurTimer:0};return d(),{hasFocus:r,connectNow:t,setInterval:u,hasConnectionError:s,enqueue:v,dequeue:x,isQueued:w,getQueuedItem:y}};b.wp=b.wp||{},b.wp.heartbeat=new d}(jQuery,window);