Don't update max tree level immediately when requested too many times…

… at a time #3383
piroor · Nov 1, 2023 · 5fa5f8d · 5fa5f8d
1 parent 10f955e
commit 5fa5f8d
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/webextensions/common/common.js b/webextensions/common/common.js
@@ -294,6 +294,7 @@ export const configs = new Configs({
   // animation
   animation: true,
   animationForce: false,
+  maxAllowedImmediateRefreshCount: 10,
   smoothScrollEnabled:  true,
   smoothScrollDuration: 150,
   burstDuration:    375,

diff --git a/webextensions/sidebar/indent.js b/webextensions/sidebar/indent.js
@@ -146,16 +146,39 @@ export async function reserveToUpdateVisualMaxTreeLevel() {
     delete updateVisualMaxTreeLevel.waiting;
   }
 
-  if (!shouldApplyAnimation()) {
+  reserveToUpdateVisualMaxTreeLevel.calledCount++;
+
+  const animation = shouldApplyAnimation();
+
+  // Immediate update may cause a performance issue when this function
+  // is called too many times.
+  // On the other hand, delayed update exposes "not updated yet" visual
+  // to people unexpectedly and it may stress some people sensitive to
+  // flickers.
+  // The threshold is a workaround to run immediate update while the
+  // slowing down is acceptable.
+  // See also: https://github.com/piroor/treestyletab/issues/3383
+  if (reserveToUpdateVisualMaxTreeLevel.calledCount <= configs.maxAllowedImmediateRefreshCount &&
+      !animation) {
     updateVisualMaxTreeLevel();
+    if (reserveToUpdateVisualMaxTreeLevel.waitingToResetCalledCount)
+      clearTimeout(reserveToUpdateVisualMaxTreeLevel.waitingToResetCalledCount);
+    reserveToUpdateVisualMaxTreeLevel.waitingToResetCalledCount = setTimeout(() => {
+      delete reserveToUpdateVisualMaxTreeLevel.waitingToResetCalledCount;
+      reserveToUpdateVisualMaxTreeLevel.calledCount = 0;
+    }, 0);
     return;
   }
 
+  const delay = animation ? configs.collapseDuration * 1.5 : 0;
+
   updateVisualMaxTreeLevel.waiting = setTimeout(() => {
     delete updateVisualMaxTreeLevel.waiting;
+    reserveToUpdateVisualMaxTreeLevel.calledCount = 0;
     updateVisualMaxTreeLevel();
-  }, configs.collapseDuration * 1.5);
+  }, delay);
 }
+reserveToUpdateVisualMaxTreeLevel.calledCount = 0;
 
 function updateVisualMaxTreeLevel() {
   const maxLevel = getMaxTreeLevel(mTargetWindow, {