fix(nested): Prevent infinite loops when resolving path (#20390)

closes #20389

Co-authored-by: jsek <[email protected]>
Co-authored-by: Kael <[email protected]>

packages/vuetify/src/components/VList/VList.tsx

@@ -162,7 +162,7 @@ export const VList = genericComponent<new <
     const { dimensionStyles } = useDimension(props)
     const { elevationClasses } = useElevation(props)
     const { roundedClasses } = useRounded(props)
-    const { children, open, parents, select } = useNested(props)
+    const { children, open, parents, select, getPath } = useNested(props)
     const lineClasses = computed(() => props.lines ? `v-list--${props.lines}-line` : undefined)
     const activeColor = toRef(props, 'activeColor')
     const baseColor = toRef(props, 'baseColor')
@@ -288,6 +288,7 @@ export const VList = genericComponent<new <
       focus,
       children,
       parents,
+      getPath,
     }
   },
 })

packages/vuetify/src/components/VList/VListItem.tsx

@@ -127,6 +127,7 @@ export const VListItem = genericComponent<VListItemSlots>()({
       root,
       parent,
       openOnSelect,
+      id: uid,
     } = useNestedItem(id, false)
     const list = useList()
     const isActive = computed(() =>
@@ -368,6 +369,8 @@ export const VListItem = genericComponent<VListItemSlots>()({
       isSelected,
       list,
       select,
+      root,
+      id: uid,
     }
   },
 })

packages/vuetify/src/composables/nested/nested.ts

@@ -17,7 +17,7 @@ import {
   leafSelectStrategy,
   leafSingleSelectStrategy,
 } from './selectStrategies'
-import { getCurrentInstance, getUid, propsFactory } from '@/util'
+import { consoleError, getCurrentInstance, getUid, propsFactory } from '@/util'
 
 // Types
 import type { InjectionKey, PropType, Ref } from 'vue'
@@ -76,6 +76,7 @@ type NestedProvide = {
     activate: (id: unknown, value: boolean, event?: Event) => void
     select: (id: unknown, value: boolean, event?: Event) => void
     openOnSelect: (id: unknown, value: boolean, event?: Event) => void
+    getPath: (id: unknown) => unknown[]
   }
 }
 
@@ -98,6 +99,7 @@ export const emptyNested: NestedProvide = {
     activated: ref(new Set()),
     selected: ref(new Map()),
     selectedValues: ref([]),
+    getPath: () => [],
   },
 }
 
@@ -191,6 +193,8 @@ export const useNested = (props: NestedProps) => {
 
   const vm = getCurrentInstance('nested')
 
+  const nodeIds = new Set<unknown>()
+
   const nested: NestedProvide = {
     id: shallowRef(),
     root: {
@@ -209,6 +213,15 @@ export const useNested = (props: NestedProps) => {
         return arr
       }),
       register: (id, parentId, isGroup) => {
+        if (nodeIds.has(id)) {
+          const path = getPath(id).join(' -> ')
+          const newPath = getPath(parentId).concat(id).join(' -> ')
+          consoleError(`Multiple nodes with the same ID\n\t${path}\n\t${newPath}`)
+          return
+        } else {
+          nodeIds.add(id)
+        }
+
         parentId && id !== parentId && parents.value.set(id, parentId)
 
         isGroup && children.value.set(id, [])
@@ -220,6 +233,7 @@ export const useNested = (props: NestedProps) => {
       unregister: id => {
         if (isUnmounted) return
 
+        nodeIds.delete(id)
         children.value.delete(id)
         const parent = parents.value.get(id)
         if (parent) {
@@ -289,6 +303,7 @@ export const useNested = (props: NestedProps) => {
       },
       children,
       parents,
+      getPath,
     },
   }
 

packages/vuetify/src/labs/VTreeview/VTreeview.tsx

@@ -86,24 +86,14 @@ export const VTreeview = genericComponent<new <T>(
     const search = toRef(props, 'search')
     const { filteredItems } = useFilter(props, flatItems, search)
     const visibleIds = computed(() => {
-      if (!search.value) {
-        return null
-      }
+      if (!search.value) return null
+      const getPath = vListRef.value?.getPath
+      if (!getPath) return null
       return new Set(filteredItems.value.flatMap(item => {
         return [...getPath(item.props.value), ...getChildren(item.props.value)]
       }))
     })
 
-    function getPath (id: unknown) {
-      const path: unknown[] = []
-      let parent: unknown = id
-      while (parent != null) {
-        path.unshift(parent)
-        parent = vListRef.value?.parents.get(parent)
-      }
-      return path
-    }
-
     function getChildren (id: unknown) {
       const arr: unknown[] = []
       const queue = ((vListRef.value?.children.get(id) ?? []).slice())

packages/vuetify/src/labs/VTreeview/VTreeviewItem.tsx

@@ -9,7 +9,6 @@ import { VProgressCircular } from '@/components/VProgressCircular'
 
 // Composables
 import { IconValue } from '@/composables/icons'
-import { useNestedItem } from '@/composables/nested/nested'
 import { useLink } from '@/composables/router'
 
 // Utilities
@@ -35,20 +34,11 @@ export const VTreeviewItem = genericComponent<VListItemSlots>()({
 
   setup (props, { attrs, slots, emit }) {
     const link = useLink(props, attrs)
-    const rawId = computed(() => props.value === undefined ? link.href.value : props.value)
     const vListItemRef = ref<VListItem>()
 
-    const {
-      activate,
-      isActivated,
-      isGroupActivator,
-      root,
-      id,
-    } = useNestedItem(rawId, false)
-
     const isActivatableGroupActivator = computed(() =>
-      (root.activatable.value) &&
-      isGroupActivator
+      (vListItemRef.value?.root.activatable.value) &&
+      vListItemRef.value?.isGroupActivator
     )
 
     const isClickable = computed(() =>
@@ -60,15 +50,11 @@ export const VTreeviewItem = genericComponent<VListItemSlots>()({
     function activateItem (e: MouseEvent | KeyboardEvent) {
       if (
         !isClickable.value ||
-        (!isActivatableGroupActivator.value && isGroupActivator)
+        (!isActivatableGroupActivator.value && vListItemRef.value?.isGroupActivator)
       ) return
 
-      if (root.activatable.value) {
-        if (isActivatableGroupActivator.value) {
-          activate(!isActivated.value, e)
-        } else {
-          vListItemRef.value?.activate(!vListItemRef.value?.isActivated, e)
-        }
+      if (vListItemRef.value?.root.activatable.value) {
+        vListItemRef.value?.activate(!vListItemRef.value?.isActivated, e)
       }
     }
 
@@ -80,13 +66,14 @@ export const VTreeviewItem = genericComponent<VListItemSlots>()({
 
       return (
         <VListItem
+          ref={ vListItemRef }
           { ...listItemProps }
-          active={ isActivated.value }
+          active={ vListItemRef.value?.isActivated }
           class={[
             'v-treeview-item',
             {
               'v-treeview-item--activatable-group-activator': isActivatableGroupActivator.value,
-              'v-treeview-item--filtered': visibleIds.value && !visibleIds.value.has(id.value),
+              'v-treeview-item--filtered': visibleIds.value && !visibleIds.value.has(vListItemRef.value?.id),
             },
             props.class,
           ]}