fix(query-bar): use hint in query COMPASS-9373 (#7581)

Anemy · web-flow · commit f713902cf00f · 2025-11-21T12:16:20.000-08:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/compass-aggregations/package.json b/packages/compass-aggregations/package.json
@@ -75,7 +75,7 @@
     "@mongodb-js/explain-plan-helper": "^1.4.24",
     "@mongodb-js/mongodb-constants": "^0.17.0",
     "@mongodb-js/my-queries-storage": "^0.50.1",
-    "@mongodb-js/shell-bson-parser": "^1.2.0",
+    "@mongodb-js/shell-bson-parser": "^1.3.3",
     "bson": "^6.10.4",
     "compass-preferences-model": "^2.66.2",
     "hadron-document": "^8.10.5",
@@ -87,7 +87,7 @@
     "mongodb-database-model": "^2.36.0",
     "mongodb-instance-model": "^12.58.2",
     "mongodb-ns": "^3.0.1",
-    "mongodb-query-parser": "^4.3.0",
+    "mongodb-query-parser": "^4.5.0",
     "mongodb-schema": "^12.6.3",
     "re-resizable": "^6.9.0",
     "react": "^17.0.2",
diff --git a/packages/compass-crud/package.json b/packages/compass-crud/package.json
@@ -85,7 +85,7 @@
     "@mongodb-js/explain-plan-helper": "^1.4.24",
     "@mongodb-js/my-queries-storage": "^0.50.1",
     "@mongodb-js/reflux-state-mixin": "^1.2.24",
-    "@mongodb-js/shell-bson-parser": "^1.2.0",
+    "@mongodb-js/shell-bson-parser": "^1.3.3",
     "ag-grid-community": "^20.2.0",
     "ag-grid-react": "^20.2.0",
     "bson": "^6.10.4",
@@ -97,7 +97,7 @@
     "mongodb": "^6.19.0",
     "mongodb-data-service": "^22.35.0",
     "mongodb-ns": "^3.0.1",
-    "mongodb-query-parser": "^4.3.0",
+    "mongodb-query-parser": "^4.5.0",
     "react": "^17.0.2",
     "reflux": "^0.4.1",
     "semver": "^7.6.3"
diff --git a/packages/compass-crud/src/stores/crud-store.spec.ts b/packages/compass-crud/src/stores/crud-store.spec.ts
@@ -2413,7 +2413,7 @@ describe('store', function () {
       );
     });
 
