NEOS-1254: update onboarding flow (#2352)

nucleuscloud · Oct 1, 2024 · 682a920 · 682a920
1 parent a6ff70a
commit 682a920
Show file tree

Hide file tree

Showing 41 changed files with 1,675 additions and 1,246 deletions.
diff --git a/backend/gen/go/protos/mgmt/v1alpha1/user_account.pb.go b/backend/gen/go/protos/mgmt/v1alpha1/user_account.pb.go
diff --git a/backend/protos/mgmt/v1alpha1/user_account.proto b/backend/protos/mgmt/v1alpha1/user_account.proto
@@ -186,10 +186,15 @@ message SetAccountOnboardingConfigResponse {
 }
 
 message AccountOnboardingConfig {
+  // @deprecated - use has_completed_onboarding
   bool has_created_source_connection = 1;
+  // @deprecated - use has_completed_onboarding
   bool has_created_destination_connection = 2;
+  // @deprecated - use has_completed_onboarding
   bool has_created_job = 3;
+  // @deprecated - use has_completed_onboarding
   bool has_invited_members = 4;
+  bool has_completed_onboarding = 5;
 }
 
 message GetAccountStatusRequest {

diff --git a/backend/services/mgmt/v1alpha1/integration_tests/user-account-service_integration_test.go b/backend/services/mgmt/v1alpha1/integration_tests/user-account-service_integration_test.go
@@ -36,10 +36,7 @@ func (s *IntegrationTestSuite) Test_UserAccountService_GetAccountOnboardingConfi
 	onboardingConfig := resp.Msg.GetConfig()
 	require.NotNil(s.T(), onboardingConfig)
 
-	require.False(s.T(), onboardingConfig.GetHasCreatedSourceConnection())
-	require.False(s.T(), onboardingConfig.GetHasCreatedDestinationConnection())
-	require.False(s.T(), onboardingConfig.GetHasCreatedJob())
-	require.False(s.T(), onboardingConfig.GetHasInvitedMembers())
+	require.False(s.T(), onboardingConfig.GetHasCompletedOnboarding())
 }
 
 func (s *IntegrationTestSuite) Test_UserAccountService_GetAccountOnboardingConfig_NoAccount() {
@@ -62,32 +59,23 @@ func (s *IntegrationTestSuite) Test_UserAccountService_SetAccountOnboardingConfi
 	onboardingConfig := resp.Msg.GetConfig()
 	require.NotNil(s.T(), onboardingConfig)
 
-	require.False(s.T(), onboardingConfig.GetHasCreatedSourceConnection())
-	require.False(s.T(), onboardingConfig.GetHasCreatedDestinationConnection())
-	require.False(s.T(), onboardingConfig.GetHasCreatedJob())
-	require.False(s.T(), onboardingConfig.GetHasInvitedMembers())
+	require.False(s.T(), onboardingConfig.GetHasCompletedOnboarding())
 }
 
 func (s *IntegrationTestSuite) Test_UserAccountService_SetAccountOnboardingConfig() {
 	accountId := s.createPersonalAccount(s.ctx, s.unauthdClients.users)
 
 	resp, err := s.unauthdClients.users.SetAccountOnboardingConfig(s.ctx, connect.NewRequest(&mgmtv1alpha1.SetAccountOnboardingConfigRequest{
 		AccountId: accountId, Config: &mgmtv1alpha1.AccountOnboardingConfig{
-			HasCreatedSourceConnection:      true,
-			HasCreatedDestinationConnection: true,
-			HasCreatedJob:                   true,
-			HasInvitedMembers:               true,
+			HasCompletedOnboarding: true,
 		}},
 	))
 	requireNoErrResp(s.T(), resp, err)
 
 	onboardingConfig := resp.Msg.GetConfig()
 	require.NotNil(s.T(), onboardingConfig)
 
-	require.True(s.T(), onboardingConfig.GetHasCreatedSourceConnection())
-	require.True(s.T(), onboardingConfig.GetHasCreatedDestinationConnection())
-	require.True(s.T(), onboardingConfig.GetHasCreatedJob())
-	require.True(s.T(), onboardingConfig.GetHasInvitedMembers())
+	require.True(s.T(), onboardingConfig.GetHasCompletedOnboarding())
 }
 
 var (

diff --git a/backend/sql/postgresql/models/models.go b/backend/sql/postgresql/models/models.go
@@ -1776,24 +1776,15 @@ func (r *RetryPolicy) FromDto(dto *mgmtv1alpha1.RetryPolicy) {
 }
 
 type AccountOnboardingConfig struct {
-	HasCreatedSourceConnection      bool `json:"hasCreatedSourceConnection"`
-	HasCreatedDestinationConnection bool `json:"hasCreatedDestinationConnection"`
-	HasCreatedJob                   bool `json:"hasCreatedJob"`
-	HasInvitedMembers               bool `json:"hasInvitedMembers"`
+	HasCompletedOnboarding bool `json:"hasCompletedOnboarding"`
 }
 
 func (t *AccountOnboardingConfig) ToDto() *mgmtv1alpha1.AccountOnboardingConfig {
 	return &mgmtv1alpha1.AccountOnboardingConfig{
-		HasCreatedSourceConnection:      t.HasCreatedSourceConnection,
-		HasCreatedDestinationConnection: t.HasCreatedDestinationConnection,
-		HasCreatedJob:                   t.HasCreatedJob,
-		HasInvitedMembers:               t.HasInvitedMembers,
+		HasCompletedOnboarding: t.HasCompletedOnboarding,
 	}
 }
 
 func (t *AccountOnboardingConfig) FromDto(dto *mgmtv1alpha1.AccountOnboardingConfig) {
-	t.HasCreatedSourceConnection = dto.GetHasCreatedSourceConnection()
-	t.HasCreatedDestinationConnection = dto.GetHasCreatedDestinationConnection()
-	t.HasCreatedJob = dto.GetHasCreatedJob()
-	t.HasInvitedMembers = dto.GetHasInvitedMembers()
+	t.HasCompletedOnboarding = dto.GetHasCompletedOnboarding()
 }
diff --git a/docs/protos/data/proto_docs.json b/docs/protos/data/proto_docs.json
@@ -13757,7 +13757,7 @@
           "fields": [
             {
               "name": "has_created_source_connection",
-              "description": "",
+              "description": "@deprecated - use has_completed_onboarding",
               "label": "",
               "type": "bool",
               "longType": "bool",
@@ -13769,7 +13769,7 @@
             },
             {
               "name": "has_created_destination_connection",
-              "description": "",
+              "description": "@deprecated - use has_completed_onboarding",
               "label": "",
               "type": "bool",
               "longType": "bool",
@@ -13781,7 +13781,7 @@
             },
             {
               "name": "has_created_job",
-              "description": "",
+              "description": "@deprecated - use has_completed_onboarding",
               "label": "",
               "type": "bool",
               "longType": "bool",
@@ -13793,6 +13793,18 @@
             },
             {
               "name": "has_invited_members",
+              "description": "@deprecated - use has_completed_onboarding",
+              "label": "",
+              "type": "bool",
+              "longType": "bool",
+              "fullType": "bool",
+              "ismap": false,
+              "isoneof": false,
+              "oneofdecl": "",
+              "defaultValue": ""
+            },
+            {
+              "name": "has_completed_onboarding",
               "description": "",
               "label": "",
               "type": "bool",

diff --git a/frontend/apps/web/app/(mgmt)/[account]/new/connection/aws-s3/AwsS3Form.tsx b/frontend/apps/web/app/(mgmt)/[account]/new/connection/aws-s3/AwsS3Form.tsx
@@ -3,7 +3,6 @@ import ButtonText from '@/components/ButtonText';
 import { PasswordInput } from '@/components/PasswordComponent';
 import Spinner from '@/components/Spinner';
 import RequiredLabel from '@/components/labels/RequiredLabel';
-import { buildAccountOnboardingConfig } from '@/components/onboarding-checklist/OnboardingChecklist';
 import { useAccount } from '@/components/providers/account-provider';
 import SkeletonForm from '@/components/skeleton/SkeletonForm';
 import SwitchCard from '@/components/switches/SwitchCard';
@@ -25,22 +24,13 @@ import {
   AWS_FORM_SCHEMA,
   CreateConnectionFormContext,
 } from '@/yup-validations/connections';
-import {
-  createConnectQueryKey,
-  useMutation,
-  useQuery,
-} from '@connectrpc/connect-query';
+import { createConnectQueryKey, useMutation } from '@connectrpc/connect-query';
 import { yupResolver } from '@hookform/resolvers/yup';
-import {
-  GetAccountOnboardingConfigResponse,
-  GetConnectionResponse,
-} from '@neosync/sdk';
+import { GetConnectionResponse } from '@neosync/sdk';
 import {
   createConnection,
-  getAccountOnboardingConfig,
   getConnection,
   isConnectionNameAvailable,
-  setAccountOnboardingConfig,
 } from '@neosync/sdk/connectquery';
 import { useQueryClient } from '@tanstack/react-query';
 import { useRouter, useSearchParams } from 'next/navigation';
@@ -55,16 +45,7 @@ export default function AwsS3Form() {
   const { account } = useAccount();
   const sourceConnId = searchParams.get('sourceId');
   const [isLoading, setIsLoading] = useState<boolean>();
-
-  const { data: onboardingData } = useQuery(
-    getAccountOnboardingConfig,
-    { accountId: account?.id ?? '' },
-    { enabled: !!account?.id }
-  );
   const queryclient = useQueryClient();
-  const { mutateAsync: setOnboardingConfigAsync } = useMutation(
-    setAccountOnboardingConfig
-  );
   const { mutateAsync: isConnectionNameAvailableAsync } = useMutation(
     isConnectionNameAvailable
   );
@@ -96,63 +77,6 @@ export default function AwsS3Form() {
         connectionConfig: buildConnectionConfigAwsS3(values),
       });
 
-      // updates the onboarding data
-      if (
-        onboardingData?.config?.hasCreatedSourceConnection &&
-        !onboardingData?.config.hasCreatedDestinationConnection
-      ) {
-        try {
-          const resp = await setOnboardingConfigAsync({
-            accountId: account.id,
-            config: buildAccountOnboardingConfig({
-              hasCreatedSourceConnection:
-                onboardingData.config.hasCreatedSourceConnection,
-              hasCreatedDestinationConnection: true,
-              hasCreatedJob: onboardingData.config.hasCreatedJob,
-              hasInvitedMembers: onboardingData.config.hasInvitedMembers,
-            }),
-          });
-          queryclient.setQueryData(
-            createConnectQueryKey(getAccountOnboardingConfig, {
-              accountId: account.id,
-            }),
-            new GetAccountOnboardingConfigResponse({
-              config: resp.config,
-            })
-          );
-        } catch (e) {
-          toast.error('Unable to update onboarding status!', {
-            description: getErrorMessage(e),
-          });
-        }
-      } else {
-        try {
-          const resp = await setOnboardingConfigAsync({
-            accountId: account.id,
-            config: buildAccountOnboardingConfig({
-              hasCreatedSourceConnection: true,
-              hasCreatedDestinationConnection:
-                onboardingData?.config?.hasCreatedSourceConnection ?? true,
-              hasCreatedJob: onboardingData?.config?.hasCreatedJob ?? true,
-              hasInvitedMembers:
-                onboardingData?.config?.hasInvitedMembers ?? true,
-            }),
-          });
-          queryclient.setQueryData(
-            createConnectQueryKey(getAccountOnboardingConfig, {
-              accountId: account.id,
-            }),
-            new GetAccountOnboardingConfigResponse({
-              config: resp.config,
-            })
-          );
-        } catch (e) {
-          toast.error('Unable to update onboarding status!', {
-            description: getErrorMessage(e),
-          });
-        }
-      }
-
       const returnTo = searchParams.get('returnTo');
       if (returnTo) {
         router.push(returnTo);

diff --git a/frontend/apps/web/app/(mgmt)/[account]/new/connection/dynamodb/DynamoDBForm.tsx b/frontend/apps/web/app/(mgmt)/[account]/new/connection/dynamodb/DynamoDBForm.tsx
@@ -3,7 +3,6 @@ import ButtonText from '@/components/ButtonText';
 import { PasswordInput } from '@/components/PasswordComponent';
 import Spinner from '@/components/Spinner';
 import RequiredLabel from '@/components/labels/RequiredLabel';
-import { buildAccountOnboardingConfig } from '@/components/onboarding-checklist/OnboardingChecklist';
 import PermissionsDialog from '@/components/permissions/PermissionsDialog';
 import { useAccount } from '@/components/providers/account-provider';
 import SkeletonForm from '@/components/skeleton/SkeletonForm';
@@ -32,24 +31,17 @@ import {
   CreateConnectionFormContext,
   DynamoDbFormValues,
 } from '@/yup-validations/connections';
-import {
-  createConnectQueryKey,
-  useMutation,
-  useQuery,
-} from '@connectrpc/connect-query';
+import { createConnectQueryKey, useMutation } from '@connectrpc/connect-query';
 import { yupResolver } from '@hookform/resolvers/yup';
 import {
   CheckConnectionConfigResponse,
-  GetAccountOnboardingConfigResponse,
   GetConnectionResponse,
 } from '@neosync/sdk';
 import {
   checkConnectionConfig,
   createConnection,
-  getAccountOnboardingConfig,
   getConnection,
   isConnectionNameAvailable,
-  setAccountOnboardingConfig,
 } from '@neosync/sdk/connectquery';
 import { ExclamationTriangleIcon } from '@radix-ui/react-icons';
 import { useQueryClient } from '@tanstack/react-query';
@@ -66,15 +58,7 @@ export default function NewDynamoDBForm(): ReactElement {
   const { data: systemAppConfig } = useGetSystemAppConfig();
   const sourceConnId = searchParams.get('sourceId');
   const [isLoading, setIsLoading] = useState<boolean>();
-  const { data: onboardingData } = useQuery(
-    getAccountOnboardingConfig,
-    { accountId: account?.id ?? '' },
-    { enabled: !!account?.id }
-  );
   const queryclient = useQueryClient();
-  const { mutateAsync: setOnboardingConfigAsync } = useMutation(
-    setAccountOnboardingConfig
-  );
   const { mutateAsync: isConnectionNameAvailableAsync } = useMutation(
     isConnectionNameAvailable
   );
@@ -178,36 +162,6 @@ export default function NewDynamoDBForm(): ReactElement {
       posthog.capture('New Connection Created', { type: 'dynamodb' });
       toast.success('Successfully created connection!');
 
-      // updates the onboarding data
-      try {
-        const resp = await setOnboardingConfigAsync({
-          accountId: account.id,
-          config: buildAccountOnboardingConfig({
-            hasCreatedSourceConnection:
-              onboardingData?.config?.hasCreatedSourceConnection ?? true,
-            hasCreatedDestinationConnection:
-              onboardingData?.config?.hasCreatedDestinationConnection ??
-              onboardingData?.config?.hasCreatedSourceConnection ??
-              false,
-            hasCreatedJob: onboardingData?.config?.hasCreatedJob ?? false,
-            hasInvitedMembers:
-              onboardingData?.config?.hasInvitedMembers ?? false,
-          }),
-        });
-        queryclient.setQueryData(
-          createConnectQueryKey(getAccountOnboardingConfig, {
-            accountId: account.id,
-          }),
-          new GetAccountOnboardingConfigResponse({
-            config: resp.config,
-          })
-        );
-      } catch (e) {
-        toast.error('Unable to update onboarding status!', {
-          description: getErrorMessage(e),
-        });
-      }
-
       const returnTo = searchParams.get('returnTo');
       if (returnTo) {
         router.push(returnTo);