Merge pull request #76 from soderlind/refresh

fix: resolve menu load/refresh reliability issues

Author: soderlind

CHANGELOG.md

@@ -1,6 +1,25 @@
 # Changelog
 
 All notable changes to this project will be documented in this file.
+
+### 1.12.1
+
+#### Fixed
+
+- Fixed menu sometimes not loading after a REST API error — `populateDB` now re-throws so the "Loading.." indicator stays visible and the next page load retries automatically
+- Fixed nonce middleware being stacked on every REST batch request, causing slowdowns on large networks
+- Fixed `loadSites` running forever when the API returns an empty data array — now terminates correctly
+- Fixed `loadSites` infinite recursion when `loadincrements` is falsy/0 — defaults to 100
+- Fixed `refreshAdminbar()` duplicating event listeners on repeated calls, causing erratic hover/toggle behaviour
+- Converted recursive `loadSites` to an iterative loop to prevent stack overflow on large networks
+- Removed unused `elements.timestamp` reference in init
+
+
+#### Added
+
+- Added `rest.test.js` covering nonce idempotency, empty-data termination, maxSites limit, error propagation, and loadincrements fallback
+- Added refresh idempotency test to `refresh.test.js`
+
 ### 1.12.0
 
 #### Added

build/index.asset.php

@@ -1 +1 @@
-<?php return array('dependencies' => array('wp-api-fetch', 'wp-i18n'), 'version' => 'a82fb6a8035da86fa674');
+<?php return array('dependencies' => array('wp-api-fetch', 'wp-i18n'), 'version' => '1e33e31af10a9a12d92d');

build/index.js

