Fix error messages on sign up (#10399)

In this PR:
- adding logs to track workspace creation performance
- refactor useIsWorkspaceSuspended to be more generic
- only fetch favorites and views if workspace is Active to avoid error
messages on sign up (workspace is not created yet)
This commit is contained in:
Charles Bochet
2025-02-21 18:34:40 +01:00
committed by GitHub
parent 1ed9de2300
commit 2039986684
12 changed files with 138 additions and 38 deletions

View File

@ -2,7 +2,7 @@ import { useIsLogged } from '@/auth/hooks/useIsLogged';
import { useDefaultHomePagePath } from '@/navigation/hooks/useDefaultHomePagePath';
import { useOnboardingStatus } from '@/onboarding/hooks/useOnboardingStatus';
import { AppPath } from '@/types/AppPath';
import { useIsWorkspaceActivationStatusSuspended } from '@/workspace/hooks/useIsWorkspaceActivationStatusSuspended';
import { useIsWorkspaceActivationStatusEqualsTo } from '@/workspace/hooks/useIsWorkspaceActivationStatusEqualsTo';
import { useParams } from 'react-router-dom';
import { useRecoilValue } from 'recoil';
@ -19,12 +19,12 @@ const setupMockOnboardingStatus = (
jest.mocked(useOnboardingStatus).mockReturnValueOnce(onboardingStatus);
};
jest.mock('@/workspace/hooks/useIsWorkspaceActivationStatusSuspended');
const setupMockIsWorkspaceActivationStatusSuspended = (
jest.mock('@/workspace/hooks/useIsWorkspaceActivationStatusEqualsTo');
const setupMockIsWorkspaceActivationStatusEqualsTo = (
isWorkspaceSuspended: boolean,
) => {
jest
.mocked(useIsWorkspaceActivationStatusSuspended)
.mocked(useIsWorkspaceActivationStatusEqualsTo)
.mockReturnValueOnce(isWorkspaceSuspended);
};
@ -270,7 +270,7 @@ describe('usePageChangeEffectNavigateLocation', () => {
it(`with location ${testCase.loc} and onboardingStatus ${testCase.onboardingStatus} and isWorkspaceSuspended ${testCase.isWorkspaceSuspended} should return ${testCase.res}`, () => {
setupMockIsMatchingLocation(testCase.loc);
setupMockOnboardingStatus(testCase.onboardingStatus);
setupMockIsWorkspaceActivationStatusSuspended(
setupMockIsWorkspaceActivationStatusEqualsTo(
testCase.isWorkspaceSuspended,
);
setupMockIsLogged(testCase.isLoggedIn);

View File

@ -4,10 +4,10 @@ import { objectMetadataItemsState } from '@/object-metadata/states/objectMetadat
import { useOnboardingStatus } from '@/onboarding/hooks/useOnboardingStatus';
import { AppPath } from '@/types/AppPath';
import { SettingsPath } from '@/types/SettingsPath';
import { useIsWorkspaceActivationStatusSuspended } from '@/workspace/hooks/useIsWorkspaceActivationStatusSuspended';
import { useIsWorkspaceActivationStatusEqualsTo } from '@/workspace/hooks/useIsWorkspaceActivationStatusEqualsTo';
import { useParams } from 'react-router-dom';
import { useRecoilValue } from 'recoil';
import { isDefined } from 'twenty-shared';
import { WorkspaceActivationStatus, isDefined } from 'twenty-shared';
import { OnboardingStatus } from '~/generated/graphql';
import { useIsMatchingLocation } from '~/hooks/useIsMatchingLocation';
@ -15,7 +15,9 @@ export const usePageChangeEffectNavigateLocation = () => {
const { isMatchingLocation } = useIsMatchingLocation();
const isLoggedIn = useIsLogged();
const onboardingStatus = useOnboardingStatus();
const isWorkspaceSuspended = useIsWorkspaceActivationStatusSuspended();
const isWorkspaceSuspended = useIsWorkspaceActivationStatusEqualsTo(
WorkspaceActivationStatus.SUSPENDED,
);
const { defaultHomePagePath } = useDefaultHomePagePath();
const isMatchingOpenRoute =

View File

@ -3,10 +3,10 @@ import { InformationBannerFailPaymentInfo } from '@/information-banner/component
import { InformationBannerNoBillingSubscription } from '@/information-banner/components/billing/InformationBannerNoBillingSubscription';
import { InformationBannerReconnectAccountEmailAliases } from '@/information-banner/components/reconnect-account/InformationBannerReconnectAccountEmailAliases';
import { InformationBannerReconnectAccountInsufficientPermissions } from '@/information-banner/components/reconnect-account/InformationBannerReconnectAccountInsufficientPermissions';
import { useIsWorkspaceActivationStatusSuspended } from '@/workspace/hooks/useIsWorkspaceActivationStatusSuspended';
import { useIsWorkspaceActivationStatusEqualsTo } from '@/workspace/hooks/useIsWorkspaceActivationStatusEqualsTo';
import { useSubscriptionStatus } from '@/workspace/hooks/useSubscriptionStatus';
import styled from '@emotion/styled';
import { isDefined } from 'twenty-shared';
import { WorkspaceActivationStatus, isDefined } from 'twenty-shared';
import { SubscriptionStatus } from '~/generated-metadata/graphql';
const StyledInformationBannerWrapper = styled.div`
@ -20,7 +20,9 @@ const StyledInformationBannerWrapper = styled.div`
export const InformationBannerWrapper = () => {
const subscriptionStatus = useSubscriptionStatus();
const isWorkspaceSuspended = useIsWorkspaceActivationStatusSuspended();
const isWorkspaceSuspended = useIsWorkspaceActivationStatusEqualsTo(
WorkspaceActivationStatus.SUSPENDED,
);
const displayBillingSubscriptionPausedBanner =
isWorkspaceSuspended && subscriptionStatus === SubscriptionStatus.Paused;

View File

@ -1,9 +1,11 @@
import { useRecoilValue } from 'recoil';
import { useIsLogged } from '@/auth/hooks/useIsLogged';
import { currentUserState } from '@/auth/states/currentUserState';
import { OnboardingStatus } from '~/generated/graphql';
export const useOnboardingStatus = (): OnboardingStatus | null | undefined => {
const currentUser = useRecoilValue(currentUserState);
return currentUser?.onboardingStatus;
const isLoggedIn = useIsLogged();
return isLoggedIn ? currentUser?.onboardingStatus : undefined;
};

View File

@ -13,14 +13,16 @@ import { prefetchFavoriteFoldersState } from '@/prefetch/states/prefetchFavorite
import { prefetchFavoritesState } from '@/prefetch/states/prefetchFavoritesState';
import { prefetchIsLoadedFamilyState } from '@/prefetch/states/prefetchIsLoadedFamilyState';
import { PrefetchKey } from '@/prefetch/types/PrefetchKey';
import { useIsWorkspaceActivationStatusSuspended } from '@/workspace/hooks/useIsWorkspaceActivationStatusSuspended';
import { isDefined } from 'twenty-shared';
import { useIsWorkspaceActivationStatusEqualsTo } from '@/workspace/hooks/useIsWorkspaceActivationStatusEqualsTo';
import { WorkspaceActivationStatus, isDefined } from 'twenty-shared';
import { isDeeplyEqual } from '~/utils/isDeeplyEqual';
export const PrefetchRunFavoriteQueriesEffect = () => {
const currentUser = useRecoilValue(currentUserState);
const isWorkspaceSuspended = useIsWorkspaceActivationStatusSuspended();
const isWorkspaceActive = useIsWorkspaceActivationStatusEqualsTo(
WorkspaceActivationStatus.ACTIVE,
);
const { objectMetadataItems } = useObjectMetadataItems();
@ -50,14 +52,14 @@ export const PrefetchRunFavoriteQueriesEffect = () => {
objectNameSingular: CoreObjectNameSingular.Favorite,
filter: findAllFavoritesOperationSignature.variables.filter,
recordGqlFields: findAllFavoritesOperationSignature.fields,
skip: !currentUser || isWorkspaceSuspended,
skip: !currentUser || !isWorkspaceActive,
});
const { records: favoriteFolders } = useFindManyRecords({
objectNameSingular: CoreObjectNameSingular.FavoriteFolder,
filter: findAllFavoriteFoldersOperationSignature.variables.filter,
recordGqlFields: findAllFavoriteFoldersOperationSignature.fields,
skip: !currentUser || isWorkspaceSuspended,
skip: !currentUser || !isWorkspaceActive,
});
const setPrefetchFavoritesState = useRecoilCallback(

View File

@ -9,14 +9,16 @@ import { findAllViewsOperationSignatureFactory } from '@/prefetch/graphql/operat
import { prefetchViewsState } from '@/prefetch/states/prefetchViewsState';
import { isPersistingViewFieldsState } from '@/views/states/isPersistingViewFieldsState';
import { View } from '@/views/types/View';
import { useIsWorkspaceActivationStatusSuspended } from '@/workspace/hooks/useIsWorkspaceActivationStatusSuspended';
import { isDefined } from 'twenty-shared';
import { useIsWorkspaceActivationStatusEqualsTo } from '@/workspace/hooks/useIsWorkspaceActivationStatusEqualsTo';
import { WorkspaceActivationStatus, isDefined } from 'twenty-shared';
import { isDeeplyEqual } from '~/utils/isDeeplyEqual';
export const PrefetchRunViewQueryEffect = () => {
const currentUser = useRecoilValue(currentUserState);
const isWorkspaceSuspended = useIsWorkspaceActivationStatusSuspended();
const isWorkspaceActive = useIsWorkspaceActivationStatusEqualsTo(
WorkspaceActivationStatus.ACTIVE,
);
const { objectMetadataItems } = useObjectMetadataItems();
@ -30,7 +32,7 @@ export const PrefetchRunViewQueryEffect = () => {
objectNameSingular: CoreObjectNameSingular.View,
filter: findAllViewsOperationSignature.variables.filter,
recordGqlFields: findAllViewsOperationSignature.fields,
skip: !currentUser || isWorkspaceSuspended,
skip: !currentUser || !isWorkspaceActive,
});
const setPrefetchViewsState = useRecoilCallback(

View File

@ -1,10 +1,13 @@
import { prefetchIsLoadedFamilyState } from '@/prefetch/states/prefetchIsLoadedFamilyState';
import { PrefetchKey } from '@/prefetch/types/PrefetchKey';
import { useIsWorkspaceActivationStatusSuspended } from '@/workspace/hooks/useIsWorkspaceActivationStatusSuspended';
import { useIsWorkspaceActivationStatusEqualsTo } from '@/workspace/hooks/useIsWorkspaceActivationStatusEqualsTo';
import { useRecoilValue } from 'recoil';
import { WorkspaceActivationStatus } from 'twenty-shared';
export const useIsPrefetchLoading = () => {
const isWorkspaceSuspended = useIsWorkspaceActivationStatusSuspended();
const isWorkspaceActive = useIsWorkspaceActivationStatusEqualsTo(
WorkspaceActivationStatus.ACTIVE,
);
const isFavoriteFoldersPrefetched = useRecoilValue(
prefetchIsLoadedFamilyState(PrefetchKey.AllFavoritesFolders),
);
@ -14,7 +17,7 @@ export const useIsPrefetchLoading = () => {
);
return (
!isWorkspaceSuspended &&
isWorkspaceActive &&
(!areFavoritesPrefetched || !isFavoriteFoldersPrefetched)
);
};

View File

@ -6,7 +6,8 @@ import { IconX, UndecoratedLink } from 'twenty-ui';
import { isNavigationDrawerExpandedState } from '@/ui/navigation/states/isNavigationDrawerExpanded';
import { navigationDrawerExpandedMemorizedState } from '@/ui/navigation/states/navigationDrawerExpandedMemorizedState';
import { navigationMemorizedUrlState } from '@/ui/navigation/states/navigationMemorizedUrlState';
import { useIsWorkspaceActivationStatusSuspended } from '@/workspace/hooks/useIsWorkspaceActivationStatusSuspended';
import { useIsWorkspaceActivationStatusEqualsTo } from '@/workspace/hooks/useIsWorkspaceActivationStatusEqualsTo';
import { WorkspaceActivationStatus } from 'twenty-shared';
type NavigationDrawerBackButtonProps = {
title: string;
@ -52,7 +53,10 @@ export const NavigationDrawerBackButton = ({
navigationDrawerExpandedMemorizedState,
);
const isWorkspaceSuspended = useIsWorkspaceActivationStatusSuspended();
const isWorkspaceSuspended = useIsWorkspaceActivationStatusEqualsTo(
WorkspaceActivationStatus.SUSPENDED,
);
if (isWorkspaceSuspended) {
return <StyledContainer />;
}

View File

@ -0,0 +1,11 @@
import { useRecoilValue } from 'recoil';
import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { WorkspaceActivationStatus } from 'twenty-shared';
export const useIsWorkspaceActivationStatusEqualsTo = (
activationStatus: WorkspaceActivationStatus,
): boolean => {
const currentWorkspace = useRecoilValue(currentWorkspaceState);
return currentWorkspace?.activationStatus === activationStatus;
};

View File

@ -1,11 +0,0 @@
import { useRecoilValue } from 'recoil';
import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { WorkspaceActivationStatus } from '~/generated/graphql';
export const useIsWorkspaceActivationStatusSuspended = (): boolean => {
const currentWorkspace = useRecoilValue(currentWorkspaceState);
return (
currentWorkspace?.activationStatus === WorkspaceActivationStatus.SUSPENDED
);
};

View File

@ -1,4 +1,4 @@
import { Injectable } from '@nestjs/common';
import { Injectable, Logger } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
@ -32,6 +32,8 @@ import { WorkspaceSyncMetadataService } from 'src/engine/workspace-manager/works
@Injectable()
export class WorkspaceManagerService {
private readonly logger = new Logger(WorkspaceManagerService.name);
constructor(
private readonly workspaceDataSourceService: WorkspaceDataSourceService,
private readonly workspaceMigrationService: WorkspaceMigrationService,
@ -63,11 +65,19 @@ export class WorkspaceManagerService {
workspaceId: string;
userId: string;
}): Promise<void> {
const schemaCreationStart = performance.now();
const schemaName =
await this.workspaceDataSourceService.createWorkspaceDBSchema(
workspaceId,
);
const schemaCreationEnd = performance.now();
this.logger.log(
`Schema creation took ${schemaCreationEnd - schemaCreationStart}ms`,
);
const dataSourceMetadataCreationStart = performance.now();
const dataSourceMetadata =
await this.dataSourceService.createDataSourceMetadata(
workspaceId,
@ -79,6 +89,13 @@ export class WorkspaceManagerService {
dataSourceId: dataSourceMetadata.id,
});
const dataSourceMetadataCreationEnd = performance.now();
this.logger.log(
`Metadata creation took ${dataSourceMetadataCreationEnd - dataSourceMetadataCreationStart}ms`,
);
const permissionsEnabledStart = performance.now();
const permissionsEnabled =
await this.permissionsService.isPermissionsEnabled();
@ -86,10 +103,24 @@ export class WorkspaceManagerService {
await this.initPermissions({ workspaceId, userId });
}
const permissionsEnabledEnd = performance.now();
this.logger.log(
`Permissions enabled took ${permissionsEnabledEnd - permissionsEnabledStart}ms`,
);
const prefillStandardObjectsStart = performance.now();
await this.prefillWorkspaceWithStandardObjects(
dataSourceMetadata,
workspaceId,
);
const prefillStandardObjectsEnd = performance.now();
this.logger.log(
`Prefill standard objects took ${prefillStandardObjectsEnd - prefillStandardObjectsStart}ms`,
);
}
/**

View File

@ -80,6 +80,8 @@ export class WorkspaceSyncMetadataService {
this.logger.log('Syncing standard objects and fields metadata');
// 1 - Sync standard objects
const workspaceObjectMigrationsStart = performance.now();
const workspaceObjectMigrations =
await this.workspaceSyncObjectMetadataService.synchronize(
context,
@ -88,7 +90,14 @@ export class WorkspaceSyncMetadataService {
workspaceFeatureFlagsMap,
);
const workspaceObjectMigrationsEnd = performance.now();
this.logger.log(
`Workspace object migrations took ${workspaceObjectMigrationsEnd - workspaceObjectMigrationsStart}ms`,
);
// 2 - Sync standard fields on standard and custom objects
const workspaceFieldMigrationsStart = performance.now();
const workspaceFieldMigrations =
await this.workspaceSyncFieldMetadataService.synchronize(
context,
@ -97,7 +106,14 @@ export class WorkspaceSyncMetadataService {
workspaceFeatureFlagsMap,
);
const workspaceFieldMigrationsEnd = performance.now();
this.logger.log(
`Workspace field migrations took ${workspaceFieldMigrationsEnd - workspaceFieldMigrationsStart}ms`,
);
// 3 - Sync standard relations on standard and custom objects
const workspaceRelationMigrationsStart = performance.now();
const workspaceRelationMigrations =
await this.workspaceSyncRelationMetadataService.synchronize(
context,
@ -106,7 +122,14 @@ export class WorkspaceSyncMetadataService {
workspaceFeatureFlagsMap,
);
const workspaceRelationMigrationsEnd = performance.now();
this.logger.log(
`Workspace relation migrations took ${workspaceRelationMigrationsEnd - workspaceRelationMigrationsStart}ms`,
);
// 4 - Sync standard indexes on standard objects
const workspaceIndexMigrationsStart = performance.now();
const workspaceIndexMigrations =
await this.workspaceSyncIndexMetadataService.synchronize(
context,
@ -115,7 +138,15 @@ export class WorkspaceSyncMetadataService {
workspaceFeatureFlagsMap,
);
const workspaceIndexMigrationsEnd = performance.now();
this.logger.log(
`Workspace index migrations took ${workspaceIndexMigrationsEnd - workspaceIndexMigrationsStart}ms`,
);
// 5 - Sync standard object metadata identifiers, does not need to return nor apply migrations
const workspaceObjectMetadataIdentifiersStart = performance.now();
await this.workspaceSyncObjectMetadataIdentifiersService.synchronize(
context,
manager,
@ -123,6 +154,14 @@ export class WorkspaceSyncMetadataService {
workspaceFeatureFlagsMap,
);
const workspaceObjectMetadataIdentifiersEnd = performance.now();
this.logger.log(
`Workspace object metadata identifiers took ${workspaceObjectMetadataIdentifiersEnd - workspaceObjectMetadataIdentifiersStart}ms`,
);
const workspaceMigrationsSaveStart = performance.now();
// Save workspace migrations into the database
workspaceMigrations = await workspaceMigrationRepository.save([
...workspaceObjectMigrations,
@ -131,6 +170,12 @@ export class WorkspaceSyncMetadataService {
...workspaceIndexMigrations,
]);
const workspaceMigrationsSaveEnd = performance.now();
this.logger.log(
`Workspace migrations save took ${workspaceMigrationsSaveEnd - workspaceMigrationsSaveStart}ms`,
);
// If we're running a dry run, rollback the transaction and do not execute migrations
if (!options.applyChanges) {
this.logger.log('Running in dry run mode, rolling back transaction');
@ -149,9 +194,16 @@ export class WorkspaceSyncMetadataService {
// Execute migrations
this.logger.log('Executing pending migrations');
const executeMigrationsStart = performance.now();
await this.workspaceMigrationRunnerService.executeMigrationFromPendingMigrations(
context.workspaceId,
);
const executeMigrationsEnd = performance.now();
this.logger.log(
`Execute migrations took ${executeMigrationsEnd - executeMigrationsStart}ms`,
);
} catch (error) {
this.logger.error('Sync of standard objects failed with:', error);