Activate/Deactivate workflow and Discard Draft (#7022)

## Setup

This PR can be tested only if some feature flags have specific values:

- `IsWorkflowEnabled` equals `true`
- `IsQueryRunnerTwentyORMEnabled` equals `false`

These feature flags weren't committed to don't break other branches.

## What this PR brings

- Display buttons to activate and deactivate a workflow version and a
button to discard the current draft version. I also scaffolded a "Test"
button, which doesn't do anything for now.
- Wired the activate, deactivate and discard draft buttons to the
backend.
- Made it possible to "edit" active and deactivated versions by
automatically creating a new draft version when the user tries to edit
the version.
- Hide the "Discard Draft", button if the current version is not a draft
or is the first version ever created.
- On the backend, don't consider discarded drafts when checking if a new
draft version can be created.
- On the backend, disallow deleting the first created workflow version.
Otherwise, we will end up with a blank canvas in the front end, and it
will be impossible to recover from it.
- On the backend, disallow running deactivation steps if the workflow
version is not currently active. Previously, we were throwing, which is
unnecessary as it's a valid case.

## Spotted bugs that we must dive into

### Duplicate workflow versions in Apollo cache


https://github.com/user-attachments/assets/7cfffd06-11e0-417a-8da0-f9a5f43b84e2

---------

Co-authored-by: Charles Bochet <charles@twenty.com>
This commit is contained in:
Baptiste Devessier
2024-09-25 18:09:31 +02:00
committed by GitHub
parent 75b493ba6c
commit 729c990546
76 changed files with 19152 additions and 27309 deletions

View File

@ -6,8 +6,8 @@ import { currentUserState } from '@/auth/states/currentUserState';
import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { useFindManyObjectMetadataItems } from '@/object-metadata/hooks/useFindManyObjectMetadataItems';
import { objectMetadataItemsState } from '@/object-metadata/states/objectMetadataItemsState';
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
import { WorkspaceActivationStatus } from '~/generated/graphql';
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
import { isDeeplyEqual } from '~/utils/isDeeplyEqual';
import { isUndefinedOrNull } from '~/utils/isUndefinedOrNull';
@ -29,7 +29,7 @@ export const ObjectMetadataItemsLoadEffect = () => {
const toSetObjectMetadataItems =
isUndefinedOrNull(currentUser) ||
currentWorkspace?.activationStatus !== WorkspaceActivationStatus.Active
? getObjectMetadataItemsMock()
? generatedMockObjectMetadataItems
: newObjectMetadataItems;
if (
!loading &&

View File

@ -3,7 +3,7 @@ import { Nullable } from 'twenty-ui';
import { useColumnDefinitionsFromFieldMetadata } from '@/object-metadata/hooks/useColumnDefinitionsFromFieldMetadata';
import { ObjectMetadataItem } from '@/object-metadata/types/ObjectMetadataItem';
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
describe('useColumnDefinitionsFromFieldMetadata', () => {
it('should return empty definitions if no object is passed', () => {
@ -22,22 +22,24 @@ describe('useColumnDefinitionsFromFieldMetadata', () => {
});
it('should return expected definitions', () => {
const mockObjectMetadataItems = getObjectMetadataItemsMock();
const companyObjectMetadata = generatedMockObjectMetadataItems.find(
(item) => item.nameSingular === 'company',
);
const { result } = renderHook(
(objectMetadataItem?: Nullable<ObjectMetadataItem>) => {
return useColumnDefinitionsFromFieldMetadata(objectMetadataItem);
},
{
initialProps: mockObjectMetadataItems[1],
initialProps: companyObjectMetadata,
},
);
const { columnDefinitions, filterDefinitions, sortDefinitions } =
result.current;
expect(columnDefinitions.length).toBe(5);
expect(filterDefinitions.length).toBe(4);
expect(sortDefinitions.length).toBe(4);
expect(columnDefinitions.length).toBe(21);
expect(filterDefinitions.length).toBe(14);
expect(sortDefinitions.length).toBe(14);
});
});

View File

@ -10,7 +10,7 @@ import {
} from '@/object-metadata/hooks/__mocks__/useFilteredObjectMetadataItems';
import { useFilteredObjectMetadataItems } from '@/object-metadata/hooks/useFilteredObjectMetadataItems';
import { objectMetadataItemsState } from '@/object-metadata/states/objectMetadataItemsState';
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
const mocks = [
{
@ -34,14 +34,12 @@ const Wrapper = ({ children }: { children: ReactNode }) => (
</RecoilRoot>
);
const mockObjectMetadataItems = getObjectMetadataItemsMock();
describe('useFilteredObjectMetadataItems', () => {
it('should findActiveObjectMetadataItemBySlug', async () => {
const { result } = renderHook(
() => {
const setMetadataItems = useSetRecoilState(objectMetadataItemsState);
setMetadataItems(mockObjectMetadataItems);
setMetadataItems(generatedMockObjectMetadataItems);
return useFilteredObjectMetadataItems();
},
@ -61,7 +59,7 @@ describe('useFilteredObjectMetadataItems', () => {
const { result } = renderHook(
() => {
const setMetadataItems = useSetRecoilState(objectMetadataItemsState);
setMetadataItems(mockObjectMetadataItems);
setMetadataItems(generatedMockObjectMetadataItems);
return useFilteredObjectMetadataItems();
},
@ -78,10 +76,14 @@ describe('useFilteredObjectMetadataItems', () => {
});
it('should findObjectMetadataItemById', async () => {
const peopleObjectMetadata = generatedMockObjectMetadataItems.find(
(item) => item.namePlural === 'people',
);
const { result } = renderHook(
() => {
const setMetadataItems = useSetRecoilState(objectMetadataItemsState);
setMetadataItems(mockObjectMetadataItems);
setMetadataItems(generatedMockObjectMetadataItems);
return useFilteredObjectMetadataItems();
},
@ -92,7 +94,7 @@ describe('useFilteredObjectMetadataItems', () => {
act(() => {
const res = result.current.findObjectMetadataItemById(
'ff2881da-89f6-4f15-8f0a-e3f355ea3b94',
peopleObjectMetadata?.id,
);
expect(res).toBeDefined();
expect(res?.namePlural).toBe('people');
@ -103,7 +105,7 @@ describe('useFilteredObjectMetadataItems', () => {
const { result } = renderHook(
() => {
const setMetadataItems = useSetRecoilState(objectMetadataItemsState);
setMetadataItems(mockObjectMetadataItems);
setMetadataItems(generatedMockObjectMetadataItems);
return useFilteredObjectMetadataItems();
},

View File

@ -3,9 +3,7 @@ import { RecoilRoot, useSetRecoilState } from 'recoil';
import { useGetObjectRecordIdentifierByNameSingular } from '@/object-metadata/hooks/useGetObjectRecordIdentifierByNameSingular';
import { objectMetadataItemsState } from '@/object-metadata/states/objectMetadataItemsState';
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
const mockObjectMetadataItems = getObjectMetadataItemsMock();
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
describe('useGetObjectRecordIdentifierByNameSingular', () => {
it('should work as expected', async () => {
@ -19,7 +17,7 @@ describe('useGetObjectRecordIdentifierByNameSingular', () => {
}) => {
const setMetadataItems = useSetRecoilState(objectMetadataItemsState);
setMetadataItems(mockObjectMetadataItems);
setMetadataItems(generatedMockObjectMetadataItems);
return useGetObjectRecordIdentifierByNameSingular()(
record,

View File

@ -5,7 +5,7 @@ import { RecoilRoot, useSetRecoilState } from 'recoil';
import { useGetRelationMetadata } from '@/object-metadata/hooks/useGetRelationMetadata';
import { objectMetadataItemsState } from '@/object-metadata/states/objectMetadataItemsState';
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
const Wrapper = ({ children }: { children: ReactNode }) => (
<RecoilRoot>
@ -15,8 +15,7 @@ const Wrapper = ({ children }: { children: ReactNode }) => (
describe('useGetRelationMetadata', () => {
it('should return correct properties', async () => {
const objectMetadataItems = getObjectMetadataItemsMock();
const objectMetadata = objectMetadataItems.find(
const objectMetadata = generatedMockObjectMetadataItems.find(
(item) => item.nameSingular === 'person',
)!;
const fieldMetadataItem = objectMetadata.fields.find(
@ -28,7 +27,7 @@ describe('useGetRelationMetadata', () => {
const setMetadataItems = useSetRecoilState(objectMetadataItemsState);
useEffect(() => {
setMetadataItems(objectMetadataItems);
setMetadataItems(generatedMockObjectMetadataItems);
}, [setMetadataItems]);
return useGetRelationMetadata();
@ -45,9 +44,10 @@ describe('useGetRelationMetadata', () => {
relationType,
} = result.current({ fieldMetadataItem }) ?? {};
const expectedRelationObjectMetadataItem = objectMetadataItems.find(
(item) => item.nameSingular === 'opportunity',
);
const expectedRelationObjectMetadataItem =
generatedMockObjectMetadataItems.find(
(item) => item.nameSingular === 'opportunity',
);
const expectedRelationFieldMetadataItem =
expectedRelationObjectMetadataItem?.fields.find(
(field) => field.name === 'pointOfContact',

View File

@ -4,6 +4,7 @@ import { ReactNode } from 'react';
import { RecoilRoot } from 'recoil';
import { useObjectMetadataItem } from '@/object-metadata/hooks/useObjectMetadataItem';
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
const Wrapper = ({ children }: { children: ReactNode }) => (
<RecoilRoot>
@ -13,6 +14,9 @@ const Wrapper = ({ children }: { children: ReactNode }) => (
// Split into tests for each new hook
describe('useObjectMetadataItem', () => {
const opportunityObjectMetadata = generatedMockObjectMetadataItems.find(
(item) => item.nameSingular === 'opportunity',
);
it('should return correct properties', async () => {
const { result } = renderHook(
() => useObjectMetadataItem({ objectNameSingular: 'opportunity' }),
@ -23,6 +27,6 @@ describe('useObjectMetadataItem', () => {
const { objectMetadataItem } = result.current;
expect(objectMetadataItem.id).toBe('b95b3f38-9fc2-4d7e-a823-7791cf13d089');
expect(objectMetadataItem.id).toBe(opportunityObjectMetadata?.id);
});
});

View File

@ -4,10 +4,10 @@ import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { ObjectMetadataItemNotFoundError } from '@/object-metadata/errors/ObjectMetadataNotFoundError';
import { objectMetadataItemFamilySelector } from '@/object-metadata/states/objectMetadataItemFamilySelector';
import { objectMetadataItemsState } from '@/object-metadata/states/objectMetadataItemsState';
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
import { isDefined } from '~/utils/isDefined';
import { WorkspaceActivationStatus } from '~/generated/graphql';
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
import { ObjectMetadataItemIdentifier } from '../types/ObjectMetadataItemIdentifier';
export const useObjectMetadataItem = ({
@ -15,9 +15,6 @@ export const useObjectMetadataItem = ({
}: ObjectMetadataItemIdentifier) => {
const currentWorkspace = useRecoilValue(currentWorkspaceState);
// Todo: deprecate this logic as mocked objectMetadataItems are load in ObjectMetadataItemsLoadEffect anyway
const mockObjectMetadataItems = getObjectMetadataItemsMock();
let objectMetadataItem = useRecoilValue(
objectMetadataItemFamilySelector({
objectName: objectNameSingular,
@ -29,11 +26,11 @@ export const useObjectMetadataItem = ({
if (currentWorkspace?.activationStatus !== WorkspaceActivationStatus.Active) {
objectMetadataItem =
mockObjectMetadataItems.find(
generatedMockObjectMetadataItems.find(
(objectMetadataItem) =>
objectMetadataItem.nameSingular === objectNameSingular,
) ?? null;
objectMetadataItems = mockObjectMetadataItems;
objectMetadataItems = generatedMockObjectMetadataItems;
}
if (!isDefined(objectMetadataItem)) {

View File

@ -2,8 +2,8 @@ import { useRecoilValue } from 'recoil';
import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { objectMetadataItemFamilySelector } from '@/object-metadata/states/objectMetadataItemFamilySelector';
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
import { WorkspaceActivationStatus } from '~/generated/graphql';
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
import { isDefined } from '~/utils/isDefined';
export const useObjectNamePluralFromSingular = ({
@ -12,7 +12,6 @@ export const useObjectNamePluralFromSingular = ({
objectNameSingular: string;
}) => {
const currentWorkspace = useRecoilValue(currentWorkspaceState);
const mockObjectMetadataItems = getObjectMetadataItemsMock();
let objectMetadataItem = useRecoilValue(
objectMetadataItemFamilySelector({
@ -23,7 +22,7 @@ export const useObjectNamePluralFromSingular = ({
if (currentWorkspace?.activationStatus !== WorkspaceActivationStatus.Active) {
objectMetadataItem =
mockObjectMetadataItems.find(
generatedMockObjectMetadataItems.find(
(objectMetadataItem) =>
objectMetadataItem.nameSingular === objectNameSingular,
) ?? null;

View File

@ -2,8 +2,8 @@ import { useRecoilValue } from 'recoil';
import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { objectMetadataItemFamilySelector } from '@/object-metadata/states/objectMetadataItemFamilySelector';
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
import { WorkspaceActivationStatus } from '~/generated/graphql';
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
import { isDefined } from '~/utils/isDefined';
export const useObjectNameSingularFromPlural = ({
@ -13,8 +13,6 @@ export const useObjectNameSingularFromPlural = ({
}) => {
const currentWorkspace = useRecoilValue(currentWorkspaceState);
const mockObjectMetadataItems = getObjectMetadataItemsMock();
let objectMetadataItem = useRecoilValue(
objectMetadataItemFamilySelector({
objectName: objectNamePlural,
@ -24,7 +22,7 @@ export const useObjectNameSingularFromPlural = ({
if (currentWorkspace?.activationStatus !== WorkspaceActivationStatus.Active) {
objectMetadataItem =
mockObjectMetadataItems.find(
generatedMockObjectMetadataItems.find(
(objectMetadataItem) =>
objectMetadataItem.namePlural === objectNamePlural,
) ?? null;

View File

@ -1,14 +1,12 @@
import { getObjectMetadataItemByNameSingular } from '@/object-metadata/utils/getObjectMetadataItemBySingularName';
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
const mockObjectMetadataItems = getObjectMetadataItemsMock();
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
describe('getObjectMetadataItemBySingularName', () => {
it('should work as expected', () => {
const firstObjectMetadataItem = mockObjectMetadataItems[0];
const firstObjectMetadataItem = generatedMockObjectMetadataItems[0];
const foundObjectMetadataItem = getObjectMetadataItemByNameSingular({
objectMetadataItems: mockObjectMetadataItems,
objectMetadataItems: generatedMockObjectMetadataItems,
objectNameSingular: firstObjectMetadataItem.nameSingular,
});

View File

@ -1,11 +1,9 @@
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
import { getOrderByFieldForObjectMetadataItem } from '@/object-metadata/utils/getObjectOrderByField';
const mockObjectMetadataItems = getObjectMetadataItemsMock();
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
describe('getObjectOrderByField', () => {
it('should work as expected', () => {
const objectMetadataItem = mockObjectMetadataItems.find(
const objectMetadataItem = generatedMockObjectMetadataItems.find(
(item) => item.nameSingular === 'person',
)!;
const res = getOrderByFieldForObjectMetadataItem(objectMetadataItem);

View File

@ -1,11 +1,9 @@
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
import { getObjectSlug } from '@/object-metadata/utils/getObjectSlug';
const mockObjectMetadataItems = getObjectMetadataItemsMock();
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
describe('getObjectSlug', () => {
it('should work as expected', () => {
const objectMetadataItem = mockObjectMetadataItems.find(
const objectMetadataItem = generatedMockObjectMetadataItems.find(
(item) => item.nameSingular === 'person',
)!;

View File

@ -1,11 +1,9 @@
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
import { isObjectMetadataAvailableForRelation } from '@/object-metadata/utils/isObjectMetadataAvailableForRelation';
const mockObjectMetadataItems = getObjectMetadataItemsMock();
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
describe('isObjectMetadataAvailableForRelation', () => {
it('should work as expected', () => {
const objectMetadataItem = mockObjectMetadataItems.find(
const objectMetadataItem = generatedMockObjectMetadataItems.find(
(item) => item.nameSingular === 'person',
)!;

View File

@ -1,10 +1,8 @@
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
import { mapFieldMetadataToGraphQLQuery } from '@/object-metadata/utils/mapFieldMetadataToGraphQLQuery';
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
import { normalizeGQLField } from '~/utils/normalizeGQLField';
const mockObjectMetadataItems = getObjectMetadataItemsMock();
const personObjectMetadataItem = mockObjectMetadataItems.find(
const personObjectMetadataItem = generatedMockObjectMetadataItems.find(
(item) => item.nameSingular === 'person',
);
@ -15,7 +13,7 @@ if (!personObjectMetadataItem) {
describe('mapFieldMetadataToGraphQLQuery', () => {
it('should return fieldName if simpleValue', async () => {
const res = mapFieldMetadataToGraphQLQuery({
objectMetadataItems: mockObjectMetadataItems,
objectMetadataItems: generatedMockObjectMetadataItems,
field: personObjectMetadataItem.fields.find(
(field) => field.name === 'id',
)!,
@ -24,7 +22,7 @@ describe('mapFieldMetadataToGraphQLQuery', () => {
});
it('should return fieldName if composite', async () => {
const res = mapFieldMetadataToGraphQLQuery({
objectMetadataItems: mockObjectMetadataItems,
objectMetadataItems: generatedMockObjectMetadataItems,
field: personObjectMetadataItem.fields.find(
(field) => field.name === 'name',
)!,
@ -40,7 +38,7 @@ describe('mapFieldMetadataToGraphQLQuery', () => {
it('should return non relation subFields if relation', async () => {
const res = mapFieldMetadataToGraphQLQuery({
objectMetadataItems: mockObjectMetadataItems,
objectMetadataItems: generatedMockObjectMetadataItems,
field: personObjectMetadataItem.fields.find(
(field) => field.name === 'company',
)!,
@ -96,7 +94,7 @@ idealCustomerProfile
it('should return only return relation subFields that are in recordGqlFields', async () => {
const res = mapFieldMetadataToGraphQLQuery({
objectMetadataItems: mockObjectMetadataItems,
objectMetadataItems: generatedMockObjectMetadataItems,
relationrecordFields: {
accountOwner: { id: true, name: true },
people: true,

View File

@ -1,10 +1,8 @@
import { getObjectMetadataItemsMock } from '@/object-metadata/utils/getObjectMetadataItemsMock';
import { mapObjectMetadataToGraphQLQuery } from '@/object-metadata/utils/mapObjectMetadataToGraphQLQuery';
import { generatedMockObjectMetadataItems } from '~/testing/mock-data/objectMetadataItems';
import { normalizeGQLQuery } from '~/utils/normalizeGQLQuery';
const mockObjectMetadataItems = getObjectMetadataItemsMock();
const personObjectMetadataItem = mockObjectMetadataItems.find(
const personObjectMetadataItem = generatedMockObjectMetadataItems.find(
(item) => item.nameSingular === 'person',
);
@ -15,7 +13,7 @@ if (!personObjectMetadataItem) {
describe('mapObjectMetadataToGraphQLQuery', () => {
it('should query only specified recordGqlFields', async () => {
const res = mapObjectMetadataToGraphQLQuery({
objectMetadataItems: mockObjectMetadataItems,
objectMetadataItems: generatedMockObjectMetadataItems,
objectMetadataItem: personObjectMetadataItem,
recordGqlFields: {
company: true,
@ -122,7 +120,7 @@ describe('mapObjectMetadataToGraphQLQuery', () => {
it('should load only specified operation fields nested', async () => {
const res = mapObjectMetadataToGraphQLQuery({
objectMetadataItems: mockObjectMetadataItems,
objectMetadataItems: generatedMockObjectMetadataItems,
objectMetadataItem: personObjectMetadataItem,
recordGqlFields: { company: { id: true }, id: true, name: true },
});