Remove hard-coded built-in folder IDs

- Remove hard-coded built-in bookmark folder IDs, which aren't the same
  across browsers.
- Remove dependency on `bookmarks.BookmarkTreeNode.type` field, which isn't
  available on all browsers.

Author: msmolens

CHANGELOG.md

@@ -1,78 +1,113 @@
 # Treetop Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
+
 ### Changed
-- Update Vite to 4.1.
+
+- Remove dependency on bookmarks.BookmarkTreeNode.type field, which isn't
+  available on all browsers.
+- Remove dependency on hard-coded built-in bookmark folder IDs, which aren't the
+  same across browsers.
 
 ### Removed
+
 - Remove options to set visibility of built-in bookmark folders.
 
 ## [1.5.0] - 2022-09-27
+
 ### Changed
+
 - Update Svelte Material UI to 6.1.4.
 - Replace Rollup with Vite as the build tool.
 
 ### Fixed
+
 - Fix selecting bookmark name or URL in properties dialog when focusing each input.
 
 ## [1.4.1] - 2022-06-20
+
 ### Fixed
+
 - Fix color scheme when legacy 'system' option is stored.
 
 ## [1.4.0] - 2022-06-19
+
 ### Changed
+
 - Update Svelte Material UI to 6.0.0-beta.16.
 - Update development and testing dependencies.
 
 ### Removed
+
 - Remove option to follow the system color scheme.
 
 ### Fixed
+
 - Fix loading stored options.
 
 ## [1.3.0] - 2021-10-02
+
 ### Added
+
 - Add webextension-polyfill.
 - Pressing Escape clears the search input.
 
 ## [1.2.0] - 2021-09-18
+
 ### Added
+
 - Add a search input to search for bookmarks by name or URL.
 
 ### Changed
+
 - Update Svelte Material UI to 4.2.0.
 
 ## [1.1.3] - 2021-01-22
+
 ### Added
+
 - List of attributions for open source software distributed in releases.
 
 ### Changed
+
 - Use fonts from Fontsource packages.
 
 ## [1.1.2] - 2020-12-08
+
 ### Changed
+
 - Fix visited bookmark styling.
 
 ## [1.1.1] - 2020-12-04
+
 ### Fixed
+
 - Fix bad 1.1.0 release on addons.mozilla.org.
 
 ## [1.1.0] - 2020-12-04
+
 ### Changed
+
 - Add option to change the color scheme.
 
 ## [1.0.1] - 2020-11-23
+
 ### Changed
+
 - Improve timer that updates when bookmarks were last visited.
 
 ### Fixed
+
 - Fix setting the document title.
 
 ## [1.0.0] - 2020-11-10
+
 ### Added
+
 - Initial release.
 
 [Unreleased]: https://github.com/msmolens/treetop/compare/v1.5.0...HEAD

src/treetop/BookmarksManager.ts

@@ -1,41 +1,45 @@
 import { get, writable } from 'svelte/store';
 import browser, { type Bookmarks } from 'webextension-polyfill';
 
-import {
-  BOOKMARK_TREE_NODE_TYPE_BOOKMARK,
-  BOOKMARK_TREE_NODE_TYPE_FOLDER,
-  BOOKMARK_TREE_NODE_TYPE_SEPARATOR,
-  BOOKMARKS_MENU_GUID,
-  BOOKMARKS_TOOLBAR_GUID,
-  OTHER_BOOKMARKS_GUID,
-} from './constants';
+import { isBookmark, isFolder, isSeparator } from './bookmarktreenode-utils';
+import { MOBILE_BOOKMARKS_GUID } from './constants';
 import * as Treetop from './types';
 
