perf: JSONForm infinite function when setting internal error state wh…

…en a field has error
appsmithorg · Aug 30, 2024 · 1d5dec6 · 1d5dec6
1 parent 67de8c1
commit 1d5dec6
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 5 deletions.
diff --git a/app/client/src/widgets/JSONFormWidget/fields/useRegisterFieldValidity.test.tsx b/app/client/src/widgets/JSONFormWidget/fields/useRegisterFieldValidity.test.tsx
@@ -193,6 +193,56 @@ describe("useRegisterFieldInvalid - setMetaInternalFieldState", () => {
     expect(mockSetError).not.toBeCalled();
   });
 
+  it("calls setError when isValid is false and error is not present", () => {
+    const mocksetMetaInternalFieldState = jest.fn();
+    const mockClearErrors = jest.fn();
+    const mockSetError = jest.fn();
+
+    function Wrapper({ children }: { children: React.ReactNode }) {
+      const methods = useForm();
+
+      return (
+        <FormContextProvider
+          executeAction={jest.fn}
+          renderMode="CANVAS"
+          setMetaInternalFieldState={mocksetMetaInternalFieldState}
+          updateFormData={jest.fn}
+          updateWidgetMetaProperty={jest.fn}
+          updateWidgetProperty={jest.fn}
+        >
+          <FormProvider
+            {...methods}
+            clearErrors={mockClearErrors}
+            setError={mockSetError}
+          >
+            {children}
+          </FormProvider>
+        </FormContextProvider>
+      );
+    }
+
+    const fieldName = "testField";
+
+    act(() => {
+      renderHook(
+        () =>
+          useRegisterFieldValidity({
+            isValid: false,
+            fieldName,
+            fieldType: FieldType.TEXT_INPUT,
+          }),
+        {
+          wrapper: Wrapper,
+        },
+      );
+    });
+
+    jest.runAllTimers();
+
+    expect(mockSetError).toBeCalledTimes(1);
+    expect(mockClearErrors).not.toBeCalledWith(fieldName);
+  });
+
   it("updates fieldState and error state with the updated isValid value", () => {
     const mocksetMetaInternalFieldState = jest.fn();
     // TODO: Fix this the next time the file is edited

diff --git a/app/client/src/widgets/JSONFormWidget/fields/useRegisterFieldValidity.ts b/app/client/src/widgets/JSONFormWidget/fields/useRegisterFieldValidity.ts
@@ -42,12 +42,14 @@ function useRegisterFieldValidity({
             });
           }
         } else {
-          startAndEndSpanForFn("JSONFormWidget.setError", {}, () => {
-            setError(fieldName, {
-              type: fieldType,
-              message: "Invalid field",
+          if (!error) {
+            startAndEndSpanForFn("JSONFormWidget.setError", {}, () => {
+              setError(fieldName, {
+                type: fieldType,
+                message: "Invalid field",
+              });
             });
-          });
+          }
         }
       } catch (e) {
         Sentry.captureException(e);