🐛 Updated base model to store null instead of empty string (#10425)

refs #10388 

This updates the base model to retrieve column information, and explicitly set every property whose column is `nullable` and content is the empty string (`""`) to `null`

core/server/models/base/index.js

@@ -201,7 +201,6 @@ ghostBookshelf.Model = ghostBookshelf.Model.extend({
      */
     onValidate: function onValidate(model, columns, options) {
         this.setEmptyValuesToNull();
-
         return validation.validateSchema(this.tableName, this, options);
     },
 
@@ -374,20 +373,16 @@ ghostBookshelf.Model = ghostBookshelf.Model.extend({
         return attrs;
     },
 
-    // Sets given values to `null`
+    getNullableStringProperties() {
+        const table = schema.tables[this.tableName];
+        return Object.keys(table).filter(column => table[column].nullable);
+    },
+
     setEmptyValuesToNull: function setEmptyValuesToNull() {
-        var self = this,
-            attr;
-
-        if (!this.emptyStringProperties) {
-            return;
-        }
-
-        attr = this.emptyStringProperties();
-
-        _.each(attr, function (value) {
-            if (self.get(value) === '') {
-                self.set(value, null);
+        const nullableStringProps = this.getNullableStringProperties();
+        return nullableStringProps.forEach((prop) => {
+            if (this.get(prop) === '') {
+                this.set(prop, null);
             }
         });
     },

core/server/models/post.js

@@ -454,13 +454,6 @@ Post = ghostBookshelf.Model.extend({
         return sequence(ops);
     },
 
-    emptyStringProperties: function emptyStringProperties() {
-        // CASE: the client might send empty image properties with "" instead of setting them to null.
-        // This can cause GQL to fail. We therefore enforce 'null' for empty image properties.
-        // See https://github.com/TryGhost/GQL/issues/24
-        return ['feature_image', 'og_image', 'twitter_image'];
-    },
-
     created_by: function createdBy() {
         return this.belongsTo('User', 'created_by');
     },

core/server/models/tag.js

@@ -49,13 +49,6 @@ Tag = ghostBookshelf.Model.extend({
         }
     },
 
-    emptyStringProperties: function emptyStringProperties() {
-        // CASE: the client might send empty image properties with "" instead of setting them to null.
-        // This can cause GQL to fail. We therefore enforce 'null' for empty image properties.
-        // See https://github.com/TryGhost/GQL/issues/24
-        return ['feature_image'];
-    },
-
     posts: function posts() {
         return this.belongsToMany('Post');
     },

core/server/models/user.js

@@ -230,13 +230,6 @@ User = ghostBookshelf.Model.extend({
         return attrs;
     },
 
-    emptyStringProperties: function emptyStringProperties() {
-        // CASE: the client might send empty image properties with "" instead of setting them to null.
-        // This can cause GQL to fail. We therefore enforce 'null' for empty image properties.
-        // See https://github.com/TryGhost/GQL/issues/24
-        return ['profile_image', 'cover_image'];
-    },
-
     format: function format(options) {
         if (!_.isEmpty(options.website) &&
             !validator.isURL(options.website, {

core/test/unit/models/base/index_spec.js

@@ -174,8 +174,8 @@ describe('Models: base', function () {
         it('resets given empty value to null', function () {
             const base = models.Base.Model.forge({a: '', b: ''});
 
-            base.emptyStringProperties = sinon.stub();
-            base.emptyStringProperties.returns(['a']);
+            base.getNullableStringProperties = sinon.stub();
+            base.getNullableStringProperties.returns(['a']);
 
             base.get('a').should.eql('');
             base.get('b').should.eql('');
@@ -183,13 +183,6 @@ describe('Models: base', function () {
             should.not.exist(base.get('a'));
             base.get('b').should.eql('');
         });
-
-        it('does not reset to null if model does\'t provide properties', function () {
-            const base = models.Base.Model.forge({a: ''});
-            base.get('a').should.eql('');
-            base.setEmptyValuesToNull();
-            base.get('a').should.eql('');
-        });
     });
 
     describe('destroy', function () {