feat: optimize sale estimate form performance.

feat: optimize sale receipt form performance.
feat: optimize sale invoice form performance.
feat: optimize bill form performance.

client/src/containers/Sales/Estimate/EstimateForm.js

@@ -1,24 +1,24 @@
-import React, {
-  useMemo,
-  useCallback,
-  useEffect,
-  useRef,
-  useState,
-} from 'react';
-import * as Yup from 'yup';
-import { useFormik } from 'formik';
+import React, { useMemo, useCallback, useEffect, useState } from 'react';
+import { Formik, Form } from 'formik';
 import moment from 'moment';
-import { Intent, FormGroup, TextArea } from '@blueprintjs/core';
+import { Intent } from '@blueprintjs/core';
 import { FormattedMessage as T, useIntl } from 'react-intl';
 import { pick, sumBy } from 'lodash';
 import classNames from 'classnames';
+import { useHistory } from 'react-router-dom';
 
 import { CLASSES } from 'common/classes';
-import EstimateFormHeader from './EstimateFormHeader';
-import EntriesItemsTable from './EntriesItemsTable';
-import EstimateFloatingActions from './EstimateFloatingActions';
+import {
+  CreateEstimateFormSchema,
+  EditEstimateFormSchema,
+} from './EstimateForm.schema';
+
+import EstimateFormHeader from './EstimateFormHeader';
+import EditableItemsEntriesTable from 'containers/Entries/EditableItemsEntriesTable';
+import EstimateFloatingActions from './EstimateFloatingActions';
+import EstimateFormFooter from './EstimateFormFooter';
+import EstimateNumberWatcher from './EstimateNumberWatcher';
 
-import withEstimates from './withEstimates';
 import withEstimateActions from './withEstimateActions';
 import withEstimateDetail from './withEstimateDetail';
 
@@ -26,25 +26,44 @@ import withDashboardActions from 'containers/Dashboard/withDashboardActions';
 import withMediaActions from 'containers/Media/withMediaActions';
 import withSettings from 'containers/Settings/withSettings';
 
-import { AppToaster, Row, Col } from 'components';
+import { AppToaster } from 'components';
 import Dragzone from 'components/Dragzone';
 import useMedia from 'hooks/useMedia';
 import { ERROR } from 'common/errors';
 
-import { compose, repeatValue } from 'utils';
+import { compose, repeatValue, orderingLinesIndexes } from 'utils';
 
 const MIN_LINES_NUMBER = 4;
 
+const defaultEstimate = {
+  index: 0,
+  item_id: null,
+  rate: null,
+  discount: 0,
+  quantity: null,
+  description: '',
+};
+
+const defaultInitialValues = {
+  customer_id: '',
+  estimate_date: moment(new Date()).format('YYYY-MM-DD'),
+  expiration_date: moment(new Date()).format('YYYY-MM-DD'),
+  estimate_number: '',
+  reference: '',
+  note: '',
+  terms_conditions: '',
+  entries: [...repeatValue(defaultEstimate, MIN_LINES_NUMBER)],
+};
+
 /**
  * Estimate form.
  */
