The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Fix cascade-before-update ordering in workspace migrations (#27767)
Félix Malfaitfc8d6084e484
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/utils/__tests__/compute-ordered-migration-actions.util.spec.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/utils/__tests__/compute-ordered-migration-actions.util.spec.tsindex 4908823f3b8..29207b6f469 100644--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/utils/__tests__/compute-ordered-migration-actions.util.spec.ts+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/utils/__tests__/compute-ordered-migration-actions.util.spec.ts@@ -1,5 +1,9 @@-import { ALL_METADATA_NAME } from 'twenty-shared/metadata';+import {+ ALL_METADATA_NAME,+ type AllMetadataName,+} from 'twenty-shared/metadata';+import { type WorkspaceMigrationActionType } from 'src/engine/metadata-modules/flat-entity/types/metadata-workspace-migration-action.type';import { createEmptyOrchestratorActionsReport } from 'src/engine/workspace-manager/workspace-migration/constant/empty-orchestrator-actions-report.constant';import { computeOrderedMigrationActions } from 'src/engine/workspace-manager/workspace-migration/utils/compute-ordered-migration-actions.util';import {@@ -172,6 +176,95 @@ describe('computeOrderedMigrationActions', () => {);});+ // A child repointed onto another parent is lost to ON DELETE CASCADE when its+ // old parent is deleted first: the update then matches nothing and still+ // reports success. Non-deferrable FKs also need their target created first.+ it.each<{+ title: string;+ earlier: [AllMetadataName, WorkspaceMigrationActionType];+ later: [AllMetadataName, WorkspaceMigrationActionType];+ }>([+ {+ title: 'viewFilterGroup creates before viewFilter updates',+ earlier: ['viewFilterGroup', 'create'],+ later: ['viewFilter', 'update'],+ },+ {+ title: 'viewFilter updates before viewFilterGroup deletes',+ earlier: ['viewFilter', 'update'],+ later: ['viewFilterGroup', 'delete'],+ },+ {+ title: 'viewFilterGroup updates before viewFilterGroup deletes',+ earlier: ['viewFilterGroup', 'update'],+ later: ['viewFilterGroup', 'delete'],+ },+ {+ title: 'pageLayout creates before commandMenuItem creates',+ earlier: ['pageLayout', 'create'],+ later: ['commandMenuItem', 'create'],+ },+ {+ title: 'commandMenuItem updates before pageLayout deletes',+ earlier: ['commandMenuItem', 'update'],+ later: ['pageLayout', 'delete'],+ },+ {+ title: 'pageLayoutWidget updates before pageLayoutTab deletes',+ earlier: ['pageLayoutWidget', 'update'],+ later: ['pageLayoutTab', 'delete'],+ },+ {+ title: 'pageLayoutWidget updates before pageLayout deletes',+ earlier: ['pageLayoutWidget', 'update'],+ later: ['pageLayout', 'delete'],+ },+ {+ title: 'navigationMenuItem updates before navigationMenuItem deletes',+ earlier: ['navigationMenuItem', 'update'],+ later: ['navigationMenuItem', 'delete'],+ },+ {+ title:+ 'rowLevelPermissionPredicateGroup creates before rowLevelPermissionPredicate updates',+ earlier: ['rowLevelPermissionPredicateGroup', 'create'],+ later: ['rowLevelPermissionPredicate', 'update'],+ },+ {+ title:+ 'rowLevelPermissionPredicate updates before rowLevelPermissionPredicateGroup deletes',+ earlier: ['rowLevelPermissionPredicate', 'update'],+ later: ['rowLevelPermissionPredicateGroup', 'delete'],+ },+ {+ title:+ 'rowLevelPermissionPredicateGroup updates before rowLevelPermissionPredicateGroup deletes',+ earlier: ['rowLevelPermissionPredicateGroup', 'update'],+ later: ['rowLevelPermissionPredicateGroup', 'delete'],+ },+ ])('should run $title', ({ earlier, later }) => {+ const orchestratorActionsReport = createEmptyOrchestratorActionsReport();+ const [earlierAction, laterAction] = [earlier, later].map(+ ([metadataName, actionType]) => {+ const sentinel = { type: actionType, metadataName };++ (orchestratorActionsReport[metadataName][actionType] as object[]).push(+ sentinel,+ );++ return sentinel;+ },+ );++ const orderedActions = computeOrderedMigrationActions(+ orchestratorActionsReport,+ ) as object[];++ expect(orderedActions.indexOf(earlierAction)).toBeLessThan(+ orderedActions.indexOf(laterAction),+ );+ });+// The ordered list is written by hand and OrchestratorActionsReport is a// mapped type, so reading fewer keys than it holds type-checks: a metadata// name left out here has its actions built, validated, then silently droppeddiff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/utils/compute-ordered-migration-actions.util.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/utils/compute-ordered-migration-actions.util.tsindex 30e31b98825..9dd72083f92 100644--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/utils/compute-ordered-migration-actions.util.ts+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/utils/compute-ordered-migration-actions.util.ts@@ -27,12 +27,13 @@ export const computeOrderedMigrationActions = (...aggregatedOrchestratorActionsReport.viewFieldGroup.update,...aggregatedOrchestratorActionsReport.viewField.create,...aggregatedOrchestratorActionsReport.viewField.update,- ...aggregatedOrchestratorActionsReport.viewFilterGroup.delete,...aggregatedOrchestratorActionsReport.viewFilterGroup.create,...aggregatedOrchestratorActionsReport.viewFilterGroup.update,...aggregatedOrchestratorActionsReport.viewFilter.delete,...aggregatedOrchestratorActionsReport.viewFilter.create,...aggregatedOrchestratorActionsReport.viewFilter.update,+ // Filters and child groups CASCADE on their group, so one moved out of a dropped group must be repointed before that group goes+ ...aggregatedOrchestratorActionsReport.viewFilterGroup.delete,...aggregatedOrchestratorActionsReport.viewGroup.delete,...aggregatedOrchestratorActionsReport.viewGroup.create,...aggregatedOrchestratorActionsReport.viewGroup.update,@@ -93,6 +94,9 @@ export const computeOrderedMigrationActions = (...aggregatedOrchestratorActionsReport.frontComponent.create,...aggregatedOrchestratorActionsReport.frontComponent.update,+ // commandMenuItem.pageLayoutId is a non-deferrable FK+ ...aggregatedOrchestratorActionsReport.pageLayout.create,+...aggregatedOrchestratorActionsReport.commandMenuItem.create,...aggregatedOrchestratorActionsReport.commandMenuItem.update,@@ -101,10 +105,6 @@ export const computeOrderedMigrationActions = (...aggregatedOrchestratorActionsReport.frontComponent.delete,- ...aggregatedOrchestratorActionsReport.pageLayout.delete,- ...aggregatedOrchestratorActionsReport.pageLayout.create,-- ...aggregatedOrchestratorActionsReport.pageLayoutTab.delete,...aggregatedOrchestratorActionsReport.pageLayoutTab.create,...aggregatedOrchestratorActionsReport.pageLayoutTab.update,@@ -114,12 +114,15 @@ export const computeOrderedMigrationActions = (...aggregatedOrchestratorActionsReport.pageLayoutWidget.create,...aggregatedOrchestratorActionsReport.pageLayoutWidget.update,- ...aggregatedOrchestratorActionsReport.navigationMenuItem.delete,+ // Widgets CASCADE on their tab, and tabs on their layout, so a widget moved off a dropped tab must be repointed before that tab or layout goes+ ...aggregatedOrchestratorActionsReport.pageLayoutTab.delete,+ ...aggregatedOrchestratorActionsReport.pageLayout.delete,+...aggregatedOrchestratorActionsReport.navigationMenuItem.create,...aggregatedOrchestratorActionsReport.navigationMenuItem.update,+ // Items CASCADE on their folder, so one moved out of a dropped folder must be repointed before that folder goes+ ...aggregatedOrchestratorActionsReport.navigationMenuItem.delete,- ...aggregatedOrchestratorActionsReport.rowLevelPermissionPredicateGroup- .delete,...aggregatedOrchestratorActionsReport.rowLevelPermissionPredicateGroup.create,...aggregatedOrchestratorActionsReport.rowLevelPermissionPredicateGroup@@ -129,6 +132,10 @@ export const computeOrderedMigrationActions = (...aggregatedOrchestratorActionsReport.rowLevelPermissionPredicate.create,...aggregatedOrchestratorActionsReport.rowLevelPermissionPredicate.update,+ // Predicates and child groups CASCADE on their group, so one moved out of a dropped group must be repointed before that group goes+ ...aggregatedOrchestratorActionsReport.rowLevelPermissionPredicateGroup+ .delete,+...aggregatedOrchestratorActionsReport.webhook.delete,...aggregatedOrchestratorActionsReport.webhook.create,...aggregatedOrchestratorActionsReport.webhook.update,diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-view-sort-validator.service.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-view-sort-validator.service.tsindex 533f8b888c9..521404cf533 100644--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-view-sort-validator.service.ts+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/services/flat-view-sort-validator.service.ts@@ -88,8 +88,8 @@ export class FlatViewSortValidatorService {const equivalentExistingFlatViewSortExists = otherFlatViewSorts.some((flatViewSort) =>- flatViewSort.universalIdentifier ===- flatViewSortToValidate.universalIdentifier &&+ flatViewSort.viewUniversalIdentifier ===+ flatViewSortToValidate.viewUniversalIdentifier &&flatViewSort.fieldMetadataUniversalIdentifier ===flatViewSortToValidate.fieldMetadataUniversalIdentifier,);diff --git a/packages/twenty-server/test/integration/metadata/suites/view-sort/__snapshots__/failing-view-sort-creation.integration-spec.ts.snap b/packages/twenty-server/test/integration/metadata/suites/view-sort/__snapshots__/failing-view-sort-creation.integration-spec.ts.snapindex b94dbb7c790..cbb87f8cc73 100644--- a/packages/twenty-server/test/integration/metadata/suites/view-sort/__snapshots__/failing-view-sort-creation.integration-spec.ts.snap+++ b/packages/twenty-server/test/integration/metadata/suites/view-sort/__snapshots__/failing-view-sort-creation.integration-spec.ts.snap@@ -12,6 +12,42 @@ exports[`View Sort creation should fail when fieldMetadataId does not exist 1`]}`;+exports[`View Sort creation should fail when the view already has a sort on the same field 1`] = `+{+ "extensions": {+ "code": "METADATA_VALIDATION_FAILED",+ "errors": {+ "viewSort": [+ {+ "errors": [+ {+ "code": "INVALID_VIEW_SORT_DATA",+ "message": "View sort with same fieldMetadataId and viewId already exists",+ "userFriendlyMessage": "View sort already exists",+ },+ ],+ "flatEntityMinimalInformation": {+ "universalIdentifier": Any<String>,+ "viewUniversalIdentifier": Any<String>,+ },+ "metadataName": "viewSort",+ "status": "fail",+ "type": "create",+ },+ ],+ },+ "message": "Validation failed for 1 viewSort",+ "summary": {+ "totalErrors": 1,+ "viewSort": 1,+ },+ "userFriendlyMessage": "View sort already exists",+ },+ "message": "Multiple validation errors occurred while creating view sort",+ "name": "GraphQLError",+}+`;+exports[`View Sort creation should fail when viewId does not exist 1`] = `{"extensions": {diff --git a/packages/twenty-server/test/integration/metadata/suites/view-sort/failing-view-sort-creation.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/view-sort/failing-view-sort-creation.integration-spec.tsindex 9bd7fd3426a..81b0355fbc2 100644--- a/packages/twenty-server/test/integration/metadata/suites/view-sort/failing-view-sort-creation.integration-spec.ts+++ b/packages/twenty-server/test/integration/metadata/suites/view-sort/failing-view-sort-creation.integration-spec.ts@@ -15,6 +15,7 @@ import { type CreateViewSortInput } from 'src/engine/metadata-modules/view-sort/type TestSetup = {createdViewId: string;+ alreadySortedFieldMetadataId: string;};type TestContext = {@@ -42,10 +43,21 @@ const failingViewSortCreationTestCases: EachTestingContext<TestContext>[] = [}),},},+ {+ title: 'when the view already has a sort on the same field',+ context: {+ input: (testSetup) => ({+ viewId: testSetup.createdViewId,+ fieldMetadataId: testSetup.alreadySortedFieldMetadataId,+ direction: ViewSortDirection.DESC,+ }),+ },+ },];describe('View Sort creation should fail', () => {let createdViewId: string;+ let alreadySortedFieldMetadataId: string;beforeAll(async () => {const { objects } = await findManyObjectMetadata({@@ -57,6 +69,10 @@ describe('View Sort creation should fail', () => {gqlFields: `idnameSingular+ fieldsList {+ id+ name+ }`,});@@ -80,6 +96,22 @@ describe('View Sort creation should fail', () => {createdViewId = viewData?.createView?.id;jestExpectToBeDefined(createdViewId);++ const nameFieldMetadata = companyObjectMetadata.fieldsList?.find(+ (fieldMetadata) => fieldMetadata.name === 'name',+ );++ jestExpectToBeDefined(nameFieldMetadata);+ alreadySortedFieldMetadataId = nameFieldMetadata.id;++ await createOneViewSort({+ expectToFail: false,+ input: {+ viewId: createdViewId,+ fieldMetadataId: alreadySortedFieldMetadataId,+ direction: ViewSortDirection.ASC,+ },+ });});afterAll(async () => {@@ -96,7 +128,10 @@ describe('View Sort creation should fail', () => {async ({ context }) => {const { errors } = await createOneViewSort({expectToFail: true,- input: context.input({ createdViewId }),+ input: context.input({+ createdViewId,+ alreadySortedFieldMetadataId,+ }),});expectOneNotInternalServerErrorSnapshot({diff --git a/packages/twenty-server/test/integration/metadata/suites/view-sort/successful-view-sort-replacement.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/view-sort/successful-view-sort-replacement.integration-spec.tsnew file mode 100644index 00000000000..55e7a6d207a--- /dev/null+++ b/packages/twenty-server/test/integration/metadata/suites/view-sort/successful-view-sort-replacement.integration-spec.ts@@ -0,0 +1,70 @@+import gql from 'graphql-tag';+import { callMcpTool } from 'test/integration/graphql/suites/application-role-intersection/utils/call-mcp-tool.util';+import { makeMetadataApiRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';+import { destroyOneView } from 'test/integration/metadata/suites/view/utils/destroy-one-view.util';+import { jestExpectToBeDefined } from 'test/utils/jest-expect-to-be-defined.util.test';+import { ViewSortDirection } from 'twenty-shared/types';++const upsertCompleteViewThroughMcp = async (+ toolArguments: Record<string, unknown>,+): Promise<{ id: string }> => {+ const result = await callMcpTool({+ toolName: 'execute_tool',+ toolArguments: {+ toolName: 'upsert_complete_view',+ arguments: toolArguments,+ },+ token: API_KEY_ACCESS_TOKEN,+ });++ expect(result.isError).toBe(false);++ return JSON.parse(result.content[0].text);+};++// upsert_complete_view replaces sorts wholesale, so re-saving a sort on the+// same field deletes the old row and creates a new one in a single migration,+// which must not trip the (fieldMetadataId, viewId) unique index or the+// duplicate-sort validation.+describe('View Sort replacement should succeed', () => {+ let createdViewId: string | undefined;++ afterAll(async () => {+ if (createdViewId) {+ await destroyOneView({ expectToFail: false, viewId: createdViewId });+ }+ });++ it('should replace a sort with another one on the same field', async () => {+ const createdView = await upsertCompleteViewThroughMcp({+ objectNameSingular: 'company',+ name: 'Test View For View Sort Replacement',+ sorts: [{ fieldName: 'name', direction: ViewSortDirection.ASC }],+ });++ createdViewId = createdView.id;+ jestExpectToBeDefined(createdViewId);++ await upsertCompleteViewThroughMcp({+ id: createdViewId,+ sorts: [{ fieldName: 'name', direction: ViewSortDirection.DESC }],+ });++ const response = await makeMetadataApiRequest({+ query: gql`+ query GetViewSorts($viewId: String) {+ getViewSorts(viewId: $viewId) {+ id+ direction+ }+ }+ `,+ variables: { viewId: createdViewId },+ });++ expect(response.body.errors).toBeUndefined();+ expect(response.body.data.getViewSorts).toEqual([+ expect.objectContaining({ direction: ViewSortDirection.DESC }),+ ]);+ });+});