/**
* Test that client cursors time out and get deleted.
*/
TEST_F(CursorManagerTest, InactiveCursorShouldTimeout) {
CursorManager* cursorManager = useCursorManager();
auto clock = useClock();
cursorManager->registerCursor(_opCtx.get(),
{makeFakePlanExecutor(),
NamespaceString{"test.collection"},
{},
repl::ReadConcernLevel::kLocalReadConcern,
BSONObj()});
ASSERT_EQ(0UL, cursorManager->timeoutCursors(_opCtx.get(), Date_t()));
clock->advance(getDefaultCursorTimeoutMillis());
ASSERT_EQ(1UL, cursorManager->timeoutCursors(_opCtx.get(), clock->now()));
ASSERT_EQ(0UL, cursorManager->numCursors());
cursorManager->registerCursor(_opCtx.get(),
{makeFakePlanExecutor(),
NamespaceString{"test.collection"},
{},
repl::ReadConcernLevel::kLocalReadConcern,
BSONObj()});
ASSERT_EQ(1UL, cursorManager->timeoutCursors(_opCtx.get(), Date_t::max()));
ASSERT_EQ(0UL, cursorManager->numCursors());
}
/**
* Test that using a cursor updates its time of last use.
*/
TEST_F(CursorManagerTest, UsingACursorShouldUpdateTimeOfLastUse) {
CursorManager* cursorManager = useCursorManager();
auto clock = useClock();
// Register a cursor which we will look at again.
auto cursorPin = cursorManager->registerCursor(
_opCtx.get(), {makeFakePlanExecutor(), kTestNss, {}, false, BSONObj()});
auto usedCursorId = cursorPin.getCursor()->cursorid();
cursorPin.release();
// Register a cursor to immediately forget about, to make sure it will time out on a normal
// schedule.
cursorManager->registerCursor(_opCtx.get(),
{makeFakePlanExecutor(), kTestNss, {}, false, BSONObj()});
// Advance the clock to simulate time passing.
clock->advance(Milliseconds(1));
// Touch the cursor with id 'usedCursorId' to advance its time of last use.
cursorManager->pinCursor(_opCtx.get(), usedCursorId).status_with_transitional_ignore();
// We should be able to time out the unused cursor, but the one we used should stay alive.
ASSERT_EQ(2UL, cursorManager->numCursors());
clock->advance(getDefaultCursorTimeoutMillis() - Milliseconds(1));
ASSERT_EQ(1UL, cursorManager->timeoutCursors(_opCtx.get(), clock->now()));
ASSERT_EQ(1UL, cursorManager->numCursors());
// We should be able to time out the used cursor after one more millisecond.
clock->advance(Milliseconds(1));
ASSERT_EQ(1UL, cursorManager->timeoutCursors(_opCtx.get(), clock->now()));
ASSERT_EQ(0UL, cursorManager->numCursors());
}
/**
* Tests that invalidating a cursor while it is in use will deregister it from the cursor manager,
* transferring ownership to the pinned cursor.
*/
TEST_F(CursorManagerTest, InvalidatePinnedCursor) {
CursorManager* cursorManager = useCursorManager();
auto cursorPin = cursorManager->registerCursor(_opCtx.get(),
{makeFakePlanExecutor(),
kTestNss,
{},
repl::ReadConcernLevel::kLocalReadConcern,
BSONObj()});
// If the cursor is pinned, it sticks around, even after invalidation.
ASSERT_EQUALS(1U, cursorManager->numCursors());
const std::string invalidateReason("InvalidatePinned Test");
cursorManager->invalidateAll(_opCtx.get(), false, invalidateReason);
ASSERT_EQUALS(0U, cursorManager->numCursors());
// The invalidation should have killed the plan executor.
BSONObj objOut;
ASSERT_EQUALS(PlanExecutor::DEAD, cursorPin.getCursor()->getExecutor()->getNext(&objOut, NULL));
ASSERT(WorkingSetCommon::isValidStatusMemberObject(objOut));
const Status status = WorkingSetCommon::getMemberObjectStatus(objOut);
ASSERT(status.reason().find(invalidateReason) != std::string::npos);
cursorPin.release();
ASSERT_EQUALS(0U, cursorManager->numCursors());
}
ClientCursorParams makeParams(OperationContext* opCtx) {
return {makeFakePlanExecutor(opCtx),
kTestNss,
{},
repl::ReadConcernLevel::kLocalReadConcern,
BSONObj()};
}
/**
* Test that a cursor cannot be timed out while in use, and that it's time of last use is updated
* when it is unpinned.
*/
TEST_F(CursorManagerTest, CursorShouldNotTimeOutUntilIdleForLongEnoughAfterBeingUnpinned) {
CursorManager* cursorManager = useCursorManager();
auto clock = useClock();
// Register a cursor which we will look at again.
auto cursorPin = cursorManager->registerCursor(_opCtx.get(),
{makeFakePlanExecutor(),
kTestNss,
{},
repl::ReadConcernLevel::kLocalReadConcern,
BSONObj()});
// Advance the clock to simulate time passing.
clock->advance(getDefaultCursorTimeoutMillis() + Milliseconds(1));
// Make sure the pinned cursor does not time out, before or after unpinning it.
ASSERT_EQ(1UL, cursorManager->numCursors());
ASSERT_EQ(0UL, cursorManager->timeoutCursors(_opCtx.get(), clock->now()));
ASSERT_EQ(1UL, cursorManager->numCursors());
cursorPin.release();
ASSERT_EQ(1UL, cursorManager->numCursors());
ASSERT_EQ(0UL, cursorManager->timeoutCursors(_opCtx.get(), clock->now()));
ASSERT_EQ(1UL, cursorManager->numCursors());
// Advance the clock to simulate more time passing, then assert that the now-inactive cursor
// times out.
clock->advance(getDefaultCursorTimeoutMillis() + Milliseconds(1));
ASSERT_EQ(1UL, cursorManager->timeoutCursors(_opCtx.get(), clock->now()));
ASSERT_EQ(0UL, cursorManager->numCursors());
}
/**
* Test that an attempt to kill a pinned cursor succeeds with more than one client.
*/
TEST_F(CursorManagerTest, ShouldBeAbleToKillPinnedCursorMultiClient) {
CursorManager* cursorManager = useCursorManager();
const bool shouldAudit = false;
OperationContext* const pinningOpCtx = _opCtx.get();
// Pin the cursor from one client.
auto cursorPin = cursorManager->registerCursor(pinningOpCtx,
{makeFakePlanExecutor(),
kTestNss,
{},
repl::ReadConcernLevel::kLocalReadConcern,
BSONObj()});
auto cursorId = cursorPin.getCursor()->cursorid();
// Set up another client to kill the cursor.
auto killCursorClientOwned = getGlobalServiceContext()->makeClient("killCursorClient");
// Keep around a raw pointer for when we transfer ownership of killingClientOwned to the global
// current client.
Client* killCursorClient = killCursorClientOwned.get();
// Need to swap the current client in order to make an operation context.
auto pinningClient = Client::releaseCurrent();
Client::setCurrent(std::move(killCursorClientOwned));
auto killCursorOpCtx = killCursorClient->makeOperationContext();
invariant(killCursorOpCtx);
ASSERT_OK(cursorManager->killCursor(killCursorOpCtx.get(), cursorId, shouldAudit));
// The original operation should have been interrupted since the cursor was pinned.
ASSERT_EQ(pinningOpCtx->checkForInterruptNoAssert(), ErrorCodes::CursorKilled);
}
TEST_F(CursorManagerTest, GlobalCursorManagerShouldReportOwnershipOfCursorsItCreated) {
for (int i = 0; i < 1000; i++) {
auto cursorPin = CursorManager::getGlobalCursorManager()->registerCursor(
_opCtx.get(),
{makeFakePlanExecutor(), NamespaceString{"test.collection"}, {}, false, BSONObj()});
ASSERT_TRUE(CursorManager::isGloballyManagedCursor(cursorPin.getCursor()->cursorid()));
}
}
TEST_F(CursorManagerTest,
CursorsFromCollectionCursorManagerShouldNotReportBeingManagedByGlobalCursorManager) {
CursorManager* cursorManager = useCursorManager();
auto opCtx = cc().makeOperationContext();
for (int i = 0; i < 1000; i++) {
auto cursorPin = cursorManager->registerCursor(
_opCtx.get(), {makeFakePlanExecutor(), kTestNss, {}, false, BSONObj()});
ASSERT_FALSE(CursorManager::isGloballyManagedCursor(cursorPin.getCursor()->cursorid()));
}
}
/**
* Test that pinned cursors do not get timed out.
*/
TEST_F(CursorManagerTest, InactivePinnedCursorShouldNotTimeout) {
CursorManager* cursorManager = useCursorManager();
auto clock = useClock();
auto cursorPin = cursorManager->registerCursor(
_opCtx.get(),
{makeFakePlanExecutor(), NamespaceString{"test.collection"}, {}, false, BSONObj()});
// The pin is still in scope, so it should not time out.
clock->advance(getDefaultCursorTimeoutMillis());
ASSERT_EQ(0UL, cursorManager->timeoutCursors(_opCtx.get(), clock->now()));
}
/**
* Test that an attempt to kill a pinned cursor fails and produces an appropriate assertion.
*/
TEST_F(CursorManagerTest, ShouldNotBeAbleToKillPinnedCursor) {
CursorManager* cursorManager = useCursorManager();
auto cursorPin = cursorManager->registerCursor(
_opCtx.get(), {makeFakePlanExecutor(), kTestNss, {}, false, BSONObj()});
auto cursorId = cursorPin.getCursor()->cursorid();
const bool shouldAudit = false;
ASSERT_EQ(cursorManager->eraseCursor(_opCtx.get(), cursorId, shouldAudit),
ErrorCodes::OperationFailed);
}
TEST_F(CursorManagerTest,
AllCursorsFromCollectionCursorManagerShouldContainIdentical32BitPrefixes) {
CursorManager* cursorManager = useCursorManager();
boost::optional<uint32_t> prefix;
for (int i = 0; i < 1000; i++) {
auto cursorPin = cursorManager->registerCursor(
_opCtx.get(), {makeFakePlanExecutor(), kTestNss, {}, false, BSONObj()});
auto cursorId = cursorPin.getCursor()->cursorid();
if (prefix) {
ASSERT_EQ(*prefix, extractLeading32Bits(cursorId));
} else {
prefix = extractLeading32Bits(cursorId);
}
}
}
/**
* Test that an attempt to kill a pinned cursor succeeds.
*/
TEST_F(CursorManagerTest, ShouldBeAbleToKillPinnedCursor) {
CursorManager* cursorManager = useCursorManager();
const bool shouldAudit = false;
OperationContext* const pinningOpCtx = _opCtx.get();
auto cursorPin = cursorManager->registerCursor(pinningOpCtx,
{makeFakePlanExecutor(),
kTestNss,
{},
repl::ReadConcernLevel::kLocalReadConcern,
BSONObj()});
auto cursorId = cursorPin.getCursor()->cursorid();
ASSERT_OK(cursorManager->killCursor(_opCtx.get(), cursorId, shouldAudit));
// The original operation should have been interrupted since the cursor was pinned.
ASSERT_EQ(pinningOpCtx->checkForInterruptNoAssert(), ErrorCodes::CursorKilled);
}
/**
* Tests that invalidating a cursor and dropping the collection while the cursor is not in use will
* not keep the cursor registered.
*/
TEST_F(CursorManagerTest, InvalidateCursorWithDrop) {
CursorManager* cursorManager = useCursorManager();
auto cursorPin = cursorManager->registerCursor(
_opCtx.get(), {makeFakePlanExecutor(), kTestNss, {}, false, BSONObj()});
auto cursorId = cursorPin.getCursor()->cursorid();
cursorPin.release();
ASSERT_EQUALS(1U, cursorManager->numCursors());
auto invalidateReason = "Invalidate Test";
const bool collectionGoingAway = true;
cursorManager->invalidateAll(_opCtx.get(), collectionGoingAway, invalidateReason);
// Since the collection is going away, the cursor should not remain open.
ASSERT_EQ(ErrorCodes::CursorNotFound,
cursorManager->pinCursor(_opCtx.get(), cursorId).getStatus());
ASSERT_EQUALS(0U, cursorManager->numCursors());
}
/**
* Test that client cursors which have been marked as killed but are still pinned *do not* time out.
*/
TEST_F(CursorManagerTest, InactiveKilledCursorsThatAreStillPinnedShouldNotTimeout) {
CursorManager* cursorManager = useCursorManager();
auto clock = useClock();
// Make a cursor from the plan executor, and immediately kill it.
auto cursorPin = cursorManager->registerCursor(
_opCtx.get(),
{makeFakePlanExecutor(), NamespaceString{"test.collection"}, {}, false, BSONObj()});
const bool collectionGoingAway = false;
cursorManager->invalidateAll(
_opCtx.get(), collectionGoingAway, "KilledCursorsShouldTimeoutTest");
// Advance the clock to simulate time passing.
clock->advance(getDefaultCursorTimeoutMillis());
// The pin is still in scope, so it should not time out.
ASSERT_EQ(0UL, cursorManager->timeoutCursors(_opCtx.get(), clock->now()));
}
/**
* Test that client cursors which have been marked as killed time out and get deleted.
*/
TEST_F(CursorManagerTest, InactiveKilledCursorsShouldTimeout) {
CursorManager* cursorManager = useCursorManager();
auto clock = useClock();
// Make a cursor from the plan executor, and immediately kill it.
auto cursorPin = cursorManager->registerCursor(
_opCtx.get(),
{makeFakePlanExecutor(), NamespaceString{"test.collection"}, {}, false, BSONObj()});
cursorPin.release();
const bool collectionGoingAway = false;
cursorManager->invalidateAll(
_opCtx.get(), collectionGoingAway, "KilledCursorsShouldTimeoutTest");
// Advance the clock to simulate time passing.
clock->advance(Milliseconds(CursorManager::kDefaultCursorTimeoutMinutes));
ASSERT_EQ(1UL, cursorManager->timeoutCursors(_opCtx.get(), clock->now()));
ASSERT_EQ(0UL, cursorManager->numCursors());
}
/**
* Tests that invalidating a cursor without dropping the collection while the cursor is not in use
* will keep the cursor registered. After being invalidated, pinning the cursor should take
* ownership of the cursor and calling getNext() on its PlanExecutor should return an error
* including the error message.
*/
TEST_F(CursorManagerTest, InvalidateCursor) {
CursorManager* cursorManager = useCursorManager();
auto cursorPin = cursorManager->registerCursor(
_opCtx.get(), {makeFakePlanExecutor(), kTestNss, {}, false, BSONObj()});
auto cursorId = cursorPin.getCursor()->cursorid();
cursorPin.release();
ASSERT_EQUALS(1U, cursorManager->numCursors());
auto invalidateReason = "Invalidate Test";
const bool collectionGoingAway = false;
cursorManager->invalidateAll(_opCtx.get(), collectionGoingAway, invalidateReason);
// Since the collection is not going away, the cursor should remain open, but be killed.
ASSERT_EQUALS(1U, cursorManager->numCursors());
// Pinning a killed cursor should result in an error and clean up the cursor.
ASSERT_EQ(ErrorCodes::QueryPlanKilled,
cursorManager->pinCursor(_opCtx.get(), cursorId).getStatus());
ASSERT_EQUALS(0U, cursorManager->numCursors());
}
std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> makeFakePlanExecutor() {
return makeFakePlanExecutor(_opCtx.get());
}
TEST_F(CursorManagerTestCustomOpCtx,
KillAllCursorsForTransactionRemovesCorrectEntryFromTransactionMap) {
CursorManager* cursorManager = CursorManager::getGlobalCursorManager();
// Create 3 sets of cursors, each with a unique LogicalSessionId/TxnNumber pair, but each
// sharing either LogicalSessionId or TxnNumber with another set.
auto lsid1 = makeLogicalSessionIdForTest();
TxnNumber txnNumber1 = 0;
{
auto opCtx = _queryServiceContext->makeOperationContext(lsid1, txnNumber1);
auto pinned = cursorManager->registerCursor(opCtx.get(),
{makeFakePlanExecutor(),
NamespaceString{"test.collection"},
{},
repl::ReadConcernLevel::kLocalReadConcern,
BSONObj()});
pinned.release();
}
auto lsid2 = lsid1;
TxnNumber txnNumber2 = 1;
{
auto opCtx = _queryServiceContext->makeOperationContext(lsid2, txnNumber2);
auto pinned = cursorManager->registerCursor(opCtx.get(),
{makeFakePlanExecutor(),
NamespaceString{"test.collection"},
{},
repl::ReadConcernLevel::kLocalReadConcern,
BSONObj()});
pinned.release();
}
auto lsid3 = makeLogicalSessionIdForTest();
TxnNumber txnNumber3 = txnNumber1;
{
auto opCtx = _queryServiceContext->makeOperationContext(lsid3, txnNumber3);
// Create 2 cursors for the third set to confirm multiple cursor deregistration.
auto pinned = cursorManager->registerCursor(opCtx.get(),
{makeFakePlanExecutor(),
NamespaceString{"test.collection"},
{},
repl::ReadConcernLevel::kLocalReadConcern,
BSONObj()});
pinned.release();
pinned = cursorManager->registerCursor(opCtx.get(),
{makeFakePlanExecutor(),
NamespaceString{"test.collection"},
{},
repl::ReadConcernLevel::kLocalReadConcern,
BSONObj()});
pinned.release();
}
auto opCtx = _queryServiceContext->makeOperationContext();
// Transaction reference exists for all 3 sets.
ASSERT_TRUE(cursorManager->hasTransactionCursorReference(lsid1, txnNumber1));
ASSERT_TRUE(cursorManager->hasTransactionCursorReference(lsid2, txnNumber2));
ASSERT_TRUE(cursorManager->hasTransactionCursorReference(lsid3, txnNumber3));
// Transaction reference does not exist for LogicalSessionId/TxnNumber that has no cursors.
ASSERT_FALSE(cursorManager->hasTransactionCursorReference(makeLogicalSessionIdForTest(), 99));
// Kill cursors for set 1.
ASSERT_EQ(1ul, cursorManager->killAllCursorsForTransaction(opCtx.get(), lsid1, txnNumber1));
ASSERT_FALSE(cursorManager->hasTransactionCursorReference(lsid1, txnNumber1));
ASSERT_TRUE(cursorManager->hasTransactionCursorReference(lsid2, txnNumber2));
ASSERT_TRUE(cursorManager->hasTransactionCursorReference(lsid3, txnNumber3));
// Kill cursors for set 2.
ASSERT_EQ(1ul, cursorManager->killAllCursorsForTransaction(opCtx.get(), lsid2, txnNumber2));
ASSERT_FALSE(cursorManager->hasTransactionCursorReference(lsid2, txnNumber2));
ASSERT_TRUE(cursorManager->hasTransactionCursorReference(lsid3, txnNumber3));
// Kill cursors for set 3.
ASSERT_EQ(2ul, cursorManager->killAllCursorsForTransaction(opCtx.get(), lsid3, txnNumber3));
ASSERT_FALSE(cursorManager->hasTransactionCursorReference(lsid3, txnNumber3));
}
ClientCursorParams makeParams(OperationContext* opCtx) {
return {makeFakePlanExecutor(opCtx), kTestNss, {}, false, BSONObj()};
}