Add tests

Author: djhi

packages/ra-core/src/form/useFormIsDirty.spec.ts

@@ -0,0 +1,118 @@
+import { checkHasDirtyFields } from './useFormIsDirty';
+
+describe('useFormIsDirty', () => {
+    describe('checkHasDirtyFields', () => {
+        it('should return true if any field is dirty on simple forms', () => {
+            const dirtyFields = { name: true, age: false };
+            expect(checkHasDirtyFields(dirtyFields)).toBe(true);
+        });
+
+        it('should return false if no field is dirty on simple forms', () => {
+            const dirtyFields = { name: false, age: false };
+            expect(checkHasDirtyFields(dirtyFields)).toBe(false);
+        });
+
+        it('should return true if any field is dirty on forms with nested fields', () => {
+            const dirtyFields = {
+                name: false,
+                age: false,
+                address: { street: true, city: false },
+            };
+            expect(checkHasDirtyFields(dirtyFields)).toBe(true);
+        });
+
+        it('should return false if no field is dirty on forms with nested fields', () => {
+            const dirtyFields = {
+                name: false,
+                age: false,
+                address: { street: false, city: false },
+            };
+            expect(checkHasDirtyFields(dirtyFields)).toBe(false);
+        });
+
+        it('should return true if any field is dirty on forms with array of scalar fields', () => {
+            const dirtyFields = {
+                name: false,
+                age: false,
+                hobbies: [true, false],
+            };
+            expect(checkHasDirtyFields(dirtyFields)).toBe(true);
+        });
+
+        it('should return false if no field is dirty on forms with array of scalar fields', () => {
+            const dirtyFields = {
+                name: false,
+                age: false,
+                hobbies: [false, false],
+            };
+            expect(checkHasDirtyFields(dirtyFields)).toBe(false);
+        });
+
+        it('should return true if any field is dirty on forms with array of objects', () => {
+            const dirtyFields = {
+                name: false,
+                age: false,
+                hobbies: [{ name: true }, { name: false }],
+            };
+            expect(checkHasDirtyFields(dirtyFields)).toBe(true);
+        });
+
+        it('should return false if no field is dirty on forms with array of objects', () => {
+            const dirtyFields = {
+                name: false,
+                age: false,
+                hobbies: [{ name: false }, { name: false }],
+            };
+            expect(checkHasDirtyFields(dirtyFields)).toBe(false);
+        });
+
+        it('should return true if any field is dirty on forms with nested array of objects', () => {
+            const dirtyFields = {
+                name: false,
+                age: false,
+                address: {
+                    street: false,
+                    city: [{ name: true }, { name: false }],
+                },
+            };
+            expect(checkHasDirtyFields(dirtyFields)).toBe(true);
+        });
+
+        it('should return false if no field is dirty on forms with nested array of objects', () => {
+            const dirtyFields = {
+                name: false,
+                age: false,
+                address: {
+                    street: false,
+                    city: [{ name: false }, { name: false }],
+                },
+            };
+            expect(checkHasDirtyFields(dirtyFields)).toBe(false);
+        });
+
+        // nested array of scalar values
+        it('should return true if any field is dirty on forms with nested array of scalar values', () => {
+            const dirtyFields = {
+                name: false,
+                age: false,
+                hobbies: [
+                    { name: false, tags: [true, true] },
+                    { name: false, tags: [false, false] },
+                ],
+            };
+            expect(checkHasDirtyFields(dirtyFields)).toBe(true);
+        });
+
+        it('should return false if no field is dirty on forms with nested array of scalar values', () => {
+            const dirtyFields = {
+                name: false,
+                age: false,
+                hobbies: [
+                    { name: false, tags: [false, false] },
+                    { name: false, tags: [false, false] },
+                ],
+            };
+            expect(checkHasDirtyFields(dirtyFields)).toBe(false);
+        });
+    });
+});

packages/ra-core/src/form/useFormIsDirty.ts

@@ -4,10 +4,10 @@ import isEmpty from 'lodash/isEmpty.js';
 // useFormState().isDirty might differ from useFormState().dirtyFields (https://github.com/react-hook-form/react-hook-form/issues/4740)
 export const useFormIsDirty = (): boolean => {
     const { dirtyFields } = useFormState();
-    return hasDirtyFields(dirtyFields);
+    return checkHasDirtyFields(dirtyFields);
 };
 
-const hasDirtyFields = (
+export const checkHasDirtyFields = (
     dirtyFields: Partial<
         Readonly<{
             [x: string]: any;
@@ -36,13 +36,13 @@ const hasDirtyFields = (
                 if (
                     typeof item === 'object' &&
                     item !== null &&
-                    hasDirtyFields(item)
+                    checkHasDirtyFields(item)
                 ) {
                     return true;
                 }
             }
         } else if (typeof value === 'object' && value !== null) {
-            return hasDirtyFields(value);
+            return checkHasDirtyFields(value);
         }
         return false;
     });