From cd6775da325eac6b5d0a45594af85ccde870c5c5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?F=C3=A9lix=20Malfait?= <felix.malfait@gmail.com>
Date: Wed, 26 Jun 2024 15:37:37 +0200
Subject: [PATCH] Don't display unmatched columns in csv import (#6037)

Adding a toggle so that, by default, we don't see dozens of fields but
only the field we matched, during the data validation step in csv export

<img width="785" alt="Screenshot 2024-06-26 at 13 25 36"
src="https://github.com/twentyhq/twenty/assets/6399865/ae558eb5-7461-4bc8-a836-ecff8b6d0dff">
---
 .../steps/components/UploadFlow.tsx           |  5 +-
 .../ValidationStep/ValidationStep.tsx         | 35 +++++++++-
 .../__stories__/Validation.stories.tsx        |  2 +
 .../spreadsheet-import/tests/mockRsiValues.ts | 28 ++++++++
 .../twenty-front/src/testing/graphqlMocks.ts  | 67 ++++++++++---------
 5 files changed, 102 insertions(+), 35 deletions(-)

diff --git a/packages/twenty-front/src/modules/spreadsheet-import/steps/components/UploadFlow.tsx b/packages/twenty-front/src/modules/spreadsheet-import/steps/components/UploadFlow.tsx
index 7e79ed33f..052082fe2 100644
--- a/packages/twenty-front/src/modules/spreadsheet-import/steps/components/UploadFlow.tsx
+++ b/packages/twenty-front/src/modules/spreadsheet-import/steps/components/UploadFlow.tsx
@@ -12,7 +12,7 @@ import { SnackBarVariant } from '@/ui/feedback/snack-bar-manager/components/Snac
 import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar';
 import { Modal } from '@/ui/layout/modal/components/Modal';
 
-import { MatchColumnsStep } from './MatchColumnsStep/MatchColumnsStep';
+import { Columns, MatchColumnsStep } from './MatchColumnsStep/MatchColumnsStep';
 import { SelectHeaderStep } from './SelectHeaderStep/SelectHeaderStep';
 import { SelectSheetStep } from './SelectSheetStep/SelectSheetStep';
 import { UploadStep } from './UploadStep/UploadStep';
