fix: improve parseValue for MongoID salar type

Author: nodkz

flow-typed/npm/mongoose_v4.x.x.js

@@ -5,12 +5,7 @@
 
 import mongoose from "mongoose";
 
-type MongoId =
-  | typeof mongoose.Types.ObjectId
-  | {
-      toString(): string
-    };
-
+type MongoId = ObjectId;
 type MongoOrScalarId = MongoId | string | number;
 
 type SchemaFields = {
@@ -63,10 +58,22 @@ type IndexOpts = {|
   weights?: Object
 |};
 
+declare class ObjectId {
+  constructor(id?: string | number | ObjectId): this,
+  toHexString(): string,
+  toString(): string,
+  toJSON(): string,
+  inspect(): string,
+  equals(otherId: string | number | ObjectId): boolean;
+  getTimestamp(): Date,
+
+  static createFromTime(time: number): ObjectId,
+  static createFromHexString(str: string): ObjectId,
+  static isValid(id: string | number | ObjectId): boolean,
+}
+
 type Mongoose$Types = {|
-  ObjectId: {
-    $call: (id: string | MongoId) => MongoId
-  },
+  ObjectId: Class<ObjectId>,
   Mixed: Object,
   Embedded: Object,
   Document: Object,

src/types/__tests__/mongoid-test.js

@@ -0,0 +1,63 @@
+/* @flow */
+
+import mongoose from 'mongoose';
+import { Kind } from 'graphql-compose/lib/graphql';
+import GraphQLMongoID from '../mongoid';
+
+const ObjectId = mongoose.Types.ObjectId;
+
+describe('GraphQLMongoID', () => {
+  describe('serialize', () => {
+    it('pass ObjectId', () => {
+      const id = new ObjectId('5a0d77aa7e65a808ad24937f');
+      expect(GraphQLMongoID.serialize(id)).toBe('5a0d77aa7e65a808ad24937f');
+    });
+
+    it('pass String', () => {
+      const id = '5a0d77aa7e65a808ad249000';
+      expect(GraphQLMongoID.serialize(id)).toBe('5a0d77aa7e65a808ad249000');
+    });
+  });
+
+  describe('parseValue', () => {
+    it('pass ObjectId', () => {
+      const id = new ObjectId('5a0d77aa7e65a808ad24937f');
+      expect(GraphQLMongoID.parseValue(id)).toBe(id);
+    });
+
+    it('pass ObjectId as string', () => {
+      const id = '5a0d77aa7e65a808ad249000';
+      expect(GraphQLMongoID.parseValue(id)).toEqual(id);
+    });
+
+    it('pass integer', () => {
+      const id = 123;
+      expect(GraphQLMongoID.parseValue(id)).toEqual(id);
+    });
+
+    it('pass any custom string', () => {
+      const id = 'custom_id';
+      expect(GraphQLMongoID.parseValue(id)).toEqual(id);
+    });
+  });
+
+  describe('parseLiteral', () => {
+    it('parse a ast STRING literal', async () => {
+      const ast = {
+        kind: Kind.STRING,
+        value: '5a0d77aa7e65a808ad249000',
+      };
+      const id: any = GraphQLMongoID.parseLiteral(ast);
+      expect(id).toEqual('5a0d77aa7e65a808ad249000');
+    });
+
+    it('parse a ast INT literal', async () => {
+      const ast: any = {
+        kind: Kind.INT,
+        value: 123,
+      };
+      const id: any = GraphQLMongoID.parseLiteral(ast);
+      expect(id).toEqual(123);
+    });
+  });
+});

src/types/mongoid.js

@@ -1,7 +1,10 @@
 /* @flow */
 
+import mongoose from 'mongoose';
 import { GraphQLScalarType, Kind } from 'graphql-compose/lib/graphql';
 
+const ObjectId = mongoose.Types.ObjectId;
+
 const GraphQLMongoID = new GraphQLScalarType({
   name: 'MongoID',
   description:
@@ -10,7 +13,12 @@ const GraphQLMongoID = new GraphQLScalarType({
     '(https://docs.mongodb.com/manual/reference/bson-types/#objectid). ' +
     'But MongoDB also may accepts string or integer as correct values for _id field.',
   serialize: String,
-  parseValue: String,
+  parseValue(value: any) {
+    if (!ObjectId.isValid(value) && typeof value !== 'string') {
+      throw new TypeError('Field error: value is an invalid ObjectId');
+    }
+    return value;
+  },
   parseLiteral(ast) {
     return ast.kind === Kind.STRING || ast.kind === Kind.INT ? ast.value : null;
   },