fix(theme-common): localStorage utils dispatch too many storage event…

…s leading to infinite loop (#8619)
facebook · Feb 2, 2023 · 5b05c0e · 5b05c0e
1 parent 140f0b1
commit 5b05c0e
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/docusaurus-theme-common/src/utils/storageUtils.ts b/packages/docusaurus-theme-common/src/utils/storageUtils.ts
@@ -31,6 +31,13 @@ function dispatchChangeEvent({
   newValue: string | null;
   storage: Storage;
 }) {
+  // If we set multiple times the same storage value, events should not be fired
+  // The native events behave this way, so our manual event dispatch should
+  // rather behave exactly the same. Not doing so might create infinite loops.
+  // See https://github.com/facebook/docusaurus/issues/8594
+  if (oldValue === newValue) {
+    return;
+  }
   const event = document.createEvent('StorageEvent');
   event.initStorageEvent(
     'storage',