@slicemachine/manager 0.24.14-alpha.jp-update-cr-links-unit.4 → 0.24.14-alpha.jp-update-cr-links-only-when-changed.1

package/src/managers/customTypes/CustomTypesManager.ts

@@ -188,6 +188,154 @@ export class CustomTypesManager extends BaseManager {
 		};
 	}
 
+	private updateCRCustomType(
+		args: { customType: CrCustomType } & CustomTypeFieldIdChangedMeta,
+	): { customType: CrCustomType; changed: boolean } {
+		const { previousPath, newPath } = args;
+		const customType = shallowClone(args.customType);
+
+		const [previousId] = previousPath;
+		const [newId] = newPath;
+
+		if (!previousId || !newId || typeof customType === "string") {
+			return { customType, changed: false };
+		}
+
+		let modelHasChanged = false;
+
+		if (customType.fields) {
+			const newFields = customType.fields.map((fieldArg) => {
+				const field = shallowClone(fieldArg);
+
+				const previousId = previousPath[1];
+				const newId = newPath[1];
+
+				if (!previousId || !newId) {
+					return field;
+				}
+
+				if (typeof field === "string") {
+					if (field === previousId && field !== newId) {
+						modelHasChanged = true;
+
+						// We have reached a field id that matches the id that was renamed,
+						// so we update it new one. The field is a string, so return the new
+						// id.
+						return newId;
+					}
+
+					return field;
+				}
+
+				if (field.id === previousId && field.id !== newId) {
+					modelHasChanged = true;
+
+					// We have reached a field id that matches the id that was renamed,
+					// so we update it new one.
+					// Since field is not a string, we don't exit, as we might have
+					// something to update further down in customtypes.
+					field.id = newId;
+				}
+
+				return {
+					...field,
+					customtypes: field.customtypes.map((customTypeArg) => {
+						const customType = shallowClone(customTypeArg);
+						const previousId = previousPath[2];
+						const newId = newPath[2];
+
+						if (!previousId || !newId) {
+							return customType;
+						}
+
+						if (typeof customType === "string") {
+							if (customType === previousId && customType !== newId) {
+								modelHasChanged = true;
+
+								// Matches the previous id, so we update it.
+								return newId;
+							}
+
+							return customType;
+						}
+
+						if (customType.id === previousId && customType.id !== newId) {
+							modelHasChanged = true;
+
+							// Matches the previous id, so we update it and return because
+							// it's the last level.
+							return { ...customType, id: newId };
+						}
+
+						return customType;
+					}),
+				};
+			});
+
+			return {
+				customType: { ...customType, fields: newFields },
+				changed: modelHasChanged,
+			};
+		}
+
+		return { customType, changed: modelHasChanged };
+	}
+
+	/**
+	 * Map over the custom types of a Content Relationship Link and update the API
+	 * IDs that were changed during the custom type update.
+	 */
+	private updateCRCustomTypes(
+		args: { customTypes: CrCustomTypes } & CustomTypeFieldIdChangedMeta,
+	): { customTypes: CrCustomTypes; changed: boolean } {
+		const { customTypes, ...updateMeta } = args;
+
+		let customTypeHasChanged = false;
+
+		const newCustomTypes = customTypes.map((customType) => {
+			const update = this.updateCRCustomType({ customType, ...updateMeta });
+
+			customTypeHasChanged ||= update.changed;
+
+			return update.customType;
+		});
+
+		return { customTypes: newCustomTypes, changed: customTypeHasChanged };
+	}
+
+	/**
+	 * Update the Content Relationship API IDs of a single field. The change is
+	 * determined by the `previousPath` and `newPath` properties.
+	 */
+	private updateFieldContentRelationships<
+		T extends UID | NestableWidget | Group | NestedGroup,
+	>(
+		args: { field: T } & CustomTypeFieldIdChangedMeta,
+	): { field: T; changed: boolean } {
+		const { field, ...updateMeta } = args;
+		if (
+			field.type !== "Link" ||
+			field.config?.select !== "document" ||
+			!field.config?.customtypes
+		) {
+			// not a content relationship field
+			return { field, changed: false };
+		}
+
+		const update = this.updateCRCustomTypes({
+			...updateMeta,
+			customTypes: field.config.customtypes,
+		});
+
+		return {
+			field: {
+				...field,
+				config: { ...field.config, customtypes: update.customTypes },
+			},
+			changed: update.changed,
+		};
+	}
+
 	/**
 	 * Update the Content Relationship API IDs for all existing custom types and
 	 * slices. The change is determined by properties inside the `updateMeta`
@@ -213,19 +361,34 @@ export class CustomTypesManager extends BaseManager {
 				// any custom type and update them to use the new one.
 				const customTypes = await this.readAllCustomTypes();
 
-				updateCustomTypeContentRelationships({
-					models: customTypes.models,
-					onUpdate: (model) => {
-						pushIfDefined(
-							crUpdates,
-							this.sliceMachinePluginRunner?.callHook("custom-type:update", {
-								model,
+				for (const customType of customTypes.models) {
+					// Keep track of whether the model has changed to avoid calling the
+					// update hook if nothing has changed
+					let customTypeHasChanged = false;
+
+					const updatedCustomTypeModel = traverseCustomType({
+						customType: customType.model,
+						onField: ({ field }) => {
+							const update = this.updateFieldContentRelationships({
+								field,
+								previousPath,
+								newPath,
+							});
+
+							customTypeHasChanged ||= update.changed;
+
+							return update.field;
+						},
+					});
+
+					if (customTypeHasChanged) {
+						crUpdates.push(
+							this.sliceMachinePluginRunner.callHook("custom-type:update", {
+								model: updatedCustomTypeModel,
 							}),
 						);
-					},
-					previousPath,
-					newPath,
-				});
+					}
+				}
 
 				// Find existing slice with content relationships that link to the renamed
 				// field id in all libraries and update them to use the new one.
@@ -236,29 +399,45 @@ export class CustomTypesManager extends BaseManager {
 						libraryID: library.libraryID,
 					});
 
-					updateSharedSliceContentRelationships({
-						models: slices.models,
-						onUpdate: (model) => {
-							pushIfDefined(
-								crUpdates,
-								this.sliceMachinePluginRunner?.callHook("slice:update", {
+					for (const slice of slices.models) {
+						// Keep track of whether the model has changed to avoid calling the
+						// update hook if nothing has changed
+						let sliceHasChanged = false;
+
+						const updatedSliceModel = traverseSharedSlice({
+							path: ["."],
+							slice: slice.model,
+							onField: ({ field }) => {
+								const update = this.updateFieldContentRelationships({
+									field,
+									previousPath,
+									newPath,
+								});
+
+								sliceHasChanged ||= update.changed;
+
+								return update.field;
+							},
+						});
+
+						if (sliceHasChanged) {
+							crUpdates.push(
+								this.sliceMachinePluginRunner.callHook("slice:update", {
 									libraryID: library.libraryID,
-									model,
+									model: updatedSliceModel,
 								}),
 							);
-						},
-						previousPath,
-						newPath,
-					});
-				}
+						}
+					}
 
-				// Process all the Content Relationship updates at once.
-				const crUpdatesResult = await Promise.all(crUpdates);
+					// Process all the Content Relationship updates at once.
+					const crUpdatesResult = await Promise.all(crUpdates);
 
-				if (crUpdatesResult.some((result) => result.errors.length > 0)) {
-					return {
-						errors: crUpdatesResult.flatMap((result) => result.errors),
-					};
+					if (crUpdatesResult.some((result) => result.errors.length > 0)) {
+						return {
+							errors: crUpdatesResult.flatMap((result) => result.errors),
+						};
+					}
 				}
 			}
 		}
@@ -495,178 +674,10 @@ const InferSliceResponse = z.object({
 	langSmithUrl: z.string().url().optional(),
 });
 
-function updateCRCustomType<T extends CrCustomType | CrCustomTypeFieldLeaf>(
-	args: {
-		customType: T;
-	} & CustomTypeFieldIdChangedMeta,
-): T {
-	const { previousPath, newPath } = args;
-
-	const customType = shallowCloneIfObject(args.customType);
-
-	const [previousId] = previousPath;
-	const [newId] = newPath;
-
-	if (!previousId || !newId || typeof customType === "string") {
-		return customType;
-	}
-
-	if (customType.fields) {
-		const newFields = customType.fields.map((fieldArg) => {
-			const field = shallowCloneIfObject(fieldArg);
-
-			const previousId = previousPath[1];
-			const newId = newPath[1];
-
-			if (!previousId || !newId) {
-				return field;
-			}
-
-			if (typeof field === "string") {
-				if (field === previousId && field !== newId) {
-					// We have reached a field id that matches the id that was renamed,
-					// so we update it new one. The field is a string, so return the new
-					// id.
-					return newId;
-				}
-
-				return field;
-			}
-
-			if (field.id === previousId && field.id !== newId) {
-				// We have reached a field id that matches the id that was renamed,
-				// so we update it new one.
-				// Since field is not a string, we don't exit, as we might have
-				// something to update further down in customtypes.
-				field.id = newId;
-			}
-
-			return {
-				...field,
-				customtypes: field.customtypes.map((customType) => {
-					return updateCRCustomType({
-						customType,
-						previousPath,
-						newPath,
-					});
-				}),
-			};
-		});
-
-		// @ts-expect-error We know that at this level we are returning the
-		// right properties, but TypeScript will not trust it because it might
-		// also have customtypes. This is because the type is not fully
-		// recursive, it just has two levels of depth.
-		return {
-			id: customType.id,
-			fields: newFields,
-		};
-	}
-
-	return customType;
-}
-
-/**
- * Map over the custom types of a Content Relationship Link and update the API
- * IDs that were changed during the custom type update.
- */
-function updateCRCustomTypes(
-	args: { customTypes: CrCustomTypes } & CustomTypeFieldIdChangedMeta,
-): CrCustomTypes {
-	const { customTypes, ...updateMeta } = args;
-
-	return customTypes.map((customType) => {
-		return updateCRCustomType({ customType, ...updateMeta });
-	});
-}
-
-/**
- * Update the Content Relationship API IDs of a single field. The change is
- * determined by the `previousPath` and `newPath` properties.
- */
-function updateFieldContentRelationships<
-	T extends UID | NestableWidget | Group | NestedGroup,
->(args: { field: T } & CustomTypeFieldIdChangedMeta): T {
-	const { field, ...updateMeta } = args;
-	if (
-		field.type !== "Link" ||
-		field.config?.select !== "document" ||
-		!field.config?.customtypes
-	) {
-		// not a content relationship field
-		return field;
-	}
-
-	const newCustomTypes = updateCRCustomTypes({
-		...updateMeta,
-		customTypes: field.config.customtypes,
-	});
-
-	return {
-		...field,
-		config: { ...field.config, customtypes: newCustomTypes },
-	};
-}
-
-export function updateCustomTypeContentRelationships(
-	args: {
-		models: { model: CustomType }[];
-		onUpdate: (model: CustomType) => void;
-	} & CustomTypeFieldIdChangedMeta,
-): void {
-	const { models, previousPath, newPath, onUpdate } = args;
-
-	for (const customType of models) {
-		const updatedCustomTypeModel = traverseCustomType({
-			customType: customType.model,
-			onField: ({ field }) => {
-				return updateFieldContentRelationships({
-					field,
-					previousPath,
-					newPath,
-				});
-			},
-		});
-
-		onUpdate(updatedCustomTypeModel);
-	}
-}
-
-export function updateSharedSliceContentRelationships(
-	args: {
-		models: { model: SharedSlice }[];
-		onUpdate: (model: SharedSlice) => void;
-	} & CustomTypeFieldIdChangedMeta,
-): void {
-	const { models, previousPath, newPath, onUpdate } = args;
-
-	for (const slice of models) {
-		const updatedSliceModel = traverseSharedSlice({
-			path: ["."],
-			slice: slice.model,
-			onField: ({ field }) => {
-				return updateFieldContentRelationships({
-					field,
-					previousPath,
-					newPath,
-				});
-			},
-		});
-
-		onUpdate(updatedSliceModel);
-	}
-}
-
-function shallowCloneIfObject<T>(value: T): T {
+function shallowClone<T>(value: T): T {
 	if (typeof value === "object") {
 		return { ...value };
 	}
 
 	return value;
 }
-
-function pushIfDefined<T>(array: T[], value: T | undefined) {
-	if (value) {
-		array.push(value);
-	}
-}