@@ -52,6 +52,7 @@ export type StepState =
   | {
       type: StepType.validateData;
       data: any[];
+      importedColumns: Columns<string>;
     }
   | {
       type: StepType.loading;
@@ -216,6 +217,7 @@ export const UploadFlow = ({ nextStep, prevStep }: UploadFlowProps) => {
               setState({
                 type: StepType.validateData,
                 data,
+                importedColumns: columns,
               });
               setPreviousState(state);
               nextStep();
@@ -233,6 +235,7 @@ export const UploadFlow = ({ nextStep, prevStep }: UploadFlowProps) => {
       return (
         <ValidationStep
           initialData={state.data}
+          importedColumns={state.importedColumns}
           file={uploadedFile}
           onSubmitStart={() =>
             setState({
diff --git a/packages/twenty-front/src/modules/spreadsheet-import/steps/components/ValidationStep/ValidationStep.tsx b/packages/twenty-front/src/modules/spreadsheet-import/steps/components/ValidationStep/ValidationStep.tsx
index e9b6ebe8b..35430fcce 100644
--- a/packages/twenty-front/src/modules/spreadsheet-import/steps/components/ValidationStep/ValidationStep.tsx
+++ b/packages/twenty-front/src/modules/spreadsheet-import/steps/components/ValidationStep/ValidationStep.tsx
@@ -8,6 +8,10 @@ import { Heading } from '@/spreadsheet-import/components/Heading';
 import { StepNavigationButton } from '@/spreadsheet-import/components/StepNavigationButton';
 import { Table } from '@/spreadsheet-import/components/Table';
 import { useSpreadsheetImportInternal } from '@/spreadsheet-import/hooks/useSpreadsheetImportInternal';
+import {
+  Columns,
+  ColumnType,
+} from '@/spreadsheet-import/steps/components/MatchColumnsStep/MatchColumnsStep';
 import { Data } from '@/spreadsheet-import/types';
 import { addErrorsAndRunHooks } from '@/spreadsheet-import/utils/dataMutations';
 import { useDialogManager } from '@/ui/feedback/dialog-manager/hooks/useDialogManager';
@@ -62,6 +66,7 @@ const StyledNoRowsContainer = styled.div`
 
 type ValidationStepProps<T extends string> = {
   initialData: Data<T>[];
+  importedColumns: Columns<string>;
   file: File;
   onSubmitStart?: () => void;
   onBack: () => void;
@@ -69,6 +74,7 @@ type ValidationStepProps<T extends string> = {
 
 export const ValidationStep = <T extends string>({
   initialData,
+  importedColumns,
   file,
   onSubmitStart,
   onBack,
@@ -88,6 +94,7 @@ export const ValidationStep = <T extends string>({
     ReadonlySet<number | string>
   >(new Set());
   const [filterByErrors, setFilterByErrors] = useState(false);
+  const [showUnmatchedColumns, setShowUnmatchedColumns] = useState(false);
 
   const updateData = useCallback(
     (rows: typeof data) => {
@@ -127,7 +134,24 @@ export const ValidationStep = <T extends string>({
     [data, updateData],
   );
 
-  const columns = useMemo(() => generateColumns(fields), [fields]);
+  const columns = useMemo(
+    () =>
+      generateColumns(fields)
+        .map((column) => {
+          const hasBeenImported =
+            importedColumns.filter(
+              (importColumn) =>
+                (importColumn.type === ColumnType.matched &&
+                  importColumn.value === column.key) ||
+                column.key === 'select-row',
+            ).length > 0;
+
+          if (!hasBeenImported && !showUnmatchedColumns) return null;
+          return column;
+        })
+        .filter(Boolean),
+    [fields, importedColumns, showUnmatchedColumns],
+  );
 
   const tableData = useMemo(() => {
     if (filterByErrors) {
@@ -212,6 +236,15 @@ export const ValidationStep = <T extends string>({
               Show only rows with errors
             </StyledErrorToggleDescription>
           </StyledErrorToggle>
+          <StyledErrorToggle>
+            <Toggle
+              value={showUnmatchedColumns}
+              onChange={() => setShowUnmatchedColumns(!showUnmatchedColumns)}
+            />
+            <StyledErrorToggleDescription>
+              Show unmatched columns
+            </StyledErrorToggleDescription>
+          </StyledErrorToggle>
           <Button
             Icon={IconTrash}
             title="Remove"
diff --git a/packages/twenty-front/src/modules/spreadsheet-import/steps/components/__stories__/Validation.stories.tsx b/packages/twenty-front/src/modules/spreadsheet-import/steps/components/__stories__/Validation.stories.tsx
index e2d79644a..1a5adabc0 100644
--- a/packages/twenty-front/src/modules/spreadsheet-import/steps/components/__stories__/Validation.stories.tsx
+++ b/packages/twenty-front/src/modules/spreadsheet-import/steps/components/__stories__/Validation.stories.tsx
@@ -5,6 +5,7 @@ import { Providers } from '@/spreadsheet-import/components/Providers';
 import { ValidationStep } from '@/spreadsheet-import/steps/components/ValidationStep/ValidationStep';
 import {
   editableTableInitialData,
+  importedColums,
   mockRsiValues,
 } from '@/spreadsheet-import/tests/mockRsiValues';
 import { DialogManagerScope } from '@/ui/feedback/dialog-manager/scopes/DialogManagerScope';
@@ -28,6 +29,7 @@ export const Default = () => (
         <ValidationStep
           initialData={editableTableInitialData}
           file={file}
+          importedColumns={importedColums}
           onBack={() => Promise.resolve()}
         />
       </ModalWrapper>
diff --git a/packages/twenty-front/src/modules/spreadsheet-import/tests/mockRsiValues.ts b/packages/twenty-front/src/modules/spreadsheet-import/tests/mockRsiValues.ts
index 814dae7a2..27dc64dab 100644
--- a/packages/twenty-front/src/modules/spreadsheet-import/tests/mockRsiValues.ts
+++ b/packages/twenty-front/src/modules/spreadsheet-import/tests/mockRsiValues.ts
@@ -1,4 +1,5 @@
 import { defaultSpreadsheetImportProps } from '@/spreadsheet-import/provider/components/SpreadsheetImport';
+import { Columns } from '@/spreadsheet-import/steps/components/MatchColumnsStep/MatchColumnsStep';
 import { Fields, SpreadsheetOptions } from '@/spreadsheet-import/types';
 import { sleep } from '~/utils/sleep';
 
@@ -88,6 +89,33 @@ const fields = [
   },
 ] as Fields<string>;
 
+export const importedColums: Columns<string> = [
+  {
+    header: 'Name',
+    index: 0,
+    type: 2,
+    value: 'name',
+  },
+  {
+    header: 'Surname',
+    index: 1,
+    type: 2,
+    value: 'surname',
+  },
+  {
+    header: 'Age',
+    index: 2,
+    type: 2,
+    value: 'age',
+  },
+  {
+    header: 'Team',
+    index: 3,
+    type: 2,
+    value: 'team',
+  },
+];
+
 const mockComponentBehaviourForTypes = <T extends string>(
   props: SpreadsheetOptions<T>,
 ) => props;
diff --git a/packages/twenty-front/src/testing/graphqlMocks.ts b/packages/twenty-front/src/testing/graphqlMocks.ts
index c55061831..5df3fe581 100644
--- a/packages/twenty-front/src/testing/graphqlMocks.ts
+++ b/packages/twenty-front/src/testing/graphqlMocks.ts
@@ -157,43 +157,44 @@ export const graphqlMocks = {
     graphql.query('FindDuplicateCompany', () => {
       return HttpResponse.json({
         data: {
-          companyDuplicates: {
-            edges: [
-              {
-                node: {
-                  ...duplicateCompanyMock,
-                  favorites: {
-                    edges: [],
-                    __typename: 'FavoriteConnection',
-                  },
-                  attachments: {
-                    edges: [],
-                    __typename: 'AttachmentConnection',
-                  },
-                  people: {
-                    edges: [],
-                    __typename: 'PersonConnection',
-                  },
-                  opportunities: {
-                    edges: [],
-                    __typename: 'OpportunityConnection',
-                  },
-                  activityTargets: {
-                    edges: [],
-                    __typename: 'ActivityTargetConnection',
+          companyDuplicates: [
+            {
+              edges: [
+                {
+                  node: {
+                    ...duplicateCompanyMock,
+                    favorites: {
+                      edges: [],
+                      __typename: 'FavoriteConnection',
+                    },
+                    attachments: {
+                      edges: [],
+                      __typename: 'AttachmentConnection',
+                    },
+                    people: {
+                      edges: [],
+                      __typename: 'PersonConnection',
+                    },
+                    opportunities: {
+                      edges: [],
+                      __typename: 'OpportunityConnection',
+                    },
+                    activityTargets: {
+                      edges: [],
+                      __typename: 'ActivityTargetConnection',
+                    },
                   },
+                  cursor: null,
                 },
-                cursor: null,
+              ],
+              pageInfo: {
+                hasNextPage: false,
+                hasPreviousPage: false,
+                startCursor: null,
+                endCursor: null,
               },
-            ],
-            pageInfo: {
-              hasNextPage: false,
-              hasPreviousPage: false,
-              startCursor: null,
-              endCursor: null,
             },
-            totalCount: 1,
-          },
+          ],
         },
       });
     }),