Merge pull request #395 from bigcapitalhq/validate-imported-sheet-empty

feat: validate the given imported sheet whether is empty

packages/server/src/services/Import/ImportFileUpload.ts

@@ -1,12 +1,11 @@
 import { Inject, Service } from 'typedi';
 import HasTenancyService from '../Tenancy/TenancyService';
-import { sanitizeResourceName } from './_utils';
+import { sanitizeResourceName, validateSheetEmpty } from './_utils';
 import ResourceService from '../Resource/ResourceService';
 import { IModelMetaField } from '@/interfaces';
 import { ImportFileCommon } from './ImportFileCommon';
 import { ImportFileDataValidator } from './ImportFileDataValidator';
 import { ImportFileUploadPOJO } from './interfaces';
-import { ServiceError } from '@/exceptions';
 
 @Service()
 export class ImportFileUploadService {
@@ -51,6 +50,10 @@ export class ImportFileUploadService {
 
     // Parse the buffer file to array data.
     const sheetData = this.importFileCommon.parseXlsxSheet(buffer);
+
+    // Throws service error if the sheet data is empty.
+    validateSheetEmpty(sheetData);
+
     const sheetColumns = this.importFileCommon.parseSheetColumns(sheetData);
     const coumnsStringified = JSON.stringify(sheetColumns);
 

packages/server/src/services/Import/_utils.ts

@@ -1,9 +1,18 @@
 import * as Yup from 'yup';
-import { defaultTo, upperFirst, camelCase, first, isUndefined, pickBy } from 'lodash';
+import {
+  defaultTo,
+  upperFirst,
+  camelCase,
+  first,
+  isUndefined,
+  pickBy,
+  isEmpty,
+} from 'lodash';
 import pluralize from 'pluralize';
 import { ResourceMetaFieldsMap } from './interfaces';
 import { IModelMetaField } from '@/interfaces';
 import moment from 'moment';
+import { ServiceError } from '@/exceptions';
 
 export const ERRORS = {
   RESOURCE_NOT_IMPORTABLE: 'RESOURCE_NOT_IMPORTABLE',
@@ -124,6 +133,15 @@ export const getUniqueImportableValue = (
   return defaultTo(objectDTO[uniqueImportableKey], '');
 };
 
+/**
+ * Throws service error the given sheet is empty.
+ * @param {Array<any>} sheetData
+ */
+export const validateSheetEmpty = (sheetData: Array<any>) => {
+  if (isEmpty(sheetData)) {
+    throw new ServiceError(ERRORS.IMPORTED_SHEET_EMPTY);
+  }
+
 const booleanValuesRepresentingTrue: string[] = ['true', 'yes', 'y', 't', '1'];
 const booleanValuesRepresentingFalse: string[] = ['false', 'no', 'n', 'f', '0'];
 

packages/webapp/src/containers/Import/AlertsManager.tsx

@@ -0,0 +1,53 @@
+import type { ReactNode } from 'react';
+import { useState, createContext, useContext } from 'react';
+
+interface AlertsManagerContextValue {
+  alerts: (string | number)[];
+  showAlert: (alert: string | number) => void;
+  hideAlert: (alert: string | number) => void;
+
+  hideAlerts: () => void;
+  isAlertActive: (alert: string | number) => boolean;
+  findAlert: (alert: string | number) => string | number | undefined;
+}
+
+const AlertsManagerContext = createContext<AlertsManagerContextValue>(
+  {} as AlertsManagerContextValue,
+);
+
+export function AlertsManager({ children }: { children: ReactNode }) {
+  const [alerts, setAlerts] = useState<(string | number)[]>([]);
+
+  const showAlert = (type: string | number): void => {
+    setAlerts([...alerts, type]);
+  };
+  const hideAlert = (type: string | number): void => {
+    alerts.filter((t) => t !== type);
+  };
+  const hideAlerts = (): void => {
+    setAlerts([]);
+  };
+  const isAlertActive = (type: string | number): boolean => {
+    return alerts.some((t) => t === type);
+  };
+  const findAlert = (type: string | number): number | string | undefined => {
+    return alerts.find((t) => t === type);
+  };
+
+  return (
+    <AlertsManagerContext.Provider
+      value={{
+        alerts,
+        showAlert,
+        hideAlert,
+        hideAlerts,
+        isAlertActive,
+        findAlert,
+      }}
+    >
+      {children}
+    </AlertsManagerContext.Provider>
+  );
+}
+
+export const useAlertsManager = () => useContext(AlertsManagerContext);

packages/webapp/src/containers/Import/ImportDropzone.tsx

@@ -3,15 +3,19 @@ import { Field } from 'formik';
 import { Box, Group, Stack } from '@/components';
 import styles from './ImportDropzone.module.css';
 import { ImportDropzoneField } from './ImportDropzoneFile';
+import { useAlertsManager } from './AlertsManager';
 
 export function ImportDropzone() {
+  const { hideAlerts } = useAlertsManager();
+
   return (
     <Stack spacing={0}>
       <Field id={'file'} name={'file'} type="file">
         {({ form }) => (
           <ImportDropzoneField
             value={form.file}
             onChange={(file) => {
+              hideAlerts();
               form.setFieldValue('file', file);
             }}
           />

packages/webapp/src/containers/Import/ImportFileUploadForm.tsx

@@ -5,7 +5,8 @@ import { Intent } from '@blueprintjs/core';
 import { Formik, Form, FormikHelpers } from 'formik';
 import * as Yup from 'yup';
 import { useImportFileContext } from './ImportFileProvider';
-import { ImportStepperStep } from './_types';
+import { ImportAlert, ImportStepperStep } from './_types';
+import { useAlertsManager } from './AlertsManager';
 
 const initialValues = {
   file: null,
@@ -28,6 +29,7 @@ export function ImportFileUploadForm({
   formikProps,
   formProps,
 }: ImportFileUploadFormProps) {
+  const { showAlert, hideAlerts } = useAlertsManager();
   const { mutateAsync: uploadImportFile } = useImportFileUpload();
   const {
     resource,
@@ -42,6 +44,7 @@ export function ImportFileUploadForm({
     values: ImportFileUploadValues,
     { setSubmitting }: FormikHelpers<ImportFileUploadValues>,
   ) => {
+    hideAlerts();
     if (!values.file) return;
 
     setSubmitting(true);
@@ -69,6 +72,9 @@ export function ImportFileUploadForm({
             message: 'The extenstion of uploaded file is not supported.',
           });
         }
+        if (data.errors.find((er) => er.type === 'IMPORTED_SHEET_EMPTY')) {
+          showAlert(ImportAlert.IMPORTED_SHEET_EMPTY);
+        }
         setSubmitting(false);
       });
   };

packages/webapp/src/containers/Import/ImportFileUploadStep.tsx

@@ -1,35 +1,56 @@
 // @ts-nocheck
-import { Classes } from '@blueprintjs/core';
+import { Callout, Classes, Intent } from '@blueprintjs/core';
 import { Stack } from '@/components';
 import { ImportDropzone } from './ImportDropzone';
 import { ImportSampleDownload } from './ImportSampleDownload';
 import { ImportFileUploadForm } from './ImportFileUploadForm';
 import { ImportFileUploadFooterActions } from './ImportFileFooterActions';
 import { ImportFileContainer } from './ImportFileContainer';
 import { useImportFileContext } from './ImportFileProvider';
+import { AlertsManager, useAlertsManager } from './AlertsManager';
+import { ImportAlert } from './_types';
+
+function ImportFileUploadCallouts() {
+  const { isAlertActive } = useAlertsManager();
+  return (
+    <>
+      {isAlertActive(ImportAlert.IMPORTED_SHEET_EMPTY) && (
+        <Callout intent={Intent.DANGER} icon={null}>
+          The imported sheet is empty.
+        </Callout>
+      )}
+    </>
+  );
+}
 
 export function ImportFileUploadStep() {
   const { exampleDownload } = useImportFileContext();
 
   return (
-    <ImportFileUploadForm>
-      <ImportFileContainer>
-        <p
-          className={Classes.TEXT_MUTED}
-          style={{ marginBottom: 18, lineHeight: 1.6 }}
-        >
-          Download a sample file and compare it with your import file to ensure
-          it is properly formatted. It's not necessary for the columns to be in
-          the same order, you can map them later.
-        </p>
+    <AlertsManager>
+      <ImportFileUploadForm>
+        <ImportFileContainer>
+          <p
+            className={Classes.TEXT_MUTED}
+            style={{ marginBottom: 18, lineHeight: 1.6 }}
+          >
+            Download a sample file and compare it with your import file to
+            ensure it is properly formatted. It's not necessary for the columns
+            to be in the same order, you can map them later.
+          </p>
+
+          <Stack>
+            <ImportFileUploadCallouts />
 
-        <Stack spacing={40}>
-          <ImportDropzone />
-          {exampleDownload && <ImportSampleDownload />}
-        </Stack>
-      </ImportFileContainer>
+            <Stack spacing={40}>
+              <ImportDropzone />
+              {exampleDownload && <ImportSampleDownload />}
+            </Stack>
+          </Stack>
+        </ImportFileContainer>
 
-      <ImportFileUploadFooterActions />
-    </ImportFileUploadForm>
+        <ImportFileUploadFooterActions />
+      </ImportFileUploadForm>
+    </AlertsManager>
   );
 }

packages/webapp/src/containers/Import/_types.ts

@@ -3,3 +3,7 @@ export enum ImportStepperStep {
   Mapping = 1,
   Preview = 2,
 }
+
+export enum ImportAlert {
+  IMPORTED_SHEET_EMPTY = 'IMPORTED_SHEET_EMPTY'
+}