5622 add a syncemail onboarding step (#5689)

- add sync email onboarding step
- refactor calendar and email visibility enums
- add a new table `keyValuePair` in `core` schema
- add a new resolved boolean field `skipSyncEmail` in current user




https://github.com/twentyhq/twenty/assets/29927851/de791475-5bfe-47f9-8e90-76c349fba56f

packages/twenty-front/src/modules/auth/hooks/__test__/useOnboardingStatus.test.ts

@@ -3,6 +3,7 @@ import { renderHook } from '@testing-library/react';
 import { RecoilRoot, useSetRecoilState } from 'recoil';
 
 import { useOnboardingStatus } from '@/auth/hooks/useOnboardingStatus';
+import { CurrentUser, currentUserState } from '@/auth/states/currentUserState';
 import { currentWorkspaceMemberState } from '@/auth/states/currentWorkspaceMemberState';
 import {
   CurrentWorkspace,
@@ -20,6 +21,13 @@ const billing = {
   billingUrl: 'testing.com',
   isBillingEnabled: true,
 };
+const currentUser = {
+  id: '1',
+  email: 'test@test',
+  supportUserHash: '1',
+  canImpersonate: false,
+  state: { skipSyncEmailOnboardingStep: true },
+} as CurrentUser;
 const currentWorkspace = {
   activationStatus: 'active',
   id: '1',
@@ -27,7 +35,7 @@ const currentWorkspace = {
   currentBillingSubscription: {
     status: 'trialing',
   },
-};
+} as CurrentWorkspace;
 const currentWorkspaceMember = {
   id: '1',
   locale: '',
@@ -46,12 +54,14 @@ const renderHooks = () => {
       const setCurrentWorkspaceMember = useSetRecoilState(
         currentWorkspaceMemberState,
       );
+      const setCurrentUser = useSetRecoilState(currentUserState);
       const setTokenPair = useSetRecoilState(tokenPairState);
       const setVerifyPending = useSetRecoilState(isVerifyPendingState);
 
       return {
         onboardingStatus,
         setBilling,
+        setCurrentUser,
         setCurrentWorkspace,
         setCurrentWorkspaceMember,
         setTokenPair,
@@ -77,6 +87,7 @@ describe('useOnboardingStatus', () => {
     const {
       setTokenPair,
       setBilling,
+      setCurrentUser,
       setCurrentWorkspace,
       setCurrentWorkspaceMember,
     } = result.current;
@@ -84,10 +95,11 @@ describe('useOnboardingStatus', () => {
     act(() => {
       setTokenPair(tokenPair);
       setBilling(billing);
+      setCurrentUser(currentUser);
       setCurrentWorkspace({
         ...currentWorkspace,
         subscriptionStatus: 'incomplete',
-      } as CurrentWorkspace);
+      });
       setCurrentWorkspaceMember(currentWorkspaceMember);
     });
 
@@ -99,6 +111,7 @@ describe('useOnboardingStatus', () => {
     const {
       setTokenPair,
       setBilling,
+      setCurrentUser,
       setCurrentWorkspace,
       setCurrentWorkspaceMember,
     } = result.current;
@@ -106,10 +119,11 @@ describe('useOnboardingStatus', () => {
     act(() => {
       setTokenPair(tokenPair);
       setBilling(billing);
+      setCurrentUser(currentUser);
       setCurrentWorkspace({
         ...currentWorkspace,
         subscriptionStatus: 'canceled',
-      } as CurrentWorkspace);
+      });
       setCurrentWorkspaceMember({
         ...currentWorkspaceMember,
         name: {
@@ -124,16 +138,18 @@ describe('useOnboardingStatus', () => {
 
   it('should return "ongoing_workspace_activation"', async () => {
     const { result } = renderHooks();
-    const { setTokenPair, setBilling, setCurrentWorkspace } = result.current;
+    const { setTokenPair, setBilling, setCurrentUser, setCurrentWorkspace } =
+      result.current;
 
     act(() => {
       setTokenPair(tokenPair);
       setBilling(billing);
+      setCurrentUser(currentUser);
       setCurrentWorkspace({
         ...currentWorkspace,
         activationStatus: 'inactive',
         subscriptionStatus: 'active',
-      } as CurrentWorkspace);
+      });
     });
 
     expect(result.current.onboardingStatus).toBe(
@@ -146,6 +162,7 @@ describe('useOnboardingStatus', () => {
     const {
       setTokenPair,
       setBilling,
+      setCurrentUser,
       setCurrentWorkspace,
       setCurrentWorkspaceMember,
     } = result.current;
@@ -153,21 +170,56 @@ describe('useOnboardingStatus', () => {
     act(() => {
       setTokenPair(tokenPair);
       setBilling(billing);
+      setCurrentUser(currentUser);
       setCurrentWorkspace({
         ...currentWorkspace,
         subscriptionStatus: 'active',
-      } as CurrentWorkspace);
+      });
       setCurrentWorkspaceMember(currentWorkspaceMember);
     });
 
     expect(result.current.onboardingStatus).toBe('ongoing_profile_creation');
   });
 
+  it('should return "ongoing_sync_email"', async () => {
+    const { result } = renderHooks();
+    const {
+      setTokenPair,
+      setBilling,
+      setCurrentUser,
+      setCurrentWorkspace,
+      setCurrentWorkspaceMember,
+    } = result.current;
+
+    act(() => {
+      setTokenPair(tokenPair);
+      setBilling(billing);
+      setCurrentUser({
+        ...currentUser,
+        state: { skipSyncEmailOnboardingStep: false },
+      });
+      setCurrentWorkspace({
+        ...currentWorkspace,
+        subscriptionStatus: 'active',
+      });
+      setCurrentWorkspaceMember({
+        ...currentWorkspaceMember,
+        name: {
+          firstName: 'John',
+          lastName: 'Doe',
+        },
+      });
+    });
+
+    expect(result.current.onboardingStatus).toBe('ongoing_sync_email');
+  });
+
   it('should return "completed"', async () => {
     const { result } = renderHooks();
     const {
       setTokenPair,
       setBilling,
+      setCurrentUser,
       setCurrentWorkspace,
       setCurrentWorkspaceMember,
     } = result.current;
@@ -175,10 +227,11 @@ describe('useOnboardingStatus', () => {
     act(() => {
       setTokenPair(tokenPair);
       setBilling(billing);
+      setCurrentUser(currentUser);
       setCurrentWorkspace({
         ...currentWorkspace,
         subscriptionStatus: 'active',
-      } as CurrentWorkspace);
+      });
       setCurrentWorkspaceMember({
         ...currentWorkspaceMember,
         name: {
@@ -196,6 +249,7 @@ describe('useOnboardingStatus', () => {
     const {
       setTokenPair,
       setBilling,
+      setCurrentUser,
       setCurrentWorkspace,
       setCurrentWorkspaceMember,
     } = result.current;
@@ -203,10 +257,11 @@ describe('useOnboardingStatus', () => {
     act(() => {
       setTokenPair(tokenPair);
       setBilling(billing);
+      setCurrentUser(currentUser);
       setCurrentWorkspace({
         ...currentWorkspace,
         subscriptionStatus: 'past_due',
-      } as CurrentWorkspace);
+      });
       setCurrentWorkspaceMember({
         ...currentWorkspaceMember,
         name: {
@@ -224,6 +279,7 @@ describe('useOnboardingStatus', () => {
     const {
       setTokenPair,
       setBilling,
+      setCurrentUser,
       setCurrentWorkspace,
       setCurrentWorkspaceMember,
     } = result.current;
@@ -231,10 +287,11 @@ describe('useOnboardingStatus', () => {
     act(() => {
       setTokenPair(tokenPair);
       setBilling(billing);
+      setCurrentUser(currentUser);
       setCurrentWorkspace({
         ...currentWorkspace,
         subscriptionStatus: 'unpaid',
-      } as CurrentWorkspace);
+      });
       setCurrentWorkspaceMember({
         ...currentWorkspaceMember,
         name: {
@@ -252,6 +309,7 @@ describe('useOnboardingStatus', () => {
     const {
       setTokenPair,
       setBilling,
+      setCurrentUser,
       setCurrentWorkspace,
       setCurrentWorkspaceMember,
     } = result.current;
@@ -259,6 +317,7 @@ describe('useOnboardingStatus', () => {
     act(() => {
       setTokenPair(tokenPair);
       setBilling(billing);
+      setCurrentUser(currentUser);
       setCurrentWorkspace({
         ...currentWorkspace,
         subscriptionStatus: 'trialing',

packages/twenty-front/src/modules/auth/hooks/useOnboardingStatus.ts

@@ -1,5 +1,6 @@
 import { useRecoilValue } from 'recoil';
 
+import { currentUserState } from '@/auth/states/currentUserState';
 import { currentWorkspaceMemberState } from '@/auth/states/currentWorkspaceMemberState';
 import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
 import { billingState } from '@/client-config/states/billingState';
@@ -14,12 +15,14 @@ export const useOnboardingStatus = (): OnboardingStatus | undefined => {
   const billing = useRecoilValue(billingState);
   const currentWorkspaceMember = useRecoilValue(currentWorkspaceMemberState);
   const currentWorkspace = useRecoilValue(currentWorkspaceState);
+  const currentUser = useRecoilValue(currentUserState);
   const isLoggedIn = useIsLogged();
 
   return getOnboardingStatus({
     isLoggedIn,
     currentWorkspaceMember,
     currentWorkspace,
+    currentUser,
     isBillingEnabled: billing?.isBillingEnabled || false,
   });
 };