fix(types): avoid "excessively deep" type instantiation error when us…

…ing bulkWrite() with type that extends from document Fix #12277
Automattic · Sep 27, 2022 · de20b5f · de20b5f
1 parent d78d631
commit de20b5f
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 4 deletions.
diff --git a/test/types/models.test.ts b/test/types/models.test.ts
@@ -12,7 +12,8 @@ import {
   HydratedDocumentFromSchema,
   LeanDocument,
   Query,
-  UpdateWriteOpResult
+  UpdateWriteOpResult,
+  InferSchemaType
 } from 'mongoose';
 import { expectAssignable, expectError, expectType } from 'tsd';
 import { AutoTypedSchemaType, autoTypedSchema } from './schema.test';
@@ -314,6 +315,33 @@ function bulkWriteAddToSet() {
   return M.bulkWrite(ops);
 }
 
+async function gh12277() {
+  type DocumentType<T> = Document<any, any, T> & T;
+
+  interface BaseModelClassDoc {
+    firstname: string;
+  }
+
+  const baseModelClassSchema = new Schema({
+    firstname: String
+  });
+
+  const BaseModel = model<DocumentType<BaseModelClassDoc>>('test', baseModelClassSchema);
+
+  await BaseModel.bulkWrite([
+    {
+      updateOne: {
+        update: {
+          firstname: 'test'
+        },
+        filter: {
+          firstname: 'asdsd'
+        }
+      }
+    }
+  ]);
+}
+
 export function autoTypedModel() {
   const AutoTypedSchema = autoTypedSchema();
   const AutoTypedModel = model('AutoTypeModel', AutoTypedSchema);

diff --git a/types/models.d.ts b/types/models.d.ts
@@ -146,9 +146,9 @@ declare module 'mongoose' {
      * if you use `create()`) because with `bulkWrite()` there is only one network
      * round trip to the MongoDB server.
      */
-    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T extends {} ? T : any>>, options: mongodb.BulkWriteOptions & MongooseBulkWriteOptions, callback: Callback<mongodb.BulkWriteResult>): void;
-    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T extends {} ? T : any>>, callback: Callback<mongodb.BulkWriteResult>): void;
-    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T extends {} ? T : any>>, options?: mongodb.BulkWriteOptions & MongooseBulkWriteOptions): Promise<mongodb.BulkWriteResult>;
+    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T extends Document ? any : (T extends {} ? T : any)>>, options: mongodb.BulkWriteOptions & MongooseBulkWriteOptions, callback: Callback<mongodb.BulkWriteResult>): void;
+    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T extends Document ? any : (T extends {} ? T : any)>>, callback: Callback<mongodb.BulkWriteResult>): void;
+    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T extends Document ? any : (T extends {} ? T : any)>>, options?: mongodb.BulkWriteOptions & MongooseBulkWriteOptions): Promise<mongodb.BulkWriteResult>;
 
     /**
      * Sends multiple `save()` calls in a single `bulkWrite()`. This is faster than