fix: isEditable for some primaryKeys

where property had defaultValue: sequelize.UUIDV4 - it was editable

Author: wojtek-krysiak

models/comment.js

@@ -0,0 +1,13 @@
+module.exports = (sequelize, DataTypes) => {
+  const Comment = sequelize.define('Comment', {
+    id: {
+      primaryKey: true,
+      type: DataTypes.UUID,
+      defaultValue: sequelize.UUIDV4,
+    },
+    title: DataTypes.STRING,
+    description: DataTypes.STRING,
+    publishedAt: DataTypes.DATE,
+  }, {})
+  return Comment
+}

src/database.spec.ts

@@ -35,7 +35,7 @@ describe('Database', () => {
   describe('#resources', () => {
     it('fetches all resources when entire db is given', () => {
       const database = new Database(db)
-      expect(database.resources()).to.have.lengthOf(2)
+      expect(database.resources()).to.have.lengthOf(Object.keys(db.sequelize.models).length)
       expect(database.resources()[0]).to.be.an.instanceof(Resource)
     })
 

src/property.spec.ts

@@ -1,73 +1,94 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 import chai, { expect } from 'chai'
 import sinonChai from 'sinon-chai'
+import { AvailableTestModels } from './utils/available-test-models'
 
 import Property from './property'
 
 chai.use(sinonChai)
 
 const db = require('../models/index.js')
 
-describe('Property', () => {
-  before(function () {
-    this.SequelizeModel = db.sequelize.models.User
-    this.rawAttributes = this.SequelizeModel.attributes || this.SequelizeModel.rawAttributes
-  })
+const getRawProperty = (modelName: AvailableTestModels, propertyName) => {
+  const model = db.sequelize.models[modelName]
+  const propertyAttrs = model.attributes || model.rawAttributes
+  return propertyAttrs[propertyName]
+}
 
+describe('Property', () => {
   describe('#isArray', () => {
-    it('returns false for regular (not arrayed) property', function () {
-      const property = new Property(this.rawAttributes.email)
+    it('returns false for regular (not arrayed) property', () => {
+      const property = new Property(getRawProperty('User', 'email'))
       expect(property.isArray()).to.equal(false)
     })
 
-    it('returns true for array property', function () {
-      const property = new Property(this.rawAttributes.arrayed)
+    it('returns true for array property', () => {
+      const property = new Property(getRawProperty('User', 'arrayed'))
       expect(property.isArray()).to.equal(true)
     })
   })
 
   describe('#type', () => {
-    it('returns correct string type', function () {
-      const property = new Property(this.rawAttributes.firstName)
+    it('returns correct string type', () => {
+      const property = new Property(getRawProperty('User', 'firstName'))
       expect(property.type()).to.equal('string')
     })
 
-    it('returns correct integer type', function () {
-      const property = new Property(this.rawAttributes.id)
+    it('returns correct integer type', () => {
+      const property = new Property(getRawProperty('User', 'id'))
       expect(property.type()).to.equal('number')
     })
 
-    it('returns correct date type', function () {
-      const property = new Property(this.rawAttributes.createdAt)
+    it('returns correct date type', () => {
+      const property = new Property(getRawProperty('User', 'createdAt'))
       expect(property.type()).to.equal('datetime')
     })
 
-    it('returns string when property is an array of strings', function () {
-      const property = new Property(this.rawAttributes.arrayed)
+    it('returns string when property is an array of strings', () => {
+      const property = new Property(getRawProperty('User', 'arrayed'))
       expect(property.type()).to.equal('string')
     })
   })
 
   describe('#availableValues', () => {
-    it('returns null for all standard (Non enum) values', function () {
-      const property = new Property(this.rawAttributes.email)
+    it('returns null for all standard (Non enum) values', () => {
+      const property = new Property(getRawProperty('User', 'email'))
       expect(property.availableValues()).to.equal(null)
     })
 
-    it('returns array of values for the enum field', function () {
-      const property = new Property(this.rawAttributes.gender)
+    it('returns array of values for the enum field', () => {
+      const property = new Property(getRawProperty('User', 'gender'))
       expect(property.availableValues()).to.deep.equal(['male', 'female'])
     })
   })
 
+  describe('#isEditable', () => {
+    it('returns false for UUID property', () => {
+      const property = new Property(getRawProperty('Comment', 'id'))
+      expect(property.isEditable()).to.equal(false)
+    })
+  })
+
+  describe('#isId', () => {
+    it('returns true for id when its default', () => {
+      const property = new Property(getRawProperty('User', 'id'))
+      expect(property.isId()).to.eq(true)
+    })
+
+    it('returns true for id when its uuid', () => {
+      const property = new Property(getRawProperty('Comment', 'id'))
+      expect(property.isId()).to.eq(true)
+    })
+  })
+
   describe('isRequired', () => {
-    it('returns true for required fields', function () {
-      const property = new Property(this.rawAttributes.email)
+    it('returns true for required fields', () => {
+      const property = new Property(getRawProperty('User', 'email'))
       expect(property.isRequired()).to.equal(true)
     })
 
-    it('returns false for not required fields', function () {
-      const property = new Property(this.rawAttributes.gender)
+    it('returns false for not required fields', () => {
+      const property = new Property(getRawProperty('User', 'gender'))
       expect(property.isRequired()).to.eq(false)
     })
   })

src/property.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-underscore-dangle */
 import { BaseProperty, PropertyType } from 'admin-bro'
 import { ModelAttributeColumnOptions } from 'sequelize/types'
 
@@ -43,8 +44,16 @@ class Property extends BaseProperty {
   }
 
   isEditable(): boolean {
-    // eslint-disable-next-line no-underscore-dangle
-    return !(this.sequelizePath as any)._autoGenerated && !this.sequelizePath.autoIncrement
+    if ((this.sequelizePath as any)._autoGenerated) {
+      return false
+    }
+    if (this.sequelizePath.autoIncrement) {
+      return false
+    }
+    if (this.isId()) {
+      return false
+    }
+    return true
   }
 
   isVisible(): boolean {

src/utils/available-test-models.ts

@@ -0,0 +1 @@
+export type AvailableTestModels = 'User' | 'Post' | 'Comment'