Implement Query findById methods

[sderrow]

Summary

Even though query.d.ts says otherwise, Query does NOT in fact have the following methods:

• findById
• findByIdAndUpdate
• findByIdAndDelete

You can see as much if you try to call them. Here's a reproducible example:

import mongoose from "mongoose";

type Person = {
  _id: mongoose.Types.ObjectId;
  name: string;
  email: string;
  archived: boolean;
  createdAt: number;
  updatedAt: number;
};

const personSchema = new mongoose.Schema<Person>({
  name: { type: String, required: true },
  email: { type: String, required: true, index: true },
  archived: { type: Boolean, default: false },

  createdAt: { type: Number },
  updatedAt: { type: Number },
});

const Person = mongoose.model("Person", personSchema);

async function run() {
  await mongoose.connect("mongodb://127.0.0.1:27017");

  await mongoose.connection.dropDatabase();
  console.log("Database dropped");

  const person = await Person.create({ name: "Alice", email: "[email protected]" });
  console.log("Person created");

  try {
    const p = await Person.find({}).findById(person._id);
    console.log("[success] Query.prototype.findById", p?.id);
  } catch (err: any) {
    console.error("[error] Query.prototype.findById failed:", err.message);
  }

  try {
    await Person.find({}).findByIdAndUpdate(person._id, { email: "[email protected]" });
    console.log("[success] Query.prototype.findByIdAndUpdate");
  } catch (err: any) {
    console.error("[error] Query.prototype.findByIdAndUpdate failed:", err.message);
  }

  try {
    await Person.find({}).findByIdAndDelete(person._id);
    console.log("[success] Query.prototype.findByIdAndDelete");
  } catch (err: any) {
    console.error("[error] Query.prototype.findByIdAndDelete failed:", err.message);
  }

  try {
    const p = await Person.find({}).findOne({ _id: person._id });
    console.log("[success] Query.prototype.findOne", p?.id);
  } catch (err: any) {
    console.error("[error] Query.prototype.findOne failed:", err.message);
  }

  try {
    const p = await Person.find({}).findOneAndUpdate({ _id: person._id }, { email: "[email protected]" });
    console.log("[success] Query.prototype.findOneAndUpdate", p?.id);
  } catch (err: any) {
    console.error("[error] Query.prototype.findOneAndUpdate failed:", err.message);
  }

  try {
    const p = await Person.find({}).findOneAndDelete({ _id: person._id });
    console.log("[success] Query.prototype.findOneAndDelete", p?.id);
  } catch (err: any) {
    console.error("[error] Query.prototype.findOneAndDelete failed:", err.message);
  }
}

void run()

That example gives zero Typescript warnings because it thinks findById, findByIdAndUpdate, and findByIdAndDelete are all valid methods on Query. But when you actually run it, you get the following output:

Database dropped
Person created
[error] Query.prototype.findById failed: Person.find(...).findById is not a function
[error] Query.prototype.findByIdAndUpdate failed: Person.find(...).findByIdAndUpdate is not a function
[error] Query.prototype.findByIdAndDelete failed: Person.find(...).findByIdAndDelete is not a function
[success] Query.prototype.findOne 67ec4b44052e05360699693f
[success] Query.prototype.findOneAndUpdate 67ec4b44052e05360699693f
[success] Query.prototype.findOneAndDelete 67ec4b44052e05360699693f

One place where this distinction matters is with the accessibleBy casl plugin. This comment references the problem, but no action was taken to address the root cause.

I'm not sure if the type declarations were included by mistake (here and here), or if the implementations used to exist and were deleted at some point.

I don't see the harm in including the implementations, so that's what this PR adds. Basic tests included.

[sderrow]

@vkarpov15 sorry to tag you, but I'm not sure the best way to request a review. Let me know if you have any thoughts on this one.

[Copilot]

Pull Request Overview

This PR implements the Query prototype methods findById, findByIdAndUpdate, and findByIdAndDelete to address discrepancies in type definitions versus actual functionality. It also adds corresponding tests to verify the correct behavior of these methods.

• Implements findById, findByIdAndUpdate, and findByIdAndDelete in lib/query.js.
• Adds tests in test/query.test.js to validate these new query methods.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
test/query.test.js	New tests added to verify the behavior of the query methods
lib/query.js	Implements the new findById, findByIdAndUpdate, and findByIdAndDelete methods

[vkarpov15]

One minor nitpick, but LGTM otherwise 👍

[vkarpov15]

Merging into 8.14 branch 👍