fix(indexes): add namespace to the URL params for Atlas Search link COMPASS-8917 (#6707)

gribnoysup · web-flow · commit f0c11ed8cbf2 · 2025-02-11T16:57:03.000+01:00
* fix(indexes): add namespace to the URL params for Atlas Search link

* chore(indexes): remove unused dep
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/compass-indexes/package.json b/packages/compass-indexes/package.json
@@ -76,7 +76,6 @@
     "@mongodb-js/compass-logging": "^1.6.0",
     "@mongodb-js/compass-telemetry": "^1.4.0",
     "@mongodb-js/compass-workspaces": "^0.31.0",
-    "@mongodb-js/connection-storage": "^0.26.0",
     "@mongodb-js/mongodb-constants": "^0.10.0",
     "@mongodb-js/shell-bson-parser": "^1.2.0",
     "bson": "^6.10.1",
diff --git a/packages/compass-indexes/src/components/indexes/indexes.tsx b/packages/compass-indexes/src/components/indexes/indexes.tsx
@@ -48,14 +48,24 @@ const containerStyles = css({
 });
 
 const linkTitle = 'Atlas Search.';
-const AtlasIndexesBanner = () => {
+
+const AtlasIndexesBanner = ({ namespace }: { namespace: string }) => {
   const { atlasMetadata } = useConnectionInfo();
+  if (!atlasMetadata) {
+    return null;
+  }
   return (
     <Banner variant="info">
       <Body weight="medium">Looking for search indexes?</Body>
       These indexes can be created and viewed under{' '}
       {atlasMetadata ? (
-        <Link href={getAtlasSearchIndexesLink(atlasMetadata)} hideExternalIcon>
+        <Link
+          href={getAtlasSearchIndexesLink({
+            clusterName: atlasMetadata.clusterName,
+            namespace,
+          })}
+          hideExternalIcon
+        >
           {linkTitle}
         </Link>
       ) : (
@@ -66,6 +76,7 @@ const AtlasIndexesBanner = () => {
 };
 
 type IndexesProps = {
+  namespace: string;
   isReadonlyView?: boolean;
   regularIndexes: Pick<RegularIndexesState, 'indexes' | 'error' | 'status'>;
   searchIndexes: Pick<SearchIndexesState, 'indexes' | 'error' | 'status'>;
@@ -88,6 +99,7 @@ const indexesContainersStyles = css({
 });
 
 export function Indexes({
+  namespace,
   isReadonlyView,
   regularIndexes,
   searchIndexes,
@@ -130,7 +142,7 @@ export function Indexes({
       >
         <div className={indexesContainersStyles}>
           {!isReadonlyView && !enableAtlasSearchIndexes && (
-            <AtlasIndexesBanner />
+            <AtlasIndexesBanner namespace={namespace} />
           )}
           {!isReadonlyView && currentIndexesView === 'regular-indexes' && (
             <RegularIndexesTable />
@@ -148,11 +160,13 @@ export function Indexes({
 }
 
 const mapState = ({
+  namespace,
   isReadonlyView,
   regularIndexes,
   searchIndexes,
   indexView,
 }: RootState) => ({
+  namespace,
   isReadonlyView,
   regularIndexes,
   searchIndexes,
diff --git a/packages/compass-indexes/src/utils/atlas-search-indexes-link.spec.ts b/packages/compass-indexes/src/utils/atlas-search-indexes-link.spec.ts
@@ -3,17 +3,19 @@ import { getAtlasSearchIndexesLink } from './atlas-search-indexes-link';
 
 describe('getAtlasSearchIndexesLink', function () {
   it('returns the correct link with clusterName', function () {
-    expect(getAtlasSearchIndexesLink({ clusterName: 'abc' })).to.equal(
-      '#/clusters/atlasSearch/abc'
-    );
-    expect(getAtlasSearchIndexesLink({ clusterName: '' })).to.equal(
-      '#/clusters/atlasSearch/'
-    );
+    expect(
+      getAtlasSearchIndexesLink({ clusterName: 'abc', namespace: 'foo.bar' })
+    ).to.equal('#/clusters/atlasSearch/abc?database=foo&collectionName=bar');
   });
 
   it('encodes the clusterName', function () {
-    expect(getAtlasSearchIndexesLink({ clusterName: 'a b c' })).to.equal(
-      '#/clusters/atlasSearch/a%20b%20c'
+    expect(
+      getAtlasSearchIndexesLink({
+        clusterName: 'a b c',
+        namespace: 'b u z.a@b@c',
+      })
+    ).to.equal(
+      '#/clusters/atlasSearch/a%20b%20c?database=b%20u%20z&collectionName=a%40b%40c'
     );
   });
 });
diff --git a/packages/compass-indexes/src/utils/atlas-search-indexes-link.ts b/packages/compass-indexes/src/utils/atlas-search-indexes-link.ts
@@ -1,7 +1,24 @@
-import type { AtlasClusterMetadata } from '@mongodb-js/connection-storage/renderer';
+import toNS from 'mongodb-ns';
 
+/**
+ * List to Atlas search indexes page. Supports certain query params that can be
+ * part of hash url: https://github.com/10gen/mms/blob/ba8025a4be58591cea0299ab500d2cf06e187f95/client/packages/project/nds/clusters/components/AtlasSearch/routeUtil.ts#L20-L30
+ */
 export function getAtlasSearchIndexesLink({
   clusterName,
-}: Pick<AtlasClusterMetadata, 'clusterName'>) {
-  return `#/clusters/atlasSearch/${encodeURIComponent(clusterName)}`;
+  namespace,
+}: {
+  clusterName: string;
+  namespace: string;
+}) {
+  const { database, collection } = toNS(namespace);
+  // Atlas Search URL params are parsed from hash, they are not real search
+  // params on a URL, appended at the end of hash part
+  let url = `#/clusters/atlasSearch/${encodeURIComponent(clusterName)}`;
+  if (database && collection) {
+    url +=
+      `?database=${encodeURIComponent(database)}` +
+      `&collectionName=${encodeURIComponent(collection)}`;
+  }
+  return url;
 }
