/*
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
'use strict';

import {
  log as internalLogger,
  configs
} from './common.js';
import * as Constants from './constants.js';

// eslint-disable-next-line no-unused-vars
function log(...args) {
  internalLogger('common/tabs', ...args);
}


let mTargetWindow;

export function setCurrentWindowId(targetWindow) {
  return mTargetWindow = targetWindow;
}

export function getCurrentWindowId() {
  return mTargetWindow;
}


//===================================================================
// Tab Tracking
//===================================================================

export const windows        = new Map();
export const tabs           = new Map();
export const tabGroups      = new Map();
export const tabsByUniqueId = new Map();

export function clear() {
  tabs.clear();
  tabsByUniqueId.clear();
}

export const queryLogs = [];
const MAX_LOGS = 100000;

const MATCHING_ATTRIBUTES = `
active
attention
audible
autoDiscardable
cookieStoreId
discarded
favIconUrl
hidden
highlighted
id
incognito
index
isArticle
isInReaderMode
pinned
sessionId
status
successorId
title
url
`.trim().split(/\s+/);

export function queryAll(query) {
  if (configs.loggingQueries) {
    queryLogs.push(query);
    queryLogs.splice(0, Math.max(0, queryLogs.length - MAX_LOGS));
    if (query.tabs?.name)
      query.indexedTabs = query.tabs.name;
  }
  fixupQuery(query);
  const startAt = Date.now();
  if (query.windowId || query.ordered) {
    let tabs = [];
    for (const win of windows.values()) {
      if (query.windowId && !matched(win.id, query.windowId))
        continue;
      const [sourceTabs, offset] = sourceTabsForQuery(query, win);
      tabs = tabs.concat(query.iterator ? getMatchedTabsIterator(sourceTabs, query, offset) : extractMatchedTabs(sourceTabs, query, offset));
    }
    query.elapsed = Date.now() - startAt;
    if (query.iterator) {
      return (function* () {
        for (const tabsIterator of tabs) {
          for (const tab of tabsIterator) {
            yield tab;
          }
        }
      })();
    }
    else {
      return tabs;
    }
  }
  else {
    const sourceTabs = (query.tabs || tabs).values();
    const matchedTabs = query.iterator ? getMatchedTabsIterator(sourceTabs, query) : extractMatchedTabs(sourceTabs, query);
    query.elapsed = Date.now() - startAt;
    return matchedTabs;
  }
}

function sourceTabsForQuery(query, win) {
  let offset = 0;
  if (!query.ordered)
    return [query.tabs?.values() || win.tabs.values(), offset];
  let fromId;
  let toId = query.toId;
  if (typeof query.index == 'number') {
    fromId = win.order[query.index];
    offset = query.index;
  }
  if (typeof query.fromIndex == 'number') {
    fromId = win.order[query.fromIndex];
    offset = query.fromIndex;
  }
  if (typeof query.toIndex == 'number') {
    toId = win.order[query.toIndex];
  }
  if (typeof fromId != 'number') {
    fromId = query.fromId;
    offset = win.order.indexOf(query.fromId);
  }
  if (query.last || query.reversed)
    return [win.getReversedOrderedTabs(fromId, toId, query.tabs), offset];
  return [win.getOrderedTabs(fromId, toId, query.tabs), offset];
}

function extractMatchedTabs(tabsInStore, query, offset) {
  const matchedTabs = [];
  let firstTime     = true;
  let logicalIndex  = offset || 0;
  for (const tab of tabsInStore) {
    if (!tabs.has(tab.id) ||
        (!query.skipMatching &&
         !matchedWithQuery(tab, query)))
      continue;

    if (!firstTime)
      logicalIndex++;
    firstTime = false;
    if ('logicalIndex' in query &&
        !matched(logicalIndex, query.logicalIndex))
      continue;

    matchedTabs.push(tab);
    if (query.first || query.last)
      break;
  }
  return matchedTabs;
}

function* getMatchedTabsIterator(tabsInStore, query, offset) {
  let firstTime     = true;
  let logicalIndex  = offset || 0;
  for (const tab of tabsInStore) {
    if (!tabs.has(tab.id) ||
        (!query.skipMatching &&
         !matchedWithQuery(tab, query)))
      continue;

    if (!firstTime)
      logicalIndex++;
    firstTime = false;
    if ('logicalIndex' in query &&
        !matched(logicalIndex, query.logicalIndex))
      continue;

    yield tab;
    if (query.first || query.last)
      break;
  }
}

function matchedWithQuery(tab, query) {
  for (const attribute of MATCHING_ATTRIBUTES) {
    if (attribute in query &&
        !matched(tab[attribute], query[attribute]))
      return false;
    const invertedAttribute = `!${attribute}`;
    if (invertedAttribute in query &&
        matched(tab[attribute], query[invertedAttribute]))
      return false;
  }

  if (!tab.$TST)
    return false;

  const tabStates = tab.$TST.states;
  if ('states' in query && tabStates) {
    const queryStates = query.states;
    for (let i = 0, maxi = queryStates.length; i < maxi; i += 2) {
      const state   = queryStates[i];
      const pattern = queryStates[i+1];
      if (!matched(tabStates.has(state), pattern))
        return false;
    }
  }
  const tabAttributes = tab.$TST.attributes;
  if ('attributes' in query && tabAttributes) {
    const queryAttributes = query.attributes;
    for (let i = 0, maxi = queryAttributes.length; i < maxi; i += 2) {
      const attribute = queryAttributes[i];
      const pattern   = queryAttributes[i+1];
      if (!matched(tabAttributes[attribute], pattern))
        return false;
    }
  }

  if (query.living &&
      !ensureLivingItem(tab))
    return false;
  if (query.normal &&
      (tab.hidden ||
       tabStates.has(Constants.kTAB_STATE_SHOWING) ||
       tab.pinned))
    return false;
  if (query.pinned &&
      (tab.hidden ||
       tabStates.has(Constants.kTAB_STATE_SHOWING) ||
       !tab.pinned))
    return false;
  if (query.visible &&
      ((tabStates.has(Constants.kTAB_STATE_COLLAPSED) &&
        !tabStates.has(Constants.kTAB_STATE_EXPANDING)) ||
       tab.hidden ||
       tabStates.has(Constants.kTAB_STATE_SHOWING)))
    return false;
  if (query.hidden &&
      !tab.hidden)
    return false;
  if (query.controllable &&
      (tab.hidden ||
       tabStates.has(Constants.kTAB_STATE_SHOWING)))
    return false;
  if ('hasChild' in query &&
      query.hasChild != tab.$TST.hasChild)
    return false;
  if ('hasParent' in query &&
      query.hasParent != tab.$TST.hasParent)
    return false;
  if ('childOf' in query &&
      !tab.$TST.parentId != query.childOf)
    return false;
  if ('descendantOf' in query &&
      !tab.$TST.ancestorIds.includes(query.descendantOf))
    return false;
  if (query.groupId &&
      tab.groupId != query.groupId)
    return false;

  return true;
}

function matched(value, pattern) {
  if (pattern instanceof RegExp &&
      !pattern.test(String(value)))
    return false;
  if (pattern instanceof Set &&
      !pattern.has(value))
    return false;
  if (Array.isArray(pattern) &&
      !pattern.includes(value))
    return false;
  if (typeof pattern == 'function' &&
      !pattern(value))
    return false;
  if (typeof pattern == 'boolean' &&
      !!value !== pattern)
    return false;
  if (typeof pattern == 'string' &&
      String(value || '') != pattern)
    return false;
  if (typeof pattern == 'number' &&
      value != pattern)
    return false;
  return true;
}

export function query(query) {
  if (configs.loggingQueries) {
    queryLogs.push(query);
    queryLogs.splice(0, Math.max(0, queryLogs.length - MAX_LOGS));
    if (query.tabs?.name)
      query.indexedTabs = query.tabs.name;
  }
  fixupQuery(query);
  if (query.last)
    query.ordered = true;
  else
    query.first = true;
  const startAt = Date.now();
  let tabs = [];
  if (query.windowId || query.ordered) {
    for (const win of windows.values()) {
      if (query.windowId && !matched(win.id, query.windowId))
        continue;
      const [sourceTabs, offset] = sourceTabsForQuery(query, win);
      tabs = tabs.concat(extractMatchedTabs(sourceTabs, query, offset));
      if (tabs.length > 0)
        break;
    }
  }
  else {
    tabs = extractMatchedTabs((query.tabs ||tabs).values(), query);
  }
  query.elapsed = Date.now() - startAt;
  return tabs.length > 0 ? tabs[0] : null ;
}

function fixupQuery(query) {
  if (query.fromId ||
      query.toId ||
      typeof query.index == 'number' ||
      typeof query.fromIndex == 'number' ||
      typeof query.logicalIndex == 'number')
    query.ordered = true;
  if ((query.normal ||
       query.visible ||
       query.controllable ||
       query.pinned) &&
       !('living' in query))
    query.living = true;
}


//===================================================================
// Indexes for optimization
//===================================================================

export const activeTabInWindow       = new Map();
export const activeTabsInWindow      = new Map();
export const bundledActiveTabsInWindow = new Map();
export const livingTabsInWindow      = new Map();
export const controllableTabsInWindow = new Map();
export const removingTabsInWindow    = new Map();
export const removedTabsInWindow     = new Map();
export const visibleTabsInWindow     = new Map();
export const expandedTabsInWindow    = new Map();
export const selectedTabsInWindow    = new Map();
export const highlightedTabsInWindow = new Map();
export const pinnedTabsInWindow      = new Map();
export const unpinnedTabsInWindow    = new Map();
export const rootTabsInWindow        = new Map();
export const groupTabsInWindow       = new Map();
export const toBeExpandedTabsInWindow = new Map();
export const subtreeCollapsableTabsInWindow = new Map();
export const draggingTabsInWindow    = new Map();
export const duplicatingTabsInWindow = new Map();
export const toBeGroupedTabsInWindow = new Map();
export const nativelyGroupedTabsInWindow = new Map();
export const loadingTabsInWindow     = new Map();
export const unsynchronizedTabsInWindow = new Map();
export const virtualScrollRenderableTabsInWindow  = new Map();
export const scrollPositionCalculationTargetTabsInWindow = new Map();
export const canBecomeStickyTabsInWindow = new Map();

function createMapWithName(name) {
  const map = new Map();
  map.name = name;
  return map;
}

export function prepareIndexesForWindow(windowId) {
  activeTabsInWindow.set(windowId, new Set());
  bundledActiveTabsInWindow.set(windowId, createMapWithName(`bundled active tabs in window ${windowId}`));
  livingTabsInWindow.set(windowId, createMapWithName(`living tabs in window ${windowId}`));
  controllableTabsInWindow.set(windowId, createMapWithName(`controllable tabs in window ${windowId}`));
  removingTabsInWindow.set(windowId, createMapWithName(`removing tabs in window ${windowId}`));
  removedTabsInWindow.set(windowId, createMapWithName(`removed tabs in window ${windowId}`));
  visibleTabsInWindow.set(windowId, createMapWithName(`visible tabs in window ${windowId}`));
  expandedTabsInWindow.set(windowId, createMapWithName(`expanded tabs in window ${windowId}`));
  selectedTabsInWindow.set(windowId, createMapWithName(`selected tabs in window ${windowId}`));
  highlightedTabsInWindow.set(windowId, createMapWithName(`highlighted tabs in window ${windowId}`));
  pinnedTabsInWindow.set(windowId, createMapWithName(`pinned tabs in window ${windowId}`));
  unpinnedTabsInWindow.set(windowId, createMapWithName(`unpinned tabs in window ${windowId}`));
  rootTabsInWindow.set(windowId, createMapWithName(`root tabs in window ${windowId}`));
  groupTabsInWindow.set(windowId, createMapWithName(`group tabs in window ${windowId}`));
  toBeExpandedTabsInWindow.set(windowId, createMapWithName(`to-be-expanded tabs in window ${windowId}`));
  subtreeCollapsableTabsInWindow.set(windowId, createMapWithName(`collapsable parent tabs in window ${windowId}`));
  draggingTabsInWindow.set(windowId, createMapWithName(`dragging tabs in window ${windowId}`));
  duplicatingTabsInWindow.set(windowId, createMapWithName(`duplicating tabs in window ${windowId}`));
  toBeGroupedTabsInWindow.set(windowId, createMapWithName(`to-be-grouped tabs in window ${windowId}`));
  nativelyGroupedTabsInWindow.set(windowId, createMapWithName(`natively grouped tabs in window ${windowId}`));
  loadingTabsInWindow.set(windowId, createMapWithName(`loading tabs in window ${windowId}`));
  unsynchronizedTabsInWindow.set(windowId, createMapWithName(`unsynchronized tabs in window ${windowId}`));
  virtualScrollRenderableTabsInWindow.set(windowId, createMapWithName(`virtual scroll renderable tabs in window ${windowId}`));
  scrollPositionCalculationTargetTabsInWindow.set(windowId, createMapWithName(`scroll position calculation target tabs in window ${windowId}`));
  canBecomeStickyTabsInWindow.set(windowId, createMapWithName(`can become sticky tabs in window ${windowId}`));
}

export function unprepareIndexesForWindow(windowId) {
  activeTabInWindow.delete(windowId);
  activeTabsInWindow.delete(windowId);
  bundledActiveTabsInWindow.delete(windowId);
  livingTabsInWindow.delete(windowId);
  controllableTabsInWindow.delete(windowId);
  removingTabsInWindow.delete(windowId);
  removedTabsInWindow.delete(windowId);
  visibleTabsInWindow.delete(windowId);
  expandedTabsInWindow.delete(windowId);
  selectedTabsInWindow.delete(windowId);
  highlightedTabsInWindow.delete(windowId);
  pinnedTabsInWindow.delete(windowId);
  unpinnedTabsInWindow.delete(windowId);
  rootTabsInWindow.delete(windowId);
  groupTabsInWindow.delete(windowId);
  toBeExpandedTabsInWindow.delete(windowId);
  subtreeCollapsableTabsInWindow.delete(windowId);
  toBeGroupedTabsInWindow.delete(windowId);
  nativelyGroupedTabsInWindow.delete(windowId);
  loadingTabsInWindow.delete(windowId);
  unsynchronizedTabsInWindow.delete(windowId);
  virtualScrollRenderableTabsInWindow.delete(windowId);
  scrollPositionCalculationTargetTabsInWindow.delete(windowId);
  canBecomeStickyTabsInWindow.delete(windowId);
}

export function getTabsMap(tabsStore, windowId = null) {
  return windowId ?
    tabsStore.get(windowId) :
    new Map([...tabsStore.values()].map(tabs => [...tabs.entries()]).flat());
}

export function updateIndexesForTab(tab) {
  addLivingTab(tab);

  if (!tab.hidden)
    addControllableTab(tab);
  else
    removeControllableTab(tab);

  if (tab.$TST.collapsed)
    removeExpandedTab(tab);
  else
    addExpandedTab(tab);

  if (tab.hidden || tab.$TST.collapsed)
    removeVisibleTab(tab);
  else
    addVisibleTab(tab);

  if (tab.$TST.states.has(Constants.kTAB_STATE_SELECTED))
    addSelectedTab(tab);
  else
    removeSelectedTab(tab);

  if (tab.highlighted)
    addHighlightedTab(tab);
  else
    removeHighlightedTab(tab);

  if (tab.pinned) {
    removeUnpinnedTab(tab);
    addPinnedTab(tab);
  }
  else {
    removePinnedTab(tab);
    addUnpinnedTab(tab);
  }

  if (tab.$TST.isGroupTab)
    addGroupTab(tab);
  else
    removeGroupTab(tab);

  if (tab.$TST.duplicating)
    addDuplicatingTab(tab);
  else
    removeDuplicatingTab(tab);

  if (tab.$TST.getAttribute(Constants.kPERSISTENT_ORIGINAL_OPENER_TAB_ID) &&
      !tab.$TST.getAttribute(Constants.kPERSISTENT_ALREADY_GROUPED_FOR_PINNED_OPENER))
    addToBeGroupedTab(tab);
  else
    removeToBeGroupedTab(tab);

  if (tab.$TST.parent)
    removeRootTab(tab);
  else
    addRootTab(tab);

  if (tab.$TST.hasChild &&
      !tab.$TST.subtreeCollapsed &&
      !tab.$TST.collapsed)
    addSubtreeCollapsableTab(tab);
  else
    removeSubtreeCollapsableTab(tab);

  if (tab.status == 'loading')
    addLoadingTab(tab);
  else
    removeLoadingTab(tab);

  if (tab.$TST.states.has(Constants.kTAB_STATE_BUNDLED_ACTIVE))
    addBundledActiveTab(tab);
  else
    removeBundledActiveTab(tab);

  if (tab.groupId && tab.groupId != -1)
    addNativelyGroupedTab(tab);
  else
    removeNativelyGroupedTab(tab);

  updateVirtualScrollRenderabilityIndexForTab(tab);

  if (tab.$TST.states.has(Constants.kTAB_STATE_COLLAPSED_DONE))
    removeScrollPositionCalculationTargetTab(tab);
  else
    addScrollPositionCalculationTargetTab(tab);

  if (tab.$TST.canBecomeSticky)
    addCanBecomeStickyTab(tab);
  else
    removeCanBecomeStickyTab(tab);
}

export function updateVirtualScrollRenderabilityIndexForTab(tab) {
  if (tab.pinned ||
      (tab.hidden &&
       ((tab.url == 'about:firefoxview' &&
         tab.cookieStoreId == 'firefox-default') ||
        !configs.renderHiddenTabs)) ||
      tab.$TST.states.has(Constants.kTAB_STATE_COLLAPSED_DONE) ||
      (tabGroups.get(tab.groupId)?.$TST.states.has(Constants.kTAB_STATE_COLLAPSED_DONE) &&
       !tab.active))
    removeVirtualScrollRenderableTab(tab);
  else
    addVirtualScrollRenderableTab(tab);
}

export function removeTabFromIndexes(tab) {
  removeBundledActiveTab(tab);
  removeLivingTab(tab);
  removeControllableTab(tab);
  removeRemovingTab(tab);
  //removeRemovedTab(tab);
  removeVisibleTab(tab);
  removeExpandedTab(tab);
  removeSelectedTab(tab);
  removeHighlightedTab(tab);
  removePinnedTab(tab);
  removeUnpinnedTab(tab);
  removeRootTab(tab);
  removeGroupTab(tab);
  removeToBeExpandedTab(tab);
  removeSubtreeCollapsableTab(tab);
  removeDuplicatingTab(tab);
  removeDraggingTab(tab);
  removeToBeGroupedTab(tab);
  removeNativelyGroupedTab(tab);
  removeLoadingTab(tab);
  removeUnsynchronizedTab(tab);
  //removeVirtualScrollRenderableTab(tab);
  removeScrollPositionCalculationTargetTab(tab);
  removeCanBecomeStickyTab(tab);
}

function addTabToIndex(tab, indexes, windowId = null) {
  if (!tab)
    throw new Error(`TabsStore.addTabToIndex gets non-tab parameter!: ${JSON.stringify(tab)} : ${new Error().stack}`);
  const tabs = indexes.get(windowId || tab.windowId);
  if (tabs)
    tabs.set(tab.id, tab);
}

function removeTabFromIndex(tab, indexes, windowId = null) {
  if (!tab)
    throw new Error(`TabsStore.removeTabFromIndex gets non-tab parameter!: ${JSON.stringify(tab)} : ${new Error().stack}`);
  const tabs = indexes.get(windowId || tab.windowId);
  if (tabs)
    tabs.delete(tab.id);
}

export function addLivingTab(tab) {
  addTabToIndex(tab, livingTabsInWindow);
}
export function removeLivingTab(tab) {
  removeTabFromIndex(tab, livingTabsInWindow);
}

export function addControllableTab(tab) {
  addTabToIndex(tab, controllableTabsInWindow);
}
export function removeControllableTab(tab) {
  removeTabFromIndex(tab, controllableTabsInWindow);
}

export function addRemovingTab(tab) {
  addTabToIndex(tab, removingTabsInWindow);
  removeTabFromIndexes(tab);
}
export function removeRemovingTab(tab) {
  removeTabFromIndex(tab, removingTabsInWindow);
}

export function addRemovedTab(tab) {
  addTabToIndex(tab, removedTabsInWindow);
  setTimeout(removeRemovedTab, 100000, {
    id:       tab.id,
    windowId: tab.windowId
  });
}
export function removeRemovedTab(tab) {
  removeTabFromIndex(tab, removedTabsInWindow);
}

export function addVisibleTab(tab) {
  addTabToIndex(tab, visibleTabsInWindow);
}
export function removeVisibleTab(tab) {
  removeTabFromIndex(tab, visibleTabsInWindow);
}

export function addExpandedTab(tab) {
  addTabToIndex(tab, expandedTabsInWindow);
}
export function removeExpandedTab(tab) {
  removeTabFromIndex(tab, expandedTabsInWindow);
}

export function addSelectedTab(tab) {
  addTabToIndex(tab, selectedTabsInWindow);
}
export function removeSelectedTab(tab) {
  removeTabFromIndex(tab, selectedTabsInWindow);
}

export function addHighlightedTab(tab) {
  addTabToIndex(tab, highlightedTabsInWindow);
}
export function removeHighlightedTab(tab) {
  removeTabFromIndex(tab, highlightedTabsInWindow);
}

export function addPinnedTab(tab) {
  addTabToIndex(tab, pinnedTabsInWindow);
}
export function removePinnedTab(tab) {
  removeTabFromIndex(tab, pinnedTabsInWindow);
}

export function addUnpinnedTab(tab) {
  addTabToIndex(tab, unpinnedTabsInWindow);
}
export function removeUnpinnedTab(tab) {
  removeTabFromIndex(tab, unpinnedTabsInWindow);
}

export function addRootTab(tab) {
  addTabToIndex(tab, rootTabsInWindow);
}
export function removeRootTab(tab) {
  removeTabFromIndex(tab, rootTabsInWindow);
}

export function addGroupTab(tab) {
  addTabToIndex(tab, groupTabsInWindow);
}
export function removeGroupTab(tab) {
  removeTabFromIndex(tab, groupTabsInWindow);
}

export function addToBeExpandedTab(tab) {
  addTabToIndex(tab, toBeExpandedTabsInWindow);
}
export function removeToBeExpandedTab(tab) {
  removeTabFromIndex(tab, toBeExpandedTabsInWindow);
}

export function addSubtreeCollapsableTab(tab) {
  addTabToIndex(tab, subtreeCollapsableTabsInWindow);
}
export function removeSubtreeCollapsableTab(tab) {
  removeTabFromIndex(tab, subtreeCollapsableTabsInWindow);
}

export function addDuplicatingTab(tab) {
  addTabToIndex(tab, duplicatingTabsInWindow);
}
export function removeDuplicatingTab(tab) {
  removeTabFromIndex(tab, duplicatingTabsInWindow);
}

export function addDraggingTab(tab) {
  addTabToIndex(tab, draggingTabsInWindow);
}
export function removeDraggingTab(tab) {
  removeTabFromIndex(tab, draggingTabsInWindow);
}

export function addToBeGroupedTab(tab) {
  addTabToIndex(tab, toBeGroupedTabsInWindow);
}
export function removeToBeGroupedTab(tab) {
  removeTabFromIndex(tab, toBeGroupedTabsInWindow);
}

export function addNativelyGroupedTab(tab, windowId = null) {
  addTabToIndex(tab, nativelyGroupedTabsInWindow, windowId);
}
export function removeNativelyGroupedTab(tab, windowId = null) {
  removeTabFromIndex(tab, nativelyGroupedTabsInWindow, windowId);
}

export function addLoadingTab(tab) {
  addTabToIndex(tab, loadingTabsInWindow);
}
export function removeLoadingTab(tab) {
  removeTabFromIndex(tab, loadingTabsInWindow);
}

export function addUnsynchronizedTab(tab) {
  addTabToIndex(tab, unsynchronizedTabsInWindow);
}
export function removeUnsynchronizedTab(tab) {
  removeTabFromIndex(tab, unsynchronizedTabsInWindow);
}

export function addBundledActiveTab(tab) {
  addTabToIndex(tab, bundledActiveTabsInWindow);
}
export function removeBundledActiveTab(tab) {
  removeTabFromIndex(tab, bundledActiveTabsInWindow);
}

export function addVirtualScrollRenderableTab(tab) {
  addTabToIndex(tab, virtualScrollRenderableTabsInWindow);
}
export function removeVirtualScrollRenderableTab(tab) {
  removeTabFromIndex(tab, virtualScrollRenderableTabsInWindow);
}

export function addScrollPositionCalculationTargetTab(tab) {
  addTabToIndex(tab, scrollPositionCalculationTargetTabsInWindow);
}
export function removeScrollPositionCalculationTargetTab(tab) {
  removeTabFromIndex(tab, scrollPositionCalculationTargetTabsInWindow);
}

export function addCanBecomeStickyTab(tab) {
  addTabToIndex(tab, canBecomeStickyTabsInWindow);
}
export function removeCanBecomeStickyTab(tab) {
  removeTabFromIndex(tab, canBecomeStickyTabsInWindow);
}



//===================================================================
// Utilities
//===================================================================

export function assertValidTab(tab) {
  if (tab?.$TST)
    return;
  const error = new Error('FATAL ERROR: invalid tab is given');
  console.log(error.message, tab, error.stack);
  throw error;
}

export function ensureLivingItem(tab) {
  const isNativeTabGroup = tab?.type == 'group';
  if (!tab ||
      !tab.id ||
      !tab.$TST ||
      (!isNativeTabGroup && !tabs.has(tab.id)) ||
      tab.$TST.removing ||
      !windows.get(tab.windowId) ||
      (isNativeTabGroup && !windows.get(tab.windowId).tabGroups.has(tab.id)))
    return null;
  return tab;
}


//===================================================================
// Logging
//===================================================================

browser.runtime.onMessage.addListener((message, _sender) => {
  if (!message ||
      typeof message != 'object' ||
      message.type != Constants.kCOMMAND_REQUEST_QUERY_LOGS)
    return;

  browser.runtime.sendMessage({
    type: Constants.kCOMMAND_RESPONSE_QUERY_LOGS,
    logs: JSON.parse(JSON.stringify(queryLogs)),
    windowId: mTargetWindow || 'background'
  });
});
