Files
mongo/jstests/libs/sbe_util.js

67 lines
2.4 KiB
JavaScript

/*
* Utilities for checking whether SBE is enabled.
*/
load("jstests/libs/discover_topology.js"); // For findNonConfigNodes.
load("jstests/libs/fixture_helpers.js"); // For 'isMongos'
/**
* Returns whether or not SBE is enabled for the given connection. Assumes that for repl sets and
* sharded clusters, SBE is either enabled on each node, or disabled on each node.
*/
function checkSBEEnabled(theDB) {
let checkResult = false;
assert.soon(() => {
// Some test suites kill the primary, potentially resulting in networking errors. We use:
// 1. try..catch below to retry the whole check if we failed to discover topology
// 2. try..catch in the loop to try the next node if the current is killed
let nodes;
try {
nodes = DiscoverTopology.findNonConfigNodes(theDB.getMongo());
} catch (e) {
return false;
}
// Find a non-mongos node and check whether its SBE feature flag is on. We assume either all
// nodes in the cluster have SBE on or none.
for (const node of nodes) {
try {
const conn = new Mongo(node);
if (FixtureHelpers.isMongos(conn.getDB("admin"))) {
continue;
}
const getParam = conn.adminCommand(
{getParameter: 1, featureFlagSBE: 1, internalQueryForceClassicEngine: 1});
checkResult = getParam.hasOwnProperty("featureFlagSBE") &&
getParam.featureFlagSBE.value &&
getParam.hasOwnProperty("internalQueryForceClassicEngine") &&
!getParam.internalQueryForceClassicEngine.value;
return true;
} catch (e) {
continue;
}
}
return false;
});
return checkResult;
}
/**
* Returns whether queries will run with SBE or not. This is distinct from determining whether SBE
* is enabled because queries run using the legacy read mode will not use SBE even if it is
* enabled.
*/
function checkSBECompatible(theDB) {
if (!checkSBEEnabled(theDB)) {
return false;
}
// We can use SBE if we're not using legacy reads, or if we're connected to mongos (which will
// always use read commands against the shards).
return theDB.getMongo().readMode() != "legacy" || FixtureHelpers.isMongos(theDB);
}