Fix clearing of account status cache. (vufind-org#4200)

There was a possibility for the _load method to retrieve old data before the actual function that requested the cache to be cleared was performed.

(cherry picked from commit 7ee4132)

module/VuFind/tests/integration-tests/src/VuFindTest/Mink/AccountMenuTest.php

@@ -278,15 +278,14 @@ public function testGlobalCacheClearing()
         $session = $this->login();
         // Seed some fines
         $this->setJSStorage(['fines' => ['value' => 30.5, 'display' => '$30.50']]);
+        // Check storage
         $storage = $this->getJSStorage();
         $this->assertNotNull($storage['fines']);
-        // Clear all cache
+        // Clear all cached data
         $session->evaluateScript('VuFind.account.clearCache();');
-        // Wait for reload
-        $this->waitForPageLoad($this->getMinkSession()->getPage());
+        // Check storage again
         $storage = $this->getJSStorage();
-        // Status code MISSING is -2 * Math.PI, but we just round it here to avoid trouble
-        $this->assertEquals(-6, ceil($storage['fines']));
+        $this->assertNull($storage['fines']);
     }
 
     /**

themes/bootstrap3/js/account_ajax.js

@@ -35,7 +35,15 @@ VuFind.register('account', function Account() {
   // Forward declaration for clearAllCaches
   var clearAllCaches = function clearAllCachesForward() {};
 
-  // Clearing save forces AJAX update next page load
+  /**
+   * Clear the specified client data cache; pass in empty/undefined value to clear
+   * all caches. Note that clearing all caches will prevent further data from loading
+   * on the current page, and should only be performed when exiting the page via a
+   * link, form submission, etc. Cleared data will be reloaded by AJAX on the next
+   * page load.
+   *
+   * @param {string|undefined} name Cache to clear (undefined/empty for all)
+   */
   var clearCache = function clearCache(name) {
     if (typeof name === "undefined" || name === '') {
       clearAllCaches();
@@ -114,6 +122,7 @@ VuFind.register('account', function Account() {
   var _load = function _load(module) {
     if (_clearCaches) {
       sessionStorage.removeItem(_sessionDataPrefix + module);
+      return;
     }
     var $element = $(_submodules[module].selector);
     if (!$element) {
@@ -179,6 +188,11 @@ VuFind.register('account', function Account() {
     }
   };
 
+  /**
+   * Clear all account status data cached in the client's browser. This will prevent future data from
+   * loading on the current page and should only be called when exiting the page by clicking a link,
+   * submitting a form, etc.
+   */
   clearAllCaches = function clearAllCachesReal() {
     // Set a flag so that any modules yet to be loaded are cleared as well
     _clearCaches = true;

themes/bootstrap5/js/account_ajax.js

@@ -35,7 +35,15 @@ VuFind.register('account', function Account() {
   // Forward declaration for clearAllCaches
   var clearAllCaches = function clearAllCachesForward() {};
 
-  // Clearing save forces AJAX update next page load
+  /**
+   * Clear the specified client data cache; pass in empty/undefined value to clear
+   * all caches. Note that clearing all caches will prevent further data from loading
+   * on the current page, and should only be performed when exiting the page via a
+   * link, form submission, etc. Cleared data will be reloaded by AJAX on the next
+   * page load.
+   *
+   * @param {string|undefined} name Cache to clear (undefined/empty for all)
+   */
   var clearCache = function clearCache(name) {
     if (typeof name === "undefined" || name === '') {
       clearAllCaches();
@@ -116,6 +124,7 @@ VuFind.register('account', function Account() {
   var _load = function _load(module) {
     if (_clearCaches) {
       sessionStorage.removeItem(_sessionDataPrefix + module);
+      return;
     }
     var $element = $(_submodules[module].selector);
     if (!$element) {
@@ -181,6 +190,11 @@ VuFind.register('account', function Account() {
     }
   };
 
+  /**
+   * Clear all account status data cached in the client's browser. This will prevent future data from
+   * loading on the current page and should only be called when exiting the page by clicking a link,
+   * submitting a form, etc.
+   */
   clearAllCaches = function clearAllCachesReal() {
     // Set a flag so that any modules yet to be loaded are cleared as well
     _clearCaches = true;