Skip to content

test(NODE-7197): migrate integration/crud/find_cursor_methods tests #4727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

test(NODE-7197): migrate integration/crud/find_cursor_methods tests #4727

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d69bdd8
test(NODE-7197): migrate to TypeScript
tadjik1 Oct 13, 2025
18c8bf6
test(NODE-7197): migrate to async/await
tadjik1 Oct 13, 2025
d0e32b5
test(7197): address review feedback
tadjik1 Oct 14, 2025
f5e6a6b
test(NODE-7197): await .forEach()
tadjik1 Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
202 changes: 80 additions & 122 deletions ...egration/crud/find_cursor_methods.test.js → ...egration/crud/find_cursor_methods.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
'use strict';
const { expect } = require('chai');
const { filterForCommands } = require('../shared');
const {
promiseWithResolvers,
MongoCursorExhaustedError,
CursorTimeoutContext,
TimeoutContext,
MongoAPIError
} = require('../../mongodb');
import { expect } from 'chai';

import {
type Collection,
type FindCursor,
MongoAPIError,
type MongoClient,
MongoCursorExhaustedError
} from '../../../src';
import { CursorTimeoutContext } from '../../../src/cursor/abstract_cursor';
import { TimeoutContext } from '../../../src/timeout';
import { promiseWithResolvers } from '../../../src/utils';
import { filterForCommands } from '../shared';

