Merge pull request #14734 from Automattic/vkarpov15/gh-14697-2

types: avoid automatically inferring lean result type when assigning to explicitly typed variable
Automattic · Jul 10, 2024 · bc13f15 · bc13f15
2 parents d30a3b9 + d375603
commit bc13f15
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 9 deletions.
diff --git a/test/types/document.test.ts b/test/types/document.test.ts
@@ -10,7 +10,7 @@ import {
   DefaultSchemaOptions
 } from 'mongoose';
 import { DeleteResult } from 'mongodb';
-import { expectAssignable, expectError, expectType } from 'tsd';
+import { expectAssignable, expectError, expectNotAssignable, expectType } from 'tsd';
 import { autoTypedModel } from './models.test';
 import { autoTypedModelConnection } from './connection.test';
 import { AutoTypedSchemaType } from './schema.test';
@@ -42,7 +42,8 @@ void async function main() {
 
   expectType<DeleteResult>(await doc.deleteOne());
   expectType<TestDocument | null>(await doc.deleteOne().findOne());
-  expectType<{ _id: Types.ObjectId, name?: string } | null>(await doc.deleteOne().findOne().lean());
+  expectAssignable<{ _id: Types.ObjectId, name?: string } | null>(await doc.deleteOne().findOne().lean());
+  expectNotAssignable<TestDocument | null>(await doc.deleteOne().findOne().lean());
 }();
 
 

diff --git a/test/types/plugin.test.ts b/test/types/plugin.test.ts
@@ -49,7 +49,7 @@ interface TestStaticMethods {
   findSomething(this: TestModel): Promise<TestDocument>;
 }
 type TestDocument = HydratedDocument<Test, TestVirtuals & TestInstanceMethods>;
-type TestQuery = Query<any, TestDocument, TestQueryHelpers> & TestQueryHelpers;
+type TestQuery = Query<any, TestDocument, TestQueryHelpers, Test> & TestQueryHelpers;
 interface TestQueryHelpers {
   whereSomething(this: TestQuery): this
 }

diff --git a/test/types/queries.test.ts b/test/types/queries.test.ts
@@ -38,11 +38,11 @@ const schema: Schema<ITest, Model<ITest, QueryHelpers>, {}, QueryHelpers> = new
   endDate: Date
 });
 
-schema.query._byName = function(name: string): QueryWithHelpers<any, ITest, QueryHelpers> {
+schema.query._byName = function(name: string): QueryWithHelpers<ITest[], ITest, QueryHelpers> {
   return this.find({ name });
 };
 
-schema.query.byName = function(name: string): QueryWithHelpers<any, ITest, QueryHelpers> {
+schema.query.byName = function(name: string): QueryWithHelpers<ITest[], ITest, QueryHelpers> {
   expectError(this.notAQueryHelper());
   return this._byName(name);
 };

diff --git a/types/query.d.ts b/types/query.d.ts
@@ -224,7 +224,7 @@ declare module 'mongoose' {
           : MergeType<ResultType, Paths>
     : MergeType<ResultType, Paths>;
 
-  class Query<ResultType, DocType, THelpers = {}, RawDocType = DocType, QueryOp = 'find', TInstanceMethods = Record<string, never>> implements SessionOperation {
+  class Query<ResultType, DocType, THelpers = {}, RawDocType = unknown, QueryOp = 'find', TInstanceMethods = Record<string, never>> implements SessionOperation {
     _mongooseOptions: MongooseQueryOptions<DocType>;
 
     /**
@@ -548,9 +548,19 @@ declare module 'mongoose' {
     j(val: boolean | null): this;
 
     /** Sets the lean option. */
-    lean<
-      LeanResultType = GetLeanResultType<RawDocType, ResultType, QueryOp>
-    >(
+    lean(
+      val?: boolean | any
+    ): QueryWithHelpers<
+      ResultType extends null
+        ? GetLeanResultType<RawDocType, ResultType, QueryOp> | null
+        : GetLeanResultType<RawDocType, ResultType, QueryOp>,
+      DocType,
+      THelpers,
+      RawDocType,
+      QueryOp,
+      TInstanceMethods
+      >;
+    lean<LeanResultType>(
       val?: boolean | any
     ): QueryWithHelpers<
       ResultType extends null