Changeset 24749

Timestamp:

07/19/2013 01:39:48 AM (13 years ago)

Author:

nacin

Message:

Simplify heartbeat API.

• Move to a method to check connection errors, a better framework for future changes.
• Remove start(), stop(), autostart.

props carldanley.
fixes #23216.

Location:

trunk/wp-includes/js

Files:

• autosave.js (modified) (1 diff)
• heartbeat.js (modified) (9 diffs)

trunk/wp-includes/js/autosave.js

@@ -247 +247 @@
 function autosave_enable_buttons() {
         jQuery(document).trigger('autosave-enable-buttons');
-        if ( ! wp.heartbeat.connectionLost ) {
+        if ( ! wp.heartbeat.hasConnectionError() ) {
                 // delay that a bit to avoid some rare collisions while the DOM is being updated.
                 setTimeout(function(){

trunk/wp-includes/js/heartbeat.js

@@ -41 +41 @@
                         userActiveEvents,
                         winBlurTimeout,
-                        frameBlurTimeout = -1;
-
-                this.autostart = true;
-                this.connectionLost = false;
+                        frameBlurTimeout = -1,
+                        hasConnectionError = false;
+
+                /**
+                 * Returns a boolean that's indicative of whether or not there is a connection error
+                 *
+                 * @returns boolean
+                 * @private
+                 */
+                this.hasConnectionError = function() {
+                        return hasConnectionError;
+                };
 
                 if ( typeof( window.heartbeatSettings ) == 'object' ) {
@@ -122 +130 @@
                                 }
 
-                                if ( trigger && ! self.connectionLost ) {
-                                        self.connectionLost = true;
+                                if ( trigger && ! self.hasConnectionError() ) {
+                                        hasConnectionError = true;
                                         $(document).trigger( 'heartbeat-connection-lost', [error] );
                                 }
-                        } else if ( self.connectionLost ) {
+                        } else if ( self.hasConnectionError() ) {
                                 errorcount = 0;
-                                self.connectionLost = false;
+                                hasConnectionError = false;
                                 $(document).trigger( 'heartbeat-connection-restored' );
                         }
@@ -153 +161 @@
                         // If nothing to send (nothing is expecting a response),
                         // schedule the next tick and bail
-                        if ( empty && ! self.connectionLost ) {
+                        if ( empty && ! self.hasConnectionError() ) {
                                 connecting = false;
                                 next();
@@ -180 +188 @@
 
                                 // Clear error state
-                                if ( self.connectionLost )
+                                if ( self.hasConnectionError() )
                                         errorstate();
 
@@ -206 +214 @@
                                 self.error( jqXHR, textStatus, error );
                         });
-                };
+                }
 
                 function next() {
@@ -333 +341 @@
                 // Check for user activity every 30 seconds.
                 window.setInterval( function(){ checkUserActive(); }, 30000 );
-
-                if ( this.autostart ) {
-                        $(document).ready( function() {
-                                // Start one tick (15 sec) after DOM ready
-                                running = true;
-                                tick = time();
-                                next();
-                        });
-                }
+                $(document).ready( function() {
+                        // Start one tick (15 sec) after DOM ready
+                        running = true;
+                        tick = time();
+                        next();
+                });
 
                 this.hasFocus = function() {
                         return hasFocus;
-                }
+                };
 
                 /**
@@ -401 +406 @@
                         return tempInterval ? tempInterval / 1000 : interval / 1000;
                 };
-
-                // 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;
-                }
 
                 /**
@@ -448 +432 @@
                         }
                         return false;
-                }
+                };
 
                 /**
@@ -458 +442 @@
                 this.isQueued = function( handle ) {
                         return queue[handle];
-                }
-        }
+                };
+        };
 
         $.extend( Heartbeat.prototype, {