Add comments and clarify auto-archiving code.

Author: benmuth

background.js

@@ -1,13 +1,5 @@
 import { Snapshot, addToArchiveBox } from "./utils.js";
 
-chrome.runtime.onMessage.addListener(async (message) => {
-    const options_url = chrome.runtime.getURL('options.html') + `?search=${message.id}`;
-    console.log('i ArchiveBox Collector showing options.html', options_url);
-    if (message.action === 'openOptionsPage') {
-      await chrome.tabs.create({ url: options_url });
-    }
-  });
-
 // Checks if URL should be auto-archived based on regex patterns and configuration settings.
 async function shouldAutoArchive(url) {
   try {
@@ -106,24 +98,28 @@ async function autoArchive(tabId, changeInfo, tab) {
 // enabled and disabled
 let tabUpdateListener = null;
 
-async function setupAutoArchiving() {
+// Checks if we should be auto-archiving, and manages the listener accordingly. If the user has
+// given the required permissions and enabled it through the UI, then we'll listen for tab updates
+// and attempt to automatically archive the desired URLs.
+async function configureAutoArchiving() {
   console.debug('[Auto-Archive Debug] Setting up auto-archiving...');
 
   const hasPermission = await chrome.permissions.contains({ permissions: ['tabs'] });
   console.debug(`[Auto-Archive Debug] Has tabs permission: ${hasPermission}`);
 
   if (!hasPermission) {
     console.log('Tabs permission not granted, auto-archiving disabled');
-    // Reset the toggle if permission was not granted
     chrome.storage.local.set({ enable_auto_archive: false });
     return;
   }
 
+  // To prevent extra listeners being registered every time the auto-archiving checkbox is toggled,
+  // we remove any existing listener first.
   if (tabUpdateListener) {
     try {
       chrome.tabs.onUpdated.removeListener(tabUpdateListener);
       tabUpdateListener = null;
-    } catch (error) {
+    } catch {
       // ignore
     }
   }
@@ -132,51 +128,7 @@ async function setupAutoArchiving() {
   console.debug(`[Auto-Archive Debug] enable_auto_archive setting: ${enable_auto_archive}`);
 
   if (enable_auto_archive) {
-    tabUpdateListener = async (tabId, changeInfo, tab) => {
-      console.debug(`[Auto-Archive Debug] Tab updated - tabId: ${tabId}, status: ${changeInfo.status}, url: ${tab?.url}`);
-
-      // Only process when the page has completed loading
-      if (changeInfo.status === 'complete' && tab.url) {
-        console.debug(`[Auto-Archive Debug] Tab load complete, checking if URL should be archived: ${tab.url}`);
-
-        // Check if URL is already archived locally
-        const { snapshots = [] } = await chrome.storage.local.get('snapshots');
-        const isAlreadyArchived = snapshots.some(s => s.url === tab.url);
-
-        if (isAlreadyArchived) {
-          console.debug(`[Auto-Archive Debug] URL already archived, skipping: ${tab.url}`);
-          return;
-        }
-
-        const shouldArchive = await shouldAutoArchive(tab.url);
-        console.debug(`[Auto-Archive Debug] shouldAutoArchive result: ${shouldArchive}`);
-
-        if (shouldArchive) {
-          console.log('Auto-archiving URL:', tab.url);
-
-          const snapshot = new Snapshot(
-            tab.url,
-            ['auto-archived'],
-            tab.title,
-            tab.favIconUrl,
-          );
-
-          console.debug('[Auto-Archive Debug] Created new snapshot, saving to storage');
-          snapshots.push(snapshot);
-          await chrome.storage.local.set({ snapshots });
-          console.debug('[Auto-Archive Debug] Snapshot saved to local storage');
-
-          try {
-            console.debug(`[Auto-Archive Debug] Calling addToArchiveBox with URL: ${snapshot.url}, tags: ${snapshot.tags.join(',')}`);
-            await addToArchiveBox([snapshot.url], snapshot.tags);
-            console.log(`Automatically archived ${snapshot.url}`);
-          } catch (error) {
-            console.error(`Failed to automatically archive ${snapshot.url}: ${error.message}`);
-          }
-        }
-      }
-    };
-
+    tabUpdateListener = autoArchive;
     console.debug('[Auto-Archive Debug] Adding tab update listener');
     chrome.tabs.onUpdated.addListener(tabUpdateListener);
     console.log('Auto-archiving enabled with tabs permission');
@@ -186,35 +138,15 @@ async function setupAutoArchiving() {
 }
 
 // Initialize auto-archiving setup on extension load
-setupAutoArchiving();
+configureAutoArchiving();
 
 // Listen for changes to the auto-archive setting
 chrome.storage.onChanged.addListener((changes, area) => {
   if (area === 'local' && changes.enable_auto_archive) {
-    setupAutoArchiving();
+    configureAutoArchiving();
   }
 });
 
-chrome.action.onClicked.addListener(async (tab) => {
-  const snapshot = new Snapshot(
-    tab.url,
-    [],
-    tab.title,
-    tab.favIconUrl,
-  );
-
-  // Save the snapshot first
-  const { snapshots = [] } = await chrome.storage.local.get('snapshots');
-  snapshots.push(snapshot);
-  await chrome.storage.local.set({ snapshots });
-
-  // Inject scripts - CSS now handled in popup.js
-  await chrome.scripting.executeScript({
-    target: { tabId: tab.id },
-    files: ['popup.js']
-  });
-});
-
 chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
   if (message.type === 'archivebox_add') {
     try {
@@ -237,18 +169,34 @@ chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
   return true;
 });
 
+chrome.runtime.onMessage.addListener(async (message) => {
+  const options_url = chrome.runtime.getURL('options.html') + `?search=${message.id}`;
+  console.log('i ArchiveBox Collector showing options.html', options_url);
+  if (message.action === 'openOptionsPage') {
+    await chrome.tabs.create({ url: options_url });
+  }
+});
 
+chrome.runtime.onInstalled.addListener(function () {
+  chrome.contextMenus.removeAll();
+  chrome.contextMenus.create({
+    id: 'save_to_archivebox_ctxmenu',
+    title: 'Save to ArchiveBox',
+  });
+});
+
+// Context menu button
 chrome.contextMenus.onClicked.addListener((item, tab) =>
   chrome.scripting.executeScript({
     target: { tabId: tab.id },
     files: ['popup.js']
   })
 );
 
-chrome.runtime.onInstalled.addListener(function () {
-  chrome.contextMenus.removeAll();
-  chrome.contextMenus.create({
-    id: 'save_to_archivebox_ctxmenu',
-    title: 'Save to ArchiveBox',
+// Toolbar button
+chrome.action.onClicked.addListener((tab) => {
+  chrome.scripting.executeScript({
+    target: { tabId: tab.id },
+    files: ['popup.js']
   });
 });

utils.js

@@ -51,6 +51,7 @@ export function updateStatusIndicator(indicator, textElement, success, message)
   textElement.className = success ? 'text-success' : 'text-danger';
 }
 
+// Archive URLs on the configured ArchiveBox server instance.
 export async function addToArchiveBox(urls, tags = [], depth = 0, update = false, update_all = false) {
   const formattedTags = tags.join(',');
   console.log(`i Adding urls ${urls} and tags ${formattedTags} to ArchiveBox`);