hack hack hack

Author: lerouxb

packages/collection-model/index.d.ts

@@ -1,4 +1,4 @@
-import type { DataService } from 'mongodb-data-service';
+import type { DataService, CollStatsIndexDetails } from 'mongodb-data-service';
 
 type CollectionMetadata = {
   /**
@@ -76,6 +76,7 @@ interface CollectionProps {
   free_storage_size: number;
   index_count: number;
   index_size: number;
+  index_details: CollStatsIndexDetails
   isTimeSeries: boolean;
   isView: boolean;
   sourceName: string | null;

packages/collection-model/lib/model.js

@@ -141,6 +141,7 @@ const CollectionModel = AmpersandModel.extend(debounceActions(['fetch']), {
     free_storage_size: 'number',
     index_count: 'number',
     index_size: 'number',
+    index_details: 'object'
   },
   derived: {
     ns: {

packages/compass-crud/src/components/crud-toolbar.tsx

@@ -1,5 +1,6 @@
 import React, { useCallback, useMemo } from 'react';
 import { useTelemetry } from '@mongodb-js/compass-telemetry/provider';
+import type { Sort } from 'mongodb';
 import {
   Body,
   DropdownMenuButton,
@@ -120,6 +121,7 @@ export type CrudToolbarProps = {
   querySkip?: number;
   docsPerPage: number;
   updateMaxDocumentsPerPage: (docsPerPage: number) => void;
+  defaultSort: Sort;
 };
 
 const CrudToolbar: React.FunctionComponent<CrudToolbarProps> = ({
@@ -150,6 +152,7 @@ const CrudToolbar: React.FunctionComponent<CrudToolbarProps> = ({
   querySkip,
   docsPerPage,
   updateMaxDocumentsPerPage,
+  defaultSort,
 }) => {
   const track = useTelemetry();
   const connectionInfoRef = useConnectionInfoRef();
@@ -192,6 +195,7 @@ const CrudToolbar: React.FunctionComponent<CrudToolbarProps> = ({
           onReset={onResetClicked}
           showExplainButton={enableExplainPlan}
           insights={insights}
+          defaultSort={defaultSort}
         />
       </div>
       <div className={crudBarStyles}>

packages/compass-crud/src/components/document-list.tsx

@@ -137,6 +137,7 @@ export type DocumentListProps = {
     | 'resultId'
     | 'docsPerPage'
     | 'updateMaxDocumentsPerPage'
+    | 'defaultSort'
   >;
 
 const DocumentViewComponent: React.FunctionComponent<
@@ -318,6 +319,7 @@ const DocumentList: React.FunctionComponent<DocumentListProps> = (props) => {
     runBulkUpdate,
     docsPerPage,
     updateMaxDocumentsPerPage,
+    defaultSort,
   } = props;
 
   const onOpenInsert = useCallback(
@@ -552,6 +554,7 @@ const DocumentList: React.FunctionComponent<DocumentListProps> = (props) => {
             )}
             docsPerPage={docsPerPage}
             updateMaxDocumentsPerPage={handleMaxDocsPerPageChanged}
+            defaultSort={defaultSort}
           />
         }
       >

packages/compass-crud/src/stores/crud-store.ts

@@ -113,17 +113,9 @@ const INITIAL_BULK_UPDATE_TEXT = `{
 type FetchDocumentsOptions = {
   serverVersion: string;
   isDataLake: boolean;
-  isTimeSeries: boolean;
+  defaultSort: Sort;
 };
 
-function getDefaultSortOrder(isTimeSeries: boolean): Sort {
-  if (isTimeSeries) {
-    return { $natural: 1 };
-  }
-
-  return { _id: -1 };
-}
-
 export const fetchDocuments: (
   dataService: DataService,
   fetchDocumentsOptions: FetchDocumentsOptions,
@@ -136,7 +128,7 @@ export const fetchDocuments: (
   options,
   executionOptions
 ) => {
-  const { isTimeSeries, isDataLake, serverVersion } = fetchDocumentsOptions;
+  const { isDataLake, serverVersion, defaultSort } = fetchDocumentsOptions;
 
   const canCalculateDocSize =
     // $bsonSize is only supported for mongodb >= 4.4.0
@@ -153,7 +145,7 @@ export const fetchDocuments: (
 
   const modifiedOptions = {
     ...options,
-    sort: options?.sort ? options.sort : getDefaultSortOrder(isTimeSeries),
+    sort: options?.sort ? options.sort : defaultSort,
     projection: canCalculateDocSize
       ? { _id: 0, __doc: '$$ROOT', __size: { $bsonSize: '$$ROOT' } }
       : options?.projection,
@@ -190,7 +182,11 @@ export const fetchDocuments: (
 
 type CollectionStats = Pick<
   Collection,
-  'document_count' | 'storage_size' | 'free_storage_size' | 'avg_document_size'
+  | 'document_count'
+  | 'storage_size'
+  | 'free_storage_size'
+  | 'avg_document_size'
+  | 'index_details'
 >;
 const extractCollectionStats = (collection: Collection): CollectionStats => {
   const coll = collection.toJSON();
@@ -199,9 +195,18 @@ const extractCollectionStats = (collection: Collection): CollectionStats => {
     storage_size: coll.storage_size,
     free_storage_size: coll.free_storage_size,
     avg_document_size: coll.avg_document_size,
+    index_details: coll.index_details,
   };
 };
 
+function getDefaultSort(collectionStats: CollectionStats): Sort {
+  if (collectionStats?.index_details._id_) {
+    return { _id: -1 };
+  }
+
+  return { $natural: -1 };
+}
+
 /**
  * Default number of docs per page.
  */
@@ -350,6 +355,7 @@ type CrudState = {
   bulkDelete: BulkDeleteState;
   docsPerPage: number;
   collectionStats: CollectionStats | null;
+  defaultSort: Sort;
 };
 
 type CrudStoreActionsOptions = {
@@ -424,6 +430,8 @@ class CrudStoreImpl
     const isDataLake = !!this.instance.dataLake.isDataLake;
     const isReadonly = !!this.options.isReadonly;
 
+    const collectionStats = extractCollectionStats(this.collection);
+
     return {
       ns: this.options.namespace,
       collection: toNS(this.options.namespace).collection,
@@ -455,7 +463,8 @@ class CrudStoreImpl
       isUpdatePreviewSupported:
         this.instance.topologyDescription.type !== 'Single',
       docsPerPage: this.getInitialDocsPerPage(),
-      collectionStats: extractCollectionStats(this.collection),
+      collectionStats,
+      defaultSort: getDefaultSort(collectionStats),
     };
   }
 
@@ -903,7 +912,7 @@ class CrudStoreImpl
         {
           serverVersion: this.state.version,
           isDataLake: this.state.isDataLake,
-          isTimeSeries: this.state.isTimeSeries,
+          defaultSort: this.state.defaultSort,
         },
         ns,
         filter ?? {},
@@ -1558,8 +1567,10 @@ class CrudStoreImpl
   }
 
   collectionStatsFetched(model: Collection) {
+    const collectionStats = extractCollectionStats(model);
     this.setState({
-      collectionStats: extractCollectionStats(model),
+      collectionStats,
+      defaultSort: getDefaultSort(collectionStats),
     });
   }
 
