-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: JSON form validation trigger on child component update (#37128)
## Description <ins>Problem</ins> Form validation was not triggered when the child component was updated, resulting in inconsistent data consistency. <ins>Root cause</ins> The `Form` component in `app/client/src/widgets/JSONFormWidget/component/Form.tsx` did not include the `trigger` function from the `methods` object, preventing form validation from being triggered on child component updates. <ins>Solution</ins> This PR adds the `trigger` function from the `methods` object to the `Form` component, ensuring form validation is triggered correctly when the child component is updated. * Adds unit tests for `Form` component as well Fixes #28018 _or_ Fixes `Issue URL` > [!WARNING] > _If no issue exists, please create an issue first, and check with the maintainers if the issue is valid._ ## Automation /ok-to-test tags="@tag.JSONForm" ### 🔍 Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/11697880527> > Commit: 1c38b05 > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=11697880527&attempt=1" target="_blank">Cypress dashboard</a>. > Tags: `@tag.JSONForm` > Spec: > <hr>Wed, 06 Nov 2024 06:06:41 UTC <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [x] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced form validation lifecycle management with the introduction of the `useUnmountFieldValidation` hook for better handling of field validation upon unmounting. - Improved testability of the form component through the inclusion of `data-testid` attributes for the submit and reset buttons. - **Bug Fixes** - Resolved edge cases in form validation, ensuring components function correctly with changing props and handle empty schemas gracefully. - **Tests** - Introduced a comprehensive suite of unit tests for the `Form` component, covering various scenarios including validation and visibility management. - Added tests for the new `useUnmountFieldValidation` hook to ensure correct validation behavior during unmounting. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
- Loading branch information
1 parent
ff3f22e
commit b23ba1d
Showing
11 changed files
with
308 additions
and
0 deletions.
There are no files selected for viewing
198 changes: 198 additions & 0 deletions
198
app/client/src/widgets/JSONFormWidget/component/Form.test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| import "@testing-library/jest-dom"; | ||
| import { fireEvent, render, screen } from "@testing-library/react"; | ||
| import { klona } from "klona"; | ||
| import React from "react"; | ||
| import { useForm } from "react-hook-form"; | ||
| import { ROOT_SCHEMA_KEY, type SchemaItem } from "../constants"; | ||
| import Form from "./Form"; | ||
| import useFixedFooter from "./useFixedFooter"; | ||
|
|
||
| jest.mock("react-hook-form", () => ({ | ||
| __esModule: true, | ||
| useForm: jest.fn(), | ||
| FormProvider: jest.fn(({ children }) => <div>{children}</div>), | ||
| })); | ||
|
|
||
| jest.mock("./useFixedFooter", () => ({ | ||
| __esModule: true, | ||
| default: jest.fn(), | ||
| })); | ||
|
|
||
| jest.mock("widgets/ButtonWidget/component", () => ({ | ||
| __esModule: true, | ||
| BaseButton: jest.fn(({ children, ...props }) => ( | ||
| <button {...props}>{children}</button> | ||
| )), | ||
| })); | ||
|
|
||
| function mockUseForm(withErrors = false) { | ||
| (useForm as jest.Mock).mockReturnValue({ | ||
| formState: { | ||
| errors: withErrors | ||
| ? { | ||
| fieldName: { | ||
| type: "required", | ||
| message: "This field is required", | ||
| }, | ||
| } | ||
| : null, | ||
| }, | ||
| reset: jest.fn(), | ||
| trigger: jest.fn(), | ||
| watch: jest.fn(() => ({ | ||
| subscribe: jest.fn(), | ||
| unsubscribe: jest.fn(), | ||
| })), | ||
| }); | ||
| } | ||
|
|
||
| const TEST_IDS = { | ||
| SUBMIT_BTN: "t--jsonform-submit-btn", | ||
| RESET_BTN: "t--jsonform-reset-btn", | ||
| }; | ||
|
|
||
| const defaultProps = { | ||
| backgroundColor: "#fff", | ||
| disabledWhenInvalid: false, | ||
| fixedFooter: false, | ||
| getFormData: jest.fn(), | ||
| hideFooter: false, | ||
| isSubmitting: false, | ||
| isWidgetMounting: false, | ||
| onFormValidityUpdate: jest.fn(), | ||
| onSubmit: jest.fn(), | ||
| onreset: jest.fn(), | ||
| registerResetObserver: jest.fn(), | ||
| resetButtonLabel: "Reset", | ||
| resetButtonStyles: {}, | ||
| scrollContents: false, | ||
| showReset: true, | ||
| stretchBodyVertically: false, | ||
| submitButtonLabel: "Submit", | ||
| submitButtonStyles: {}, | ||
| title: "Test Form", | ||
| unregisterResetObserver: jest.fn(), | ||
| updateFormData: jest.fn(), | ||
| children: <input />, | ||
| }; | ||
|
|
||
| describe("Form Component", () => { | ||
| beforeEach(() => { | ||
| const mockBodyRef = React.createRef<HTMLFormElement>(); | ||
| const mockFooterRef = React.createRef<HTMLDivElement>(); | ||
|
|
||
| (useFixedFooter as jest.Mock).mockReturnValue({ | ||
| bodyRef: mockBodyRef, | ||
| footerRef: mockFooterRef, | ||
| }); | ||
| }); | ||
|
|
||
| describe("happy render path", () => { | ||
| beforeEach(() => mockUseForm()); | ||
| it("renders the form title", () => { | ||
| render(<Form {...defaultProps}>Form Content</Form>); | ||
| expect(screen.getByText("Test Form")).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it("renders children inside the form body", () => { | ||
| render(<Form {...defaultProps}>Form Content</Form>); | ||
| expect(screen.getByText("Form Content")).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it("renders the submit button with correct label", () => { | ||
| const { getByTestId } = render( | ||
| <Form {...defaultProps}>Form Content</Form>, | ||
| ); | ||
| const submitBtn = getByTestId(TEST_IDS.SUBMIT_BTN); | ||
|
|
||
| expect(submitBtn).toBeInTheDocument(); | ||
| expect(submitBtn).toHaveAttribute("text", defaultProps.submitButtonLabel); | ||
|
|
||
| fireEvent.click(submitBtn); | ||
| expect(defaultProps.onSubmit).toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it("renders the reset button with correct label when showReset is true", () => { | ||
| const { getByTestId } = render( | ||
| <Form {...defaultProps}>Form Content</Form>, | ||
| ); | ||
| const resetBtn = getByTestId(TEST_IDS.RESET_BTN); | ||
|
|
||
| expect(resetBtn).toBeInTheDocument(); | ||
| expect(resetBtn).toHaveAttribute("text", defaultProps.resetButtonLabel); | ||
| expect(defaultProps.registerResetObserver).toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| // Form updates data correctly when input values change | ||
| it("should update data when input values change", () => { | ||
| const mockUpdateFormData = jest.fn(); | ||
| const mockGetFormData = jest.fn().mockReturnValue({}); | ||
| const mockRegisterResetObserver = jest.fn(); | ||
| const mockUnregisterResetObserver = jest.fn(); | ||
| const mockOnSubmit = jest.fn(); | ||
| const mockOnFormValidityUpdate = jest.fn(); | ||
| const mockSchema = { [ROOT_SCHEMA_KEY]: {} as SchemaItem }; | ||
| const props = klona({ | ||
| ...defaultProps, | ||
| updateFormData: mockUpdateFormData, | ||
| getFormData: mockGetFormData, | ||
| registerResetObserver: mockRegisterResetObserver, | ||
| unregisterResetObserver: mockUnregisterResetObserver, | ||
| onSubmit: mockOnSubmit, | ||
| onFormValidityUpdate: mockOnFormValidityUpdate, | ||
| schema: mockSchema, | ||
| }); | ||
| const { getByTestId } = render(<Form {...props} />); | ||
|
|
||
| fireEvent.click(getByTestId(TEST_IDS.SUBMIT_BTN)); | ||
| expect(mockUpdateFormData).toHaveBeenCalled(); | ||
| }); | ||
| }); | ||
|
|
||
| describe("unhappy render path", () => { | ||
| it("does not render the reset button when showReset is false", () => { | ||
| mockUseForm(); | ||
| const { queryByTestId } = render( | ||
| <Form {...defaultProps} showReset={false}> | ||
| Form Content | ||
| </Form>, | ||
| ); | ||
|
|
||
| expect(queryByTestId(TEST_IDS.RESET_BTN)).not.toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it("disables the submit button when disabledWhenInvalid is true and form is invalid", () => { | ||
| mockUseForm(true); | ||
| const { getByTestId } = render( | ||
| <Form {...defaultProps} disabledWhenInvalid> | ||
| Form Content | ||
| </Form>, | ||
| ); | ||
|
|
||
| expect(getByTestId(TEST_IDS.SUBMIT_BTN)).toBeDisabled(); | ||
| }); | ||
|
|
||
| it("triggers a check, necessitating a re-render, when the children in form are updated", () => { | ||
| mockUseForm(true); | ||
| const propsToUpdate = klona({ | ||
| ...defaultProps, | ||
| disabledWhenInvalid: true, | ||
| }); | ||
| const { getByTestId } = render( | ||
| <Form {...propsToUpdate}>Form Content</Form>, | ||
| ); | ||
|
|
||
| expect(getByTestId(TEST_IDS.SUBMIT_BTN)).toBeDisabled(); | ||
| }); | ||
|
|
||
| it("should handle empty schema gracefully without errors", () => { | ||
| mockUseForm(); | ||
| const mockUpdateFormData = jest.fn(); | ||
| const props = klona({ ...defaultProps, schema: undefined }); | ||
| const { container } = render(<Form {...props} />); | ||
|
|
||
| expect(container).toBeInTheDocument(); | ||
| expect(mockUpdateFormData).not.toHaveBeenCalled(); | ||
| }); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
65 changes: 65 additions & 0 deletions
65
app/client/src/widgets/JSONFormWidget/fields/useUnmountFieldValidation.test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| import { renderHook } from "@testing-library/react-hooks"; | ||
| import { useFormContext } from "react-hook-form"; | ||
| import useUnmountFieldValidation from "./useUnmountFieldValidation"; | ||
| import { startAndEndSpanForFn } from "UITelemetry/generateTraces"; | ||
|
|
||
| // Mock dependencies | ||
| jest.mock("react-hook-form", () => ({ | ||
| useFormContext: jest.fn(), | ||
| })); | ||
|
|
||
| jest.mock("UITelemetry/generateTraces", () => ({ | ||
| startAndEndSpanForFn: jest.fn((name, options, fn) => fn()), | ||
| })); | ||
|
|
||
| describe("useUnmountFieldValidation", () => { | ||
| const mockTrigger = jest.fn(); | ||
|
|
||
| beforeEach(() => { | ||
| (useFormContext as jest.Mock).mockReturnValue({ | ||
| trigger: mockTrigger, | ||
| }); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| jest.clearAllMocks(); | ||
| }); | ||
|
|
||
| it("should trigger validation on unmount", () => { | ||
| const fieldName = "testField"; | ||
| const { unmount } = renderHook(() => | ||
| useUnmountFieldValidation({ fieldName }), | ||
| ); | ||
|
|
||
| // Verify trigger hasn't been called yet | ||
| expect(mockTrigger).not.toHaveBeenCalled(); | ||
| expect(startAndEndSpanForFn).not.toHaveBeenCalled(); | ||
|
|
||
| // Unmount the hook | ||
| unmount(); | ||
|
|
||
| // Verify trigger was called with correct field name | ||
| expect(startAndEndSpanForFn).toHaveBeenCalledWith( | ||
| "JSONFormWidget.triggerFieldValidation", | ||
| {}, | ||
| expect.any(Function), | ||
| ); | ||
| expect(mockTrigger).toHaveBeenCalledWith(fieldName); | ||
| }); | ||
|
|
||
| it("should update cleanup when fieldName changes", () => { | ||
| const { rerender, unmount } = renderHook( | ||
| ({ fieldName }) => useUnmountFieldValidation({ fieldName }), | ||
| { | ||
| initialProps: { fieldName: "field1" }, | ||
| }, | ||
| ); | ||
|
|
||
| // Change the field name | ||
| rerender({ fieldName: "field2" }); | ||
| unmount(); | ||
|
|
||
| // Should trigger validation for the latest field name | ||
| expect(mockTrigger).toHaveBeenCalledWith("field2"); | ||
| }); | ||
| }); |
Oops, something went wrong.