refactor: [M3-8877] - Refactor VPC Create to use react-hook-form (#…

…11357) * begin refactoring VPC create hook * save * save progress * update tests for vpc components * update drawer * remove unnecessary types * fix vpc create drawer bug default values * general subnet errors? * remove unnecessary util * switch back to scrollIntoError v1 :/ * general subnet errors i think this works for real * Added changeset: Refactor VPC Create to use `react-hook-form` instead of `formik` * feedback @bnussman-akamai, fix reset when using cancel button for VPCCreateDrawer * cleanup use of useWatch and add some accessibility help to remove button * update cypress test due to updated accessibility labels for subnet remove buttons * hiding mention of IPv6 in validation for now since we don't support it * validation changeset
linode · Dec 11, 2024 · cca950f · cca950f
1 parent 61987af
commit cca950f
Show file tree

Hide file tree

Showing 20 changed files with 515 additions and 765 deletions.
diff --git a/packages/manager/.changeset/pr-11357-tech-stories-1733778960338.md b/packages/manager/.changeset/pr-11357-tech-stories-1733778960338.md
@@ -0,0 +1,5 @@
+---
+"@linode/manager": Tech Stories
+---
+
+Refactor VPC Create to use `react-hook-form` instead of `formik` ([#11357](https://github.com/linode/manager/pull/11357))
diff --git a/packages/manager/cypress/e2e/core/vpc/vpc-create.spec.ts b/packages/manager/cypress/e2e/core/vpc/vpc-create.spec.ts
@@ -71,7 +71,8 @@ describe('VPC create flow', () => {
       subnets: mockSubnets,
     });
 
-    const ipValidationErrorMessage = 'The IPv4 range must be in CIDR format';
+    const ipValidationErrorMessage1 = 'A subnet must have an IPv4 range.';
+    const ipValidationErrorMessage2 = 'The IPv4 range must be in CIDR format.';
     const vpcCreationErrorMessage = 'An unknown error has occurred.';
     const totalSubnetUniqueLinodes = getUniqueLinodesFromSubnets(mockSubnets);
 
@@ -111,7 +112,7 @@ describe('VPC create flow', () => {
       .should('be.enabled')
       .click();
 
-    cy.findByText(ipValidationErrorMessage).should('be.visible');
+    cy.findByText(ipValidationErrorMessage1).should('be.visible');
 
     // Enter a random non-IP address string to further test client side validation.
     cy.findByText('Subnet IP Address Range')
@@ -126,7 +127,7 @@ describe('VPC create flow', () => {
       .should('be.enabled')
       .click();
 
-    cy.findByText(ipValidationErrorMessage).should('be.visible');
+    cy.findByText(ipValidationErrorMessage2).should('be.visible');
 
     // Enter a valid IP address with an invalid network prefix to further test client side validation.
     cy.findByText('Subnet IP Address Range')
@@ -141,7 +142,7 @@ describe('VPC create flow', () => {
       .should('be.enabled')
       .click();
 
-    cy.findByText(ipValidationErrorMessage).should('be.visible');
+    cy.findByText(ipValidationErrorMessage2).should('be.visible');
 
     // Replace invalid IP address range with valid range.
     cy.findByText('Subnet IP Address Range')
@@ -180,10 +181,12 @@ describe('VPC create flow', () => {
     getSubnetNodeSection(1)
       .should('be.visible')
       .within(() => {
-        cy.findByText('Label is required').should('be.visible');
+        cy.findByText('Label must be between 1 and 64 characters.').should(
+          'be.visible'
+        );
 
         // Delete subnet.
-        cy.findByLabelText('Remove Subnet')
+        cy.findByLabelText('Remove Subnet 1')
           .should('be.visible')
           .should('be.enabled')
           .click();
@@ -300,7 +303,7 @@ describe('VPC create flow', () => {
     getSubnetNodeSection(0)
       .should('be.visible')
       .within(() => {
-        cy.findByLabelText('Remove Subnet')
+        cy.findByLabelText('Remove Subnet 0')
           .should('be.visible')
           .should('be.enabled')
           .click();

diff --git a/packages/manager/src/features/VPCs/VPCCreate/FormComponents/SubnetContent.test.tsx b/packages/manager/src/features/VPCs/VPCCreate/FormComponents/SubnetContent.test.tsx
@@ -1,24 +1,22 @@
 import * as React from 'react';
 
-import { renderWithTheme } from 'src/utilities/testHelpers';
+import { renderWithThemeAndHookFormContext } from 'src/utilities/testHelpers';
 
 import { SubnetContent } from './SubnetContent';
 
-const props = {
-  disabled: false,
-  onChangeField: vi.fn(),
-  subnets: [
-    {
-      ip: { ipv4: '', ipv4Error: '' },
-      label: '',
-      labelError: '',
-    },
-  ],
-};
-
 describe('Subnet form content', () => {
   it('renders the subnet content correctly', () => {
-    const { getByText } = renderWithTheme(<SubnetContent {...props} />);
+    const { getByText } = renderWithThemeAndHookFormContext({
+      component: <SubnetContent />,
+      useFormOptions: {
+        defaultValues: {
+          description: '',
+          label: '',
+          region: '',
+          subnets: [{ ipv4: '', label: '' }],
+        },
+      },
+    });
 
     getByText('Subnets');
     getByText('Subnet Label');

diff --git a/packages/manager/src/features/VPCs/VPCCreate/FormComponents/SubnetContent.tsx b/packages/manager/src/features/VPCs/VPCCreate/FormComponents/SubnetContent.tsx
@@ -1,5 +1,6 @@
 import { Notice } from '@linode/ui';
 import * as React from 'react';
+import { useFormContext } from 'react-hook-form';
 import { useLocation } from 'react-router-dom';
 
 import { Link } from 'src/components/Link';
@@ -13,28 +14,28 @@ import {
   StyledHeaderTypography,
 } from './VPCCreateForm.styles';
 
-import type { APIError } from '@linode/api-v4';
+import type { CreateVPCPayload } from '@linode/api-v4';
 import type { LinodeCreateType } from 'src/features/Linodes/LinodeCreate/types';
 import type { LinodeCreateQueryParams } from 'src/features/Linodes/types';
-import type { SubnetFieldState } from 'src/utilities/subnets';
 
 interface Props {
   disabled?: boolean;
   isDrawer?: boolean;
-  onChangeField: (field: string, value: SubnetFieldState[]) => void;
-  subnetErrors?: APIError[];
-  subnets: SubnetFieldState[];
 }
 
 export const SubnetContent = (props: Props) => {
-  const { disabled, isDrawer, onChangeField, subnetErrors, subnets } = props;
+  const { disabled, isDrawer } = props;
 
   const location = useLocation();
   const isFromLinodeCreate = location.pathname.includes('/linodes/create');
   const queryParams = getQueryParamsFromQueryString<LinodeCreateQueryParams>(
     location.search
   );
 
+  const {
+    formState: { errors },
+  } = useFormContext<CreateVPCPayload>();
+
   return (
     <>
       <StyledHeaderTypography isDrawer={isDrawer} variant="h2">
@@ -59,22 +60,21 @@ export const SubnetContent = (props: Props) => {
         </Link>
         .
       </StyledBodyTypography>
-      {subnetErrors
-        ? subnetErrors.map((apiError: APIError) => (
-            <Notice
-              key={apiError.reason}
-              spacingBottom={8}
-              text={apiError.reason}
-              variant="error"
-            />
-          ))
-        : null}
-      <MultipleSubnetInput
-        disabled={disabled}
-        isDrawer={isDrawer}
-        onChange={(subnets) => onChangeField('subnets', subnets)}
-        subnets={subnets}
-      />
+      {errors.root?.subnetLabel && (
+        <Notice
+          spacingBottom={8}
+          text={errors.root.subnetLabel.message}
+          variant="error"
+        />
+      )}
+      {errors.root?.subnetIPv4 && (
+        <Notice
+          spacingBottom={8}
+          text={errors.root.subnetIPv4.message}
+          variant="error"
+        />
+      )}
+      <MultipleSubnetInput disabled={disabled} isDrawer={isDrawer} />
     </>
   );
 };
diff --git a/packages/manager/src/features/VPCs/VPCCreate/FormComponents/VPCTopSectionContent.test.tsx b/packages/manager/src/features/VPCs/VPCCreate/FormComponents/VPCTopSectionContent.test.tsx
@@ -1,19 +1,26 @@
 import * as React from 'react';
 
-import { renderWithTheme } from 'src/utilities/testHelpers';
+import { renderWithThemeAndHookFormContext } from 'src/utilities/testHelpers';
 
 import { VPCTopSectionContent } from './VPCTopSectionContent';
 
 const props = {
-  errors: {},
-  onChangeField: vi.fn(),
   regions: [],
-  values: { description: '', label: '', region: '', subnets: [] },
 };
 
 describe('VPC Top Section form content', () => {
   it('renders the vpc top section form content correctly', () => {
-    const { getByText } = renderWithTheme(<VPCTopSectionContent {...props} />);
+    const { getByText } = renderWithThemeAndHookFormContext({
+      component: <VPCTopSectionContent {...props} />,
+      useFormOptions: {
+        defaultValues: {
+          description: '',
+          label: '',
+          region: '',
+          subnets: [],
+        },
+      },
+    });
 
     getByText('Region');
     getByText('VPC Label');

diff --git a/packages/manager/src/features/VPCs/VPCCreate/FormComponents/VPCTopSectionContent.tsx b/packages/manager/src/features/VPCs/VPCCreate/FormComponents/VPCTopSectionContent.tsx
@@ -1,5 +1,6 @@
 import { TextField } from '@linode/ui';
 import * as React from 'react';
+import { Controller, useFormContext } from 'react-hook-form';
 import { useLocation } from 'react-router-dom';
 
 import { Link } from 'src/components/Link';
@@ -10,29 +11,27 @@ import { getQueryParamsFromQueryString } from 'src/utilities/queryParams';
 import { VPC_CREATE_FORM_VPC_HELPER_TEXT } from '../../constants';
 import { StyledBodyTypography } from './VPCCreateForm.styles';
 
+import type { CreateVPCPayload } from '@linode/api-v4';
 import type { Region } from '@linode/api-v4';
-import type { FormikErrors } from 'formik';
 import type { LinodeCreateType } from 'src/features/Linodes/LinodeCreate/types';
 import type { LinodeCreateQueryParams } from 'src/features/Linodes/types';
-import type { CreateVPCFieldState } from 'src/hooks/useCreateVPC';
 
 interface Props {
   disabled?: boolean;
-  errors: FormikErrors<CreateVPCFieldState>;
   isDrawer?: boolean;
-  onChangeField: (field: string, value: string) => void;
   regions: Region[];
-  values: CreateVPCFieldState;
 }
 
 export const VPCTopSectionContent = (props: Props) => {
-  const { disabled, errors, isDrawer, onChangeField, regions, values } = props;
+  const { disabled, isDrawer, regions } = props;
   const location = useLocation();
   const isFromLinodeCreate = location.pathname.includes('/linodes/create');
   const queryParams = getQueryParamsFromQueryString<LinodeCreateQueryParams>(
     location.search
   );
 
+  const { control } = useFormContext<CreateVPCPayload>();
+
   return (
     <>
       <StyledBodyTypography isDrawer={isDrawer} variant="body1">
@@ -53,36 +52,53 @@ export const VPCTopSectionContent = (props: Props) => {
         </Link>
         .
       </StyledBodyTypography>
-      <RegionSelect
-        aria-label="Choose a region"
-        currentCapability="VPCs"
-        disabled={isDrawer ? true : disabled}
-        errorText={errors.region}
-        onChange={(e, region) => onChangeField('region', region?.id ?? '')}
-        regions={regions}
-        value={values.region}
+      <Controller
+        render={({ field, fieldState }) => (
+          <RegionSelect
+            aria-label="Choose a region"
+            currentCapability="VPCs"
+            disabled={isDrawer ? true : disabled}
+            errorText={fieldState.error?.message}
+            onBlur={field.onBlur}
+            onChange={(_, region) => field.onChange(region?.id ?? '')}
+            regions={regions}
+            value={field.value}
+          />
+        )}
+        control={control}
+        name="region"
       />
-      <TextField
-        onChange={(e: React.ChangeEvent<HTMLInputElement>) =>
-          onChangeField('label', e.target.value)
-        }
-        aria-label="Enter a label"
-        disabled={disabled}
-        errorText={errors.label}
-        label="VPC Label"
-        value={values.label}
+      <Controller
+        render={({ field, fieldState }) => (
+          <TextField
+            aria-label="Enter a label"
+            disabled={disabled}
+            errorText={fieldState.error?.message}
+            label="VPC Label"
+            onBlur={field.onBlur}
+            onChange={field.onChange}
+            value={field.value}
+          />
+        )}
+        control={control}
+        name="label"
       />
-      <TextField
-        onChange={(e: React.ChangeEvent<HTMLInputElement>) =>
-          onChangeField('description', e.target.value)
-        }
-        disabled={disabled}
-        errorText={errors.description}
-        label="Description"
-        maxRows={1}
-        multiline
-        optional
-        value={values.description}
+      <Controller
+        render={({ field, fieldState }) => (
+          <TextField
+            disabled={disabled}
+            errorText={fieldState.error?.message}
+            label="Description"
+            maxRows={1}
+            multiline
+            onBlur={field.onBlur}
+            onChange={field.onChange}
+            optional
+            value={field.value}
+          />
+        )}
+        control={control}
+        name="description"
       />
     </>
   );