Skip to content

fix(NODE-5691): make findOne() close implicit session to avoid memory leak #3889

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

Merged
merged 8 commits into from
Oct 18, 2023
Merged

fix(NODE-5691): make findOne() close implicit session to avoid memory leak #3889

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c51d47e
fix: make findOne() close implicit session to avoid memory leak
vkarpov15 Oct 11, 2023
9835b6d
test: ensure findOne calls cursor.close
nbbeeken Oct 17, 2023
241f1c5
test: success and fail with server side errors, check cursor state
nbbeeken Oct 18, 2023
4cb11d2
test: check session hasEnded
nbbeeken Oct 18, 2023
878f587
test: rm only
nbbeeken Oct 18, 2023
c091e14
fix: lint
nbbeeken Oct 18, 2023
9119c69
test: skip where failpoints aren't supported
nbbeeken Oct 18, 2023
5c2fd19
fix: skipping
nbbeeken Oct 18, 2023
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
5 changes: 4 additions & 1 deletion src/collection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,10 @@ export class Collection<TSchema extends Document = Document> {
filter: Filter<TSchema> = {},
options: FindOptions = {}
): Promise<WithId<TSchema> | null> {
return this.find(filter, options).limit(-1).batchSize(1).next();
const cursor = this.find(filter, options).limit(-1).batchSize(1);
const res = await cursor.next();
await cursor.close();
Copy link
Contributor

@nbbeeken nbbeeken Oct 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Calling close without try/finally here I believe is correct, a cursor that receives an error always calls close. Also, calling close unconditionally makes sense because close already includes the logic to no-op when the cursor has already been closed.

return res;
}

/**
Expand Down
19 changes: 17 additions & 2 deletions test/integration/crud/crud_api.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
import { expect } from 'chai';
import { on } from 'events';

import { type MongoClient, MongoError, ObjectId, ReturnDocument } from '../../mongodb';
import * as sinon from 'sinon';

import {
AbstractCursor,
type MongoClient,
MongoError,
ObjectId,
ReturnDocument
} from '../../mongodb';
import { assert as test } from '../shared';

// instanceof cannot be use reliably to detect the new models in js due to scoping and new
Expand Down Expand Up @@ -31,6 +38,8 @@ describe('CRUD API', function () {
});

afterEach(async function () {
sinon.restore();

await client?.close();
client = null;

Expand Down Expand Up @@ -61,6 +70,12 @@ describe('CRUD API', function () {
await client.close();
});

it('findOne calls cursor.close()', async function () {
const spy = sinon.spy(AbstractCursor.prototype, 'close');
await client.db().collection('t').findOne({});
expect(spy).to.be.calledOnce;
});

context('when creating a cursor with find', () => {
let collection;

Expand Down