fix: handle undefined values in migration generation [ZEND-6547] (#3033)

Author: jjolton-contentful

lib/cmds/space_cmds/generate_cmds/migration.js

@@ -151,6 +151,12 @@ const ctVariableEscape = function (ctId) {
 
 module.exports.ctVariableEscape = ctVariableEscape
 
+const filterNullAndUndefined = function (entries) {
+  return entries.filter(([, value]) => value !== null && value !== undefined)
+}
+
+module.exports.filterNullAndUndefined = filterNullAndUndefined
+
 const wrapMigrationWithBase = function (blockStatement) {
   const migration = b.program([
     b.expressionStatement(
@@ -185,11 +191,11 @@ const createCallChain = function (base, chain) {
 const createContentType = function (ct) {
   const id = ct.sys.id
   const { name, description, displayField } = ct
-  const chain = [
+  const chain = filterNullAndUndefined([
     ['name', name],
     ['description', description],
     ['displayField', displayField]
-  ].filter(([, value]) => value !== null)
+  ])
 
   const variableName = ctVariableEscape(id)
 
@@ -216,9 +222,11 @@ const createField = function (ctId, field) {
   const fieldId = field.id
   const ctVariable = ctVariableEscape(ctId)
 
-  const chain = Object.keys(_.omit(field, 'id')).map(key => {
-    return [key, field[key]]
-  })
+  const chain = filterNullAndUndefined(
+    Object.keys(_.omit(field, 'id')).map(key => {
+      return [key, field[key]]
+    })
+  )
 
   return createCallChain(
     b.callExpression(
@@ -238,13 +246,18 @@ const changeFieldControl = function (
   widgetId,
   settings
 ) {
+  if (!widgetNamespace || !widgetId) {
+    return null
+  }
+
   const ctVariable = ctVariableEscape(ctId)
   settings = settings || {}
 
   const settingsExpression = b.objectExpression(
-    _.map(settings, (v, k) => {
-      return b.property('init', b.identifier(k), b.literal(v))
-    })
+    filterNullAndUndefined(Object.entries(settings))
+      .map(([k, v]) => {
+        return b.property('init', b.identifier(k), b.literal(v))
+      })
   )
 
   return b.callExpression(
@@ -290,18 +303,22 @@ const generateContentTypeMigration = async function (environment, contentType) {
         return control.fieldId === field.id
       })
 
+      if (!control) {
+        return null
+      }
+
       const { widgetId, settings, widgetNamespace = 'builtin' } = control
 
-      return b.expressionStatement(
-        changeFieldControl(
-          contentType.sys.id,
-          field.id,
-          widgetNamespace,
-          widgetId,
-          settings
-        )
+      const changeFieldControlCall = changeFieldControl(
+        contentType.sys.id,
+        field.id,
+        widgetNamespace,
+        widgetId,
+        settings
       )
-    })
+
+      return changeFieldControlCall ? b.expressionStatement(changeFieldControlCall) : null
+    }).filter(creator => creator !== null)
   } catch (err) {
     if (err.name === 'NotFound') {
       log('Skipping editor interfaces. Content type has no fields.')

test/unit/cmds/space_cmds/generate_cmds/migration.test.js

@@ -40,6 +40,25 @@ const simpleContentType = {
   ]
 }
 
+const contentTypeWithUndefined = {
+  sys: {
+    id: 'bar'
+  },
+  name: 'Bar',
+  description: undefined,
+  displayField: undefined,
+  fields: [
+    {
+      id: 'title',
+      name: 'Title',
+      type: 'Symbol',
+      required: undefined,
+      localized: undefined,
+      disabled: false
+    }
+  ]
+}
+
 const editorInterface = {
   controls: [
     {
@@ -53,6 +72,38 @@ const editorInterface = {
   ]
 }
 
+const editorInterfaceWithUndefined = {
+  controls: [
+    {
+      fieldId: 'title',
+      widgetId: 'singleLine',
+      widgetNamespace: 'builtin',
+      settings: {
+        helpText: undefined,
+        placeholder: 'Enter title',
+        showLinkEntityAction: undefined
+      }
+    }
+  ]
+}
+
+const editorInterfaceWithMissingProperties = {
+  controls: [
+    {
+      fieldId: 'title',
+      widgetId: 'singleLine',
+      widgetNamespace: 'builtin',
+      settings: {
+        helpText: 'Valid title'
+      }
+    },
+    {
+      fieldId: 'description'
+      // Missing widgetId and widgetNamespace
+    }
+  ]
+}
+
 const EditorInterfaceNotFoundErrorMock = function () {
   this.name = 'NotFound'
 }
@@ -173,6 +224,79 @@ test('it creates the editor interface', async () => {
   )
 })
 
+test('it handles undefined values in content type', async () => {
+  const programStub = b.blockStatement([createContentType(contentTypeWithUndefined)])
+
+  const expected = `module.exports = function(migration) {
+    const bar = migration.createContentType("bar").name("Bar");
+};`
+
+  expect(recast.prettyPrint(wrapMigrationWithBase(programStub)).code).toBe(
+    expected
+  )
+})
+
+test('it handles undefined values in field properties', async () => {
+  const programStub = b.blockStatement([
+    b.expressionStatement(
+      createField(contentTypeWithUndefined.sys.id, contentTypeWithUndefined.fields[0])
+    )
+  ])
+
+  const expected = `module.exports = function(migration) {
+    bar.createField("title").name("Title").type("Symbol").disabled(false);
+};`
+
+  expect(recast.prettyPrint(wrapMigrationWithBase(programStub)).code).toBe(
+    expected
+  )
+})
+
+test('it handles undefined values in editor interface settings', async () => {
+  const programStub = b.blockStatement([
+    b.expressionStatement(
+      changeFieldControl(
+        'bar',
+        editorInterfaceWithUndefined.controls[0].fieldId,
+        editorInterfaceWithUndefined.controls[0].widgetNamespace,
+        editorInterfaceWithUndefined.controls[0].widgetId,
+        editorInterfaceWithUndefined.controls[0].settings
+      )
+    )
+  ])
+
+  const expected = `module.exports = function(migration) {
+    bar.changeFieldControl("title", "builtin", "singleLine", {
+        placeholder: "Enter title"
+    });
+};`
+
+  expect(recast.prettyPrint(wrapMigrationWithBase(programStub)).code).toBe(
+    expected
+  )
+})
+
+test('it skips changeFieldControl when required parameters are undefined', async () => {
+  const validControl = changeFieldControl(
+    'bar',
+    editorInterfaceWithMissingProperties.controls[0].fieldId,
+    editorInterfaceWithMissingProperties.controls[0].widgetNamespace,
+    editorInterfaceWithMissingProperties.controls[0].widgetId,
+    editorInterfaceWithMissingProperties.controls[0].settings
+  )
+
+  const invalidControl = changeFieldControl(
+    'bar',
+    editorInterfaceWithMissingProperties.controls[1].fieldId,
+    editorInterfaceWithMissingProperties.controls[1].widgetNamespace,
+    editorInterfaceWithMissingProperties.controls[1].widgetId,
+    editorInterfaceWithMissingProperties.controls[1].settings
+  )
+
+  expect(validControl).not.toBeNull()
+  expect(invalidControl).toBeNull()
+})
+
 test('it creates the full migration script', async () => {
   const expected = `module.exports = function (migration) {
   const foo = migration