-    it('should keep user projection when provided', async function () {
+    it('should keep user fields when provided', async function () {
       await fetchDocuments(
         dataService,
         track,
@@ -2422,13 +2422,25 @@ describe('store', function () {
         'test.test',
         {},
         {
-          projection: { _id: 1 },
+          projection: { _id: 1, pineapple: 1 },
+          hint: 'pineapple',
+          limit: 10,
+          skip: 7,
+          sort: { pineapple: 1 },
         }
       );
       expect(find).to.have.been.calledOnce;
       expect(find.getCall(0))
         .to.have.nested.property('args.2.projection')
-        .deep.eq({ _id: 1 });
+        .deep.eq({ _id: 1, pineapple: 1 });
+      expect(find.getCall(0)).to.have.nested.property('args.2.limit').eq(10);
+      expect(find.getCall(0)).to.have.nested.property('args.2.skip').eq(7);
+      expect(find.getCall(0))
+        .to.have.nested.property('args.2.sort')
+        .deep.eq({ pineapple: 1 });
+      expect(find.getCall(0))
+        .to.have.nested.property('args.2.hint')
+        .eq('pineapple');
     });
 
     it('should retry find operation if failed with server error when applying custom projection', async function () {
diff --git a/packages/compass-crud/src/stores/crud-store.ts b/packages/compass-crud/src/stores/crud-store.ts
@@ -68,7 +68,7 @@ import type {
 } from '@mongodb-js/compass-connections/provider';
 import type { Query, QueryBarService } from '@mongodb-js/compass-query-bar';
 import type { TrackFunction } from '@mongodb-js/compass-telemetry';
-import type { MongoServerError } from 'mongodb';
+import type { CollationOptions, MongoServerError } from 'mongodb';
 
 export type BSONObject = TypeCastMap['Object'];
 export type BSONArray = TypeCastMap['Array'];
@@ -589,7 +589,7 @@ class CrudStoreImpl
     if (id !== undefined) {
       doc.onRemoveStart();
       try {
-        await this.dataService.deleteOne(this.state.ns, { _id: id } as any);
+        await this.dataService.deleteOne(this.state.ns, { _id: id as any });
         // emit on the document(list view) and success state(json view)
         doc.onRemoveSuccess();
         const payload = { view: this.state.view, ns: this.state.ns };
@@ -866,6 +866,7 @@ class CrudStoreImpl
       filter,
       limit,
       sort,
+      hint,
       project: projection,
       collation,
       maxTimeMS,
@@ -894,9 +895,10 @@ class CrudStoreImpl
     const opts = {
       skip,
       limit: nextPageCount,
-      sort,
-      projection,
-      collation,
+      hint: hint ?? undefined,
+      sort: sort ?? undefined,
+      projection: projection ?? undefined,
+      collation: collation as CollationOptions,
       maxTimeMS: capMaxTimeMSAtPreferenceLimit(this.preferences, maxTimeMS),
       promoteValues: false,
       bsonRegExp: true,
@@ -920,7 +922,7 @@ class CrudStoreImpl
         this.state.isDataLake,
         ns,
         filter ?? {},
-        opts as any,
+        opts,
         {
           abortSignal: signal,
         }
@@ -1649,9 +1651,14 @@ class CrudStoreImpl
           : query.maxTimeMS
       ),
       signal,
+      ...(query.hint
+        ? {
+            hint: query.hint,
+          }
+        : {}),
     };
 
-    if (this.isCountHintSafe(query)) {
+    if (!countOptions.hint && this.isCountHintSafe(query)) {
       countOptions.hint = '_id_';
     }
 
@@ -1671,11 +1678,12 @@ class CrudStoreImpl
     }
 
     const findOptions = {
-      sort,
-      projection: query.project,
+      sort: sort ?? undefined,
+      projection: query.project ?? undefined,
       skip: query.skip,
       limit: docsPerPage,
-      collation: query.collation,
+      collation: query.collation as CollationOptions,
+      hint: query.hint ?? undefined,
       maxTimeMS: capMaxTimeMSAtPreferenceLimit(
         this.preferences,
         query.maxTimeMS
@@ -1705,7 +1713,7 @@ class CrudStoreImpl
     // Only check if index was used if query filter or sort is not empty
     if (!isEmpty(query.filter) || !isEmpty(query.sort)) {
       void this.dataService
-        .explainFind(ns, query.filter ?? {}, findOptions as any, {
+        .explainFind(ns, query.filter ?? {}, findOptions, {
           explainVerbosity: 'queryPlanner',
           abortSignal: signal,
         })
@@ -1772,7 +1780,7 @@ class CrudStoreImpl
         this.state.isDataLake,
         ns,
         query.filter ?? {},
-        findOptions as any,
+        findOptions,
         {
           abortSignal: signal,
         }
diff --git a/packages/compass-editor/package.json b/packages/compass-editor/package.json
@@ -74,7 +74,7 @@
     "@lezer/highlight": "^1.2.1",
     "@mongodb-js/compass-components": "^1.59.1",
     "@mongodb-js/mongodb-constants": "^0.17.0",
-    "mongodb-query-parser": "^4.3.0",
+    "mongodb-query-parser": "^4.5.0",
     "polished": "^4.2.2",
     "prettier": "^2.7.1",
     "react": "^17.0.2"
diff --git a/packages/compass-export-to-language/package.json b/packages/compass-export-to-language/package.json
@@ -54,7 +54,7 @@
     "@mongodb-js/compass-editor": "^0.61.1",
     "@mongodb-js/compass-maybe-protect-connection-string": "^0.64.2",
     "@mongodb-js/compass-telemetry": "^1.19.4",
-    "@mongodb-js/shell-bson-parser": "^1.2.0",
+    "@mongodb-js/shell-bson-parser": "^1.3.3",
     "bson-transpilers": "^3.2.23",
     "compass-preferences-model": "^2.66.2",
     "@mongodb-js/compass-app-registry": "^9.4.28",
diff --git a/packages/compass-import-export/package.json b/packages/compass-import-export/package.json
@@ -67,7 +67,7 @@
     "mongodb": "^6.19.0",
     "mongodb-data-service": "^22.35.0",
     "mongodb-ns": "^3.0.1",
-    "mongodb-query-parser": "^4.3.0",
+    "mongodb-query-parser": "^4.5.0",
     "mongodb-schema": "^12.6.3",
     "papaparse": "^5.3.2",
     "react": "^17.0.2",
diff --git a/packages/compass-indexes/package.json b/packages/compass-indexes/package.json
@@ -76,7 +76,7 @@
     "@mongodb-js/compass-telemetry": "^1.19.4",
     "@mongodb-js/compass-workspaces": "^0.69.2",
     "@mongodb-js/mongodb-constants": "^0.17.0",
-    "@mongodb-js/shell-bson-parser": "^1.2.0",
+    "@mongodb-js/shell-bson-parser": "^1.3.3",
     "@mongodb-js/connection-info": "^0.23.0",
     "bson": "^6.10.4",
     "compass-preferences-model": "^2.66.2",
@@ -85,7 +85,7 @@
     "mongodb-collection-model": "^5.36.0",
     "mongodb-data-service": "^22.35.0",
     "mongodb-ns": "^3.0.1",
-    "mongodb-query-parser": "^4.3.0",
+    "mongodb-query-parser": "^4.5.0",
     "react": "^17.0.2",
     "react-redux": "^8.1.3",
     "redux": "^4.2.1",
diff --git a/packages/compass-query-bar/package.json b/packages/compass-query-bar/package.json
@@ -84,7 +84,7 @@
     "mongodb": "^6.19.0",
     "mongodb-instance-model": "^12.58.2",
     "mongodb-ns": "^3.0.1",
-    "mongodb-query-parser": "^4.3.0",
+    "mongodb-query-parser": "^4.5.0",
     "mongodb-query-util": "^2.5.12",
     "mongodb-schema": "^12.6.3",
     "react": "^17.0.2",
diff --git a/packages/compass-query-bar/src/constants/query-bar-store.ts b/packages/compass-query-bar/src/constants/query-bar-store.ts
@@ -6,6 +6,7 @@ import {
   DEFAULT_PROJECT,
   DEFAULT_COLLATION,
   DEFAULT_MAX_TIME_MS,
+  DEFAULT_HINT,
 } from 'mongodb-query-parser';
 
 /**
@@ -30,7 +31,7 @@ const DEFAULT_QUERY_VALUES = {
   project: DEFAULT_PROJECT,
   collation: DEFAULT_COLLATION,
   sort: DEFAULT_SORT,
-  hint: null,
+  hint: DEFAULT_HINT,
   skip: DEFAULT_SKIP,
   limit: DEFAULT_LIMIT,
   maxTimeMS: DEFAULT_MAX_TIME_MS,
diff --git a/packages/compass-query-bar/src/constants/query-option-definition.ts b/packages/compass-query-bar/src/constants/query-option-definition.ts
@@ -41,7 +41,7 @@ export const OPTION_DEFINITION: {
     name: 'hint',
     label: 'Index Hint',
     type: 'document',
-    placeholder: '{ field: -1 }',
+    placeholder: '{ field: -1 } or "indexName"',
     link: 'https://docs.mongodb.com/manual/reference/method/cursor.hint/',
   },
   collation: {
diff --git a/packages/compass-query-bar/src/constants/query-properties.ts b/packages/compass-query-bar/src/constants/query-properties.ts
@@ -27,7 +27,7 @@ export type QueryFormFields = {
   project: FormField<Document | null>;
   collation: FormField<Document | null>;
   sort: FormField<Document | null>;
-  hint: FormField<Document | null>;
+  hint: FormField<Document | string | null>;
   skip: FormField<number>;
   limit: FormField<number>;
   maxTimeMS: FormField<number>;
diff --git a/packages/compass-query-bar/src/stores/query-bar-reducer.spec.ts b/packages/compass-query-bar/src/stores/query-bar-reducer.spec.ts
@@ -71,6 +71,12 @@ describe('queryBarReducer', function () {
 
       ['maxTimeMS', '1', 1, true],
       ['maxTimeMS', '-1', DEFAULT_QUERY_VALUES['maxTimeMS'], false],
+
+      ['hint', '"hintPineappleIndex"', 'hintPineappleIndex', true],
+      ['hint', '{ pineapple: 1 }', { pineapple: 1 }, true],
+      ['hint', 'pineapple', DEFAULT_QUERY_VALUES['hint'], false],
+      ['hint', '1', DEFAULT_QUERY_VALUES['hint'], false],
+      ['hint', '-1', DEFAULT_QUERY_VALUES['hint'], false],
     ];
 
     specs.forEach(([field, str, expectedValue, expectedValid]) => {
diff --git a/packages/compass-query-bar/src/stores/query-bar-reducer.ts b/packages/compass-query-bar/src/stores/query-bar-reducer.ts
@@ -228,7 +228,7 @@ export const applyFromHistory = (
   return (dispatch, getState, { localAppRegistry, preferences }) => {
     const currentFields = getState().queryBar.fields;
     const currentQuery = currentQueryFieldsToRetain.reduce<
-      Record<string, Document | number>
+      Record<string, Document | number | string>
     >((acc, key) => {
       const { value } = currentFields[key];
       if (value) {
diff --git a/packages/compass-query-bar/src/utils/query.ts b/packages/compass-query-bar/src/utils/query.ts
@@ -131,7 +131,7 @@ export function validateField(
   }: Pick<UserPreferences, 'maxTimeMS' | 'maxTimeMSEnvLimit'>
 ) {
   const validated = validate(field, value);
-  if (field === 'filter' && validated === '') {
+  if ((field === 'filter' || field === 'hint') && validated === '') {
     // TODO(COMPASS-5205): Things like { i: $} confuses queryParser and
     // ultimately it sets filter to '' whereas it has to be a {} (if valid) or
     // false (if invalid). Should probably be fixed in mongodb-query-parser,
@@ -163,12 +163,6 @@ export function validateField(
     }
   }
 
-  // We don't have a validator for indexes, but indexes share the same structure as
-  // a sort document, so we're leveraging this to validate the hint field
-  if (field === 'hint') {
-    return validate('sort', value);
-  }
-
   return validated;
 }
 
diff --git a/packages/compass-schema-validation/package.json b/packages/compass-schema-validation/package.json
@@ -85,7 +85,7 @@
     "lodash": "^4.17.21",
     "mongodb": "^6.19.0",
     "mongodb-ns": "^3.0.1",
-    "mongodb-query-parser": "^4.3.0",
+    "mongodb-query-parser": "^4.5.0",
     "react": "^17.0.2",
     "react-redux": "^8.1.3",
     "redux": "^4.2.1",
diff --git a/packages/compass-schema/src/stores/schema-analysis-reducer.ts b/packages/compass-schema/src/stores/schema-analysis-reducer.ts
@@ -314,6 +314,7 @@ export const startAnalysis = (): SchemaThunkAction<
 
     const driverOptions: AggregateOptions = {
       maxTimeMS: capMaxTimeMSAtPreferenceLimit(preferences, query.maxTimeMS),
+      hint: query.hint ?? undefined,
     };
 
     analysisAbortControllerRef.current = new AbortController();
diff --git a/packages/connection-form/package.json b/packages/connection-form/package.json
@@ -51,13 +51,13 @@
     "@mongodb-js/compass-components": "^1.59.1",
     "@mongodb-js/compass-editor": "^0.61.1",
     "@mongodb-js/connection-info": "^0.23.0",
-    "@mongodb-js/shell-bson-parser": "^1.2.0",
+    "@mongodb-js/shell-bson-parser": "^1.3.3",
     "lodash": "^4.17.21",
     "mongodb": "^6.19.0",
     "mongodb-build-info": "^1.8.1",
     "mongodb-connection-string-url": "^3.0.1",
     "mongodb-data-service": "^22.35.0",
-    "mongodb-query-parser": "^4.3.0",
+    "mongodb-query-parser": "^4.5.0",
     "react": "^17.0.2"
   },
   "devDependencies": {
diff --git a/packages/databases-collections/package.json b/packages/databases-collections/package.json
@@ -74,7 +74,7 @@
     "mongodb-database-model": "^2.36.0",
     "mongodb-instance-model": "^12.58.2",
     "mongodb-ns": "^3.0.1",
-    "mongodb-query-parser": "^4.3.0",
+    "mongodb-query-parser": "^4.5.0",
     "prop-types": "^15.7.2",
     "react": "^17.0.2",
     "react-redux": "^8.1.3",
diff --git a/packages/explain-plan-helper/package.json b/packages/explain-plan-helper/package.json
@@ -50,7 +50,7 @@
     "reformat": "npm run eslint . -- --fix && npm run prettier -- --write ."
   },
   "dependencies": {
-    "@mongodb-js/shell-bson-parser": "^1.2.0",
+    "@mongodb-js/shell-bson-parser": "^1.3.3",
     "mongodb-explain-compat": "^3.3.23"
   },
   "devDependencies": {
