fix: batch and sort paths for safer unsets closes #4115

logaretm · May 9, 2023 · fe322a0 · fe322a0
1 parent 9b50cad
commit fe322a0
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 3 deletions.
diff --git a/.changeset/lucky-pears-kick.md b/.changeset/lucky-pears-kick.md
@@ -0,0 +1,5 @@
+---
+'vee-validate': patch
+---
+
+batch unsets and sort paths unset order for safer unsets closes #4115
diff --git a/packages/vee-validate/src/useField.ts b/packages/vee-validate/src/useField.ts
@@ -10,6 +10,7 @@ import {
   ComponentInternalInstance,
   onBeforeUnmount,
   warn,
+  nextTick,
 } from 'vue';
 import { klona as deepCopy } from 'klona/full';
 import { validate as validateValue } from './validate';
@@ -434,7 +435,7 @@ function _useField<TValue = unknown>(
         pathState.id.splice(pathState.id.indexOf(field.id), 1);
       }
     } else {
-      form.unsetPathValue(path);
+      form.unsetPathValue(unravel(name));
     }
 
     form.removePathState(path, id);

diff --git a/packages/vee-validate/src/useForm.ts b/packages/vee-validate/src/useForm.ts
@@ -381,8 +381,23 @@ export function useForm<
     return pathState as PathState<PathValue<TValues, TPath>> | undefined;
   }
 
+  let UNSET_BATCH: Path<TValues>[] = [];
+  let PENDING_UNSET: Promise<void> | null;
   function unsetPathValue<TPath extends Path<TValues>>(path: TPath) {
-    unsetPath(formValues, path);
+    UNSET_BATCH.push(path);
+    if (!PENDING_UNSET) {
+      PENDING_UNSET = nextTick(() => {
+        const sortedPaths = [...UNSET_BATCH].sort().reverse();
+        sortedPaths.forEach(p => {
+          unsetPath(formValues, p);
+        });
+
+        UNSET_BATCH = [];
+        PENDING_UNSET = null;
+      });
+    }
+
+    return PENDING_UNSET;
   }
 
   function makeSubmissionFactory(onlyControlled: boolean) {

diff --git a/packages/vee-validate/tests/FieldArray.spec.ts b/packages/vee-validate/tests/FieldArray.spec.ts
@@ -1,4 +1,4 @@
-import { defineRule, useField } from '@/vee-validate';
+import { Form, defineRule, useField } from '@/vee-validate';
 import { toRef, ref, defineComponent } from 'vue';
 import * as yup from 'yup';
 import { mountWithHoc, setValue, getValue, dispatchEvent, flushPromises } from './helpers';
@@ -980,3 +980,44 @@ test('adding or removing fields should update form dirty correctly', async () =>
   await flushPromises();
   expect(dirty.textContent).toBe('false');
 });
+
+// #4115
+test('removing fields with `v-if` should clean up their state properly', async () => {
+  const showFields = ref(true);
+  const formRef = ref<InstanceType<typeof Form>>();
+  const initialValues = {
+    users: [
+      { name: 'test 1', amount: 123 },
+      { name: 'test 2', amount: 567 },
+    ],
+  };
+  mountWithHoc({
+    setup() {
+      return {
+        initialValues,
+        formRef,
+        showFields,
+      };
+    },
+    template: `
+      <VForm ref="formRef" :initial-values="initialValues">
+        <FieldArray name="users" v-slot="{ fields }">
+          <fieldset v-for="(field, idx) in fields" :key="field.key">
+            <legend>User #{{ idx }}</legend>
+            <template v-if="showFields">
+              <Field :name="'users[' + idx + '].name'" />
+              <Field :name="'users[' + idx + '].amount'" />
+            </template>
+          </fieldset>
+        </FieldArray>
+
+      </VForm>
+    `,
+  });
+
+  await flushPromises();
+  expect(formRef.value?.getValues()).toEqual(initialValues);
+  showFields.value = false;
+  await flushPromises();
+  expect(formRef.value?.getValues()).toEqual({});
+});