fix: make sure removePathState removes proper pathState (#4649)

closes #4643 Co-authored-by: Bartosz Gościński <bartosz.goscinski@gmail.com>
logaretm · Jan 29, 2024 · d779980 · d779980
1 parent 998ca37
commit d779980
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 3 deletions.
diff --git a/.changeset/clean-seas-speak.md b/.changeset/clean-seas-speak.md
@@ -0,0 +1,5 @@
+---
+"vee-validate": patch
+---
+
+fix: make sure removePathState removes the correct path state
diff --git a/packages/vee-validate/src/useForm.ts b/packages/vee-validate/src/useForm.ts
@@ -559,7 +559,9 @@ export function useForm<
   handleSubmit.withControlled = makeSubmissionFactory(true);
 
   function removePathState<TPath extends Path<TValues>>(path: TPath, id: number) {
-    const idx = pathStates.value.findIndex(s => s.path === path);
+    const idx = pathStates.value.findIndex(s => {
+      return s.path === path && (Array.isArray(s.id) ? s.id.includes(id) : s.id === id);
+    });
     const pathState = pathStates.value[idx];
     if (idx === -1 || !pathState) {
       return;

diff --git a/packages/vee-validate/tests/Form.spec.ts b/packages/vee-validate/tests/Form.spec.ts
@@ -1,8 +1,8 @@
-import { defineRule, useField, Form, Field, useIsValidating } from '@/vee-validate';
+import { defineRule, useField, Form, Field, useIsValidating, useForm } from '@/vee-validate';
 import { mountWithHoc, setValue, setChecked, dispatchEvent, flushPromises } from './helpers';
 import * as yup from 'yup';
 import { computed, defineComponent, onErrorCaptured, ref, Ref } from 'vue';
-import { InvalidSubmissionContext } from '../src/types';
+import { InvalidSubmissionContext, PrivateFormContext } from '../src/types';
 
 describe('<Form />', () => {
   const REQUIRED_MESSAGE = `This field is required`;
@@ -3141,3 +3141,40 @@ test('radio fields with single field component binding', async () => {
   expect(model.value).toBe('Tea');
   expect(submit).toHaveBeenLastCalledWith({ drink: 'Tea' }, expect.anything());
 });
+
+// #4643
+test('removes proper pathState when field is unmounting', async () => {
+  const renderTemplateField = ref(false);
+  let form!: PrivateFormContext;
+
+  mountWithHoc({
+    template: `
+      <form>
+        <Field v-if="renderTemplateField" name="foo" rules="required" />
+      </form>
+    `,
+    setup() {
+      form = useForm() as unknown as PrivateFormContext;
+      useField('foo');
+      return { renderTemplateField };
+    },
+  });
+
+  expect(form.meta.value.valid).toBe(true);
+  expect(form.getAllPathStates()).toMatchObject([{ id: 0, path: 'foo' }]);
+
+  renderTemplateField.value = true;
+  await flushPromises();
+
+  expect(form.meta.value.valid).toBe(false);
+  expect(form.getAllPathStates()).toMatchObject([
+    { id: 0, path: 'foo' },
+    { id: 1, path: 'foo' },
+  ]);
+
+  renderTemplateField.value = false;
+  await flushPromises();
+
+  expect(form.meta.value.valid).toBe(true);
+  expect(form.getAllPathStates()).toMatchObject([{ id: 0, path: 'foo' }]);
+});