SERVER-83098: Make existing jstest work with the new CQF explain (core/query and core/sbe) (2)

Author: mattsimply

jstests/core/index/elemmatch_index.js

@@ -6,8 +6,6 @@
  *   assumes_read_concern_local,
  * ]
  */
-
-// adding temporary comment
 import {getOptimizer, getWinningPlan, isIxscan} from "jstests/libs/analyze_plan.js";
 
 const coll = db.elemMatch_index;

jstests/core/index/index_check7.js

@@ -44,5 +44,3 @@ switch (getOptimizer(explainResult)) {
     default:
         break
 }
-
-t.drop();

jstests/core/query/agg_hint.js

@@ -11,7 +11,7 @@
 // where agg execution differs from query. It also includes confirmation that hint works for find
 // command against views, which is converted to a hinted aggregation on execution.
 
-import {getAggPlanStage, getPlanStage} from "jstests/libs/analyze_plan.js";
+import {getAggPlanStage, getOptimizer, getPlanStage} from "jstests/libs/analyze_plan.js";
 
 const testDB = db.getSiblingDB("agg_hint");
 assert.commandWorked(testDB.dropDatabase());
@@ -22,11 +22,27 @@ const view = testDB.getCollection(viewName);
 
 function confirmWinningPlanUsesExpectedIndex(
     explainResult, expectedKeyPattern, stageName, pipelineOptimizedAway) {
-    const planStage = pipelineOptimizedAway ? getPlanStage(explainResult, stageName)
-                                            : getAggPlanStage(explainResult, stageName);
-    assert.neq(null, planStage);
+    const optimizer = getOptimizer(explainResult);
 
-    assert.eq(planStage.keyPattern, expectedKeyPattern, tojson(planStage));
+    if (!(optimizer in stageName) || stageName[optimizer] === "") {
+        // TODO SERVER-77719: Ensure that the expected operator is defined for all optimizers. There
+        // should be an exception here.
+        return;
+    }
+
+    const planStage = pipelineOptimizedAway ? getPlanStage(explainResult, stageName[optimizer])
+                                            : getAggPlanStage(explainResult, stageName[optimizer]);
+
+    switch (optimizer) {
+        case "classic":
+            assert.neq(null, planStage);
+            assert.eq(planStage.keyPattern, expectedKeyPattern, tojson(planStage));
+            break;
+        case "CQF":
+            // TODO SERVER-77719: Ensure that the decision for using the scan lines up with CQF
+            // optimizer. M2: allow only collscans, M4: check bonsai behavior for index scan.
+            break;
+    }
 }
 
 // Runs explain on 'command', with the hint specified by 'hintKeyPattern' when not null.
