WIP

Author: addaleax

package-lock.json

@@ -45,6 +45,7 @@ type CollectionMetadata = {
    * Aggregation pipeline view definition
    */
   sourcePipeline?: unknown[];
+  shardKey: unknown | null;
 };
 
 interface Collection {
@@ -60,6 +61,7 @@ interface Collection {
   command: boolean;
   special: boolean;
   specialish: boolean;
+  shardKey: unknown | null;
   normal: boolean;
   readonly: boolean;
   view_on: string;

packages/collection-model/index.d.ts

@@ -5,6 +5,7 @@ const PROPERTIES_CLUSTERED = 'clustered';
 const PROPERTIES_FLE2 = 'fle2';
 const PROPERTIES_VIEW = 'view';
 const PROPERTIES_READ_ONLY = 'read-only';
+const PROPERTIES_SHARDED = 'sharded';
 
 function getProperties(coll) {
   const properties = [];
@@ -52,6 +53,12 @@ function getProperties(coll) {
     });
   }
 
+  if (coll.shardKey) {
+    properties.push({
+      id: PROPERTIES_SHARDED,
+    });
+  }
+
   return properties;
 }
 

packages/collection-model/lib/collection-properties.js

@@ -100,8 +100,9 @@ function pickCollectionInfo({
   validation,
   clustered,
   fle2,
+  shardKey
 }) {
-  return { readonly, view_on, collation, pipeline, validation, clustered, fle2 };
+  return { readonly, view_on, collation, pipeline, validation, clustered, fle2, shardKey };
 }
 
 /**
@@ -128,6 +129,7 @@ const CollectionModel = AmpersandModel.extend(debounceActions(['fetch']), {
     view_on: 'string',
     collation: 'object',
     pipeline: 'array',
+    shardKey: 'object',
     validation: 'object',
 
     // Normalized values from collStats command
@@ -220,7 +222,7 @@ const CollectionModel = AmpersandModel.extend(debounceActions(['fetch']), {
       },
     },
     properties: {
-      deps: ['collation', 'type', 'capped', 'clustered', 'readonly', 'fle2'],
+      deps: ['collation', 'type', 'capped', 'clustered', 'readonly', 'fle2', 'shardKey'],
       fn() {
         return getProperties(this);
       },
@@ -289,6 +291,7 @@ const CollectionModel = AmpersandModel.extend(debounceActions(['fetch']), {
       isClustered: this.clustered,
       isFLE: this.fle2,
       isSearchIndexesSupported,
+      shardKey: this.shardKey
     };
     if (this.sourceId) {
       try {

packages/collection-model/lib/model.js

@@ -10,7 +10,8 @@ export type CollectionBadgeType =
   | 'timeseries'
   | 'view'
   | 'fle'
-  | 'clustered';
+  | 'clustered'
+  | 'sharded';
 
 const badges: Record<
   CollectionBadgeType,
@@ -48,6 +49,10 @@ const badges: Record<
   clustered: {
     label: 'CLUSTERED',
   },
+  sharded: {
+    label: 'SHARDED',
+    variant: BadgeVariant.LightGray,
+  },
 };
 
 export const CollectionBadge = ({ type }: { type: CollectionBadgeType }) => {

packages/compass-collection/src/components/collection-header/badges.tsx

@@ -109,6 +109,7 @@ type CollectionHeaderProps = {
   isClustered: boolean;
   isFLE: boolean;
   isAtlas: boolean;
+  shardKey: unknown | null;
   sourceName?: string;
   editViewName?: string;
   sourcePipeline?: unknown[];
@@ -218,6 +219,7 @@ class CollectionHeader extends Component<CollectionHeaderProps> {
           {this.props.isTimeSeries && <CollectionBadge type="timeseries" />}
           {this.props.isClustered && <CollectionBadge type="clustered" />}
           {this.props.isFLE && <CollectionBadge type="fle" />}
+          {this.props.shardKey && <CollectionBadge type="sharded" />}
           {this.props.isReadonly && this.props.sourceName && (
             <CollectionBadge type="view" />
           )}

packages/compass-collection/src/components/collection-header/collection-header.tsx

@@ -85,6 +85,7 @@ const initialMetadata: CollectionStateMetadata = {
   isAtlas: false,
   isDataLake: false,
   serverVersion: '0.0.0',
+  shardKey: null,
 };
 
 enum CollectionActions {

packages/compass-collection/src/modules/collection-tab.ts

@@ -22,6 +22,7 @@ const HELP_URLS = {
     'https://docs.mongodb.com/master/reference/bson-type-comparison-order/#collation',
   COLLATION_REF: 'https://docs.mongodb.com/master/reference/collation',
   HIDDEN: 'https://www.mongodb.com/docs/manual/core/index-hidden/',
+  SHARDKEY: 'https://www.mongodb.com/docs/manual/core/sharding-shard-key/',
   UNKNOWN: null,
 };
 

packages/compass-indexes/src/utils/index-link-helper.ts

@@ -0,0 +1,11 @@
+ignores:
+ - '@mongodb-js/prettier-config-compass'
+ - '@mongodb-js/tsconfig-compass'
+ - '@types/chai'
+ - '@types/sinon-chai'
+ - 'sinon'
+ - '@types/chai-dom'
+ - '@types/react'
+ - '@types/react-dom'
+ignore-patterns:
+ - 'dist'

packages/compass-topology/.depcheckrc

@@ -0,0 +1,2 @@
+.nyc-output
+dist