-// Map bookmarks.BookmarkTreeNodeType to Treetop.NodeType
-const BookmarkTypeMap: Map<Bookmarks.BookmarkTreeNodeType, Treetop.NodeType> =
-  new Map([
-    [BOOKMARK_TREE_NODE_TYPE_BOOKMARK, Treetop.NodeType.Bookmark],
-    [BOOKMARK_TREE_NODE_TYPE_FOLDER, Treetop.NodeType.Folder],
-    [BOOKMARK_TREE_NODE_TYPE_SEPARATOR, Treetop.NodeType.Separator],
-  ]);
-
 /**
  * Class to initialize and manage updating bookmark node stores.
  */
 export class BookmarksManager {
-  constructor(private readonly nodeStoreMap: Treetop.NodeStoreMap) {}
+  constructor(
+    private readonly nodeStoreMap: Treetop.NodeStoreMap,
+    private readonly builtInFolderInfo: Treetop.BuiltInFolderInfo
+  ) {}
 
   /**
    * Load all bookmarks and initialize node stores for folders.
+   * Initialize built-in folder info.
    */
   async loadBookmarks(): Promise<void> {
     const nodes = await browser.bookmarks.getTree();
-    this.orderBookmarksRootChildren(nodes[0]);
 
+    // Store root node ID
+    const rootNode = nodes[0];
+    this.builtInFolderInfo.rootNodeId = rootNode.id;
+
+    // Firefox: Exclude Mobile Bookmarks folder
+    rootNode.children = rootNode.children?.filter(
+      ({ id }) => id !== MOBILE_BOOKMARKS_GUID
+    );
+
+    // Store built-in folder IDs (e.g. Other Bookmarks)
+    this.builtInFolderInfo.builtInFolderIds = rootNode.children!.map(
+      ({ id }) => id
+    );
+
+    // Initialize node stores for folders
     while (nodes.length > 0) {
       const node = nodes.pop()!;
 
-      if (node.type === BOOKMARK_TREE_NODE_TYPE_FOLDER) {
+      if (isFolder(node)) {
         this.buildNodeStore(node);
         nodes.push(...node.children!);
       }
@@ -54,32 +58,27 @@ export class BookmarksManager {
       title: node.title,
       children: node.children!.map((child): Treetop.Node => {
         let newChild: Treetop.Node;
-        const type = BookmarkTypeMap.get(child.type!)!;
-        switch (type) {
-          case Treetop.NodeType.Bookmark:
-            newChild = {
-              type,
-              id: child.id,
-              title: child.title,
-              url: child.url!,
-            };
-            break;
-          case Treetop.NodeType.Folder:
-            newChild = {
-              type,
-              id: child.id,
-              title: child.title,
-              children: [],
-            };
-            break;
-          case Treetop.NodeType.Separator:
-            newChild = {
-              type,
-              id: child.id,
-            };
-            break;
-          default:
-            throw new TypeError();
+        if (isBookmark(child)) {
+          newChild = {
+            id: child.id,
+            title: child.title,
+            type: Treetop.NodeType.Bookmark,
+            url: child.url!,
+          };
+        } else if (isFolder(child)) {
+          newChild = {
+            id: child.id,
+            title: child.title,
+            type: Treetop.NodeType.Folder,
+            children: [],
+          };
+        } else if (isSeparator(child)) {
+          newChild = {
+            id: child.id,
+            type: Treetop.NodeType.Separator,
+          };
+        } else {
+          throw new TypeError();
         }
 
         return newChild;
@@ -93,10 +92,6 @@ export class BookmarksManager {
    * Create and record a node store for the specified bookmark node.
    */
   private buildNodeStore(node: Bookmarks.BookmarkTreeNode): void {
-    if (node.type !== BOOKMARK_TREE_NODE_TYPE_FOLDER) {
-      throw new TypeError();
-    }
-
     const newNode = this.convertNode(node);
     const nodeStore = writable(newNode);
     this.nodeStoreMap.set(node.id, nodeStore);
@@ -108,7 +103,7 @@ export class BookmarksManager {
   private async updateNodeStore(nodeId: string): Promise<void> {
     const [node] = await browser.bookmarks.get(nodeId);
 
-    if (node.type !== BOOKMARK_TREE_NODE_TYPE_FOLDER) {
+    if (!isFolder(node)) {
       throw new TypeError();
     }
 
@@ -126,7 +121,7 @@ export class BookmarksManager {
     id: string,
     bookmark: Bookmarks.BookmarkTreeNode
   ): Promise<void> {
-    if (bookmark.type === BOOKMARK_TREE_NODE_TYPE_FOLDER) {
+    if (isFolder(bookmark)) {
       // Add node store for the new folder
       const [node] = await browser.bookmarks.get(id);
       node.children = await browser.bookmarks.getChildren(id);
@@ -149,7 +144,7 @@ export class BookmarksManager {
   ): Promise<string[]> {
     const removedNodeIds = [];
 
-    if (removeInfo.node.type === BOOKMARK_TREE_NODE_TYPE_FOLDER) {
+    if (isFolder(removeInfo.node)) {
       const nodeStore = this.nodeStoreMap.get(id)!;
       const nodes: [Treetop.FolderNode] = [get(nodeStore)];
 
@@ -219,35 +214,4 @@ export class BookmarksManager {
       await this.updateNodeStore(oldParentId);
     }
   }
-
-  /**
-   * Order root bookmark node children like:
-   * - Bookmarks Toolbar
-   * - Bookmarks Menu
-   * - Other Bookmarks
-   *
-   * Respect preference settings for whether to include each folder.
-   *
-   * Omit Mobile Bookmarks.
-   */
-  private orderBookmarksRootChildren(node: Bookmarks.BookmarkTreeNode): void {
-    const children: Bookmarks.BookmarkTreeNode[] = [];
-
-    const bookmarksToolbarNode = node.children!.find(
-      ({ id }) => id === BOOKMARKS_TOOLBAR_GUID
-    )!;
-    children.push(bookmarksToolbarNode);
-
-    const bookmarksMenuNode = node.children!.find(
-      ({ id }) => id === BOOKMARKS_MENU_GUID
-    )!;
-    children.push(bookmarksMenuNode);
-
-    const otherBookmarksNode = node.children!.find(
-      ({ id }) => id === OTHER_BOOKMARKS_GUID
-    )!;
-    children.push(otherBookmarksNode);
-
-    node.children = children;
-  }
 }

src/treetop/FilterManager.ts

@@ -1,7 +1,7 @@
 import { get } from 'svelte/store';
 import type { Bookmarks } from 'webextension-polyfill';
 
-import { BOOKMARK_TREE_NODE_TYPE_BOOKMARK } from './constants';
+import { isBookmark } from './bookmarktreenode-utils';
 import * as Treetop from './types';
 
 /**
@@ -92,7 +92,7 @@ export class FilterManager {
       return;
     }
 
-    if (bookmark.type !== BOOKMARK_TREE_NODE_TYPE_BOOKMARK) {
+    if (!isBookmark(bookmark)) {
       return;
     }
 

src/treetop/Folder.svelte

@@ -4,12 +4,13 @@
   import * as browser from 'webextension-polyfill';
 
   import Bookmark from './Bookmark.svelte';
-  import { BOOKMARKS_ROOT_GUID } from './constants';
   import * as Treetop from './types';
 
   export let nodeId: string;
   export let root = false;
 
+  const builtInFolderInfo: Treetop.BuiltInFolderInfo =
+    getContext('builtInFolderInfo');
   const nodeStoreMap: Treetop.NodeStoreMap = getContext('nodeStoreMap');
   const filterActive = getContext<Writable<boolean>>('filterActive');
   const filterSet = getContext<Treetop.FilterSet>('filterSet');
@@ -51,7 +52,7 @@
   function getFallbackTitle(nodeId: string): string {
     let key;
 
-    if (nodeId === BOOKMARKS_ROOT_GUID) {
+    if (nodeId === builtInFolderInfo.rootNodeId) {
       key = 'bookmarks';
     } else {
       key = 'folderNoTitle';

src/treetop/HistoryManager.ts

@@ -1,7 +1,7 @@
 import { get, writable } from 'svelte/store';
 import browser, { type Bookmarks, type History } from 'webextension-polyfill';
 
-import { BOOKMARK_TREE_NODE_TYPE_BOOKMARK } from './constants';
+import { isBookmark } from './bookmarktreenode-utils';
 import * as Treetop from './types';
 
 /**
@@ -85,7 +85,7 @@ export class HistoryManager {
     _id: string,
     bookmark: Bookmarks.BookmarkTreeNode
   ): Promise<void> {
-    if (bookmark.type !== BOOKMARK_TREE_NODE_TYPE_BOOKMARK) {
+    if (!isBookmark(bookmark)) {
       return;
     }