feat(query-bar): allow to specify index hints COMPASS-7829 (#5666)

Author: luca-nardelli

packages/compass-query-bar/src/components/query-bar.spec.tsx

@@ -122,7 +122,7 @@ describe('QueryBar Component', function () {
 
     it('renders the expanded inputs', function () {
       const queryInputs = screen.getAllByRole('textbox');
-      expect(queryInputs.length).to.equal(7);
+      expect(queryInputs.length).to.equal(8);
     });
   });
 

packages/compass-query-bar/src/components/query-bar.tsx

@@ -140,6 +140,7 @@ export const QueryBar: React.FunctionComponent<QueryBarProps> = ({
     'project',
     ['sort', 'maxTimeMS'],
     ['collation', 'skip', 'limit'],
+    'hint',
   ],
   queryChanged,
   resultId,

packages/compass-query-bar/src/components/query-option.tsx

@@ -175,7 +175,7 @@ const QueryOption: React.FunctionComponent<QueryOptionProps> = ({
                 : queryOptionLabelStyles
             }
           >
-            {name}
+            {optionDefinition.label ?? name}
           </Label>
         </div>
       )}

packages/compass-query-bar/src/constants/query-bar-store.ts

@@ -16,6 +16,7 @@ const DEFAULT_FIELD_VALUES = {
   project: undefined,
   collation: undefined,
   sort: undefined,
+  hint: undefined,
   skip: undefined,
   limit: undefined,
   maxTimeMS: undefined,
@@ -29,6 +30,7 @@ const DEFAULT_QUERY_VALUES = {
   project: DEFAULT_PROJECT,
   collation: DEFAULT_COLLATION,
   sort: DEFAULT_SORT,
+  hint: null,
   skip: DEFAULT_SKIP,
   limit: DEFAULT_LIMIT,
   maxTimeMS: DEFAULT_MAX_TIME_MS,

packages/compass-query-bar/src/constants/query-option-definition.ts

@@ -33,6 +33,13 @@ export const OPTION_DEFINITION: {
     placeholder: "{ field: -1 } or [['field', -1]]",
     link: 'https://docs.mongodb.com/manual/reference/method/cursor.sort/',
   },
+  hint: {
+    name: 'hint',
+    label: 'Index Hint',
+    type: 'document',
+    placeholder: '{ field: -1 }',
+    link: 'https://docs.mongodb.com/manual/reference/method/cursor.hint/',
+  },
   collation: {
     name: 'collation',
     type: 'document',

packages/compass-query-bar/src/constants/query-properties.ts

@@ -6,6 +6,7 @@ export const QUERY_PROPERTIES = [
   'project',
   'collation',
   'sort',
+  'hint',
   'skip',
   'limit',
   'maxTimeMS',
@@ -26,6 +27,7 @@ export type QueryFormFields = {
   project: FormField<Document>;
   collation: FormField<Document>;
   sort: FormField<Document>;
+  hint: FormField<Document>;
   skip: FormField<number>;
   limit: FormField<number>;
   maxTimeMS: FormField<number>;

packages/compass-query-bar/src/stores/query-bar-reducer.spec.ts

@@ -270,6 +270,7 @@ describe('queryBarReducer', function () {
             filter: { _id: { $exists: true } },
             collation: null,
             sort: null,
+            hint: null,
             skip: 0,
             limit: 10,
             maxTimeMS: 60000,

packages/compass-query-bar/src/utils/query.ts

@@ -149,6 +149,12 @@ 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;
 }