@@ -1734,7 +1745,7 @@ class CrudStoreImpl
         {
           serverVersion: this.state.version,
           isDataLake: this.state.isDataLake,
-          isTimeSeries: this.state.isTimeSeries,
+          defaultSort: this.state.defaultSort,
         },
         ns,
         query.filter ?? {},

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

@@ -1,4 +1,6 @@
 import React from 'react';
+import type { Sort } from 'mongodb';
+import { toJSString } from 'mongodb-query-parser';
 import { css, spacing } from '@mongodb-js/compass-components';
 import type {
   QueryOption,
@@ -20,14 +22,23 @@ type QueryBarRowProps = {
   onApply?(): void;
   placeholders?: Record<QueryProperty, string>;
   disabled?: boolean;
+  defaultSort: Sort;
 };
 
 export const QueryBarRow: React.FunctionComponent<QueryBarRowProps> = ({
   queryOptionsLayout,
   onApply,
   placeholders,
   disabled,
+  defaultSort,
 }) => {
+  const getPlaceholder = (name: QueryOption): string | undefined => {
+    if (name === 'sort') {
+      return toJSString(defaultSort)?.replace(/\s+/gm, ' ');
+    }
+    return placeholders?.[name];
+  };
+
   return (
     <div className={rowStyles}>
       {typeof queryOptionsLayout === 'string' ? (
@@ -36,7 +47,7 @@ export const QueryBarRow: React.FunctionComponent<QueryBarRowProps> = ({
           name={queryOptionsLayout}
           id={`query-bar-option-input-${queryOptionsLayout}`}
           onApply={onApply}
-          placeholder={placeholders?.[queryOptionsLayout]}
+          placeholder={getPlaceholder(queryOptionsLayout)}
           disabled={disabled}
         />
       ) : (
@@ -46,7 +57,7 @@ export const QueryBarRow: React.FunctionComponent<QueryBarRowProps> = ({
             name={optionName}
             id={`query-bar-option-input-${optionName}`}
             onApply={onApply}
-            placeholder={placeholders?.[optionName]}
+            placeholder={getPlaceholder(optionName)}
             disabled={disabled}
           />
         ))

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

@@ -1,4 +1,5 @@
 import React, { useCallback, useMemo } from 'react';
+import type { Sort } from 'mongodb';
 import {
   Button,
   Icon,
@@ -129,6 +130,7 @@ type QueryBarProps = {
   isAIFetching?: boolean;
   onShowAIInputClick: () => void;
   onHideAIInputClick: () => void;
+  defaultSort: Sort;
 };
 
 export const QueryBar: React.FunctionComponent<QueryBarProps> = ({
@@ -158,6 +160,7 @@ export const QueryBar: React.FunctionComponent<QueryBarProps> = ({
   isAIFetching = false,
   onShowAIInputClick,
   onHideAIInputClick,
+  defaultSort,
 }) => {
   const darkMode = useDarkMode();
   const isAIFeatureEnabled = useIsAIFeatureEnabled();
@@ -311,6 +314,7 @@ export const QueryBar: React.FunctionComponent<QueryBarProps> = ({
                 onApply={onApply}
                 disabled={isAIFetching}
                 placeholders={placeholders}
+                defaultSort={defaultSort}
               />
             ))}
           </div>

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

@@ -30,7 +30,7 @@ export const OPTION_DEFINITION: {
   sort: {
     name: 'sort',
     type: 'document',
-    placeholder: '{ $_id: -1}',
+    placeholder: '{ _id: -1 } or { $natural: 1 }',
     link: 'https://docs.mongodb.com/manual/reference/method/cursor.sort/',
   },
   hint: {

packages/data-service/src/data-service.ts

@@ -1108,6 +1108,7 @@ class DataServiceImpl extends WithLogContext implements DataService {
                   ],
                 },
               },
+              indexDetails: { $first: '$storageStats.indexDetails' },
               nindexes: { $max: '$storageStats.nindexes' },
             },
           },
@@ -2581,6 +2582,7 @@ class DataServiceImpl extends WithLogContext implements DataService {
       storage_size: data.storageSize ?? 0,
       free_storage_size: data.freeStorageSize ?? 0,
       index_count: data.nindexes ?? 0,
+      index_details: data.indexDetails ?? {},
       index_size: data.totalIndexSize ?? 0,
     };
   }

packages/data-service/src/types.ts

@@ -9,6 +9,7 @@ export interface CollectionStats {
   storage_size: number;
   free_storage_size: number;
   index_count: number;
+  index_details: CollStatsIndexDetails;
   index_size: number;
 }