improvement: identify primary key fields as such (#409)

Author: ghusse

src/adapters/mongoose.js

@@ -64,6 +64,10 @@ module.exports = (model, opts) => {
         type: getType(fieldName),
       };
 
+      if (fieldName === '_id') {
+        field.isPrimaryKey = true;
+      }
+
       if (!field.type) { return; }
 
       const ref = detectReference(fieldInfo);
@@ -191,6 +195,10 @@ module.exports = (model, opts) => {
         type: getTypeFromMongoose(fieldType),
       };
 
+      if (fieldName === '_id') {
+        field.isPrimaryKey = true;
+      }
+
       if (fieldType.enumValues && fieldType.enumValues.length) {
         field.enums = fieldType.enumValues;
       }
@@ -274,6 +282,10 @@ module.exports = (model, opts) => {
       schema.isRequired = isRequired;
     }
 
+    if (path === '_id') {
+      schema.isPrimaryKey = true;
+    }
+
     if (fieldInfo.options && !_.isNull(fieldInfo.options.default)
       && !_.isUndefined(fieldInfo.options.default)
       && !_.isFunction(fieldInfo.options.default)) {

test/tests/adapters/expected-results/deep-nested-object.json

@@ -173,7 +173,8 @@
     },
     {
       "field": "_id",
-      "type": "String"
+      "type": "String",
+      "isPrimaryKey": true
     }
   ]
 }

test/tests/adapters/expected-results/deep-nested-schema.json

@@ -62,7 +62,8 @@
                   },
                   {
                     "field": "_id",
-                    "type": "String"
+                    "type": "String",
+                    "isPrimaryKey": true
                   }
                 ]
               }
@@ -73,7 +74,8 @@
     },
     {
       "field": "_id",
-      "type": "String"
+      "type": "String",
+      "isPrimaryKey": true
     }
   ]
 }

test/tests/adapters/expected-results/real-world-schema.json

@@ -73,6 +73,7 @@
             },
             {
               "field": "_id",
+              "isPrimaryKey": true,
               "type": "String"
             }
           ]
@@ -145,6 +146,7 @@
             },
             {
               "field": "_id",
+              "isPrimaryKey": true,
               "type": "String"
             }
           ]
@@ -173,6 +175,7 @@
             },
             {
               "field": "_id",
+              "isPrimaryKey": true,
               "type": "String"
             }
           ]
@@ -241,6 +244,7 @@
                     },
                     {
                       "field": "_id",
+                      "isPrimaryKey": true,
                       "type": "String"
                     }
                   ]
@@ -259,6 +263,7 @@
             },
             {
               "field": "_id",
+              "isPrimaryKey": true,
               "type": "String"
             }
           ]
@@ -299,6 +304,7 @@
             },
             {
               "field": "_id",
+              "isPrimaryKey": true,
               "type": "String"
             }
           ]
@@ -377,6 +383,7 @@
                 },
                 {
                   "field": "_id",
+                  "isPrimaryKey": true,
                   "type": "String"
                 }
               ]
@@ -394,6 +401,7 @@
                 },
                 {
                   "field": "_id",
+                  "isPrimaryKey": true,
                   "type": "String"
                 }
               ]
@@ -432,7 +440,8 @@
     },
     {
       "field": "_id",
-      "type": "String"
+      "type": "String",
+      "isPrimaryKey": true
     }
   ]
 }

test/tests/adapters/mongoose.test.js

@@ -450,7 +450,7 @@ describe('adapters > schema-adapter', () => {
         { field: 'firstName', type: 'String' },
         { field: 'lastName', type: 'String' },
         { field: 'createdAt', type: 'Date' },
-        { field: '_id', type: 'String' },
+        { field: '_id', type: 'String', isPrimaryKey: true },
       ]);
     });
   });
@@ -755,4 +755,30 @@ describe('adapters > schema-adapter', () => {
       expect(result.fields).toHaveLength(2);
     });
   });
+
+  describe('isPrimaryKey flag', () => {
+    let model;
+
+    beforeAll(() => {
+      const schema = new mongoose.Schema({
+        _id: mongoose.Schema.ObjectId,
+        bar: String,
+      });
+      model = mongoose.model('Foo', schema);
+    });
+
+    it('should be set to true on field _id', async () => {
+      expect.assertions(2);
+
+      const result = await createSchemaAdapter(model, {
+        mongoose,
+        connections: [mongoose],
+      });
+      expect(result).toHaveProperty('fields');
+
+      const idField = result.fields.find((field) => field.field === '_id');
+
+      expect(idField.isPrimaryKey).toBe(true);
+    });
+  });
 });