fix(NODE-3895): Emit TypeScript errors when filtering on fields not in collection schema

src/index.ts

@@ -284,6 +284,7 @@ export type {
   InferIdType,
   IntegerType,
   IsAny,
+  IsInUnion,
   Join,
   KeysOfAType,
   KeysOfOtherType,
@@ -306,6 +307,7 @@ export type {
   RootFilterOperators,
   SchemaMember,
   SetFields,
+  TypeEquals,
   UpdateFilter,
   WithId,
   WithoutId

src/mongo_types.ts

@@ -66,7 +66,9 @@ export type WithoutId<TSchema> = Omit<TSchema, '_id'>;
 
 /** A MongoDB filter can be some portion of the schema or a set of operators @public */
 export type Filter<TSchema> =
-  | Partial<TSchema>
+  | Partial<{
+      [Property in keyof TSchema]: Condition<TSchema[Property]>;
+    }>
   | ({
       [Property in Join<NestedPaths<WithId<TSchema>>, '.'>]?: Condition<
         PropertyType<WithId<TSchema>, Property>
@@ -89,8 +91,23 @@ export type AlternativeType<T> = T extends ReadonlyArray<infer U>
 /** @public */
 export type RegExpOrString<T> = T extends string ? BSONRegExp | RegExp | T : T;
 
+/**
+ * This is a type that allows any `$` prefixed keys and makes no assumptions
+ * about their value types. This stems from a design decision that newly added
+ * filter operators should be accepted without needing to upgrade this package.
+ *
+ * This has the unfortunate side effect of preventing type errors on unknown
+ * operator keys, so we should prefer not to extend this type whenever possible.
+ *
+ * @see https://github.com/mongodb/node-mongodb-native/pull/3115#issuecomment-1021303302
+ * @public
+ */
+export type OpenOperatorQuery = {
+  [key: `$${string}`]: unknown;
+};
+
 /** @public */
-export interface RootFilterOperators<TSchema> extends Document {
+export interface RootFilterOperators<TSchema> extends OpenOperatorQuery {
   $and?: Filter<TSchema>[];
   $nor?: Filter<TSchema>[];
   $or?: Filter<TSchema>[];
@@ -479,6 +496,24 @@ export type PropertyType<Type, Property extends string> = string extends Propert
     : unknown
   : unknown;
 
+/**
+ * Check if two types are exactly equal
+ *
+ * From https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650,
+ * credit to https://github.com/mattmccutchen.
+ * @public
+ */
+// prettier-ignore
+export type TypeEquals<X, Y> =
+    (<T>() => T extends X ? 1 : 2) extends
+    (<T>() => T extends Y ? 1 : 2) ? true : false
+
+/**
+ * Check if A is a union type that includes B
+ * @public
+ */
+export type IsInUnion<A, B> = TypeEquals<Extract<A, B>, B>;
+
 /**
  * @public
  * returns tuple of strings (keys to be joined on '.') that represent every path into a schema
@@ -504,9 +539,7 @@ export type NestedPaths<Type> = Type extends
   ? {
       [Key in Extract<keyof Type, string>]: Type[Key] extends Type // type of value extends the parent
         ? [Key]
-        : // for a recursive union type, the child will never extend the parent type.
-        // but the parent will still extend the child
-        Type extends Type[Key]
+        : IsInUnion<Type[Key], Type> extends true
         ? [Key]
         : Type[Key] extends ReadonlyArray<infer ArrayType> // handling recursive types with arrays
         ? Type extends ArrayType // is the type of the parent the same as the type of the array?

test/types/community/collection/filterQuery.test-d.ts

@@ -126,6 +126,11 @@ expectType<WithId<PetModel>[]>(
 expectType<WithId<PetModel>[]>(
   await collectionT.find({ name: new BSONRegExp('MrMeow', 'i') }).toArray()
 );
+
+/// it should not accept fields that are not in the schema
+type FT = Filter<PetModel>;
+expectNotType<FT>({ missing: true });
+
 /// it should not accept wrong types for string fields
 expectNotType<Filter<PetModel>>({ name: 23 });
 expectNotType<Filter<PetModel>>({ name: { suffix: 'Jr' } });
@@ -235,7 +240,7 @@ await collectionT.find({ name: { $eq: /Spot/ } }).toArray();
 await collectionT.find({ type: { $eq: 'dog' } }).toArray();
 await collectionT.find({ age: { $gt: 12, $lt: 13 } }).toArray();
 await collectionT.find({ treats: { $eq: 'kibble' } }).toArray();
-await collectionT.find({ scores: { $gte: 23 } }).toArray();
+await collectionT.find({ age: { $gte: 23 } }).toArray();
 await collectionT.find({ createdAt: { $lte: new Date() } }).toArray();
 await collectionT.find({ friends: { $ne: spot } }).toArray();
 /// it should not accept wrong queries
@@ -283,6 +288,9 @@ expectNotType<Filter<PetModel>>({ name: { $or: ['Spot', 'Bubbles'] } });
 /// it should not accept single objects for __$and, $or, $nor operator__ query
 expectNotType<Filter<PetModel>>({ $and: { name: 'Spot' } });
 
+/// it allows using unknown root operators with any value
+expectAssignable<Filter<PetModel>>({ $fakeOp: 123 });
+
 /**
  * test 'element' query operators
  */
@@ -361,9 +369,11 @@ expectError(
     otherField: new ObjectId()
   })
 );
-nonObjectIdCollection.find({
-  fieldThatDoesNotExistOnSchema: new ObjectId()
-});
+expectError(
+  nonObjectIdCollection.find({
+    fieldThatDoesNotExistOnSchema: new ObjectId()
+  })
+);
 
 // we only forbid objects that "look like" object ids, so other random objects are permitted
 nonObjectIdCollection.find({

test/types/community/collection/findX-recursive-types.test-d.ts

@@ -87,6 +87,7 @@ recursiveOptionalCollection.find({
  * recursive union types are supported
  */
 interface Node {
+  value?: string;
   next: Node | null;
 }
 
@@ -103,10 +104,12 @@ expectError(
 );
 
 nodeCollection.find({
-  'next.next': 'asdf'
+  'next.value': 'asdf'
 });
 
-nodeCollection.find({ 'next.next.next': 'yoohoo' });
+// type safety is lost through recursive relations; callers will
+// need to annotate queries with `ts-expect-error` comments
+expectError(nodeCollection.find({ 'next.next.value': 'yoohoo' }));
 
 /**
  * Recursive schemas with arrays are also supported
@@ -149,9 +152,11 @@ expectError(
 
 // type safety breaks after the first
 //   level of nested types
-recursiveSchemaWithArray.findOne({
-  'branches.0.directories.0.files.0.id': 'hello'
-});
+expectError(
+  recursiveSchemaWithArray.findOne({
+    'branches.0.directories.0.files.0.id': 'hello'
+  })
+);
 
 recursiveSchemaWithArray.findOne({
   branches: [

test/types/community/transaction.test-d.ts

@@ -8,6 +8,7 @@ const client = new MongoClient('');
 const session = client.startSession();
 
 interface Account {
+  name: string;
   balance: number;
 }