fix: select deep watch options, close #5398

tangjinzhou · tangjinzhou · commit 3613eceff80c · 2022-03-25T16:40:06.000+08:00
diff --git a/components/vc-select/Select.tsx b/components/vc-select/Select.tsx
@@ -42,7 +42,7 @@ import { toArray } from './utils/commonUtil';
 import useFilterOptions from './hooks/useFilterOptions';
 import useCache from './hooks/useCache';
 import type { Key, VueNode } from '../_util/type';
-import { computed, defineComponent, ref, toRef, watchEffect } from 'vue';
+import { computed, defineComponent, ref, shallowRef, toRef, watchEffect } from 'vue';
 import type { ExtractPropTypes, PropType } from 'vue';
 import PropTypes from '../_util/vue-types';
 import { initDefaultProps } from '../_util/props-util';
@@ -314,13 +314,15 @@ export default defineComponent({
     };
 
     // Fill tag as option if mode is `tags`
-    const filledTagOptions = computed(() => {
+    const filledTagOptions = shallowRef();
+    watchEffect(() => {
       if (props.mode !== 'tags') {
-        return mergedOptions.value;
+        filledTagOptions.value = mergedOptions.value;
+        return;
       }
 
       // >>> Tag mode
-      const cloneOptions = [...mergedOptions.value];
+      const cloneOptions = mergedOptions.value.slice();
 
       // Check if value exist in options (include new patch item)
       const existOptions = (val: RawValueType) => valueOptions.value.has(val);
@@ -336,7 +338,7 @@ export default defineComponent({
           }
         });
 
-      return cloneOptions;
+      filledTagOptions.value = cloneOptions;
     });
 
     const filteredOptions = useFilterOptions(
diff --git a/components/vc-select/hooks/useFilterOptions.ts b/components/vc-select/hooks/useFilterOptions.ts
@@ -7,15 +7,15 @@ import type {
   BaseOptionType,
 } from '../Select';
 import { injectPropsWithOption } from '../utils/valueUtil';
-import type { Ref } from 'vue';
-import { toRaw, computed } from 'vue';
+import type { Ref, ShallowRef } from 'vue';
+import { computed } from 'vue';
 
 function includes(test: any, search: string) {
   return toArray(test).join('').toUpperCase().includes(search);
 }
 
 export default (
-  options: Ref<DefaultOptionType[]>,
+  options: ShallowRef<DefaultOptionType[]>,
   fieldNames: Ref<FieldNames>,
   searchValue?: Ref<string>,
   filterOption?: Ref<SelectProps['filterOption']>,
@@ -55,7 +55,7 @@ export default (
       ? opt => injectPropsWithOption(opt)
       : opt => opt;
 
-    toRaw(options.value).forEach(item => {
+    options.value.forEach(item => {
       // Group should check child options
       if (item[fieldOptions]) {
         // Check group first
diff --git a/components/vc-select/hooks/useOptions.ts b/components/vc-select/hooks/useOptions.ts
@@ -1,5 +1,5 @@
 import type { Ref } from 'vue';
-import { toRaw, shallowRef, watchEffect } from 'vue';
+import { toRaw, shallowRef, watchEffect, watch } from 'vue';
 import type { FieldNames, RawValueType } from '../Select';
 import { convertChildrenToData } from '../utils/legacyUtil';
 
@@ -15,13 +15,20 @@ export default function useOptions<OptionType>(
   const mergedOptions = shallowRef();
   const valueOptions = shallowRef();
   const labelOptions = shallowRef();
+  const tempMergedOptions = shallowRef([]);
+  watch(
+    [options, children],
+    () => {
+      if (options.value) {
+        tempMergedOptions.value = toRaw(options.value).slice();
+      } else {
+        tempMergedOptions.value = convertChildrenToData(children.value);
+      }
+    },
+    { immediate: true, deep: true },
+  );
   watchEffect(() => {
-    let newOptions = toRaw(options.value);
-    const childrenAsData = !options.value;
-
-    if (childrenAsData) {
-      newOptions = convertChildrenToData(children.value);
-    }
+    const newOptions = tempMergedOptions.value;
 
     const newValueOptions = new Map<RawValueType, OptionType>();
     const newLabelOptions = new Map<any, OptionType>();
diff --git a/components/vc-tree-select/OptionList.tsx b/components/vc-tree-select/OptionList.tsx
@@ -98,7 +98,7 @@ export default defineComponent({
     );
     const mergedExpandedKeys = computed(() => {
       if (legacyContext.treeExpandedKeys) {
-        return toRaw(legacyContext.treeExpandedKeys).slice();
+        return legacyContext.treeExpandedKeys.slice();
       }
       return baseProps.searchValue ? searchExpandedKeys.value : expandedKeys.value;
     });
diff --git a/components/vc-tree-select/hooks/useCache.ts b/components/vc-tree-select/hooks/useCache.ts
@@ -1,5 +1,5 @@
 import type { Ref } from 'vue';
-import { toRaw, computed, shallowRef } from 'vue';
+import { watch, toRaw, computed, shallowRef } from 'vue';
 import type { LabeledValueType, RawValueType } from '../TreeSelect';
 
 /**
@@ -10,12 +10,19 @@ export default (values: Ref<LabeledValueType[]>): [Ref<LabeledValueType[]>] => {
   const cacheRef = shallowRef({
     valueLabels: new Map<RawValueType, any>(),
   });
-
+  const mergedValues = shallowRef();
+  watch(
+    values,
+    () => {
+      mergedValues.value = toRaw(values.value);
+    },
+    { immediate: true },
+  );
   const newFilledValues = computed(() => {
     const { valueLabels } = cacheRef.value;
     const valueLabelsCache = new Map<RawValueType, any>();
 
-    const filledValues = toRaw(values.value).map(item => {
+    const filledValues = mergedValues.value.map(item => {
       const { value } = item;
       const mergedLabel = item.label ?? valueLabels.get(value);
 
diff --git a/components/vc-tree-select/hooks/useCheckedKeys.ts b/components/vc-tree-select/hooks/useCheckedKeys.ts
@@ -3,11 +3,11 @@ import type { DataEntity } from '../../vc-tree/interface';
 import { conductCheck } from '../../vc-tree/utils/conductUtil';
 import type { LabeledValueType, RawValueType } from '../TreeSelect';
 import type { Ref, ShallowRef } from 'vue';
-import { toRaw, shallowRef, watchEffect } from 'vue';
+import { shallowRef, watchEffect } from 'vue';
 
 export default (
-  rawLabeledValues: Ref<LabeledValueType[]>,
-  rawHalfCheckedValues: Ref<LabeledValueType[]>,
+  rawLabeledValues: ShallowRef<LabeledValueType[]>,
+  rawHalfCheckedValues: ShallowRef<LabeledValueType[]>,
   treeConduction: Ref<boolean>,
   keyEntities: Ref<Record<Key, DataEntity>>,
   maxLevel: Ref<number>,
@@ -17,10 +17,8 @@ export default (
   const newRawHalfCheckedValues = shallowRef<RawValueType[]>([]);
 
   watchEffect(() => {
-    let checkedKeys: RawValueType[] = toRaw(rawLabeledValues.value).map(({ value }) => value);
-    let halfCheckedKeys: RawValueType[] = toRaw(rawHalfCheckedValues.value).map(
-      ({ value }) => value,
-    );
+    let checkedKeys: RawValueType[] = rawLabeledValues.value.map(({ value }) => value);
+    let halfCheckedKeys: RawValueType[] = rawHalfCheckedValues.value.map(({ value }) => value);
 
     const missingValues = checkedKeys.filter(key => !keyEntities.value[key]);
 
diff --git a/components/vc-tree-select/hooks/useDataEntities.ts b/components/vc-tree-select/hooks/useDataEntities.ts
@@ -3,16 +3,16 @@ import type { DataEntity } from '../../vc-tree/interface';
 import type { FieldNames, RawValueType } from '../TreeSelect';
 
 import { isNil } from '../utils/valueUtil';
-import type { Ref } from 'vue';
-import { toRaw, ref, watchEffect } from 'vue';
+import type { Ref, ShallowRef } from 'vue';
+import { shallowRef, watchEffect } from 'vue';
 import { warning } from '../../vc-util/warning';
 
-export default (treeData: Ref<any>, fieldNames: Ref<FieldNames>) => {
-  const valueEntities = ref<Map<RawValueType, DataEntity>>(new Map());
-  const keyEntities = ref<Record<string, DataEntity>>({});
+export default (treeData: ShallowRef<any>, fieldNames: Ref<FieldNames>) => {
+  const valueEntities = shallowRef<Map<RawValueType, DataEntity>>(new Map());
+  const keyEntities = shallowRef<Record<string, DataEntity>>({});
   watchEffect(() => {
     const fieldNamesValue = fieldNames.value;
-    const collection = convertDataToEntities(toRaw(treeData.value), {
+    const collection = convertDataToEntities(treeData.value, {
       fieldNames: fieldNamesValue,
       initWrapper: wrapper => ({
         ...wrapper,
diff --git a/components/vc-tree-select/hooks/useFilterTreeData.ts b/components/vc-tree-select/hooks/useFilterTreeData.ts
@@ -1,13 +1,13 @@
-import type { Ref } from 'vue';
-import { toRaw, computed } from 'vue';
+import type { Ref, ShallowRef } from 'vue';
+import { computed } from 'vue';
 import type { DefaultOptionType, InternalFieldName, TreeSelectProps } from '../TreeSelect';
 import { fillLegacyProps } from '../utils/legacyUtil';
 
 type GetFuncType<T> = T extends boolean ? never : T;
 type FilterFn = GetFuncType<TreeSelectProps['filterTreeNode']>;
 
 export default (
-  treeData: Ref<DefaultOptionType[]>,
+  treeData: ShallowRef<DefaultOptionType[]>,
   searchValue: Ref<string>,
   {
     treeNodeFilterProp,
@@ -56,24 +56,8 @@ export default (
         }
       }
       return res;
-      // return list
-      //   .map(dataNode => {
-      //     const children = dataNode[fieldChildren];
-
-      //     const match = keepAll || filterOptionFunc(searchValueVal, fillLegacyProps(dataNode));
-      //     const childList = dig(children || [], match);
-
-      //     if (match || childList.length) {
-      //       return {
-      //         ...dataNode,
-      //         [fieldChildren]: childList,
-      //       };
-      //     }
-      //     return null;
-      //   })
-      //   .filter(node => node);
     }
 
-    return dig(toRaw(treeData.value));
+    return dig(treeData.value);
   });
 };
diff --git a/components/vc-tree-select/hooks/useTreeData.ts b/components/vc-tree-select/hooks/useTreeData.ts
@@ -1,5 +1,5 @@
-import type { Ref } from 'vue';
-import { toRaw, computed } from 'vue';
+import type { Ref, ShallowRef } from 'vue';
+import { shallowRef, watch, toRaw } from 'vue';
 import type { DataNode, SimpleModeConfig } from '../interface';
 import { convertChildrenToData } from '../utils/legacyUtil';
 import type { DefaultOptionType } from '../TreeSelect';
@@ -49,20 +49,26 @@ export default function useTreeData(
   treeData: Ref<DataNode[]>,
   children: Ref<VueNode[]>,
   simpleMode: Ref<boolean | SimpleModeConfig>,
-): Ref<DefaultOptionType[]> {
-  return computed(() => {
-    const simpleModeValue = simpleMode.value;
-    if (treeData.value) {
-      return simpleMode.value
-        ? parseSimpleTreeData(toRaw(treeData.value), {
-            id: 'id',
-            pId: 'pId',
-            rootPId: null,
-            ...(simpleModeValue !== true ? simpleModeValue : {}),
-          })
-        : treeData.value;
-    }
-
-    return convertChildrenToData(toRaw(children.value));
-  });
+): ShallowRef<DefaultOptionType[]> {
+  const mergedTreeData = shallowRef<DefaultOptionType[]>();
+  watch(
+    [simpleMode, treeData, children],
+    () => {
+      const simpleModeValue = simpleMode.value;
+      if (treeData.value) {
+        mergedTreeData.value = simpleMode.value
+          ? parseSimpleTreeData(toRaw(treeData.value), {
+              id: 'id',
+              pId: 'pId',
+              rootPId: null,
+              ...(simpleModeValue !== true ? simpleModeValue : {}),
+            })
+          : toRaw(treeData.value);
+      } else {
+        mergedTreeData.value = convertChildrenToData(toRaw(children.value));
+      }
+    },
+    { immediate: true, deep: true },
+  );
+  return mergedTreeData;
 }
diff --git a/components/vc-tree/Tree.tsx b/components/vc-tree/Tree.tsx
@@ -104,12 +104,16 @@ export default defineComponent({
       dragOverNodeKey: null,
     });
     const treeData = shallowRef([]);
-    watchEffect(() => {
-      treeData.value =
-        props.treeData !== undefined
-          ? toRaw(props.treeData)
-          : convertTreeToData(toRaw(props.children));
-    });
+    watch(
+      [() => props.treeData, () => props.children],
+      () => {
+        treeData.value =
+          props.treeData !== undefined
+            ? toRaw(props.treeData)
+            : convertTreeToData(toRaw(props.children));
+      },
+      { immediate: true, deep: true },
+    );
     const keyEntities = shallowRef({});
 
     const focused = ref(false);
@@ -143,7 +147,7 @@ export default defineComponent({
 
     watchEffect(() => {
       if (treeData.value) {
-        const entitiesMap = convertDataToEntities(toRaw(treeData.value), {
+        const entitiesMap = convertDataToEntities(treeData.value, {
           fieldNames: fieldNames.value,
         });
         keyEntities.value = {
@@ -190,19 +194,15 @@ export default defineComponent({
     // ================ flattenNodes =================
     const flattenNodes = shallowRef([]);
     watchEffect(() => {
-      flattenNodes.value = flattenTreeData(
-        toRaw(treeData.value),
-        toRaw(expandedKeys.value),
-        fieldNames.value,
-      );
+      flattenNodes.value = flattenTreeData(treeData.value, expandedKeys.value, fieldNames.value);
     });
     // ================ selectedKeys =================
     watchEffect(() => {
       if (props.selectable) {
         if (props.selectedKeys !== undefined) {
-          selectedKeys.value = calcSelectedKeys(toRaw(props.selectedKeys), props);
+          selectedKeys.value = calcSelectedKeys(props.selectedKeys, props);
         } else if (!init && props.defaultSelectedKeys) {
-          selectedKeys.value = calcSelectedKeys(toRaw(props.defaultSelectedKeys), props);
+          selectedKeys.value = calcSelectedKeys(props.defaultSelectedKeys, props);
         }
       }
     });
@@ -213,12 +213,12 @@ export default defineComponent({
         let checkedKeyEntity;
 
         if (props.checkedKeys !== undefined) {
-          checkedKeyEntity = parseCheckedKeys(toRaw(props.checkedKeys)) || {};
+          checkedKeyEntity = parseCheckedKeys(props.checkedKeys) || {};
         } else if (!init && props.defaultCheckedKeys) {
-          checkedKeyEntity = parseCheckedKeys(toRaw(props.defaultCheckedKeys)) || {};
+          checkedKeyEntity = parseCheckedKeys(props.defaultCheckedKeys) || {};
         } else if (treeData.value) {
           // If `treeData` changed, we also need check it
-          checkedKeyEntity = parseCheckedKeys(toRaw(props.checkedKeys)) || {
+          checkedKeyEntity = parseCheckedKeys(props.checkedKeys) || {
             checkedKeys: checkedKeys.value,
             halfCheckedKeys: halfCheckedKeys.value,
           };

Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ export default defineComponent({`
`98`	`98`	`);`
`99`	`99`	`const mergedExpandedKeys = computed(() => {`
`100`	`100`	`if (legacyContext.treeExpandedKeys) {`
`101`		`- return toRaw(legacyContext.treeExpandedKeys).slice();`
	`101`	`+ return legacyContext.treeExpandedKeys.slice();`
`102`	`102`	`}`
`103`	`103`	`return baseProps.searchValue ? searchExpandedKeys.value : expandedKeys.value;`
`104`	`104`	`});`