The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
fix: eliminate workflow editing flicker on active-to-draft transitions (#21176)
Thomas Trompetteac0368e87613
diff --git a/packages/twenty-front/src/modules/workflow/hooks/useEffectiveDraftVersionId.ts b/packages/twenty-front/src/modules/workflow/hooks/useEffectiveDraftVersionId.tsnew file mode 100644index 00000000000..689ea2aeed9--- /dev/null+++ b/packages/twenty-front/src/modules/workflow/hooks/useEffectiveDraftVersionId.ts@@ -0,0 +1,70 @@+import { useGetRecordFromCache } from '@/object-record/cache/hooks/useGetRecordFromCache';+import { lastDiscardedDraftIdState } from '@/workflow/states/lastDiscardedDraftIdState';+import { useAtom } from 'jotai';+import { useState } from 'react';+import { CoreObjectNameSingular } from 'twenty-shared/types';+import { isDefined } from 'twenty-shared/utils';++export const useEffectiveDraftVersionId = (+ draftVersionFromServer: { id: string } | undefined,+): {+ effectiveDraftId: string | undefined;+ lastDiscardedDraftId: string | undefined;+} => {+ const getVersionFromCache = useGetRecordFromCache({+ objectNameSingular: CoreObjectNameSingular.WorkflowVersion,+ recordGqlFields: { id: true, status: true, deletedAt: true },+ });++ const [lastDiscardedDraftId, setLastDiscardedDraftId] = useAtom(+ lastDiscardedDraftIdState,+ );++ const [previouslyKnownDraftId, setPreviouslyKnownDraftId] = useState<+ string | undefined+ >();++ if (isDefined(draftVersionFromServer)) {+ const isReaddedBySSEAfterDiscard =+ draftVersionFromServer.id === lastDiscardedDraftId;++ if (isReaddedBySSEAfterDiscard) {+ return { effectiveDraftId: undefined, lastDiscardedDraftId };+ }++ const isNewDraft = draftVersionFromServer.id !== previouslyKnownDraftId;++ if (isNewDraft) {+ setPreviouslyKnownDraftId(draftVersionFromServer.id);+ }++ if (isDefined(lastDiscardedDraftId)) {+ setLastDiscardedDraftId(undefined);+ }++ return {+ effectiveDraftId: draftVersionFromServer.id,+ lastDiscardedDraftId,+ };+ }++ if (!isDefined(previouslyKnownDraftId)) {+ return { effectiveDraftId: undefined, lastDiscardedDraftId };+ }++ const cachedDraft = getVersionFromCache(previouslyKnownDraftId);++ const isDraftStillAlive =+ isDefined(cachedDraft) &&+ cachedDraft.status === 'DRAFT' &&+ !isDefined(cachedDraft.deletedAt);++ if (isDraftStillAlive) {+ return { effectiveDraftId: previouslyKnownDraftId, lastDiscardedDraftId };+ }++ setLastDiscardedDraftId(previouslyKnownDraftId);+ setPreviouslyKnownDraftId(undefined);++ return { effectiveDraftId: undefined, lastDiscardedDraftId };+};diff --git a/packages/twenty-front/src/modules/workflow/hooks/useWorkflowWithCurrentVersion.ts b/packages/twenty-front/src/modules/workflow/hooks/useWorkflowWithCurrentVersion.tsindex 203d8ba032f..7f62e1d7141 100644--- a/packages/twenty-front/src/modules/workflow/hooks/useWorkflowWithCurrentVersion.ts+++ b/packages/twenty-front/src/modules/workflow/hooks/useWorkflowWithCurrentVersion.ts@@ -1,9 +1,5 @@-import { useEffect } from 'react';-import { useFindOneRecord } from '@/object-record/hooks/useFindOneRecord';-import { useAtomFamilyStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomFamilyStateValue';-import { useSetAtomFamilyState } from '@/ui/utilities/state/jotai/hooks/useSetAtomFamilyState';-import { shouldWorkflowRefetchRequestFamilyState } from '@/workflow/states/shouldWorkflowRefetchRequestFamilyState';+import { useEffectiveDraftVersionId } from '@/workflow/hooks/useEffectiveDraftVersionId';import {type Workflow,type WorkflowVersion,@@ -21,62 +17,45 @@ type WorkflowWithAllVersions = Omit<Workflow, 'versions'> & {export const useWorkflowWithCurrentVersion = (workflowId: string | undefined,): WorkflowWithCurrentVersion | undefined => {- const shouldWorkflowRefetchRequest = useAtomFamilyStateValue(- shouldWorkflowRefetchRequestFamilyState,- workflowId ?? '',- );- const setShouldWorkflowRefetchRequest = useSetAtomFamilyState(- shouldWorkflowRefetchRequestFamilyState,- workflowId ?? '',- );-- const { record: workflow, refetch: refetchWorkflow } =- useFindOneRecord<WorkflowWithAllVersions>({- objectNameSingular: CoreObjectNameSingular.Workflow,- objectRecordId: workflowId,- recordGqlFields: {+ const { record: workflow } = useFindOneRecord<WorkflowWithAllVersions>({+ objectNameSingular: CoreObjectNameSingular.Workflow,+ objectRecordId: workflowId,+ recordGqlFields: {+ id: true,+ name: true,+ statuses: true,+ lastPublishedVersionId: true,+ versions: {id: true,+ status: true,name: true,- statuses: true,- lastPublishedVersionId: true,- versions: {- id: true,- status: true,- name: true,- createdAt: true,- },+ createdAt: true,},- skip: !isDefined(workflowId),- });-- useEffect(() => {- if (shouldWorkflowRefetchRequest) {- setShouldWorkflowRefetchRequest(false);- refetchWorkflow();- }- }, [- shouldWorkflowRefetchRequest,- setShouldWorkflowRefetchRequest,- refetchWorkflow,- ]);+ },+ skip: !isDefined(workflowId),+ });- const draftVersion = workflow?.versions.find(+ const draftVersionFromServer = workflow?.versions.find((workflowVersion) => workflowVersion.status === 'DRAFT',);- const workflowVersions = [...(workflow?.versions ?? [])];+ const { effectiveDraftId, lastDiscardedDraftId } = useEffectiveDraftVersionId(+ draftVersionFromServer,+ );- workflowVersions.sort((a, b) => (a.createdAt > b.createdAt ? -1 : 1));+ const workflowVersions = [...(workflow?.versions ?? [])]+ .filter((version) => version.id !== lastDiscardedDraftId)+ .sort((a, b) => (a.createdAt > b.createdAt ? -1 : 1));const latestVersion = workflowVersions[0];- const currentVersionWithoutSteps = draftVersion ?? latestVersion;+ const currentVersionId = effectiveDraftId ?? latestVersion?.id;const { record: currentVersionWithSteps } = useFindOneRecord<WorkflowVersion>({objectNameSingular: CoreObjectNameSingular.WorkflowVersion,- objectRecordId: currentVersionWithoutSteps?.id,- skip: !isDefined(currentVersionWithoutSteps?.id),+ objectRecordId: currentVersionId,+ skip: !isDefined(currentVersionId),},);diff --git a/packages/twenty-front/src/modules/workflow/states/lastDiscardedDraftIdState.ts b/packages/twenty-front/src/modules/workflow/states/lastDiscardedDraftIdState.tsnew file mode 100644index 00000000000..d8ee605df83--- /dev/null+++ b/packages/twenty-front/src/modules/workflow/states/lastDiscardedDraftIdState.ts@@ -0,0 +1,4 @@+import { atom } from 'jotai';++export const lastDiscardedDraftIdState = atom<string | undefined>(undefined);+lastDiscardedDraftIdState.debugLabel = 'lastDiscardedDraftIdState';diff --git a/packages/twenty-front/src/modules/workflow/workflow-diagram/components/WorkflowDiagramEffect.tsx b/packages/twenty-front/src/modules/workflow/workflow-diagram/components/WorkflowDiagramEffect.tsxindex ab96e5c77c3..90454cee612 100644--- a/packages/twenty-front/src/modules/workflow/workflow-diagram/components/WorkflowDiagramEffect.tsx+++ b/packages/twenty-front/src/modules/workflow/workflow-diagram/components/WorkflowDiagramEffect.tsx@@ -12,7 +12,7 @@ import { useStepsOutputSchema } from '@/workflow/workflow-variables/hooks/useSteimport { getWorkflowVersionDiagram } from '@/workflow/workflow-diagram/utils/getWorkflowVersionDiagram';import { mergeWorkflowDiagrams } from '@/workflow/workflow-diagram/utils/mergeWorkflowDiagrams';import { useStore } from 'jotai';-import { useCallback, useEffect } from 'react';+import { useCallback, useEffect, useState } from 'react';import { isDefined } from 'twenty-shared/utils';export const WorkflowDiagramEffect = () => {@@ -37,8 +37,10 @@ export const WorkflowDiagramEffect = () => {const store = useStore();const currentVersion = workflowWithCurrentVersion?.currentVersion;+ const [previousVersionId, setPreviousVersionId] = useState<string>();+const computeAndMergeNewWorkflowDiagram = useCallback(- (version: WorkflowVersion) => {+ (version: WorkflowVersion, preservePositions: boolean) => {const previousWorkflowDiagram = store.get(workflowDiagram);const nextWorkflowDiagram = getWorkflowVersionDiagram({@@ -52,6 +54,7 @@ export const WorkflowDiagramEffect = () => {mergedWorkflowDiagram = mergeWorkflowDiagrams(previousWorkflowDiagram,nextWorkflowDiagram,+ { preservePositions },);}@@ -80,13 +83,20 @@ export const WorkflowDiagramEffect = () => {return;}+ const isSameVersion = previousVersionId === currentVersion.id;+ const isTransitionToDraft = currentVersion.status === 'DRAFT';+ const shouldPreservePositions = isSameVersion || isTransitionToDraft;++ setPreviousVersionId(currentVersion.id);+setFlow({workflowVersionId: currentVersion.id,trigger: currentVersion.trigger,steps: currentVersion.steps,});- computeAndMergeNewWorkflowDiagram(currentVersion);+ computeAndMergeNewWorkflowDiagram(currentVersion, shouldPreservePositions);+ // eslint-disable-next-line react-hooks/exhaustive-deps}, [computeAndMergeNewWorkflowDiagram, setFlow, currentVersion]);useEffect(() => {diff --git a/packages/twenty-front/src/modules/workflow/workflow-diagram/utils/__tests__/mergeWorkflowDiagrams.test.ts b/packages/twenty-front/src/modules/workflow/workflow-diagram/utils/__tests__/mergeWorkflowDiagrams.test.tsindex 6ecd4c18127..9c689421e3e 100644--- a/packages/twenty-front/src/modules/workflow/workflow-diagram/utils/__tests__/mergeWorkflowDiagrams.test.ts+++ b/packages/twenty-front/src/modules/workflow/workflow-diagram/utils/__tests__/mergeWorkflowDiagrams.test.ts@@ -56,7 +56,6 @@ it('Preserves the properties defined in the previous version but not in the next"stepId": "",},"id": "1",- "measured": undefined,"position": {"x": 0,"y": 0,@@ -122,12 +121,10 @@ it('Replaces duplicated properties with the next value', () => {"stepId": "",},"id": "1",- "measured": undefined,"position": {"x": 0,"y": 0,},- "selected": undefined,},],}diff --git a/packages/twenty-front/src/modules/workflow/workflow-diagram/utils/mergeWorkflowDiagrams.ts b/packages/twenty-front/src/modules/workflow/workflow-diagram/utils/mergeWorkflowDiagrams.tsindex 196a990d783..8a57303f309 100644--- a/packages/twenty-front/src/modules/workflow/workflow-diagram/utils/mergeWorkflowDiagrams.ts+++ b/packages/twenty-front/src/modules/workflow/workflow-diagram/utils/mergeWorkflowDiagrams.ts@@ -2,8 +2,9 @@ import {type WorkflowDiagram,type WorkflowDiagramNode,} from '@/workflow/workflow-diagram/types/WorkflowDiagram';+import { isDefined } from 'twenty-shared/utils';-const nodePropertiesToPreserve: Array<keyof WorkflowDiagramNode> = [+const BASE_PROPERTIES_TO_PRESERVE: Array<keyof WorkflowDiagramNode> = ['selected','measured',];@@ -11,22 +12,32 @@ const nodePropertiesToPreserve: Array<keyof WorkflowDiagramNode> = [export const mergeWorkflowDiagrams = (previousDiagram: WorkflowDiagram,nextDiagram: WorkflowDiagram,+ options?: { preservePositions?: boolean },): WorkflowDiagram => {+ const propertiesToPreserve = options?.preservePositions+ ? [...BASE_PROPERTIES_TO_PRESERVE, 'position' as const]+ : BASE_PROPERTIES_TO_PRESERVE;+const lastNodes = nextDiagram.nodes.map((nextNode) => {const previousNode = previousDiagram.nodes.find((previousNode) => previousNode.id === nextNode.id,);- const nodeWithPreservedProperties = nodePropertiesToPreserve.reduce(- (nodeToSet, propertyToPreserve) => {- return Object.assign(nodeToSet, {- [propertyToPreserve]: previousNode?.[propertyToPreserve],+ if (!isDefined(previousNode)) {+ return nextNode;+ }++ const preservedProperties: Partial<WorkflowDiagramNode> = {};++ for (const property of propertiesToPreserve) {+ if (isDefined(previousNode[property])) {+ Object.assign(preservedProperties, {+ [property]: previousNode[property],});- },- {} as Partial<WorkflowDiagramNode>,- );+ }+ }- return Object.assign(nodeWithPreservedProperties, nextNode);+ return { ...nextNode, ...preservedProperties };});return {