fix: tabs: incorrect handling of unloaded tabs opened from another addon

- Correctly handle unloaded tabs opened from the outside: wait for the
session restore detection and continue a new tab handling if it's not a
session restore.
- Rename 'Session Restore' to more generic 'Processing tabs...' because
we don't know in advance if it's actually a session restore.

(resolves #2249)

Author: mbnuqw

src/_locales/dict.sidebar.ts

@@ -484,28 +484,17 @@ export const sidebarTranslations: Translations = {
     zh_TW: '不再顯示',
     ja: '再表示しない',
   },
-  // - Session restore
-  'popup.ses_res.title': {
-    en: 'Session Restore',
-    de: 'Sitzung wiederherstellen',
-    fr: 'Restauration de session',
-    hu: 'Munkamenet visszaállítása',
-    pl: 'Przywrócenie sesji',
-    ru: 'Восстановление сеанса',
-    zh_CN: '会话恢复',
-    zh_TW: '回復瀏覽階段',
-    ja: 'セッション復元',
-  },
-  'popup.ses_res.desc': {
-    en: 'Sidebery is reinitializing tabs for restored session, please wait...',
-    de: 'Sidebery initialisiert die Registerkarten für die wiederhergestellte Sitzung neu. Bitte warten Sie...',
-    fr: 'Sidebery réinitialise les onglets pour la session restaurée, veuillez patienter...',
-    hu: 'Sidebery újraindítja a visszaállított munkamenet lapjait, kérjük, várjon...',
-    pl: 'Sidebery ponownie inicjuje karty dla przywróconej sesji, proszę czekać...',
-    ru: 'Sidebery инициализирует вкладки для восстановленной сессии, пожалуйста, подождите...',
-    zh_CN: 'Sidebery 正在为恢复的会话重新初始化标签页，请稍候...',
-    zh_TW: 'Sidebery 正為回復的瀏覽階段重新初始化分頁，請稍候...',
-    ja: 'Sideberyは復元されたセッションのタブを再初期化中です。お待ちください...',
+  // - Processing tabs
+  'popup.proc_tabs.title': {
+    en: 'Processing tabs...',
+    de: 'Verarbeitung der Tabs...',
+    fr: 'Traitement des onglets...',
+    hu: 'Feldolgozás lapok...',
+    pl: 'Przetwarzanie karty...',
+    ru: 'Обработка вкладок...',
+    zh_CN: '正在处理标签页...',
+    zh_TW: '處理標籤中...',
+    ja: 'タブを処理しています...',
   },
 
   // ---

src/services/popups.ts

@@ -14,7 +14,7 @@ export interface PopupsReactiveState {
   siteConfigPopup: SiteConfigPopup | null
   tabMoveRulesPopup: TabMoveRulesPopup | null
   tabReopenRulesPopup: TabReopenRulesPopup | null
-  sessionRestorePopup: SessionRestorePopup | null
+  processingTabsPopup: ProcessingTabsPopup | null
   confirm: ConfirmDialog | null
   dialog: Dialog | null
 }
@@ -57,7 +57,7 @@ export interface SiteConfigPopup {
   url: string
 }
 
-export interface SessionRestorePopup {}
+export interface ProcessingTabsPopup {}
 
 export let reactive: PopupsReactiveState = {
   panelConfigPopup: null,
@@ -67,7 +67,7 @@ export let reactive: PopupsReactiveState = {
   siteConfigPopup: null,
   tabMoveRulesPopup: null,
   tabReopenRulesPopup: null,
-  sessionRestorePopup: null,
+  processingTabsPopup: null,
   confirm: null,
   dialog: null,
 }
@@ -225,11 +225,11 @@ export function closeTabReopenRulesPopup(): void {
   reactive.tabReopenRulesPopup = null
 }
 
-export function openSessionRestorePopup() {
-  reactive.sessionRestorePopup = {}
+export function openProcessingTabsPopup() {
+  reactive.processingTabsPopup = {}
 }
 
-export function closeSessionRestorePopup() {
-  if (!reactive.sessionRestorePopup) return
-  reactive.sessionRestorePopup = null
+export function closeProcessingTabsPopup() {
+  if (!reactive.processingTabsPopup) return
+  reactive.processingTabsPopup = null
 }

src/services/tabs.fg.handlers.ts

@@ -122,11 +122,7 @@ function checkIfSessionIsRestoring(newTab: Tab) {
     maybeRestoredTabs &&
     maybeRestoredTabs.length >= SESSION_RESTORE_MIN_TABS_COUNT
   ) {
-    // TODO: well, at this moment sidebery doesn't know yet if
-    // this is a session restore or just multiple new tabs (low probability though)
-    // so maybe I should show popup with the title like "Processing new tabs..."
-    // instead?
-    Popups.openSessionRestorePopup()
+    Popups.openProcessingTabsPopup()
 
     cancelDeferredMovingOfNewTabs()
 
@@ -146,6 +142,13 @@ function checkIfSessionIsRestoring(newTab: Tab) {
     maybeRestoredTabsDataQuerying.push(dataQuerying.catch(() => undefined))
   }
 
+  // Set the promise for awaiting a session restore detection
+  if (maybeRestoredTabsDataQuerying) {
+    newTab.checkingSessionRestore = new Promise(ok => {
+      newTab.resolveSessionRestoreDetection = ok
+    })
+  }
+
   clearTimeout(checkingIfSessionRestoringTimeout)
   checkingIfSessionRestoringTimeout = setTimeout(async () => {
     if (
@@ -163,13 +166,8 @@ function checkIfSessionIsRestoring(newTab: Tab) {
 
       tryToRestoreTabsStateFromSessionData(maybeRestoredTabs, tabsSessionData)
     } else {
-      cancelDeferredMovingOfNewTabs()
-
-      // Reinit tabs
-      Tabs.unload()
-      Tabs.load(LoadSrc.SessionOnly)
-
-      Popups.closeSessionRestorePopup()
+      // It's not a session restore, resolve the promises
+      maybeRestoredTabs?.forEach(t => t.resolveSessionRestoreDetection?.(false))
     }
 
     maybeRestoredTabs = null
@@ -189,18 +187,23 @@ async function tryToRestoreTabsStateFromSessionData(
   if (tabsWithSessionDataLen < SESSION_RESTORE_MIN_TABS_COUNT) {
     Logs.warn('Tabs.tryToRestoreTabsStateFromSessionData: Not enough session data')
 
-    cancelDeferredMovingOfNewTabs()
+    // Restart deferred tabs moving to sort all new tabs, not just
+    // the last one in case of two opened tabs b/c the first deferred
+    // moving was canceled in checkIfSessionIsRestoring fn.
+    handleNewTabMove()
 
-    // Reinit tabs
-    Tabs.unload()
-    Tabs.load(LoadSrc.SessionOnly)
+    // It's not a session restore, resolve the promises
+    tabs?.forEach(t => t.resolveSessionRestoreDetection?.(false))
 
-    Popups.closeSessionRestorePopup()
+    Popups.closeProcessingTabsPopup()
     return
   }
 
+  // It's a session restore, resolve the session restore detection promises
+  tabs.forEach(t => t.resolveSessionRestoreDetection?.(true))
+
   // Show popup about restoring the tabs
-  Popups.openSessionRestorePopup()
+  Popups.openProcessingTabsPopup()
 
   // Unload tabs
   Tabs.unload()
@@ -226,10 +229,10 @@ async function tryToRestoreTabsStateFromSessionData(
   await Utils.sleep(100)
 
   // Close popup
-  Popups.closeSessionRestorePopup()
+  Popups.closeProcessingTabsPopup()
 }
 
-function onTabCreated(nativeTab: NativeTab, attached?: boolean): void {
+async function onTabCreated(nativeTab: NativeTab, attached?: boolean) {
   if (nativeTab.windowId !== Windows.id) return
   if (!Tabs.ready || Tabs.sorting) {
     Tabs.deferredEventHandling.push(() => onTabCreated(nativeTab))
@@ -248,9 +251,16 @@ function onTabCreated(nativeTab: NativeTab, attached?: boolean): void {
   const tab = Tabs.mutateNativeTabToSideberyTab(nativeTab)
 
   // Stop if multiple tabs were open and data querying is started
+  let notSessionRestore
   if (maybeRestoredTabsDataQuerying) {
     checkIfSessionIsRestoring(tab)
-    return
+    if (tab.checkingSessionRestore) {
+      const sessionRestoreIsDetected = await tab.checkingSessionRestore
+      delete tab.checkingSessionRestore
+      delete tab.resolveSessionRestoreDetection
+      if (sessionRestoreIsDetected) return
+      notSessionRestore = true
+    }
   }
 
   // Check if opener tab is pinned
@@ -381,11 +391,9 @@ function onTabCreated(nativeTab: NativeTab, attached?: boolean): void {
 
   // Find appropriate position using the current settings
   else {
-    panel = Tabs.getPanelForNewTab(tab)
-    if (!panel) return Logs.err('Cannot handle new tab: Cannot find target panel')
-
     // Check if this is event is part of session restore
     if (
+      !notSessionRestore &&
       !attached &&
       // Tab is unloaded and has set url
       ((tab.discarded && tab.url !== 'about:blank') ||
@@ -395,17 +403,28 @@ function onTabCreated(nativeTab: NativeTab, attached?: boolean): void {
         tab.pinned)
     ) {
       checkIfSessionIsRestoring(tab)
-      if (maybeRestoredTabsDataQuerying) return
+      if (maybeRestoredTabsDataQuerying && tab.checkingSessionRestore) {
+        const sessionRestoreIsDetected = await tab.checkingSessionRestore
+        delete tab.checkingSessionRestore
+        delete tab.resolveSessionRestoreDetection
+        if (sessionRestoreIsDetected) return
+      }
     }
 
-    // Get parent tab
+    // Get panel
+    panel = Tabs.getPanelForNewTab(tab)
+    if (!panel) return Logs.err('Cannot handle new tab: Cannot find target panel')
+
+    // Outdent if opener tab is folded (if configured)
     const parent = Tabs.byId[tab.openerTabId ?? NOID]
     if (!attached && parent?.folded && Settings.state.ignoreFoldedParent) {
       tab.openerTabId = parent.parentId
     }
 
-    // Get index
+    // Get target index
     index = Tabs.getIndexForNewTab(panel, tab)
+
+    // Update opener
     if (!autoGroupTab) {
       tab.openerTabId = Tabs.getParentForNewTab(panel, tab)
     }

src/sidebar/components/popup.session-restore.vue renamed to src/sidebar/components/popup.processing-tabs.vue

@@ -1,9 +1,8 @@
 <template lang="pug">
-.SessionRestore.popup-container
+.ProcessingTabs.popup-container
   .popup(@click.stop)
-    h2 {{translate('popup.ses_res.title')}}
+    h2 {{translate('popup.proc_tabs.title')}}
     LoadingDots.loading-dots
-    .msg {{translate('popup.ses_res.desc')}}
 </template>
 
 <script lang="ts" setup>

src/sidebar/sidebar.vue

@@ -47,7 +47,7 @@
   Transition(name="popup" type="transition"): DialogPopup(v-if="Popups.reactive.dialog" :dialog="Popups.reactive.dialog")
   Transition(name="popup" type="transition"): NewTabShortcutsPopup(v-if="Popups.reactive.newTabShortcutsPopup")
   Transition(name="popup" type="transition"): SiteConfigPopup(v-if="Popups.reactive.siteConfigPopup")
-  Transition(name="popup" type="transition"): SessionRestorePopup(v-if="Popups.reactive.sessionRestorePopup")
+  Transition(name="popup" type="transition"): ProcessingTabsPopup(v-if="Popups.reactive.processingTabsPopup")
   CtxMenuPopup
   DragAndDropTooltip
   NotificationsPopup
@@ -146,7 +146,7 @@ import GroupConfigPopup from './components/popup.group-config.vue'
 import DialogPopup from 'src/components/popup.dialog.vue'
 import NewTabShortcutsPopup from '../components/popup.new-tab-shortcuts.vue'
 import SiteConfigPopup from '../components/popup.site-config.vue'
-import SessionRestorePopup from './components/popup.session-restore.vue'
+import ProcessingTabsPopup from './components/popup.processing-tabs.vue'
 import SubPanel from './components/sub-panel.vue'
 import * as Utils from 'src/utils'
 import * as Popups from 'src/services/popups'

src/styles/themes/proton/sidebar/popup.session-restore.styl renamed to src/styles/themes/proton/sidebar/popup.processing-tabs.styl

@@ -1,20 +1,20 @@
 @import '../../../utils'
 
-.SessionRestore
+.ProcessingTabs
   background-color: var(--frame-bg)
 
-.SessionRestore .popup
+.ProcessingTabs .popup
   box-shadow: none
   background-color: transparent
 
-.SessionRestore .msg
+.ProcessingTabs .msg
   position: relative
   font-size: rem(14)
   padding: 0 8px
   color: var(--popup-fg)
   opacity: .7
   text-align: center
 
-.SessionRestore .loading-dots
+.ProcessingTabs .loading-dots
   position: relative
   margin: 8px 0 16px

src/styles/themes/proton/sidebar/sidebar.styl

@@ -23,7 +23,7 @@ vendors = official
 @import './popup'
 @import './popup.windows'
 @import './popup.confirm'
-@import './popup.session-restore'
+@import './popup.processing-tabs'
 @import './popup.context-menu'
 @import './popup.notifications'
 @import './popup.bookmarks'

src/types/tabs.ts

@@ -46,6 +46,9 @@ export interface Tab extends NativeTab {
   favImgEl?: HTMLImageElement
   favSvgUseEl?: SVGElement
   flashFxEl?: HTMLElement
+
+  checkingSessionRestore?: Promise<boolean>
+  resolveSessionRestoreDetection?: (isSessionRestore: boolean) => void
 }
 
 export const enum TabStatus {