fix: a rare broken initialization with empty storage

caused by race condition:
Both sidebar and bg generate default sidebar configs with different
panel ids.

changed:
In sidebar, wait until bg set default sidebar config (or 5sec).
In sidebar, setup sidebar listeners after sidebar is loaded.

Author: mbnuqw

src/services/sidebar.actions.ts

@@ -64,25 +64,30 @@ export function registerHorizontalNavBarEl(el: HTMLElement): void {
   horizontalNavBarEl = el
 }
 
+async function loadSidebarConfig() {
+  return browser.storage.managed
+    .get<Stored>('sidebar')
+    .catch(() => undefined)
+    .then(storage => (!storage?.sidebar ? browser.storage.local.get<Stored>('sidebar') : storage))
+}
+
 export async function loadPanels(): Promise<void> {
   const ts = performance.now()
   Logs.info('Sidebar.loadPanels')
 
-  const gettingActiveId = browser.sessions.getWindowValue<ID>(Windows.id, 'activePanelId')
-  const gettingHiddenPanels = browser.sessions.getWindowValue<ID[]>(Windows.id, 'hiddenPanels')
-  const gettingStorage = browser.storage.managed
-    .get<Stored>('sidebar')
-    .catch(() => {})
-    .then(storage => (!storage?.sidebar ? browser.storage.local.get<Stored>('sidebar') : storage))
-
-  const [activeId, storage, hiddenPanels] = await Promise.all([
-    gettingActiveId,
-    gettingStorage,
-    gettingHiddenPanels,
+  const [storage, activeId, hiddenPanels] = await Promise.all([
+    Utils.pending({
+      action: loadSidebarConfig,
+      check: storage => !!storage.sidebar?.nav?.length,
+      interval: 250,
+      tryCount: 20,
+    }),
+    browser.sessions.getWindowValue<ID>(Windows.id, 'activePanelId').catch(() => undefined),
+    browser.sessions.getWindowValue<ID[]>(Windows.id, 'hiddenPanels').catch(() => undefined),
   ])
 
   if (!storage.sidebar?.nav?.length) {
-    Logs.warn('Sidebar.loadPanels: Creating default sidebar config')
+    Logs.warn('Sidebar.loadPanels: No sidebar config: Creating default sidebar config')
     storage.sidebar = createDefaultSidebarConfig()
   }
 

src/services/tabs.fg.actions.ts

@@ -425,7 +425,7 @@ async function restoreTabPanelsContent(tabs: Tab[]) {
   }
 
   if (tabsAreUnsorted) {
-    Logs.warn('Tabs.restoreTabPanelsContent: Tabs are unsorted!')
+    Logs.warn('Tabs.restoreTabPanelsContent: Tabs are unsorted; unmatchIndex:', unmatchIndex)
 
     // Sort tabs
     Tabs.ignoreMoveEvents(true, 'initsort')

src/sidebar/sidebar.ts

@@ -113,12 +113,12 @@ async function main(): Promise<void> {
   Permissions.setupListeners()
   Windows.setupWindowsListeners()
   Containers.setupContainersListeners()
-  Sidebar.setupListeners()
 
   Styles.loadCustomSidebarCSS()
   Styles.initColorScheme()
 
   await Sidebar.loadPanels()
+  Sidebar.setupListeners()
 
   const actPanel = Sidebar.panelsById[Sidebar.activePanelId]
   const initBookmarks = !Settings.state.loadBookmarksOnDemand || Utils.isBookmarksPanel(actPanel)

src/utils.ts

@@ -952,6 +952,38 @@ export async function retry(conf: RetryConfig): Promise<void> {
   })
 }
 
+interface PendingConfig<R> {
+  action: () => Promise<R>
+  check: (result: R) => boolean
+  interval: number
+  tryCount: number
+}
+
+export async function pending<R>(conf: PendingConfig<R>): Promise<R> {
+  return new Promise<R>(async (ok, meh) => {
+    let i = 0
+
+    while (true) {
+      let result
+      try {
+        result = await conf.action()
+      } catch (err) {
+        return meh(err)
+      }
+
+      if (conf.check(result)) {
+        return ok(result)
+      }
+
+      if (++i >= conf.tryCount) {
+        return ok(result)
+      }
+
+      await sleep(conf.interval)
+    }
+  })
+}
+
 /**
  * Search back then forth
  */