fix(editor-interface): control changes of newly created fields should not trigger errors for editor interfaces with editorLayout property

[ruderngespra]

We are seeing a few customer complaints for migration scripts which create new fields on a content type and then immediately change field controls for the newly created field in the same migration script. Customers run into a validation error and then are unable to do the field control changes. The reason for this is whenever field updates happen on content types which have corresponding editorInterfaces with editorLayout properties, those editorInterfaces are silently updated as well by our API. Contentful-migration however does not know about this and therefore sends an outdated payload to the editor_interface endpoint.

This PR aims to hotfix the issue for creating fields by adding a custom check during editorInterface updates that detects whether for a given editorInterface there is a fieldId missing in editorLayout and if so silently adds the id to the first group. This way, it mimics the implicit update to the editorInterface which silently happened in the backend and thereby avoids validation errors on the update.

what this is not yet solving

• Similar cases for deleting fields or changing field ids. For that, we would need different patching logic.

On the long run, we should make sure that the migration tool always has access to the updated editorInterfaces it applies migrations to, so we might think about re-fetching editorInterfaces after content type updates which involve field updates.

todos

• double check with team that owns editorLayout if two layers of nesting is enough ✅
• For now we are just adding the fieldId to the first group in the list. Is there a better way to chose to which group the fieldId should be added? (e.g. a marked default?) --> The first item is used as default everywhere, so we are fine ✅
• Create follow up tickets for the actual fix ✅

[andreascful]

Very good concise change. Great that you figured out this hard issue!

[contentful-automation]

🎉 This PR is included in version 4.12.2 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