Fixed applying of snapshot changes to/from alias fields (#24120)

* Fix applying of snapshot changes to/from alias fields * Add changeset
directus · Dec 2, 2024 · 92684fc · 92684fc
1 parent fb41400
commit 92684fc
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 4 deletions.
diff --git a/.changeset/tiny-deers-scream.md b/.changeset/tiny-deers-scream.md
@@ -0,0 +1,5 @@
+---
+'@directus/api': patch
+---
+
+Fixed applying of snapshot changes to/from alias fields
diff --git a/api/src/utils/apply-diff.ts b/api/src/utils/apply-diff.ts
@@ -205,7 +205,7 @@ export async function applyDiff(
 			}
 		}
 
-		const fieldsService = new FieldsService({
+		let fieldsService = new FieldsService({
 			knex: trx,
 			schema: await getSchema({ database: trx, bypassCache: true }),
 		});
@@ -214,6 +214,12 @@ export async function applyDiff(
 			if (diff?.[0]?.kind === DiffKind.NEW && !isNestedMetaUpdate(diff?.[0])) {
 				try {
 					await fieldsService.createField(collection, (diff[0] as DiffNew<Field>).rhs, undefined, mutationOptions);
+
+					// Refresh the schema
+					fieldsService = new FieldsService({
+						knex: trx,
+						schema: await getSchema({ database: trx, bypassCache: true }),
+					});
 				} catch (err) {
 					logger.error(`Failed to create field "${collection}.${field}"`);
 					throw err;
@@ -243,15 +249,24 @@ export async function applyDiff(
 			if (diff?.[0]?.kind === DiffKind.DELETE && !isNestedMetaUpdate(diff?.[0])) {
 				try {
 					await fieldsService.deleteField(collection, field, mutationOptions);
+
+					// Refresh the schema
+					fieldsService = new FieldsService({
+						knex: trx,
+						schema: await getSchema({ database: trx, bypassCache: true }),
+					});
 				} catch (err) {
 					logger.error(`Failed to delete field "${collection}.${field}"`);
 					throw err;
 				}
 
 				// Field deletion also cleans up the relationship. We should ignore any relationship
-				// changes attached to this now non-existing field
+				// changes attached to this now non-existing field except newly created relationship
 				snapshotDiff.relations = snapshotDiff.relations.filter(
-					(relation) => (relation.collection === collection && relation.field === field) === false,
+					(relation) =>
+						(relation.collection === collection &&
+							relation.field === field &&
+							!relation.diff.some((diff) => diff.kind === DiffKind.NEW)) === false,
 				);
 			}
 		}

diff --git a/api/src/utils/get-snapshot-diff.ts b/api/src/utils/get-snapshot-diff.ts
@@ -38,6 +38,22 @@ export function getSnapshotDiff(current: Snapshot, after: Snapshot): SnapshotDif
 				const isAutoIncrementPrimaryKey =
 					!!currentField.schema?.is_primary_key && !!currentField.schema?.has_auto_increment;
 
+				// Changing to/from alias fields should delete the current field
+				if (
+					afterField &&
+					currentField.type !== afterField.type &&
+					(currentField.type === 'alias' || afterField.type === 'alias')
+				) {
+					return {
+						collection: currentField.collection,
+						field: currentField.field,
+						diff: deepDiff.diff(
+							sanitizeField(currentField, isAutoIncrementPrimaryKey),
+							sanitizeField(undefined, isAutoIncrementPrimaryKey),
+						),
+					};
+				}
+
 				return {
 					collection: currentField.collection,
 					field: currentField.field,
@@ -49,11 +65,20 @@ export function getSnapshotDiff(current: Snapshot, after: Snapshot): SnapshotDif
 			}),
 			...after.fields
 				.filter((afterField) => {
-					const currentField = current.fields.find(
+					let currentField = current.fields.find(
 						(currentField) =>
 							currentField.collection === afterField.collection && afterField.field === currentField.field,
 					);
 
+					// Changing to/from alias fields should create the new field
+					if (
+						currentField &&
+						currentField.type !== afterField.type &&
+						(currentField.type === 'alias' || afterField.type === 'alias')
+					) {
+						currentField = undefined;
+					}
+
 					return !!currentField === false;
 				})
 				.map((afterField) => ({