-
 const EstimateForm = ({
-  //#WithMedia
+  // #WithMedia
   requestSubmitMedia,
   requestDeleteMedia,
 
-  //#WithEstimateActions
+  // #WithEstimateActions
   requestSubmitEstimate,
   requestEditEstimate,
   setEstimateNumberChanged,
@@ -69,27 +88,10 @@ const EstimateForm = ({
   onCancelForm,
 }) => {
   const { formatMessage } = useIntl();
-  const [payload, setPayload] = useState({});
+  const history = useHistory();
+  const [submitPayload, setSubmitPayload] = useState({});
 
-  const {
-    setFiles,
-    saveMedia,
-    deletedFiles,
-    setDeletedFiles,
-    deleteMedia,
-  } = useMedia({
-    saveCallback: requestSubmitMedia,
-    deleteCallback: requestDeleteMedia,
-  });
-
-  const handleDropFiles = useCallback((_files) => {
-    setFiles(_files.filter((file) => file.uploaded === false));
-  }, []);
-
-  const savedMediaIds = useRef([]);
-  const clearSavedMediaIds = () => {
-    savedMediaIds.current = [];
-  };
+  const isNewMode = !estimateId;
 
   const estimateNumber = estimateNumberPrefix
     ? `${estimateNumberPrefix}-${estimateNextNumber}`
@@ -103,94 +105,15 @@ const EstimateForm = ({
       changePageSubtitle(`No. ${estimateNumber}`);
       changePageTitle(formatMessage({ id: 'new_estimate' }));
     }
-  }, [changePageTitle, estimate, formatMessage]);
-
-  const validationSchema = Yup.object().shape({
-    customer_id: Yup.number()
-      .label(formatMessage({ id: 'customer_name_' }))
-      .required(),
-    estimate_date: Yup.date()
-      .required()
-      .label(formatMessage({ id: 'estimate_date_' })),
-    expiration_date: Yup.date()
-      .required()
-      .label(formatMessage({ id: 'expiration_date_' })),
-    estimate_number: Yup.string()
-      .required()
-      .nullable()
-      .label(formatMessage({ id: 'estimate_number_' })),
-    reference: Yup.string().min(1).max(255),
-    note: Yup.string()
-      .trim()
-      .min(1)
-      .max(1024)
-      .label(formatMessage({ id: 'note' })),
-    terms_conditions: Yup.string()
-      .trim()
-      .min(1)
-      .max(1024)
-      .label(formatMessage({ id: 'note' })),
-    entries: Yup.array().of(
-      Yup.object().shape({
-        quantity: Yup.number()
-          .nullable()
-          .when(['rate'], {
-            is: (rate) => rate,
-            then: Yup.number().required(),
-          }),
-        rate: Yup.number().nullable(),
-        item_id: Yup.number()
-          .nullable()
-          .when(['quantity', 'rate'], {
-            is: (quantity, rate) => quantity || rate,
-            then: Yup.number().required(),
-          }),
-        discount: Yup.number().nullable().min(0).max(100),
-        description: Yup.string().nullable(),
-      }),
-    ),
-  });
-
-  const saveEstimateSubmit = useCallback(
-    (payload) => {
-      onFormSubmit && onFormSubmit(payload);
-    },
-    [onFormSubmit],
-  );
-
-  const defaultEstimate = useMemo(
-    () => ({
-      index: 0,
-      item_id: null,
-      rate: null,
-      discount: 0,
-      quantity: null,
-      description: '',
-    }),
-    [],
-  );
-
-  const defaultInitialValues = useMemo(
-    () => ({
-      customer_id: '',
-      estimate_date: moment(new Date()).format('YYYY-MM-DD'),
-      expiration_date: moment(new Date()).format('YYYY-MM-DD'),
-      estimate_number: estimateNumber,
-      reference: '',
-      note: '',
-      terms_conditions: '',
-      entries: [...repeatValue(defaultEstimate, MIN_LINES_NUMBER)],
-    }),
-    [defaultEstimate],
-  );
-
-  const orderingProductsIndex = (_entries) => {
-    return _entries.map((item, index) => ({
-      ...item,
-      index: index + 1,
-    }));
-  };
+  }, [
+    estimate,
+    estimateNumber,
+    formatMessage,
+    changePageTitle,
+    changePageSubtitle,
+  ]);
 
