@mongodb-js/explain-plan-helper 1.5.18 → 1.6.0

package/dist/index.d.ts

@@ -16,6 +16,9 @@ export type IndexInformation = {
     shard: null;
     index: string;
 });
+export type SerializedExplainPlan = Pick<ExplainPlan, 'namespace' | 'parsedQuery' | 'executionSuccess' | 'nReturned' | 'executionTimeMillis' | 'totalKeysExamined' | 'totalDocsExamined' | 'originalExplainData' | 'executionStats' | 'isCovered' | 'isMultiKey' | 'inMemorySort' | 'isCollectionScan' | 'isSharded' | 'numShards' | 'indexType'> & {
+    usedIndexes: IndexInformation[];
+};
 export declare class ExplainPlan {
     namespace: string;
     parsedQuery: Stage;
@@ -28,7 +31,8 @@ export declare class ExplainPlan {
     executionStats?: ExecutionStats;
     winningPlan: Stage;
     constructor(originalExplainData: Stage);
-    get usedIndexes(): IndexInformation[];
+    private _getIndexEntries;
+    getUsedIndexes(): Promise<IndexInformation[]>;
     get isCovered(): boolean;
     get isMultiKey(): boolean;
     get inMemorySort(): boolean;
@@ -62,7 +66,7 @@ export declare class ExplainPlan {
     findAllStagesByName(name: string, root?: Stage): Stage[];
     /** DFS stack iterator implementation */
     _getStageIterator(root?: Stage): Iterable<Stage>;
-    serialize(): Pick<ExplainPlan, 'namespace' | 'parsedQuery' | 'executionSuccess' | 'nReturned' | 'executionTimeMillis' | 'totalKeysExamined' | 'totalDocsExamined' | 'originalExplainData' | 'executionStats' | 'usedIndexes' | 'isCovered' | 'isMultiKey' | 'inMemorySort' | 'isCollectionScan' | 'isSharded' | 'numShards' | 'indexType'>;
+    serialize(): Promise<SerializedExplainPlan>;
     /**
      * Returns child stage or stages of current stage as array. If there are
      * no more child stages, returns empty array []. Also works for sharded

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAG5D,QAAA,MAAM,OAAO,eAAgC,CAAC;AAE9C,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,CAAC,OAAO,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,GAAG,CACjE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,IAAI,CAAA;CAAE,GAC9B;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CACjC,CAAC;AAEF,qBAAa,WAAW;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,KAAK,CAAC;IACnB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,mBAAmB,EAAE,KAAK,CAAC;IAC3B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,WAAW,EAAE,KAAK,CAAC;gBAEP,mBAAmB,EAAE,KAAK;IAqBtC,IAAI,WAAW,IAAI,gBAAgB,EAAE,CAmCpC;IAED,IAAI,SAAS,IAAI,OAAO,CASvB;IAED,IAAI,UAAU,IAAI,OAAO,CAExB;IAED,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IAED,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED,IAAI,SAAS,IAAI,MAAM,CAItB;IAED,IAAI,eAAe,IAAI,OAAO,CAK7B;IAED,IAAI,SAAS,gFAkDZ;IAED;;;;;;;;;;OAUG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,IAAI;IASzD;;;;;;;;;OASG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,KAAK,GAAG,KAAK,EAAE;IAMxD,wCAAwC;IACvC,iBAAiB,CAAC,IAAI,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;IAcjD,SAAS,IAAI,IAAI,CACf,WAAW,EACT,WAAW,GACX,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,gBAAgB,GAChB,aAAa,GACb,WAAW,GACX,YAAY,GACZ,cAAc,GACd,kBAAkB,GAClB,WAAW,GACX,WAAW,GACX,WAAW,CACd;IAwBD;;;;;;;OAOG;IACH,MAAM,CAAE,cAAc,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;IA+BtD;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAQ1C;;;;OAIG;IACH,MAAM,CAAE,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;CAMvD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAG5D,QAAA,MAAM,OAAO,eAAgC,CAAC;AAE9C,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,CAAC,OAAO,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,GAAG,CACjE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,IAAI,CAAA;CAAE,GAC9B;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CACjC,CAAC;AAWF,MAAM,MAAM,qBAAqB,GAAG,IAAI,CACtC,WAAW,EACT,WAAW,GACX,aAAa,GACb,kBAAkB,GAClB,WAAW,GACX,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,gBAAgB,GAChB,WAAW,GACX,YAAY,GACZ,cAAc,GACd,kBAAkB,GAClB,WAAW,GACX,WAAW,GACX,WAAW,CACd,GAAG;IAAE,WAAW,EAAE,gBAAgB,EAAE,CAAA;CAAE,CAAC;AAExC,qBAAa,WAAW;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,KAAK,CAAC;IACnB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,mBAAmB,EAAE,KAAK,CAAC;IAC3B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,WAAW,EAAE,KAAK,CAAC;gBAEP,mBAAmB,EAAE,KAAK;IAqBtC,OAAO,CAAC,gBAAgB;IA4ClB,cAAc,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAenD,IAAI,SAAS,IAAI,OAAO,CASvB;IAED,IAAI,UAAU,IAAI,OAAO,CAExB;IAED,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IAED,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED,IAAI,SAAS,IAAI,MAAM,CAItB;IAED,IAAI,eAAe,IAAI,OAAO,CAK7B;IAED,IAAI,SAAS,gFAkDZ;IAED;;;;;;;;;;OAUG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,IAAI;IASzD;;;;;;;;;OASG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,KAAK,GAAG,KAAK,EAAE;IAMxD,wCAAwC;IACvC,iBAAiB,CAAC,IAAI,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;IAc3C,SAAS,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAyBjD;;;;;;;OAOG;IACH,MAAM,CAAE,cAAc,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;IA+BtD;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAQ1C;;;;OAIG;IACH,MAAM,CAAE,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;CAMvD"}

package/dist/index.js

@@ -39,13 +39,16 @@ class ExplainPlan {
         this.originalExplainData = originalExplainData;
         this.winningPlan = qpInfo.winningPlan;
     }
-    get usedIndexes() {
+    _getIndexEntries() {
         const ixscan = this.findAllStagesByName('IXSCAN');
         const expressIxscan = this.findAllStagesByName('EXPRESS_IXSCAN');
         const countScan = this.findAllStagesByName('COUNT_SCAN');
         // special case for IDHACK stage, using the _id_ index.
         const idhack = this.findStageByName('IDHACK');
-        const ret = this.executionStats?.stageIndexes ?? [];
+        const ret = (this.executionStats?.stageIndexes ?? []).map((indexInfo) => ({
+            ...indexInfo,
+            stage: null,
+        }));
         for (const stage of [...ixscan, ...expressIxscan, ...countScan, idhack]) {
             if (!stage)
                 continue;
@@ -58,18 +61,32 @@ class ExplainPlan {
                     }
                 }
             }
-            const index = stage === idhack ? '_id_' : stage.indexName;
-            const fields = stage === idhack ? { _id: 1 } : (0, utils_1.getStageIndexFields)(stage);
-            ret.push({ index, shard, fields });
+            ret.push(stage === idhack
+                ? { index: '_id_', shard, stage: null, fields: { _id: 1 } }
+                : { index: stage.indexName, shard, stage });
         }
         if (this.isSharded) {
             for (const shard of this.executionStats?.executionStages?.shards ?? []) {
-                if (!ret.some((indexInfo) => indexInfo.shard === shard.shardName)) {
-                    ret.push({ index: null, shard: shard.shardName, fields: {} });
+                if (!ret.some((entry) => entry.shard === shard.shardName)) {
+                    ret.push({ index: null, shard: shard.shardName, stage: null });
                 }
             }
         }
-        return ret.filter((indexInfo, index, arr) => arr.findIndex((i) => i.index === indexInfo.index && i.shard === indexInfo.shard) === index);
+        return ret.filter((entry, index, arr) => arr.findIndex((i) => i.index === entry.index && i.shard === entry.shard) === index);
+    }
+    async getUsedIndexes() {
+        const usedIndexes = [];
+        for (const entry of this._getIndexEntries()) {
+            const fields = entry.fields ??
+                (entry.stage ? await (0, utils_1.getStageIndexFields)(entry.stage) : {});
+            if (entry.index === null) {
+                usedIndexes.push({ index: null, shard: entry.shard, fields });
+            }
+            else {
+                usedIndexes.push({ index: entry.index, shard: entry.shard, fields });
+            }
+        }
+        return usedIndexes;
     }
     get isCovered() {
         // @todo (thomas) implement for sharded explain plans
@@ -103,7 +120,7 @@ class ExplainPlan {
             this.findStageByName('CLUSTERED_IXSCAN'));
     }
     get indexType() {
-        const indexes = this.usedIndexes;
+        const indexes = this._getIndexEntries();
         // Currently the CLUSTERED_IXSCAN and EXPRESS_CLUSTERED_IXSCAN do not report
         // any indexes in the winning stage. Even though the query clearly uses
         // an index. And since we can't determine the index used, we will return CLUSTER.
@@ -181,7 +198,8 @@ class ExplainPlan {
             yield* this._getStageIterator(child);
         }
     }
-    serialize() {
+    async serialize() {
+        const usedIndexes = await this.getUsedIndexes();
         return JSON.parse(JSON.stringify({
             namespace: this.namespace,
             parsedQuery: this.parsedQuery,
@@ -192,7 +210,7 @@ class ExplainPlan {
             totalDocsExamined: this.totalDocsExamined,
             originalExplainData: this.originalExplainData,
             executionStats: this.executionStats,
-            usedIndexes: this.usedIndexes,
+            usedIndexes,
             isCovered: this.isCovered,
             isMultiKey: this.isMultiKey,
             inMemorySort: this.inMemorySort,

package/dist/utils.d.ts

@@ -1,3 +1,3 @@
 import type { Stage } from '.';
-export declare function getStageIndexFields(stage: Stage): Record<string, string>;
+export declare function getStageIndexFields(stage: Stage): Promise<Record<string, string>>;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC;AAE/B,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAkBxE"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC;AAE/B,wBAAsB,mBAAmB,CACvC,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAkBjC"}

package/dist/utils.js

@@ -35,15 +35,15 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getStageIndexFields = getStageIndexFields;
 const shell_bson_parser_1 = __importStar(require("@mongodb-js/shell-bson-parser"));
-function getStageIndexFields(stage) {
+async function getStageIndexFields(stage) {
     if (stage.stage === 'EXPRESS_IXSCAN' &&
         typeof stage.keyPattern === 'string') {
         // For EXPRESS stages, the keyPattern is a string, which is not valid json.
+        // TODO(COMPASS-10806): This was fixed in 9.0. Currently it has not been
+        // backported, so we will keep this workaround for now.
         try {
-            const result = (0, shell_bson_parser_1.default)(stage.keyPattern, {
+            const result = await (0, shell_bson_parser_1.default)(stage.keyPattern, {
                 mode: shell_bson_parser_1.ParseMode.Strict,
-                allowComments: true,
-                allowMethods: true,
             });
             return typeof result === 'string' ? {} : result;
         }

package/package.json

@@ -13,7 +13,7 @@
     "email": "compass@mongodb.com"
   },
   "homepage": "https://github.com/mongodb-js/compass",
-  "version": "1.5.18",
+  "version": "1.6.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/mongodb-js/compass.git"
@@ -50,12 +50,12 @@
     "reformat": "npm run eslint . -- --fix && npm run prettier -- --write ."
   },
   "dependencies": {
-    "@mongodb-js/shell-bson-parser": "^1.6.3",
-    "mongodb-explain-compat": "^3.3.41"
+    "@mongodb-js/shell-bson-parser": "^2.0.0",
+    "mongodb-explain-compat": "^3.3.42"
   },
   "devDependencies": {
-    "@mongodb-js/eslint-config-compass": "^1.4.30",
-    "@mongodb-js/mocha-config-compass": "^1.8.2",
+    "@mongodb-js/eslint-config-compass": "^1.4.31",
+    "@mongodb-js/mocha-config-compass": "^1.9.0",
     "@mongodb-js/prettier-config-compass": "^1.2.10",
     "@mongodb-js/tsconfig-compass": "^1.3.2",
     "@types/chai": "^4.2.21",
@@ -68,5 +68,5 @@
     "sinon": "^9.2.3",
     "typescript": "^6.0.3"
   },
-  "gitHead": "ba44a9dbfe032bf5acb4b6daac0718fbc96892c0"
+  "gitHead": "ffed0669174748402f0d54164e9aaed0949eb888"
 }