Changeset 26428

Timestamp:

11/27/2013 01:55:59 AM (11 years ago)

Author:

azaozz

Message:

Heartbeat: introduce "suspend" functionality and enable it after 20 min. of inactivity, see #25073.

Location:

trunk/src

Files:

• wp-admin/includes/misc.php (modified) (1 diff)
• wp-includes/js/heartbeat.js (modified) (9 diffs)

trunk/src/wp-admin/includes/misc.php

@@ -740 +740 @@
 }
 add_filter( 'heartbeat_received', 'wp_refresh_post_nonces', 10, 3 );
+
+/**
+ * Disable suspending of Heartbeat on the Add/Edit Post screens
+ *
+ * @since 3.8
+ */
+function wp_disable_heartbeat_suspend( $settings ) {
+    global $pagenow;
+
+    if ( 'post.php' === $pagenow || 'post-new.php' === $pagenow ) {
+        $settings['suspend'] = 'disable';
+    }
+
+    return $settings;
+}
+add_filter( 'heartbeat_settings', 'wp_disable_heartbeat_suspend' );

trunk/src/wp-includes/js/heartbeat.js

@@ -35 +35 @@
         var $document = $(document),
             settings = {
-                // Used to stop the "beat"
-                isRunning: true,
+                // Suspend/resume
+                suspend: false,
+
+                // Whether suspending is enabled
+                suspendEnabled: true,
 
                 // Current screen id, defaults to the JS global 'pagenow' when present (in the admin) or 'front'
@@ -128 +131 @@
                 if ( ! settings.screenId ) {
                     settings.screenId = options.screenId || 'front';
+                }
+
+                if ( options.suspend === 'disable' ) {
+                    settings.suspendEnabled = false;
                 }
             }
@@ -146 +153 @@
             }).on( 'unload.wp-heartbeat', function() {
                 // Don't connect any more
-                settings.isRunning = false;
+                settings.suspend = true;
+
+                // Abort the last request if not completed
+                if ( settings.xhr && settings.xhr.readyState !== 4 ) {
+                    settings.xhr.abort();
+                }
             });
 
@@ -275 +287 @@
             // 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 ) {
+            if ( settings.connecting || settings.suspend ) {
                 return;
             }
@@ -352 +364 @@
                 interval = settings.mainInterval;
 
-            if ( ! settings.isRunning ) {
+            if ( settings.suspend ) {
                 return;
             }
@@ -404 +416 @@
             settings.userActivity = time();
 
+            // Resume if suspended
+            settings.suspend = false;
+
             if ( ! settings.hasFocus ) {
                 settings.hasFocus = true;
@@ -514 +529 @@
             }
 
+            if ( settings.suspendEnabled && lastActive > 1200000 ) {
+                // Suspend after 20 min. of inactivity
+                settings.suspend = true;
+            }
+
             if ( ! settings.userActivityEvents ) {
                 $document.on( 'mouseover.wp-heartbeat-active keyup.wp-heartbeat-active', function(){ userIsActive(); } );
@@ -560 +580 @@
             settings.lastTick = 0;
             scheduleNextTick();
+        }
+
+        /**
+         * Disable suspending
+         *
+         * Should be used only when Heartbeat is performing critical tasks like autosave, post-locking, etc.
+         * Using this on many screens may overload the user's hosting account if several
+         * browser windows/tabs are left open for a long time.
+         *
+         * @return void
+         */
+        function disableSuspend() {
+            settings.suspendEnabled = false;
         }
 
@@ -692 +725 @@
             hasFocus: hasFocus,
             connectNow: connectNow,
+            disableSuspend: disableSuspend,
             setInterval: setInterval,
             hasConnectionError: hasConnectionError,