summaryrefslogtreecommitdiff
path: root/jstests/noPassthrough/explain_output_truncation.js
blob: 563bbaddbda2a0717795bb1c67e9322248a4cdd3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/**
 * Test that explain output is correctly truncated when it grows too large.
 */
(function() {
"use strict";

load("jstests/libs/analyze_plan.js");

const dbName = "test";
const collName = jsTestName();
const explainSizeParam = "internalQueryExplainSizeThresholdBytes";

const conn = MongoRunner.runMongod({});
assert.neq(conn, null, "mongod failed to start up");

const testDb = conn.getDB(dbName);
const coll = testDb[collName];
coll.drop();

assert.commandWorked(coll.createIndex({a: 1}));

// Explain output should show a simple IXSCAN => FETCH => SORT plan with no truncation.
let explain = coll.find({a: 1, b: 1}).sort({c: 1}).explain();
let winningPlan = getWinningPlan(explain.queryPlanner);
let sortStage = getPlanStage(winningPlan, "SORT");
assert.neq(sortStage, null, explain);
let fetchStage = getPlanStage(sortStage, "FETCH");
assert.neq(fetchStage, null, explain);
let ixscanStage = getPlanStage(sortStage, "IXSCAN");
assert.neq(ixscanStage, null, explain);

// Calculate the size of explain output's winning plan without the index scan. If the explain size
// threshold is set near this amount, then the IXSCAN stage will need to be truncated.
assert.neq(ixscanStage, null, explain);
const newExplainSize = Object.bsonsize(winningPlan) - Object.bsonsize(ixscanStage) - 10;
assert.gt(newExplainSize, 0);

// Reduce the size at which we start truncating explain output. If we explain the same query again,
// then the FETCH stage should be present, but the IXSCAN stage should be truncated.
assert.commandWorked(testDb.adminCommand({setParameter: 1, [explainSizeParam]: newExplainSize}));

explain = coll.find({a: 1, b: 1}).sort({c: 1}).explain();
assert(planHasStage(testDb, explain, "SORT"), explain);
fetchStage = getPlanStage(getWinningPlan(explain.queryPlanner), "FETCH");
assert.neq(fetchStage, null, explain);
assert(fetchStage.hasOwnProperty("inputStage"), explain);
assert(fetchStage.inputStage.hasOwnProperty("warning"), explain);
assert.eq(
    fetchStage.inputStage.warning, "stats tree exceeded BSON size limit for explain", explain);
assert(!planHasStage(testDb, explain, "IXSCAN"), explain);

MongoRunner.stopMongod(conn);
}());