fix(NODE-3452): readonly filters not permitted by typings (#2927)

Author: nbbeeken

src/mongo_types.ts

@@ -95,11 +95,11 @@ export interface FilterOperators<TValue> extends Document {
   $eq?: TValue;
   $gt?: TValue;
   $gte?: TValue;
-  $in?: TValue[];
+  $in?: ReadonlyArray<TValue>;
   $lt?: TValue;
   $lte?: TValue;
   $ne?: TValue;
-  $nin?: TValue[];
+  $nin?: ReadonlyArray<TValue>;
   // Logical
   $not?: TValue extends string ? FilterOperators<TValue> | RegExp : FilterOperators<TValue>;
   // Element
@@ -122,8 +122,8 @@ export interface FilterOperators<TValue> extends Document {
   $nearSphere?: Document;
   $maxDistance?: number;
   // Array
-  $all?: TValue extends ReadonlyArray<any> ? any[] : never;
-  $elemMatch?: TValue extends ReadonlyArray<any> ? Document : never;
+  $all?: ReadonlyArray<any>;
+  $elemMatch?: Document;
   $size?: TValue extends ReadonlyArray<any> ? number : never;
   // Bitwise
   $bitsAllClear?: BitwiseFilter;
@@ -137,7 +137,7 @@ export interface FilterOperators<TValue> extends Document {
 export type BitwiseFilter =
   | number /** numeric bit mask */
   | Binary /** BinData bit mask */
-  | number[]; /** `[ <position1>, <position2>, ... ]` */
+  | ReadonlyArray<number>; /** `[ <position1>, <position2>, ... ]` */
 
 /** @public */
 export const BSONType = Object.freeze({
@@ -286,7 +286,7 @@ export type PullAllOperator<TSchema> = ({
   readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: TSchema[key];
 } &
   NotAcceptedFields<TSchema, ReadonlyArray<any>>) & {
-  readonly [key: string]: any[];
+  readonly [key: string]: ReadonlyArray<any>;
 };
 
 /** @public */
@@ -320,7 +320,7 @@ export type UpdateFilter<TSchema> = {
 export type Nullable<AnyType> = AnyType | null | undefined;
 
 /** @public */
-export type OneOrMore<T> = T | T[];
+export type OneOrMore<T> = T | ReadonlyArray<T>;
 
 /** @public */
 export type GenericListener = (...args: any[]) => void;

src/utils.ts

@@ -158,9 +158,9 @@ export function parseIndexOptions(indexSpec: IndexSpecification): IndexOptions {
   } else if (isObject(indexSpec)) {
     // {location:'2d', type:1}
     keys = Object.keys(indexSpec);
-    keys.forEach(key => {
-      indexes.push(key + '_' + indexSpec[key]);
-      fieldHash[key] = indexSpec[key];
+    Object.entries(indexSpec).forEach(([key, value]) => {
+      indexes.push(key + '_' + value);
+      fieldHash[key] = value;
     });
   }
 

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

@@ -135,3 +135,58 @@ expectNotType<FindOptions<Car>>({
 
 printCar(await car.findOne({}, options));
 printCar(await car.findOne({}, optionsWithProjection));
+
+// Readonly tests -- NODE-3452
+const colorCollection = client.db('test_db').collection<{ color: string }>('test_collection');
+const colorsFreeze: ReadonlyArray<string> = Object.freeze(['blue', 'red']);
+const colorsWritable: Array<string> = ['blue', 'red'];
+
+// Permitted Readonly fields
+expectType<FindCursor<{ color: string }>>(colorCollection.find({ color: { $in: colorsFreeze } }));
+expectType<FindCursor<{ color: string }>>(colorCollection.find({ color: { $in: colorsWritable } }));
+expectType<FindCursor<{ color: string }>>(colorCollection.find({ color: { $nin: colorsFreeze } }));
+expectType<FindCursor<{ color: string }>>(
+  colorCollection.find({ color: { $nin: colorsWritable } })
+);
+// $all and $elemMatch works against single fields (it's just redundant)
+expectType<FindCursor<{ color: string }>>(colorCollection.find({ color: { $all: colorsFreeze } }));
+expectType<FindCursor<{ color: string }>>(
+  colorCollection.find({ color: { $all: colorsWritable } })
+);
+expectType<FindCursor<{ color: string }>>(
+  colorCollection.find({ color: { $elemMatch: colorsFreeze } })
+);
+expectType<FindCursor<{ color: string }>>(
+  colorCollection.find({ color: { $elemMatch: colorsWritable } })
+);
+
+const countCollection = client.db('test_db').collection<{ count: number }>('test_collection');
+expectType<FindCursor<{ count: number }>>(
+  countCollection.find({ count: { $bitsAnySet: Object.freeze([1, 0, 1]) } })
+);
+expectType<FindCursor<{ count: number }>>(
+  countCollection.find({ count: { $bitsAnySet: [1, 0, 1] as number[] } })
+);
+
+const listsCollection = client.db('test_db').collection<{ lists: string[] }>('test_collection');
+await listsCollection.updateOne({}, { list: { $pullAll: Object.freeze(['one', 'two']) } });
+expectType<FindCursor<{ lists: string[] }>>(listsCollection.find({ lists: { $size: 1 } }));
+
+const rdOnlyListsCollection = client
+  .db('test_db')
+  .collection<{ lists: ReadonlyArray<string> }>('test_collection');
+expectType<FindCursor<{ lists: ReadonlyArray<string> }>>(
+  rdOnlyListsCollection.find({ lists: { $size: 1 } })
+);
+
+// Before NODE-3452's fix we would get this strange result that included the filter shape joined with the actual schema
+expectNotType<FindCursor<{ color: string | { $in: ReadonlyArray<string> } }>>(
+  colorCollection.find({ color: { $in: colorsFreeze } })
+);
+
+// This is related to another bug that will be fixed in NODE-3454
+expectType<FindCursor<{ color: { $in: number } }>>(colorCollection.find({ color: { $in: 3 } }));
+
+// When you use the override, $in doesn't permit readonly
+colorCollection.find<{ color: string }>({ color: { $in: colorsFreeze } });
+colorCollection.find<{ color: string }>({ color: { $in: ['regularArray'] } });

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

@@ -1,4 +1,4 @@
-import { expectError, expectNotType, expectType } from 'tsd';
+import { expectError, expectNotAssignable, expectNotType, expectType } from 'tsd';
 import { MongoClient, ObjectId, OptionalId } from '../../../../src';
 import type { PropExists } from '../../utility_types';
 
@@ -223,3 +223,17 @@ expectType<PropExists<typeof indexTypeResultMany2, 'ops'>>(false);
 
 expectType<number>(indexTypeResult2.insertedId);
 expectType<{ [key: number]: number }>(indexTypeResultMany2.insertedIds);
+
+// Readonly Tests -- NODE-3452
+const colorsColl = client.db('test').collection<{ colors: string[] }>('writableColors');
+const colorsFreeze: ReadonlyArray<string> = Object.freeze(['blue', 'red']);
+// Users must define their properties as readonly if they want to be able to insert readonly
+type InsertOneParam = Parameters<typeof colorsColl.insertOne>[0];
+expectNotAssignable<InsertOneParam>({ colors: colorsFreeze });
+// Correct usage:
+const rdOnlyColl = client
+  .db('test')
+  .collection<{ colors: ReadonlyArray<string> }>('readonlyColors');
+rdOnlyColl.insertOne({ colors: colorsFreeze });
+const colorsWritable = ['a', 'b'];
+rdOnlyColl.insertOne({ colors: colorsWritable });

test/types/helper_types.test-d.ts

@@ -8,7 +8,8 @@ import type {
   FilterOperations,
   OnlyFieldsOfType,
   IntegerType,
-  IsAny
+  IsAny,
+  OneOrMore
 } from '../../src/mongo_types';
 import { Decimal128, Double, Int32, Long, Document } from '../../src/index';
 
@@ -97,3 +98,8 @@ interface IndexedSchema {
 // This means we can't properly enforce the subtype and there doesn't seem to be a way to detect it
 // and reduce strictness like we can with any, users with indexed schemas will have to use `as any`
 expectNotAssignable<OnlyFieldsOfType<IndexedSchema, NumericType>>({ a: 2 });
+
+// OneOrMore should accept readonly arrays
+expectAssignable<OneOrMore<number>>(1);
+expectAssignable<OneOrMore<number>>([1, 2]);
+expectAssignable<OneOrMore<number>>(Object.freeze([1, 2]));