@@ -37,7 +53,10 @@ function confirmCommandUsesIndex({
     command = null,
     hintKeyPattern = null,
     expectedKeyPattern = null,
-    stageName = "IXSCAN",
+    stageName = {
+        "classic": "IXSCAN",
+        "CQF": "IndexScan"
+    },
     pipelineOptimizedAway = false
 } = {}) {
     if (hintKeyPattern) {
@@ -60,7 +79,10 @@ function confirmAggUsesIndex({
     aggPipeline = [],
     hintKeyPattern = null,
     expectedKeyPattern = null,
-    stageName = "IXSCAN",
+    stageName = {
+        "classic": "IXSCAN",
+        "CQF": "IndexScan"
+    },
     pipelineOptimizedAway = false
 } = {}) {
     let options = {};
@@ -248,19 +270,21 @@ for (let i = 0; i < 5; ++i) {
 }
 assert.commandWorked(testDB.createView(viewName, collName, []));
 
+// TODO SERVER-77719: Ensure that the decision for using the scan lines up with CQF
+// optimizer. M2: allow only collscans, M4: check bonsai behavior for index scan.
 confirmCommandUsesIndex({
     command: {count: view.getName(), query: {x: 3}},
     expectedKeyPattern: {x: 1},
-    stageName: "COUNT_SCAN"
+    stageName: {"classic": "COUNT_SCAN", "CQF": ""}
 });
 confirmCommandUsesIndex({
     command: {count: view.getName(), query: {x: 3}},
     hintKeyPattern: {x: 1},
     expectedKeyPattern: {x: 1},
-    stageName: "COUNT_SCAN"
+    stageName: {"classic": "COUNT_SCAN", "CQF": ""}
 });
 confirmCommandUsesIndex({
     command: {count: view.getName(), query: {x: 3}},
     hintKeyPattern: {_id: 1},
     expectedKeyPattern: {_id: 1}
-});
+});

jstests/core/query/covered_multikey.js

@@ -9,7 +9,15 @@
  * Test covering behavior for queries over a multikey index.
  */
 // For making assertions about explain output.
-import {getPlanStage, getWinningPlan, isIxscan, planHasStage} from "jstests/libs/analyze_plan.js";
+import {
+    getOptimizer,
+    getPlanStage,
+    getWinningPlan,
+    isCollscan,
+    isIxscan,
+    isIxscanMultikey,
+    planHasStage
+} from "jstests/libs/analyze_plan.js";
 
 let coll = db.covered_multikey;
 coll.drop();
@@ -21,7 +29,18 @@ assert.eq(1, coll.find({a: 1, b: 2}, {_id: 0, a: 1}).itcount());
 assert.eq({a: 1}, coll.findOne({a: 1, b: 2}, {_id: 0, a: 1}));
 let explainRes = coll.explain("queryPlanner").find({a: 1, b: 2}, {_id: 0, a: 1}).finish();
 let winningPlan = getWinningPlan(explainRes.queryPlanner);
-assert(isIxscan(db, winningPlan));
+switch (getOptimizer(explainRes)) {
+    case "classic": {
+        assert(isIxscan(db, winningPlan));
+        break;
+    }
+    case "CQF": {
+        // TODO SERVER-77719: Ensure that the decision for using the scan lines up with CQF
+        // optimizer. M2: allow only collscans, M4: check bonsai behavior for index scan.
+        assert(isCollscan(db, winningPlan));
+        break
+    }
+}
 assert(!planHasStage(db, winningPlan, "FETCH"));
 
 coll.drop();
@@ -47,10 +66,20 @@ assert.commandWorked(coll.createIndex({a: 1}));
 assert.eq({a: []}, coll.findOne({a: []}, {_id: 0, a: 1}));
 explainRes = coll.explain("queryPlanner").find({a: []}, {_id: 0, a: 1}).finish();
 winningPlan = getWinningPlan(explainRes.queryPlanner);
-assert(planHasStage(db, winningPlan, "IXSCAN"));
-assert(planHasStage(db, winningPlan, "FETCH"));
-let ixscanStage = getPlanStage(winningPlan, "IXSCAN");
-assert.eq(true, ixscanStage.isMultiKey);
+switch (getOptimizer(explainRes)) {
+    case "classic": {
+        assert(isIxscan(db, winningPlan));
+        assert(planHasStage(db, winningPlan, "FETCH"));
+        assert(isIxscanMultikey(winningPlan));
+        break;
+    }
+    case "CQF": {
+        // TODO SERVER-77719: Ensure that the decision for using the scan lines up with CQF
+        // optimizer. M2: allow only collscans, M4: check bonsai behavior for index scan.
+        assert(isCollscan(db, winningPlan));
+        break
+    }
+}
 
 // Verify that a query cannot be covered over a path which is multikey due to a single-element
 // array.
@@ -60,10 +89,20 @@ assert.commandWorked(coll.createIndex({a: 1}));
 assert.eq({a: [2]}, coll.findOne({a: 2}, {_id: 0, a: 1}));
 explainRes = coll.explain("queryPlanner").find({a: 2}, {_id: 0, a: 1}).finish();
 winningPlan = getWinningPlan(explainRes.queryPlanner);
-assert(planHasStage(db, winningPlan, "IXSCAN"));
-assert(planHasStage(db, winningPlan, "FETCH"));
-ixscanStage = getPlanStage(winningPlan, "IXSCAN");
-assert.eq(true, ixscanStage.isMultiKey);
+switch (getOptimizer(explainRes)) {
+    case "classic": {
+        assert(isIxscan(db, winningPlan));
+        assert(planHasStage(db, winningPlan, "FETCH"));
+        assert(isIxscanMultikey(winningPlan));
+        break;
+    }
+    case "CQF": {
+        // TODO SERVER-77719: Ensure that the decision for using the scan lines up with CQF
+        // optimizer. M2: allow only collscans, M4: check bonsai behavior for index scan.
+        assert(isCollscan(db, winningPlan));
+        break;
+    }
+}
 
 // Verify that a query cannot be covered over a path which is multikey due to a single-element
 // array, where the path is made multikey by an update rather than an insert.
@@ -74,43 +113,82 @@ assert.commandWorked(coll.update({}, {$set: {a: [2]}}));
 assert.eq({a: [2]}, coll.findOne({a: 2}, {_id: 0, a: 1}));
 explainRes = coll.explain("queryPlanner").find({a: 2}, {_id: 0, a: 1}).finish();
 winningPlan = getWinningPlan(explainRes.queryPlanner);
-assert(planHasStage(db, winningPlan, "IXSCAN"));
-assert(planHasStage(db, winningPlan, "FETCH"));
-ixscanStage = getPlanStage(winningPlan, "IXSCAN");
-assert.eq(true, ixscanStage.isMultiKey);
+switch (getOptimizer(explainRes)) {
+    case "classic": {
+        assert(isIxscan(db, winningPlan));
+        assert(planHasStage(db, winningPlan, "FETCH"));
+        assert(isIxscanMultikey(winningPlan));
+        break;
+    }
+    case "CQF": {
+        // TODO SERVER-77719: Ensure that the decision for using the scan lines up with CQF
+        // optimizer. M2: allow only collscans, M4: check bonsai behavior for index scan.
+        assert(isCollscan(db, winningPlan));
+        break;
+    }
+}
 
 // Verify that a trailing empty array makes a 2dsphere index multikey.
 assert(coll.drop());
 assert.commandWorked(coll.createIndex({"a.b": 1, c: "2dsphere"}));
 assert.commandWorked(coll.insert({a: {b: 1}, c: {type: "Point", coordinates: [0, 0]}}));
 explainRes = coll.explain().find().hint({"a.b": 1, c: "2dsphere"}).finish();
 winningPlan = getWinningPlan(explainRes.queryPlanner);
-ixscanStage = getPlanStage(winningPlan, "IXSCAN");
+let optimizer = getOptimizer(explainRes);
+let stages = {"classic": "IXSCAN", "CQF": "IndexScan"};
+let ixscanStage = getPlanStage(winningPlan, stages[optimizer]);
 assert.neq(null, ixscanStage);
 assert.eq(false, ixscanStage.isMultiKey);
 assert.commandWorked(coll.insert({a: {b: []}, c: {type: "Point", coordinates: [0, 0]}}));
 explainRes = coll.explain().find().hint({"a.b": 1, c: "2dsphere"}).finish();
 winningPlan = getWinningPlan(explainRes.queryPlanner);
-ixscanStage = getPlanStage(winningPlan, "IXSCAN");
-assert.neq(null, ixscanStage);
-assert.eq(true, ixscanStage.isMultiKey);
+switch (getOptimizer(explainRes)) {
+    case "classic": {
+        assert(isIxscan(db, winningPlan));
+        assert(isIxscanMultikey(winningPlan));
+        break;
+    }
+    case "CQF": {
+        // TODO SERVER-77719: Ensure that the decision for using the scan lines up with CQF
+        // optimizer. M2: allow only collscans, M4: check bonsai behavior for index scan.
+        break;
+    }
+}
 
 // Verify that a mid-path empty array makes a 2dsphere index multikey.
 assert(coll.drop());
 assert.commandWorked(coll.createIndex({"a.b": 1, c: "2dsphere"}));
 assert.commandWorked(coll.insert({a: [], c: {type: "Point", coordinates: [0, 0]}}));
 explainRes = coll.explain().find().hint({"a.b": 1, c: "2dsphere"}).finish();
 winningPlan = getWinningPlan(explainRes.queryPlanner);
-ixscanStage = getPlanStage(winningPlan, "IXSCAN");
-assert.neq(null, ixscanStage);
-assert.eq(true, ixscanStage.isMultiKey);
+switch (getOptimizer(explainRes)) {
+    case "classic": {
+        assert(isIxscan(db, winningPlan));
+        assert(isIxscanMultikey(winningPlan));
+        break;
+    }
+    case "CQF": {
+        // TODO SERVER-77719: Ensure that the decision for using the scan lines up with CQF
+        // optimizer. M2: allow only collscans, M4: check bonsai behavior for index scan.
+        break;
+    }
+}
 
 // Verify that a single-element array makes a 2dsphere index multikey.
 assert(coll.drop());
 assert.commandWorked(coll.createIndex({"a.b": 1, c: "2dsphere"}));
 assert.commandWorked(coll.insert({a: {b: [3]}, c: {type: "Point", coordinates: [0, 0]}}));
 explainRes = coll.explain().find().hint({"a.b": 1, c: "2dsphere"}).finish();
 winningPlan = getWinningPlan(explainRes.queryPlanner);
-ixscanStage = getPlanStage(winningPlan, "IXSCAN");
-assert.neq(null, ixscanStage);
-assert.eq(true, ixscanStage.isMultiKey);
+switch (getOptimizer(explainRes)) {
+    case "classic": {
+        assert(isIxscan(db, winningPlan));
+        assert(isIxscanMultikey(winningPlan));
+        break;
+    }
+    case "CQF": {
+        // TODO SERVER-77719: Ensure that the decision for using the scan lines up with CQF
+        // optimizer. M2: allow only collscans, M4: check bonsai behavior for index scan.
+        break;
+    }
+}

jstests/core/query/explain/explain_multi_plan.js

@@ -7,6 +7,8 @@
 //   does_not_support_causal_consistency,
 // ]
 
+import {hasRejectedPlans} from "jstests/libs/analyze_plan.js";
+
 /**
  * Tests running explain on a variety of explainable commands (find, update, remove, etc.) when
  * there are multiple plans available. This is a regression test for SERVER-20849 and SERVER-21376.
@@ -55,25 +57,10 @@ assert.doesNotThrow(function() {
     coll.explain("allPlansExecution").distinct("a", {a: {$gte: 1}});
 });
 
-// SERVER-21376: Make sure the 'rejectedPlans' field is filled in appropriately.
-function assertHasRejectedPlans(explainOutput) {
-    var queryPlannerOutput = explainOutput.queryPlanner;
-
-    // The 'rejectedPlans' section will be in a different place if passed through a mongos.
-    if ("SINGLE_SHARD" == queryPlannerOutput.winningPlan.stage) {
-        var shards = queryPlannerOutput.winningPlan.shards;
-        shards.forEach(function assertShardHasRejectedPlans(shard) {
-            assert.gt(shard.rejectedPlans.length, 0);
-        });
-    } else {
-        assert.gt(queryPlannerOutput.rejectedPlans.length, 0);
-    }
-}
-
 var res = coll.explain("queryPlanner").find({a: {$gte: 1}}).finish();
 assert.commandWorked(res);
-assertHasRejectedPlans(res);
+assert(hasRejectedPlans(res));
 
 res = coll.explain("executionStats").find({a: {$gte: 1}}).finish();
 assert.commandWorked(res);
-assertHasRejectedPlans(res);
+assert(hasRejectedPlans(res));

jstests/core/query/explain/explain_winning_plan.js

@@ -8,6 +8,8 @@
 //   assumes_against_mongod_not_mongos,
 // ]
 
+import {getOptimizer} from "jstests/libs/analyze_plan.js";
+
 const coll = db.explain_winning_plan;
 coll.drop();
 
@@ -43,7 +45,16 @@ assert.eq(explain.executionStats.nReturned, numDocs);
 // representing two candidate plans evaluated by the multi-planner.
 assert(explain.executionStats.hasOwnProperty("allPlansExecution"), explain);
 assert(Array.isArray(explain.executionStats.allPlansExecution), explain);
-assert.eq(explain.executionStats.allPlansExecution.length, 2, explain);
+
+switch (getOptimizer(explain)) {
+    case "classic":
+        assert.eq(explain.executionStats.allPlansExecution.length, 2, explain);
+        break;
+    case "CQF":
+        // TODO SERVER-77719: Ensure that the decision for using the scan lines up with CQF
+        // optimizer. M2: allow only collscans, M4: check bonsai behavior for index scan.
+        break;
+}
 
 // Each candidate plan should have returned exactly 'maxResults' number of documents during the
 // trial period.
@@ -60,4 +71,4 @@ assert(explainSinglePlan.executionStats.hasOwnProperty("allPlansExecution"), exp
 assert(Array.isArray(explainSinglePlan.executionStats.allPlansExecution), explainSinglePlan);
 assert.eq(explainSinglePlan.executionStats.allPlansExecution.length, 0, explainSinglePlan);
 
-assert(coll.drop());
+assert(coll.drop());