types: typing error on bulkWrite with AnyBulkWriteOperation<T>

[andreialecu]

Prerequisites

• I have written a descriptive issue title
• I have searched existing issues to ensure the bug has not already been reported

Mongoose version

6.4.0

Node.js version

16

MongoDB server version

5

Description

1. bulkWrite will show a typescript error if passed a variable of type AnyBulkWriteOperation<ISchema>[]

Steps to Reproduce

function modelBulkTest() {
  interface ISchema {
    _id: string;
    num: number;
  }

  const schema = new Schema({
    _id: { type: String },
    num: Number
  });

  const M = model<ISchema>('Test', schema);

  const ops: AnyBulkWriteOperation<ISchema>[] = [
    {
      updateOne: {
        filter: { _id: 'test' },
        update: {
          $inc: { num: 1 }
        },
        upsert: true
      }
    }
  ];
  M.bulkWrite(ops);
}

const ops: AnyBulkWriteOperation<ISchema>[]
Argument of type 'AnyBulkWriteOperation<ISchema>[]' is not assignable to parameter of type 'AnyBulkWriteOperation<Document>[]'.
  Type 'AnyBulkWriteOperation<ISchema>' is not assignable to type 'AnyBulkWriteOperation<Document>'.
    Type '{ insertOne: InsertOneModel<ISchema>; }' is not assignable to type 'AnyBulkWriteOperation<Document>'.
      Type '{ insertOne: InsertOneModel<ISchema>; }' is not assignable to type '{ insertOne: InsertOneModel<Document>; }'.
        The types of 'insertOne.document' are incompatible between these types.
          Type 'OptionalId<ISchema>' is not assignable to type 'OptionalId<Document>'.
            Type 'OptionalId<ISchema>' is not assignable to type '{ _id?: ObjectId | undefined; }'.
              Types of property '_id' are incompatible.
                Type 'string | undefined' is not assignable to type 'ObjectId | undefined'.
                  Type 'string' is not assignable to type 'ObjectId'.

Expected Behavior

The test should pass.

[IslandRhythms]

Please include your imports on future issue submissions

import * as mongoose from 'mongoose';
import * as mongodb from 'mongodb';

function modelBulkTest() {
  interface ISchema {
    _id: string;
    num: number;
  }

  const schema = new mongoose.Schema({
    _id: { type: String },
    num: Number
  });

  const M = mongoose.model<ISchema>('Test', schema);

  const ops: mongodb.AnyBulkWriteOperation<ISchema>[] = [
    {
      updateOne: {
        filter: { _id: 'test' },
        update: {
          $inc: { num: 1 }
        },
        upsert: true
      }
    }
  ];
  M.bulkWrite(ops);
}

modelBulkTest();

[github-actions]

This issue is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days

[RubenatorX]

We have this problem as well. What can we provide to help you reproduce? And anything we can do to bandaid the problem?

[vkarpov15]

@RubenatorX a standalone a code sample that repros the issue you're seeing. Ideally please open a new issue and follow the issue template, but at least a code sample would be helpful.

[keyCat]

We have this issue, as well.
The code sample from the author demonstrates it perfectly, IMO.

I will attempt to describe the reason behind it, and I hope you find it useful:

Type AnyBulkWriteOperation<TSchema extends Document = Document> is a generic, however, .bulkWrite() method has following overloads:

interface Model<T, TQueryHelpers = {}, TMethodsAndOverrides = {}, TVirtuals = {}, TSchema = any> extends
  NodeJS.EventEmitter,
  AcceptsDiscriminator,
  IndexManager,
  SessionStarter {
  // ...
  bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation>, options: mongodb.BulkWriteOptions & MongooseBulkWriteOptions, callback: Callback<mongodb.BulkWriteResult>): void;
  bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation>, callback: Callback<mongodb.BulkWriteResult>): void;
  bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation>, options?: mongodb.BulkWriteOptions & MongooseBulkWriteOptions): Promise<mongodb.BulkWriteResult>;
  // ...

As you can see, a type is not supplied (and cannot be supplied) to AnyBulkWriteOperation generic and it becomes locked to AnyBulkWriteOperation<Document> type for each and every model method.

[vkarpov15]

@keyCat so the issue you're seeing is that writes typing isn't sufficiently strict because AnyBulkWriteOperation takes any?

[keyCat]

@vkarpov15 The issue is that AnyBulkWriteOperation treated AnyBulkWriteOperation<Document> for each and every model and unable to accept anything, except for AnyBulkWriteOperation<Document> or any, while it should be able to accept AnyBulkWriteOperation<TSchema> by default.

[vkarpov15]

Should be fixed by #12167

[Kezzsim]

Hi, I just upgraded to 7.0.2 and suddenly I have this problem, code that was working just fine demands to be typed as this MongoDB type, but I've tried many configurations for getting it to realize that the data is already structured correctly and none of them work. Is there a way to bypass this? I've tried using "as AnyBulkWriteOperation" and "as AnyBulkWriteOperation" it never works

[vkarpov15]

@Kezzsim can you please open a new issue and follow the issue template? It is hard to figure out what's going on from an isolated screenshot.