fix(navigation): prevent duplicate nodes (#2959)

Author: farnabaz

src/runtime/internal/navigation.ts

@@ -88,7 +88,21 @@ export async function generateNavigationTree<T extends PageCollectionItemBase>(q
 
       // First-level item, push it straight to nav
       if (parts.length === 1) {
-        nav.push(navItem)
+        // Check for duplicate link
+        const existed = nav.find(item => item.path === navItem.path && item.page === false)
+        if (isIndex && existed) {
+          Object.assign(existed, {
+            page: undefined,
+            children: [
+              ...navItem.children,
+              ...existed.children,
+            ],
+          })
+        }
+        else {
+          nav.push(navItem)
+        }
+
         return nav
       }
 
@@ -115,7 +129,7 @@ export async function generateNavigationTree<T extends PageCollectionItemBase>(q
             ...navigationConfig,
             title: navigationConfig.title || generateTitle(part),
             path: currentPathPart,
-            stem: idParts.join('/'),
+            stem: idParts.slice(0, i + 1).join('/'),
             children: [],
             page: false,
           }
@@ -125,7 +139,21 @@ export async function generateNavigationTree<T extends PageCollectionItemBase>(q
         return parent!.children!
       }, nav)
 
-      siblings.push(navItem)
+      // Check for duplicate link
+      const existed = siblings.find(item => item.path === navItem.path && item.page === false)
+      if (existed) {
+        Object.assign(existed, {
+          ...navItem,
+          page: undefined,
+          children: [
+            ...navItem.children,
+            ...existed.children,
+          ],
+        })
+      }
+      else {
+        siblings.push(navItem)
+      }
 
       return nav
     }, [] as ContentNavigationItem[])

test/unit/generateNavigationTree.test.ts

@@ -243,4 +243,134 @@ describe('generateNavigationTree', () => {
     expect(tree[0]).toHaveProperty('description', 'Home page')
     expect(tree[0]).toHaveProperty('customField', 'custom value')
   })
+
+  it('index file in directory', async () => {
+    const items = [
+      {
+        title: 'bourg-en-bresse',
+        path: '/devenir-benevole/bourg-en-bresse',
+        stem: 'devenir-benevole/bourg-en-bresse',
+      },
+      {
+        title: 'index',
+        path: '/devenir-benevole',
+        stem: 'devenir-benevole/index',
+      },
+    ] as Array<PageCollectionItemBase & { customField: string }>
+
+    const tree = await generateNavigationTree(mockQueryBuilder(items))
+    expect(tree).toMatchObject([
+      {
+        title: 'Devenir Benevole',
+        path: '/devenir-benevole',
+        stem: 'devenir-benevole',
+        children: [
+          {
+            title: 'bourg-en-bresse',
+            path: '/devenir-benevole/bourg-en-bresse',
+            stem: 'devenir-benevole/bourg-en-bresse',
+          },
+          {
+            title: 'index',
+            path: '/devenir-benevole',
+            stem: 'devenir-benevole/index',
+          },
+        ],
+      },
+    ])
+  })
+
+  it('index file in directory 2', async () => {
+    const items = [
+      {
+        title: 'bourg-en-bresse',
+        path: '/devenir-benevole/france/ain/bourg-en-bresse',
+        stem: 'devenir-benevole/france/ain/bourg-en-bresse',
+      },
+      {
+        title: 'index',
+        path: '/devenir-benevole/france/ain',
+        stem: 'devenir-benevole/france/ain/index',
+      },
+    ] as Array<PageCollectionItemBase & { customField: string }>
+
+    const tree = await generateNavigationTree(mockQueryBuilder(items))
+
+    expect(tree).toMatchObject([
+      {
+        title: 'Devenir Benevole',
+        path: '/devenir-benevole',
+        stem: 'devenir-benevole',
+        children: [
+          {
+            title: 'France',
+            path: '/devenir-benevole/france',
+            stem: 'devenir-benevole/france',
+            children: [
+              {
+                title: 'index',
+                path: '/devenir-benevole/france/ain',
+                stem: 'devenir-benevole/france/ain/index',
+                children: [
+                  {
+                    title: 'bourg-en-bresse',
+                    path: '/devenir-benevole/france/ain/bourg-en-bresse',
+                    stem: 'devenir-benevole/france/ain/bourg-en-bresse',
+                  },
+                  {
+                    title: 'index',
+                    path: '/devenir-benevole/france/ain',
+                    stem: 'devenir-benevole/france/ain/index',
+                  },
+                ],
+              },
+            ],
+            page: false,
+          },
+        ],
+        page: false,
+      },
+    ])
+  })
+
+  it('index file in directory 3', async () => {
+    const items = [
+      {
+        title: 'Title from `.navigation.yml` file',
+        path: '/devenir-benevole/navigation',
+        stem: 'devenir-benevole/.navigation',
+      },
+      {
+        title: 'bourg-en-bresse',
+        path: '/devenir-benevole/bourg-en-bresse',
+        stem: 'devenir-benevole/bourg-en-bresse',
+      },
+      {
+        title: 'index',
+        path: '/devenir-benevole',
+        stem: 'devenir-benevole/index',
+      },
+    ] as Array<PageCollectionItemBase & { customField: string }>
+
+    const tree = await generateNavigationTree(mockQueryBuilder(items))
+    expect(tree).toMatchObject([
+      {
+        title: 'Title from `.navigation.yml` file',
+        path: '/devenir-benevole',
+        stem: 'devenir-benevole',
+        children: [
+          {
+            title: 'bourg-en-bresse',
+            path: '/devenir-benevole/bourg-en-bresse',
+            stem: 'devenir-benevole/bourg-en-bresse',
+          },
+          {
+            title: 'index',
+            path: '/devenir-benevole',
+            stem: 'devenir-benevole/index',
+          },
+        ],
+      },
+    ])
+  })
 })