avoid over-visiting sidebar nodes in NavigationContextProvider

fern-api · Apr 2, 2024 · 875001e · 875001e
1 parent f12c1e7
commit 875001e
Show file tree

Hide file tree

Showing 3 changed files with 112 additions and 46 deletions.
diff --git a/packages/commons/fdr-utils/src/visitSidebarNode.ts b/packages/commons/fdr-utils/src/visitSidebarNode.ts
@@ -1,34 +1,59 @@
-import { noop, visitDiscriminatedUnion } from "@fern-ui/core-utils";
+import { visitDiscriminatedUnion } from "@fern-ui/core-utils";
 import { SidebarNode } from "./types";
 
 export function visitSidebarNode(
     node: SidebarNode | SidebarNode.Page,
-    visit: (node: SidebarNode | SidebarNode.Page, parents: SidebarNode[]) => void,
+    visit: (node: SidebarNode | SidebarNode.Page, parents: SidebarNode[]) => void | boolean | "skip",
     parentNodes: SidebarNode[] = [],
-): void {
-    visit(node, parentNodes);
-    visitDiscriminatedUnion(node, "type")._visit({
+): boolean {
+    const flag = visit(node, parentNodes);
+    if (flag === true || flag == null) {
+        // continue visiting
+    } else if (flag === "skip") {
+        // skip visiting children of this node
+        return true;
+    } else if (flag === false) {
+        // exit
+        return false;
+    }
+
+    return visitDiscriminatedUnion(node, "type")._visit<boolean>({
         pageGroup: (pageGroup) => {
-            pageGroup.pages.forEach((page) => {
+            for (const page of pageGroup.pages) {
                 if (page.type !== "link") {
-                    visitSidebarNode(page, visit, parentNodes);
+                    const flag = visitSidebarNode(page, visit, parentNodes);
+                    if (flag === false) {
+                        return false;
+                    }
                 }
-            });
+            }
+            return true;
         },
         apiSection: (apiSection) => {
-            apiSection.items.forEach((item) => {
-                visitSidebarNode(item, visit, [...parentNodes, apiSection]);
-            });
+            for (const item of apiSection.items) {
+                const flag = visitSidebarNode(item, visit, [...parentNodes, apiSection]);
+                if (flag === false) {
+                    return false;
+                }
+            }
             if (apiSection.changelog) {
-                visitSidebarNode(apiSection.changelog, visit, [...parentNodes, apiSection]);
+                const flag = visitSidebarNode(apiSection.changelog, visit, [...parentNodes, apiSection]);
+                if (flag === false) {
+                    return false;
+                }
             }
+            return true;
         },
         section: (section) => {
-            section.items.forEach((item) => {
-                visitSidebarNode(item, visit, [...parentNodes, section]);
-            });
+            for (const item of section.items) {
+                const flag = visitSidebarNode(item, visit, [...parentNodes, section]);
+                if (flag === false) {
+                    return false;
+                }
+            }
+            return true;
         },
-        page: noop,
-        _other: noop,
+        page: () => true,
+        _other: () => true,
     });
 }
diff --git a/packages/commons/fdr-utils/src/visitSidebarNodeRaw.ts b/packages/commons/fdr-utils/src/visitSidebarNodeRaw.ts
@@ -1,50 +1,86 @@
-import { noop, visitDiscriminatedUnion } from "@fern-ui/core-utils";
+import { visitDiscriminatedUnion } from "@fern-ui/core-utils";
 import { SidebarNodeRaw } from "./types";
 
 export function visitSidebarNodeRaw(
     node: SidebarNodeRaw.VisitableNode,
-    visit: (node: SidebarNodeRaw.VisitableNode, parents: SidebarNodeRaw.ParentNode[]) => void,
+    visit: (node: SidebarNodeRaw.VisitableNode, parents: SidebarNodeRaw.ParentNode[]) => void | boolean | "skip",
     parentNodes: SidebarNodeRaw.ParentNode[] = [],
-): void {
-    visit(node, parentNodes);
-    visitDiscriminatedUnion(node, "type")._visit({
+): boolean {
+    const flag = visit(node, parentNodes);
+    if (flag === true || flag == null) {
+        // continue visiting
+    } else if (flag === "skip") {
+        // skip visiting children of this node
+        return true;
+    } else if (flag === false) {
+        // exit
+        return false;
+    }
+
+    return visitDiscriminatedUnion(node, "type")._visit<boolean>({
         pageGroup: (pageGroup) => {
-            pageGroup.pages.forEach((page) => {
+            for (const page of pageGroup.pages) {
                 if (page.type !== "link") {
-                    // pageGroup is a psuedo-node that should not be considered as a parent
-                    visitSidebarNodeRaw(page, visit, parentNodes);
+                    const flag = visitSidebarNodeRaw(page, visit, parentNodes);
+                    if (flag === false) {
+                        return false;
+                    }
                 }
-            });
+            }
+            return true;
         },
         apiSection: (apiSection) => {
-            apiSection.items.forEach((item) => {
-                visitSidebarNodeRaw(item, visit, [...parentNodes, apiSection]);
-            });
+            for (const item of apiSection.items) {
+                const flag = visitSidebarNodeRaw(item, visit, [...parentNodes, apiSection]);
+                if (flag === false) {
+                    return false;
+                }
+            }
             if (apiSection.changelog) {
-                visitSidebarNodeRaw(apiSection.changelog, visit, [...parentNodes, apiSection]);
+                const flag = visitSidebarNodeRaw(apiSection.changelog, visit, [...parentNodes, apiSection]);
+                if (flag === false) {
+                    return false;
+                }
             }
+            return true;
         },
         section: (section) => {
-            section.items.forEach((item) => {
-                visitSidebarNodeRaw(item, visit, [...parentNodes, section]);
-            });
+            for (const item of section.items) {
+                const flag = visitSidebarNodeRaw(item, visit, [...parentNodes, section]);
+                if (flag === false) {
+                    return false;
+                }
+            }
+            return true;
         },
         versionGroup: (versionGroup) => {
-            versionGroup.items.forEach((item) => {
-                visitSidebarNodeRaw(item, visit, [...parentNodes, versionGroup]);
-            });
+            for (const item of versionGroup.items) {
+                const flag = visitSidebarNodeRaw(item, visit, [...parentNodes, versionGroup]);
+                if (flag === false) {
+                    return false;
+                }
+            }
+            return true;
         },
         tabGroup: (tabGroup) => {
-            tabGroup.items.forEach((item) => {
-                visitSidebarNodeRaw(item, visit, [...parentNodes, tabGroup]);
-            });
+            for (const item of tabGroup.items) {
+                const flag = visitSidebarNodeRaw(item, visit, [...parentNodes, tabGroup]);
+                if (flag === false) {
+                    return false;
+                }
+            }
+            return true;
         },
-        page: noop,
+        page: () => true,
         root: (root) => {
-            root.items.forEach((item) => {
-                visitSidebarNodeRaw(item, visit, [root, ...parentNodes]);
-            });
+            for (const item of root.items) {
+                const flag = visitSidebarNodeRaw(item, visit, [root, ...parentNodes]);
+                if (flag === false) {
+                    return false;
+                }
+            }
+            return true;
         },
-        _other: noop,
+        _other: () => true,
     });
 }
diff --git a/packages/ui/app/src/contexts/navigation-context/NavigationContextProvider.tsx b/packages/ui/app/src/contexts/navigation-context/NavigationContextProvider.tsx
@@ -303,13 +303,18 @@ const resolveActiveSidebarNode = memoize(
     (sidebarNodes: SidebarNode[], fullSlug: string[]): SidebarNode.Page | undefined => {
         const hits: SidebarNode.Page[] = [];
 
-        sidebarNodes.forEach((node) => {
+        for (const node of sidebarNodes) {
             visitSidebarNode(node, (n) => {
                 if (n.type === "page" && n.slug.join("/") === fullSlug.join("/")) {
                     hits.push(n);
+                    return false;
                 }
+                return true;
             });
-        });
+            if (hits.length > 0) {
+                break;
+            }
+        }
 
         return hits[0];
     },