+  // Initial values in create and edit mode.
   const initialValues = useMemo(
     () => ({
       ...(estimate
@@ -208,22 +131,14 @@ const EstimateForm = ({
           }
         : {
             ...defaultInitialValues,
-            entries: orderingProductsIndex(defaultInitialValues.entries),
+            estimate_number: estimateNumber,
+            entries: orderingLinesIndexes(defaultInitialValues.entries),
           }),
     }),
-    [estimate, defaultInitialValues, defaultEstimate],
+    [estimate, estimateNumber],
   );
 
-  const initialAttachmentFiles = useMemo(() => {
-    return estimate && estimate.media
-      ? estimate.media.map((attach) => ({
-          preview: attach.attachment_file,
-          uploaded: true,
-          metadata: { ...attach },
-        }))
-      : [];
-  }, [estimate]);
-
+  // Transform response errors to fields.
   const handleErrors = (errors, { setErrors }) => {
     if (errors.some((e) => e.type === ERROR.ESTIMATE_NUMBER_IS_NOT_UNQIUE)) {
       setErrors({
@@ -234,130 +149,64 @@ const EstimateForm = ({
     }
   };
 
-  const formik = useFormik({
-    validationSchema,
-    initialValues: {
-      ...initialValues,
-    },
-    onSubmit: (values, { setSubmitting, setErrors, resetForm }) => {
-      const entries = values.entries.filter(
-        (item) => item.item_id && item.quantity,
-      );
+  // Handles form submit.
+  const handleFormSubmit = (
+    values,
+    { setSubmitting, setErrors, resetForm },
+  ) => {
+    const entries = values.entries.filter(
+      (item) => item.item_id && item.quantity,
+    );
 
-      const totalQuantity = sumBy(entries, (entry) => parseInt(entry.quantity));
+    const totalQuantity = sumBy(entries, (entry) => parseInt(entry.quantity));
 
-      if (totalQuantity === 0) {
-        AppToaster.show({
-          message: formatMessage({
-            id: 'quantity_cannot_be_zero_or_empty',
-          }),
-          intent: Intent.DANGER,
-        });
-        setSubmitting(false);
-        return;
-      }
-      const form = {
-        ...values,
-        entries,
-      };
-      const requestForm = { ...form };
-
-      if (estimate && estimate.id) {
-        requestEditEstimate(estimate.id, requestForm)
-          .then((response) => {
-            AppToaster.show({
-              message: formatMessage(
-                {
-                  id: 'the_estimate_has_been_successfully_edited',
-                },
-                { number: values.estimate_number },
-              ),
-              intent: Intent.SUCCESS,
-            });
-            setSubmitting(false);
-            saveEstimateSubmit({ action: 'update', ...payload });
-            resetForm();
-          })
-          .catch((errors) => {
-            handleErrors(errors, { setErrors });
-            setSubmitting(false);
-          });
-      } else {
-        requestSubmitEstimate(requestForm)
-          .then((response) => {
-            AppToaster.show({
-              message: formatMessage(
-                { id: 'the_estimate_has_been_successfully_created' },
-                { number: values.estimate_number },
-              ),
-              intent: Intent.SUCCESS,
-            });
-            setSubmitting(false);
-            resetForm();
-            saveEstimateSubmit({ action: 'new', ...payload });
-          })
-          .catch((errors) => {
-            handleErrors(errors, { setErrors });
-            setSubmitting(false);
-          });
-      }
-    },
-  });
-
-  useEffect(() => {
-    if (estimateNumberChanged) {
-      formik.setFieldValue('estimate_number', estimateNumber);
-      changePageSubtitle(`No. ${estimateNumber}`);
-      setEstimateNumberChanged(false);
-    }
-  }, [
-    estimateNumber,
-    estimateNumberChanged,
-    setEstimateNumberChanged,
-    formik.setFieldValue,
-    changePageSubtitle,
-  ]);
-
-  const handleSubmitClick = useCallback(
-    (payload) => {
-      setPayload(payload);
-      formik.submitForm();
-    },
-    [setPayload, formik],
-  );
-
-  const handleCancelClick = useCallback(
-    (payload) => {
-      onCancelForm && onCancelForm(payload);
-    },
-    [onCancelForm],
-  );
-
-  const handleDeleteFile = useCallback(
-    (_deletedFiles) => {
-      _deletedFiles.forEach((deletedFile) => {
-        if (deletedFile.uploaded && deletedFile.metadata.id) {
-          setDeletedFiles([...deletedFiles, deletedFile.metadata.id]);
-        }
+    if (totalQuantity === 0) {
+      AppToaster.show({
+        message: formatMessage({
+          id: 'quantity_cannot_be_zero_or_empty',
+        }),
+        intent: Intent.DANGER,
       });
-    },
-    [setDeletedFiles, deletedFiles],
-  );
+      setSubmitting(false);
+      return;
+    }
+    const form = {
+      ...values,
+      // Exclude all entries properties that out of request schema.
+      entries: entries.map((entry) => ({
+        ...pick(entry, Object.keys(defaultEstimate)),
+      })),
+    };
+    const onSuccess = (response) => {
+      AppToaster.show({
+        message: formatMessage(
+          {
+            id: isNewMode
+              ? 'the_estimate_has_been_successfully_edited'
+              : 'the_estimate_has_been_successfully_created',
+          },
+          { number: values.estimate_number },
+        ),
+        intent: Intent.SUCCESS,
+      });
+      setSubmitting(false);
+      resetForm();
 
-  const handleClickAddNewRow = () => {
-    formik.setFieldValue(
-      'entries',
-      orderingProductsIndex([...formik.values.entries, defaultEstimate]),
-    );
-  };
+      if (submitPayload.redirect) {
+        history.push('/estimates');
+      }
+    };
 
-  const handleClearAllLines = () => {
-    formik.setFieldValue(
-      'entries',
-      orderingProductsIndex([
-        ...repeatValue(defaultEstimate, MIN_LINES_NUMBER),
-      ]),
-    );
+    const onError = (errors) => {
+      handleErrors(errors, { setErrors });
+      setSubmitting(false);
+    };
+
+    if (estimate && estimate.id) {
+      requestEditEstimate(estimate.id, form).then(onSuccess).catch(onError);
+    } else {
+      requestSubmitEstimate(form).then(onSuccess).catch(onError);
+    }
   };
 
   const handleEstimateNumberChange = useCallback(
@@ -367,62 +216,40 @@ const EstimateForm = ({
     [changePageSubtitle],
   );
 
+  const handleSubmitClick = useCallback((event) => {
+    setSubmitPayload({ redirect: true });
+  }, [setSubmitPayload]);
+
+  const handleCancelClick = useCallback((event) => {
+    history.goBack();
+  }, [history]);
+
   return (
     <div className={classNames(CLASSES.PAGE_FORM, CLASSES.PAGE_FORM_ESTIMATE)}>
-      <form onSubmit={formik.handleSubmit}>
-        <EstimateFormHeader
-          onEstimateNumberChanged={handleEstimateNumberChange}
-          formik={formik}
-        />
-        <EntriesItemsTable
-          entries={formik.values.entries}
-          onClickAddNewRow={handleClickAddNewRow}
-          onClickClearAllLines={handleClearAllLines}
-          formik={formik}
-        />
-
-        <div class={classNames(CLASSES.PAGE_FORM_FOOTER)}>
-          <Row>
-            <Col md={8}>
-              {/* --------- Customer Note --------- */}
-              <FormGroup
-                label={<T id={'customer_note'} />}
-                className={'form-group--customer_note'}
-              >
-                <TextArea
-                  growVertically={true}
-                  {...formik.getFieldProps('note')}
-                />
-              </FormGroup>
-              {/* --------- Terms and conditions --------- */}
-              <FormGroup
-                label={<T id={'terms_conditions'} />}
-                className={'form-group--terms_conditions'}
-              >
-                <TextArea
-                  growVertically={true}
-                  {...formik.getFieldProps('terms_conditions')}
-                />
-              </FormGroup>
-            </Col>
-
-            <Col md={4}>
-              <Dragzone
-                initialFiles={initialAttachmentFiles}
-                onDrop={handleDropFiles}
-                onDeleteFile={handleDeleteFile}
-                hint={'Attachments: Maxiumum size: 20MB'}
-              />
-            </Col>
-          </Row>
-        </div>
-      </form>
-      <EstimateFloatingActions
-        formik={formik}
-        onSubmitClick={handleSubmitClick}
-        estimate={estimate}
-        onCancelClick={handleCancelClick}
-      />
+      <Formik
+        validationSchema={
+          isNewMode ? CreateEstimateFormSchema : EditEstimateFormSchema
+        }
+        initialValues={initialValues}
+        onSubmit={handleFormSubmit}
+      >
+        {({ isSubmitting }) => (
+          <Form>
+            <EstimateFormHeader
+              onEstimateNumberChanged={handleEstimateNumberChange}
+            />
+            <EstimateNumberWatcher estimateNumber={estimateNumber}  />
+            <EditableItemsEntriesTable />
+            <EstimateFormFooter />
+            <EstimateFloatingActions
+              isSubmiting={isSubmitting}
+              estimateId={estimateId}
+              onSubmitClick={handleSubmitClick}
+              onCancelClick={handleCancelClick}
+            />
+          </Form>
+        )}
+      </Formik>
     </div>
   );
 };
@@ -436,7 +263,4 @@ export default compose(
     estimateNextNumber: estimatesSettings?.nextNumber,
     estimateNumberPrefix: estimatesSettings?.numberPrefix,
   })),
-  withEstimates(({ estimateNumberChanged }) => ({
-    estimateNumberChanged,
-  })),
 )(EstimateForm);