Changeset 56809

Timestamp:

10/09/2023 09:29:42 PM (3 years ago)

Author:

westonruter

Message:

Administration: Remove deprecated unload event handlers and use pagehide (and pageshow) when appropriate.

Use pagehide event instead of unload in the following cases:

• For classic editor to release the post lock.
• In Text widget to rebuild editor after dragging widget to new location in classic widgets interface.
• To clear out the window.name when navigating away from a post preview.
• To suspend heartbeat, while also using pageshow event to resume as if it had been a focused tab in case page restored from bfcache.

Also:

• Remove obsolete mobile cleanup code in js/_enqueues/lib/gallery.js (introduced in [9894]). Do same for src/js/_enqueues/wp/media/models.js (introduced in [22872]). See #22552.
• Remove obsolete Firefox-specific workaround in js/_enqueues/wp/mce-view.js from [39282]. See #38511.

Fixes #55491.
Props spenserhale, westonruter, adamsilverstein, azaozz, shawfactor, peterwilsoncc, swissspidy.

Location:

trunk/src

Files:

• js/_enqueues/admin/post.js (modified) (1 diff)
• js/_enqueues/lib/gallery.js (modified) (1 diff)
• js/_enqueues/wp/heartbeat.js (modified) (5 diffs)
• js/_enqueues/wp/mce-view.js (modified) (2 diffs)
• js/_enqueues/wp/media/models.js (modified) (2 diffs)
• js/_enqueues/wp/widgets/text.js (modified) (1 diff)
• wp-includes/functions.php (modified) (2 diffs)

trunk/src/js/_enqueues/admin/post.js

@@ -512 +512 @@
                         return __( 'The changes you made will be lost if you navigate away from this page.' );
                 }
-        }).on( 'unload.edit-post', function( event ) {
+        }).on( 'pagehide.edit-post', function( event ) {
                 if ( ! releaseLock ) {
                         return;

trunk/src/js/_enqueues/lib/gallery.js

@@ -89 +89 @@
 });
 
-jQuery(window).on( 'unload', function () { window.tinymce = window.tinyMCE = window.wpgallery = null; } ); // Cleanup.
-
 /* gallery settings */
 window.tinymce = null;

trunk/src/js/_enqueues/wp/heartbeat.js

@@ -224 +224 @@
                         }
 
-                        $(window).on( 'unload.wp-heartbeat', function() {
+                        $(window).on( 'pagehide.wp-heartbeat', function() {
                                 // Don't connect anymore.
-                                settings.suspend = true;
+                                suspend();
 
                                 // Abort the last request if not completed.
@@ -233 +233 @@
                                 }
                         });
+
+                        $(window).on(
+                                'pageshow.wp-heartbeat',
+                                /**
+                                 * Handles pageshow event, specifically when page navigation is restored from back/forward cache.
+                                 *
+                                 * @param {jQuery.Event} event
+                                 * @param {PageTransitionEvent} event.originalEvent
+                                 */
+                                function ( event ) {
+                                        if ( event.originalEvent.persisted ) {
+                                                /*
+                                                 * When page navigation is stored via bfcache (Back/Forward Cache), consider this the same as
+                                                 * if the user had just switched to the tab since the behavior is similar.
+                                                 */
+                                                focused();
+                                        }
+                                }
+                        );
 
                         // Check for user activity every 30 seconds.
@@ -542 +561 @@
 
                         // Resume if suspended.
-                        settings.suspend = false;
+                        resume();
 
                         if ( ! settings.hasFocus ) {
@@ -551 +570 @@
 
                 /**
+                 * Suspends connecting.
+                 */
+                function suspend() {
+                        settings.suspend = true;
+                }
+
+                /**
+                 * Resumes connecting.
+                 */
+                function resume() {
+                        settings.suspend = false;
+                }
+
+                /**
                  * Runs when the user becomes active after a period of inactivity.
                  *
@@ -594 +627 @@
                         // Always suspend after 60 minutes of inactivity. This will release the post lock, etc.
                         if ( ( settings.suspendEnabled && lastActive > 600000 ) || lastActive > 3600000 ) {
-                                settings.suspend = true;
+                                suspend();
                         }
 

trunk/src/js/_enqueues/wp/mce-view.js

@@ -644 +644 @@
                                 }
 
-                                function reload() {
-                                        if ( ! editor.isHidden() ) {
-                                                $( node ).data( 'rendered', null );
-
-                                                setTimeout( function() {
-                                                        wp.mce.views.render();
-                                                } );
-                                        }
-                                }
-
                                 function addObserver() {
                                         observer = new MutationObserver( _.debounce( resize, 100 ) );
@@ -664 +654 @@
                                 }
 
-                                $( iframeWin ).on( 'load', resize ).on( 'unload', reload );
+                                $( iframeWin ).on( 'load', resize );
 
                                 MutationObserver = iframeWin.MutationObserver || iframeWin.WebKitMutationObserver || iframeWin.MozMutationObserver;

trunk/src/js/_enqueues/wp/media/models.js

@@ -3 +3 @@
  */
 
-var $ = jQuery,
-        Attachment, Attachments, l10n, media;
+var Attachment, Attachments, l10n, media;
 
 /** @namespace wp */
@@ -238 +237 @@
         });
 };
-
-// Clean up. Prevents mobile browsers caching.
-$(window).on('unload', function(){
-        window.wp = null;
-});

trunk/src/js/_enqueues/wp/widgets/text.js

@@ -292 +292 @@
 
                                         // When a widget is moved in the DOM the dynamically-created TinyMCE iframe will be destroyed and has to be re-built.
-                                        $( editor.getWin() ).on( 'unload', function() {
+                                        $( editor.getWin() ).on( 'pagehide', function() {
                                                 _.defer( buildEditor );
                                         });

trunk/src/wp-includes/functions.php

@@ -7586 +7586 @@
 
 /**
- * Outputs a small JS snippet on preview tabs/windows to remove `window.name` on unload.
+ * Outputs a small JS snippet on preview tabs/windows to remove `window.name` when a user is navigating to another page.
  *
  * This prevents reusing the same tab for a preview when the user has navigated away.
@@ -7615 +7615 @@
 
                 if ( window.addEventListener ) {
-                        window.addEventListener( 'unload', function() { window.name = ''; }, false );
+                        window.addEventListener( 'pagehide', function() { window.name = ''; } );
                 }
         }());