Skip to content

Commit b93d405

Browse files
alenakhineikanbbeeken
alenakhineika
and
nbbeeken
authored
fix(NODE-5791): type error with $addToSet in bulkWrite (#3953)
Co-authored-by: Neal Beeken <[email protected]>
1 parent efece79 commit b93d405

File tree

5 files changed

+288
-11
lines changed

5 files changed

+288
-11
lines changed

‎src/bulk/common.ts‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,12 @@ export interface ReplaceOneModel<TSchema extends Document = Document> {
8787
export interface UpdateOneModel<TSchema extends Document = Document> {
8888
/** The filter to limit the updated documents. */
8989
filter: Filter<TSchema>;
90-
/** A document or pipeline containing update operators. */
91-
update: UpdateFilter<TSchema> | UpdateFilter<TSchema>[];
90+
/**
91+
* The modifications to apply. The value can be either:
92+
* UpdateFilter<TSchema> - A document that contains update operator expressions,
93+
* Document[] - an aggregation pipeline.
94+
*/
95+
update: UpdateFilter<TSchema> | Document[];
9296
/** A set of filters specifying to which array elements an update should apply. */
9397
arrayFilters?: Document[];
9498
/** Specifies a collation. */
@@ -103,8 +107,12 @@ export interface UpdateOneModel<TSchema extends Document = Document> {
103107
export interface UpdateManyModel<TSchema extends Document = Document> {
104108
/** The filter to limit the updated documents. */
105109
filter: Filter<TSchema>;
106-
/** A document or pipeline containing update operators. */
107-
update: UpdateFilter<TSchema> | UpdateFilter<TSchema>[];
110+
/**
111+
* The modifications to apply. The value can be either:
112+
* UpdateFilter<TSchema> - A document that contains update operator expressions,
113+
* Document[] - an aggregation pipeline.
114+
*/
115+
update: UpdateFilter<TSchema> | Document[];
108116
/** A set of filters specifying to which array elements an update should apply. */
109117
arrayFilters?: Document[];
110118
/** Specifies a collation. */

‎src/collection.ts‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -339,13 +339,17 @@ export class Collection<TSchema extends Document = Document> {
339339
/**
340340
* Update a single document in a collection
341341
*
342+
* The value of `update` can be either:
343+
* - UpdateFilter<TSchema> - A document that contains update operator expressions,
344+
* - Document[] - an aggregation pipeline.
345+
*
342346
* @param filter - The filter used to select the document to update
343-
* @param update - The update operations to be applied to the document
347+
* @param update - The modifications to apply
344348
* @param options - Optional settings for the command
345349
*/
346350
async updateOne(
347351
filter: Filter<TSchema>,
348-
update: UpdateFilter<TSchema> | Partial<TSchema>,
352+
update: UpdateFilter<TSchema> | Document[],
349353
options?: UpdateOptions
350354
): Promise<UpdateResult<TSchema>> {
351355
return executeOperation(
@@ -385,13 +389,17 @@ export class Collection<TSchema extends Document = Document> {
385389
/**
386390
* Update multiple documents in a collection
387391
*
388-
* @param filter - The filter used to select the documents to update
389-
* @param update - The update operations to be applied to the documents
392+
* The value of `update` can be either:
393+
* - UpdateFilter<TSchema> - A document that contains update operator expressions,
394+
* - Document[] - an aggregation pipeline.
395+
*
396+
* @param filter - The filter used to select the document to update
397+
* @param update - The modifications to apply
390398
* @param options - Optional settings for the command
391399
*/
392400
async updateMany(
393401
filter: Filter<TSchema>,
394-
update: UpdateFilter<TSchema>,
402+
update: UpdateFilter<TSchema> | Document[],
395403
options?: UpdateOptions
396404
): Promise<UpdateResult<TSchema>> {
397405
return executeOperation(

‎src/mongo_types.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,11 @@ export type SetFields<TSchema> = ({
243243
readonly [key in KeysOfAType<TSchema, ReadonlyArray<any> | undefined>]?:
244244
| OptionalId<Flatten<TSchema[key]>>
245245
| AddToSetOperators<Array<OptionalId<Flatten<TSchema[key]>>>>;
246-
} & NotAcceptedFields<TSchema, ReadonlyArray<any> | undefined>) & {
246+
} & IsAny<
247+
TSchema[keyof TSchema],
248+
object,
249+
NotAcceptedFields<TSchema, ReadonlyArray<any> | undefined>
250+
>) & {
247251
readonly [key: string]: AddToSetOperators<any> | any;
248252
};
249253

‎test/types/community/collection/bulkWrite.test-d.ts‎

Lines changed: 195 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { expectError } from 'tsd';
22

3-
import { MongoClient, ObjectId } from '../../../mongodb';
3+
import { type Collection, type Document, MongoClient, ObjectId } from '../../../mongodb';
44

55
// TODO(NODE-3347): Improve these tests to use more expect assertions
66

@@ -297,3 +297,197 @@ collectionType.bulkWrite([
297297
}
298298
}
299299
]);
300+
301+
{
302+
// NODE-5647 - Type error with $addToSet in bulkWrite
303+
interface TestDocument {
304+
readonly myId: number;
305+
readonly mySet: number[];
306+
readonly myAny: any;
307+
}
308+
const collection = undefined as unknown as Collection<TestDocument>;
309+
expectError(
310+
collection.bulkWrite([
311+
{
312+
updateOne: {
313+
filter: { myId: 0 },
314+
update: {
315+
$addToSet: { mySet: 'value of other type' }
316+
}
317+
}
318+
}
319+
])
320+
);
321+
collection.bulkWrite([
322+
{
323+
updateOne: {
324+
filter: { myId: 0 },
325+
update: {
326+
$addToSet: { mySet: 0 }
327+
}
328+
}
329+
}
330+
]);
331+
collection.bulkWrite([
332+
{
333+
updateOne: {
334+
filter: { myId: 0 },
335+
update: {
336+
$addToSet: { myAny: 1 }
337+
}
338+
}
339+
}
340+
]);
341+
collection.bulkWrite([
342+
{
343+
updateOne: {
344+
filter: { myId: 0 },
345+
update: [
346+
{
347+
$addToSet: { myAny: 0 }
348+
}
349+
]
350+
}
351+
}
352+
]);
353+
expectError(
354+
collection.bulkWrite([
355+
{
356+
updateMany: {
357+
filter: { myId: 0 },
358+
update: {
359+
$addToSet: { mySet: 'value of other type' }
360+
}
361+
}
362+
}
363+
])
364+
);
365+
collection.bulkWrite([
366+
{
367+
updateMany: {
368+
filter: { myId: 0 },
369+
update: {
370+
$addToSet: { mySet: 0 }
371+
}
372+
}
373+
}
374+
]);
375+
collection.bulkWrite([
376+
{
377+
updateMany: {
378+
filter: { myId: 0 },
379+
update: {
380+
$addToSet: { myAny: 1 }
381+
}
382+
}
383+
}
384+
]);
385+
collection.bulkWrite([
386+
{
387+
updateMany: {
388+
filter: { myId: 0 },
389+
update: [
390+
{
391+
$addToSet: { mySet: 0 }
392+
}
393+
]
394+
}
395+
}
396+
]);
397+
398+
interface IndexSingatureTestDocument extends Document {
399+
readonly myId: number;
400+
readonly mySet: number[];
401+
}
402+
const indexSingatureCollection = undefined as unknown as Collection<IndexSingatureTestDocument>;
403+
indexSingatureCollection.bulkWrite([
404+
{
405+
updateOne: {
406+
filter: { myId: 0 },
407+
update: {
408+
$addToSet: { mySet: 0 }
409+
}
410+
}
411+
}
412+
]);
413+
indexSingatureCollection.bulkWrite([
414+
{
415+
updateOne: {
416+
filter: { myId: 0 },
417+
update: [
418+
{
419+
$addToSet: { mySet: 0 }
420+
}
421+
]
422+
}
423+
}
424+
]);
425+
indexSingatureCollection.bulkWrite([
426+
{
427+
updateMany: {
428+
filter: { myId: 0 },
429+
update: {
430+
$addToSet: { mySet: 0 }
431+
}
432+
}
433+
}
434+
]);
435+
indexSingatureCollection.bulkWrite([
436+
{
437+
updateMany: {
438+
filter: { myId: 0 },
439+
update: [
440+
{
441+
$addToSet: { mySet: 0 }
442+
}
443+
]
444+
}
445+
}
446+
]);
447+
448+
const collectionOfAnyType = undefined as unknown as Collection<any>;
449+
collectionOfAnyType.bulkWrite([
450+
{
451+
updateOne: {
452+
filter: { myId: 0 },
453+
update: {
454+
$addToSet: { mySet: 0 }
455+
}
456+
}
457+
}
458+
]);
459+
collectionOfAnyType.bulkWrite([
460+
{
461+
updateOne: {
462+
filter: { myId: 0 },
463+
update: [
464+
{
465+
$addToSet: { mySet: 0 }
466+
}
467+
]
468+
}
469+
}
470+
]);
471+
collectionOfAnyType.bulkWrite([
472+
{
473+
updateMany: {
474+
filter: { myId: 0 },
475+
update: {
476+
$addToSet: { mySet: 0 }
477+
}
478+
}
479+
}
480+
]);
481+
collectionOfAnyType.bulkWrite([
482+
{
483+
updateMany: {
484+
filter: { myId: 0 },
485+
update: [
486+
{
487+
$addToSet: { mySet: 0 }
488+
}
489+
]
490+
}
491+
}
492+
]);
493+
}

‎test/types/community/collection/updateX.test-d.ts‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -439,3 +439,66 @@ export async function testPushWithId(): Promise<void> {
439439
collectionWithSchema.updateMany({}, {})
440440
);
441441
}
442+
443+
{
444+
// NODE-5647 - Type error with $addToSet in bulkWrite
445+
interface TestDocument {
446+
readonly myId: number;
447+
readonly mySet: number[];
448+
readonly myAny: any;
449+
}
450+
const collection = undefined as unknown as Collection<TestDocument>;
451+
expectError(collection.updateOne({ myId: 0 }, { $addToSet: { mySet: 'value of other type' } }));
452+
collection.updateOne({ myId: 0 }, { $addToSet: { mySet: 0 } });
453+
collection.updateOne({ myId: 0 }, { $addToSet: { myAny: 1 } });
454+
collection.updateOne({ myId: 0 }, [
455+
{
456+
$addToSet: { mySet: 0 }
457+
}
458+
]);
459+
expectError(collection.updateMany({ myId: 0 }, { $addToSet: { mySet: 'value of other type' } }));
460+
collection.updateMany({ myId: 0 }, { $addToSet: { mySet: 0 } });
461+
collection.updateMany({ myId: 0 }, { $addToSet: { myAny: 1 } });
462+
collection.updateMany({ myId: 0 }, [
463+
{
464+
$addToSet: { mySet: 0 }
465+
}
466+
]);
467+
468+
interface IndexSingatureTestDocument extends Document {
469+
readonly myId: number;
470+
readonly mySet: number[];
471+
readonly myAny: any;
472+
}
473+
const indexSingatureCollection = undefined as unknown as Collection<IndexSingatureTestDocument>;
474+
indexSingatureCollection.updateOne({ myId: 0 }, { $addToSet: { mySet: 0 } });
475+
indexSingatureCollection.updateOne({ myId: 0 }, { $addToSet: { myAny: 1 } });
476+
indexSingatureCollection.updateOne({ myId: 0 }, [
477+
{
478+
$addToSet: { mySet: 0 }
479+
}
480+
]);
481+
indexSingatureCollection.updateMany({ myId: 0 }, { $addToSet: { mySet: 0 } });
482+
indexSingatureCollection.updateMany({ myId: 0 }, { $addToSet: { myAny: 1 } });
483+
indexSingatureCollection.updateMany({ myId: 0 }, [
484+
{
485+
$addToSet: { mySet: 0 }
486+
}
487+
]);
488+
489+
const collectionOfAnyType = undefined as unknown as Collection<any>;
490+
collectionOfAnyType.updateOne({ myId: 0 }, { $addToSet: { mySet: 0 } });
491+
collectionOfAnyType.updateOne({ myId: 0 }, { $addToSet: { myAny: 1 } });
492+
collectionOfAnyType.updateOne({ myId: 0 }, [
493+
{
494+
$addToSet: { mySet: 0 }
495+
}
496+
]);
497+
collectionOfAnyType.updateMany({ myId: 0 }, { $addToSet: { mySet: 0 } });
498+
collectionOfAnyType.updateMany({ myId: 0 }, { $addToSet: { myAny: 1 } });
499+
collectionOfAnyType.updateMany({ myId: 0 }, [
500+
{
501+
$addToSet: { mySet: 0 }
502+
}
503+
]);
504+
}

0 commit comments

Comments
 (0)