Merge branch 'MDL-79194-403' of https://github.com/laurentdavid/moodle …

…into MOODLE_403_STABLE
moodle · Oct 27, 2023 · 990b740 · 990b740
2 parents 8bf31f2 + 81cdd8d
commit 990b740
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 11 deletions.
diff --git a/course/format/amd/build/local/content.min.js b/course/format/amd/build/local/content.min.js
diff --git a/course/format/amd/build/local/content.min.js.map b/course/format/amd/build/local/content.min.js.map
diff --git a/course/format/amd/src/local/content.js b/course/format/amd/src/local/content.js
@@ -238,6 +238,8 @@ export default class Component extends BaseComponent {
             {watch: `transaction:start`, handler: this._startProcessing},
             {watch: `course.sectionlist:updated`, handler: this._refreshCourseSectionlist},
             {watch: `section.cmlist:updated`, handler: this._refreshSectionCmlist},
+            // Section visibility.
+            {watch: `section.visible:updated`, handler: this._reloadSection},
             // Reindex sections and cms.
             {watch: `state:updated`, handler: this._indexContents},
         ];
@@ -525,12 +527,12 @@ export default class Component extends BaseComponent {
         if (debouncedReload) {
             return debouncedReload;
         }
-        const pendingReload = new Pending(pendingKey);
         const reload = () => {
+            const pendingReload = new Pending(pendingKey);
             this.debouncedReloads.delete(pendingKey);
             const cmitem = this.getElement(this.selectors.CM, cmId);
             if (!cmitem) {
-                return;
+                return pendingReload.resolve();
             }
             const promise = Fragment.loadFragment(
                 'core_courseformat',
@@ -543,17 +545,45 @@ export default class Component extends BaseComponent {
                 }
             );
             promise.then((html, js) => {
+                // Other state change can reload the CM or the section before this one.
+                if (!document.contains(cmitem)) {
+                    pendingReload.resolve();
+                    return false;
+                }
                 Templates.replaceNode(cmitem, html, js);
                 this._indexContents();
                 pendingReload.resolve();
-                return;
-            }).catch();
+                return true;
+            }).catch(() => {
+                pendingReload.resolve();
+            });
+            return pendingReload;
         };
-        debouncedReload = debounce(reload, 200);
+        debouncedReload = debounce(
+            reload,
+            200,
+            {
+                cancel: true, pending: true
+            }
+        );
         this.debouncedReloads.set(pendingKey, debouncedReload);
         return debouncedReload;
     }
 
+    /**
+     * Cancel the active reload CM debounced function, if any.
+     * @param {Number} cmId
+     */
+    _cancelDebouncedReloadCm(cmId) {
+        const pendingKey = `courseformat/content:reloadCm_${cmId}`;
+        const debouncedReload = this.debouncedReloads.get(pendingKey);
+        if (!debouncedReload) {
+            return;
+        }
+        debouncedReload.cancel();
+        this.debouncedReloads.delete(pendingKey);
+    }
+
     /**
      * Reload a course section contents.
      *
@@ -567,6 +597,10 @@ export default class Component extends BaseComponent {
         const pendingReload = new Pending(`courseformat/content:reloadSection_${element.id}`);
         const sectionitem = this.getElement(this.selectors.SECTION, element.id);
         if (sectionitem) {
+            // Cancel any pending reload because the section will reload cms too.
+            for (const cmId of element.cmlist) {
+                this._cancelDebouncedReloadCm(cmId);
+            }
             const promise = Fragment.loadFragment(
                 'core_courseformat',
                 'section',
@@ -581,8 +615,9 @@ export default class Component extends BaseComponent {
                 Templates.replaceNode(sectionitem, html, js);
                 this._indexContents();
                 pendingReload.resolve();
-                return;
-            }).catch();
+            }).catch(() => {
+                pendingReload.resolve();
+            });
         }
     }
 

diff --git a/lib/amd/build/utils.min.js b/lib/amd/build/utils.min.js
diff --git a/lib/amd/build/utils.min.js.map b/lib/amd/build/utils.min.js.map
diff --git a/lib/amd/src/utils.js b/lib/amd/src/utils.js
@@ -87,13 +87,15 @@ const debounceMap = new Map();
  * @param {Number} wait The number of milliseconds to wait after the final attempt to execute
  * @param {Object} [options]
  * @param {boolean} [options.pending=false] Whether to wrap the debounced method in a pending promise
+ * @param {boolean} [options.cancel=false] Whether to add a cancel method to the debounced function
  * @return {Function}
  */
 export const debounce = (
     func,
     wait,
     {
         pending = false,
+        cancel = false,
     } = {},
 ) => {
     let timeout = null;
@@ -119,6 +121,14 @@ export const debounce = (
         }, wait);
     };
 
+    if (cancel) {
+        returnedFunction.cancel = () => {
+            const pendingPromise = debounceMap.get(returnedFunction);
+            pendingPromise?.resolve();
+            clearTimeout(timeout);
+        };
+    }
+
     return returnedFunction;
 };
 

diff --git a/lib/upgrade.txt b/lib/upgrade.txt
@@ -4,6 +4,7 @@ information provided here is intended especially for developers.
 === 4.3.1 ===
 
 * Added modalform config object `moduleName` param that can be used to define alternative modal type for the modalform. By default 'core/modal_save_cancel' is used.
+* Add a new parameter to the debounce (core/utils) function to allow for cancellation.
 
 === 4.3 ===