@@ -1,7 +1,7 @@
 {
 	"name": "soderlind/super-admin-all-sites-menu",
 	"description": "For the super admin, replace WP Admin Bar My Sites menu with an All Sites menu.",
-	"version": "1.12.0",
+	"version": "1.12.1",
 	"keywords": [
 		"wordpress",
 		"multisite",

composer.json

@@ -1,6 +1,6 @@
 {
 	"name": "super-admin-all-sites-menu",
-	"version": "1.12.0",
+	"version": "1.12.1",
 	"description": "For the super admin, replace WP Admin Bar My Sites menu with an All Sites menu.",
 	"main": "index.js",
 	"scripts": {

package.json

@@ -1,5 +1,5 @@
 === Super Admin All Sites Menu ===
-Stable tag: 1.12.0
+Stable tag: 1.12.1
 Requires at least: 5.6  
 Tested up to: 7.0  
 Requires PHP: 8.0  
@@ -121,6 +121,16 @@ You can use the following filters to override the defaults:
 
 == Changelog ==
 
+= 1.12.1 =
+* Fixed: Menu sometimes not loading after a REST API error — partial data is cleared and the next page load retries automatically
+* Fixed: Nonce middleware stacking on every REST batch request, causing slowdowns on large networks
+* Fixed: Infinite REST requests when API returns empty data — loading now terminates correctly
+* Fixed: Infinite loop when `loadincrements` is falsy/0 — defaults to 100
+* Fixed: `refreshAdminbar()` duplicating event listeners on repeated calls, causing erratic hover/toggle
+* Changed: Converted recursive REST loader to iterative loop to prevent stack overflow on large networks
+* Fixed: Fatal error in `wp-portable-text` plugin — broken `stringNAMESPACE` constant and `self::NAMESPACE` (reserved keyword) references renamed to `REST_NAMESPACE`
+* Added: Test coverage for REST loading edge cases and refresh idempotency
+
 = 1.12.0 =
 * Added: Menu colors now follow the user's Administration Color Scheme
 * Added: Hover/focus on menu items uses the scheme's highlight background, matching the admin sidebar

readme.txt

@@ -41,7 +41,6 @@ async function init() {
 	const elements = {
 		load: document.querySelector( '#wp-admin-bar-load-more' ),
 		menu: document.querySelector( '#wp-admin-bar-my-sites-list' ),
-		timestamp: document.querySelector( '#load-more-timestamp' ),
 	};
 
 	if ( ! elements.load || ! elements.menu ) return;
@@ -98,9 +97,10 @@ async function populateDB( db ) {
 				offset: 0,
 				delayMs: 200,
 			} );
-		} catch {
+		} catch ( err ) {
 			// Clear partial data so next page load retries from scratch.
 			await db.delete();
+			throw err;
 		}
 	}
 }

src/index.js

@@ -4,11 +4,15 @@
  * Submenu offset adjustment based on:
  * @see https://qiita.com/zephyr7501/items/dd0967fddabd888b28c4
  */
+
+let listenersAttached = false;
+
 export function refreshAdminbar() {
 	const sitemenu = document.getElementById( 'wp-admin-bar-my-sites-list' );
-	if ( ! sitemenu ) {
+	if ( ! sitemenu || listenersAttached ) {
 		return;
 	}
+	listenersAttached = true;
 
 	sitemenu.addEventListener(
 		'mouseenter',

src/modules/refresh.js

@@ -7,8 +7,23 @@ import apiFetch from '@wordpress/api-fetch';
  */
 const delay = ( ms ) => new Promise( ( resolve ) => setTimeout( resolve, ms ) );
 
+/** Track whether the nonce middleware has already been registered. */
+let nonceMiddlewareSet = false;
+
 /**
- * Using REST, incremental load sites and add them to local storage.
+ * Register the REST nonce middleware once.
+ */
+function ensureNonceMiddleware() {
+	if ( ! nonceMiddlewareSet ) {
+		apiFetch.use(
+			apiFetch.createNonceMiddleware( pluginAllSitesMenu.nonce )
+		);
+		nonceMiddlewareSet = true;
+	}
+}
+
+/**
+ * Using REST, incrementally load sites and add them to local storage.
  *
  * @author Per Søderlind
  * @param {IndexedDB} db - IndexedDB instance
@@ -22,49 +37,43 @@ export async function loadSites(
 	db,
 	{ offset = 0, maxSites = 1000, delayMs = 1000 } = {}
 ) {
-	try {
-		// Check if we've reached the maximum sites limit
-		if ( maxSites > 0 && offset >= maxSites ) {
-			return;
-		}
+	ensureNonceMiddleware();
 
-		// Set the nonce for the request
-		apiFetch.use(
-			apiFetch.createNonceMiddleware( pluginAllSitesMenu.nonce )
-		);
+	const increments = Number( pluginAllSitesMenu.loadincrements ) || 100;
+	let currentOffset = offset;
 
+	while ( ! ( maxSites > 0 && currentOffset >= maxSites ) ) {
 		// Add delay between requests to prevent overwhelming the server
-		if ( offset > 0 ) {
+		if ( currentOffset > 0 ) {
 			await delay( delayMs );
 		}
 
-		const res = await apiFetch( {
-			url: pluginAllSitesMenu.restURL,
-			method: 'POST',
-			data: { offset },
-		} );
+		let res;
+		try {
+			res = await apiFetch( {
+				url: pluginAllSitesMenu.restURL,
+				method: 'POST',
+				data: { offset: currentOffset },
+			} );
+		} catch ( err ) {
+			console.error( 'Error in loadSites:', err.message );
+			throw err;
+		}
 
 		if ( ! res || typeof res.response !== 'string' ) {
 			throw new Error( 'Invalid response format' );
 		}
 
-		if ( res.response === 'success' && Array.isArray( res.data ) ) {
-			await db.save( res.data );
-
-			// Calculate next offset
-			const nextOffset = offset + pluginAllSitesMenu.loadincrements;
+		// Server signals no more data.
+		if ( res.response !== 'success' ) {
+			return;
+		}
 
-			// Recursive call with updated offset
-			return loadSites( db, {
-				offset: nextOffset,
-				maxSites,
-				delayMs,
-			} );
+		if ( ! Array.isArray( res.data ) || res.data.length === 0 ) {
+			return;
 		}
 
-		// TODO, should I:  throw new Error( 'Unexpected response format' + res.response );
-	} catch ( err ) {
-		console.error( 'Error in loadSites:', err.message );
-		throw err;
+		await db.save( res.data );
+		currentOffset += increments;
 	}
 }

src/modules/rest.js

@@ -12,7 +12,7 @@
  * Plugin URI: https://github.com/soderlind/super-admin-all-sites-menu
  * GitHub Plugin URI: https://github.com/soderlind/super-admin-all-sites-menu
  * Description: For the super admin, replace WP Admin Bar My Sites menu with an All Sites menu.
- * Version:     1.12.0
+ * Version:     1.12.1
  * Author:      Per Soderlind
  * Network:     true
  * Author URI:  https://soderlind.no