describe('Find Cursor', function () {
let client;
let client: MongoClient;

beforeEach(async function () {
const setupClient = this.configuration.newClient();
Expand All @@ -32,20 +35,16 @@ describe('Find Cursor', function () {
});

context('#next', function () {
it('should support a batch size', function (done) {
it('should support a batch size', async function () {
const commands = [];
client.on('commandStarted', filterForCommands(['getMore'], commands));

const coll = client.db().collection('abstract_cursor');
const cursor = coll.find({}, { batchSize: 2 });
this.defer(() => cursor.close());

cursor.toArray((err, docs) => {
expect(err).to.not.exist;
expect(docs).to.have.length(6);
expect(commands).to.have.length(3);
done();
});
const docs = await cursor.toArray();
expect(docs).to.have.length(6);
expect(commands).to.have.length(3);
});
});

Expand Down Expand Up @@ -174,50 +173,36 @@ describe('Find Cursor', function () {
});

context('#forEach', function () {
it('should iterate each document in a cursor', function (done) {
it('should iterate each document in a cursor', async function () {
const coll = client.db().collection('abstract_cursor');
const cursor = coll.find({}, { batchSize: 2 });

const bag = [];
cursor.forEach(
doc => bag.push(doc),
err => {
expect(err).to.not.exist;
expect(bag).to.have.lengthOf(6);
done();
}
);
await cursor.forEach(doc => {
bag.push(doc);
});

expect(bag).to.have.lengthOf(6);
});
});

context('#tryNext', function () {
it('should return control to the user if an empty batch is returned', function (done) {
it('should return control to the user if an empty batch is returned', async function () {
const db = client.db();
db.createCollection('try_next', { capped: true, size: 10000000 }, () => {
const coll = db.collection('try_next');
coll.insertMany([{}, {}], err => {
expect(err).to.not.exist;

const cursor = coll.find({}, { tailable: true, awaitData: true });
this.defer(() => cursor.close());

cursor.tryNext((err, doc) => {
expect(err).to.not.exist;
expect(doc).to.exist;

cursor.tryNext((err, doc) => {
expect(err).to.not.exist;
expect(doc).to.exist;

cursor.tryNext((err, doc) => {
expect(err).to.not.exist;
expect(doc).to.be.null;
done();
});
});
});
});
});
await db.createCollection('try_next', { capped: true, size: 10000000 });
const coll = db.collection('try_next');
await coll.insertMany([{}, {}]);

const cursor = coll.find({}, { tailable: true, awaitData: true });

const doc1 = await cursor.tryNext();
expect(doc1).to.exist;

const doc2 = await cursor.tryNext();
expect(doc2).to.exist;

const doc3 = await cursor.tryNext();
expect(doc3).to.be.null;
});
});

Expand Down Expand Up @@ -293,51 +278,36 @@ describe('Find Cursor', function () {
}
});

it('should end an implicit session on rewind', {
metadata: { requires: { mongodb: '>=3.6' } },
test: function (done) {
const coll = client.db().collection('abstract_cursor');
const cursor = coll.find({}, { batchSize: 1 });
this.defer(() => cursor.close());

cursor.next((err, doc) => {
expect(err).to.not.exist;
expect(doc).to.exist;

const session = cursor.session;
expect(session).property('hasEnded').to.be.false;
cursor.rewind();
expect(session).property('hasEnded').to.be.true;
done();
});
}
});
it('should end an implicit session on rewind', async function () {
const coll = client.db().collection('abstract_cursor');
const cursor = coll.find({}, { batchSize: 1 });

it('should not end an explicit session on rewind', {
metadata: { requires: { mongodb: '>=3.6' } },
test: function (done) {
const coll = client.db().collection('abstract_cursor');
const session = client.startSession();
const doc = await cursor.next();
expect(doc).to.exist;

const cursor = coll.find({}, { batchSize: 1, session });
this.defer(() => cursor.close());
const session = cursor.session;
expect(session).property('hasEnded').to.be.false;
cursor.rewind();
expect(session).property('hasEnded').to.be.true;
});

cursor.next((err, doc) => {
expect(err).to.not.exist;
expect(doc).to.exist;
it('should not end an explicit session on rewind', async function () {
const coll = client.db().collection('abstract_cursor');
const cursor = coll.find({}, { batchSize: 1, session: client.startSession() });

const session = cursor.session;
expect(session).property('hasEnded').to.be.false;
cursor.rewind();
expect(session).property('hasEnded').to.be.false;
const doc = await cursor.next();
expect(doc).to.exist;

session.endSession(done);
});
}
const session = cursor.session;
expect(session).property('hasEnded').to.be.false;
cursor.rewind();
expect(session).property('hasEnded').to.be.false;

await session.endSession();
});

it('emits close after rewind', async () => {
let cursor;
let cursor: FindCursor;
try {
const coll = client.db().collection('abstract_cursor');
cursor = coll.find({}, { batchSize: 1 });
Expand All @@ -359,41 +329,33 @@ describe('Find Cursor', function () {
context('#allowDiskUse', function () {
it('should set allowDiskUse to true by default', {
metadata: { requires: { mongodb: '>=4.4' } },
test: function (done) {
test: async function () {
const commands = [];
client.on('commandStarted', filterForCommands(['find'], commands));

const coll = client.db().collection('abstract_cursor');
const cursor = coll.find({}, { sort: 'foo' });
cursor.allowDiskUse();
this.defer(() => cursor.close());

cursor.toArray(err => {
expect(err).to.not.exist;
expect(commands).to.have.length(1);
expect(commands[0].command.allowDiskUse).to.equal(true);
done();
});
await cursor.toArray();
expect(commands).to.have.length(1);
expect(commands[0].command.allowDiskUse).to.equal(true);
}
});

it('should set allowDiskUse to false if specified', {
metadata: { requires: { mongodb: '>=4.4' } },
test: function (done) {
test: async function () {
const commands = [];
client.on('commandStarted', filterForCommands(['find'], commands));

const coll = client.db().collection('abstract_cursor');
const cursor = coll.find({}, { sort: 'foo' });
cursor.allowDiskUse(false);
this.defer(() => cursor.close());

cursor.toArray(err => {
expect(err).to.not.exist;
expect(commands).to.have.length(1);
expect(commands[0].command.allowDiskUse).to.equal(false);
done();
});
await cursor.toArray();
expect(commands).to.have.length(1);
expect(commands[0].command.allowDiskUse).to.equal(false);
}
});

Expand All @@ -411,9 +373,9 @@ describe('Find Cursor', function () {
});

describe('mixing iteration APIs', function () {
let client;
let collection;
let cursor;
let client: MongoClient;
let collection: Collection;
let cursor: FindCursor;

beforeEach(async function () {
client = this.configuration.newClient();
Expand All @@ -437,7 +399,7 @@ describe('Find Cursor', function () {
});

await cursor.next();
// eslint-disable-next-line no-unused-vars

for await (const _ of cursor) {
/* empty */
}
Expand All @@ -454,8 +416,7 @@ describe('Find Cursor', function () {

await cursor.next();

let doc;
while ((doc = (await cursor.next()) && doc != null)) {
while ((await cursor.next()) != null) {
/** empty */
}

Expand All @@ -472,8 +433,7 @@ describe('Find Cursor', function () {

await cursor.next();

let doc;
while ((doc = (await cursor.next()) && doc != null)) {
while ((await cursor.next()) != null) {
/** empty */
}

Expand Down Expand Up @@ -543,7 +503,7 @@ describe('Find Cursor', function () {
await promise;

let count = 0;
// eslint-disable-next-line no-unused-vars

for await (const _ of cursor) {
count++;
}
Expand Down Expand Up @@ -587,7 +547,7 @@ describe('Find Cursor', function () {
cursor = collection.find({});

await cursor.toArray();
// eslint-disable-next-line no-unused-vars

for await (const _ of cursor) {
expect.fail('should not iterate');
}
Expand Down Expand Up @@ -633,7 +593,7 @@ describe('Find Cursor', function () {
});

await cursor.next();
// eslint-disable-next-line no-unused-vars

for await (const _ of cursor) {
/* empty */
}
Expand All @@ -647,7 +607,6 @@ describe('Find Cursor', function () {
it('throws a MongoCursorExhaustedError', async function () {
cursor = collection.find({}, { batchSize: 1 });

// eslint-disable-next-line no-unused-vars
for await (const _ of cursor) {
/* empty */
break;
Expand All @@ -672,8 +631,7 @@ describe('Find Cursor', function () {

await cursor.next();

let doc;
while ((doc = (await cursor.next()) && doc != null)) {
while ((await cursor.next()) != null) {
/** empty */
}

Expand Down Expand Up @@ -715,7 +673,7 @@ describe('Find Cursor', function () {
cursor = collection.find({}, { batchSize: 1 });

await cursor.toArray();
// eslint-disable-next-line no-unused-vars

for await (const _ of cursor) {
expect.fail('should not iterate');
}
Expand Down