Skip to content

feat(indexes): add Atlas search indexes link when banner dismissed COMPASS-9158 #6880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 29, 2025
Merged

feat(indexes): add Atlas search indexes link when banner dismissed COMPASS-9158 #6880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
877e8bb
update banner
syn-zhu Apr 23, 2025
024f26a
add dismissed
syn-zhu Apr 23, 2025
5a430a8
Update banner
syn-zhu Apr 28, 2025
e9cce2e
fix test
syn-zhu Apr 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/compass-indexes/src/components/indexes-toolbar/indexes-toolbar.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ describe('IndexesToolbar Component', function () {
onIndexViewChanged={() => {}}
onCreateRegularIndexClick={() => {}}
onCreateSearchIndexClick={() => {}}
namespace=""
showAtlasSearchLink={false}
Copy link
Member

@Anemy Anemy Apr 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a unit test to make sure it's the right url?

Copy link
Collaborator Author

@syn-zhu syn-zhu Apr 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's already somewhat covered by https://github.com/mongodb-js/compass/blob/main/packages/compass-indexes/src/utils/atlas-search-indexes-link.spec.ts?

{...props}
/>
</PreferencesProvider>
Expand Down
22 changes: 22 additions & 0 deletions packages/compass-indexes/src/components/indexes-toolbar/indexes-toolbar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
ErrorSummary,
Tooltip,
WarningSummary,
Link,
css,
spacing,
Icon,
Expand All @@ -19,9 +20,11 @@ import {
SegmentedControl,
SegmentedControlOption,
} from '@mongodb-js/compass-components';
import { useConnectionInfo } from '@mongodb-js/compass-connections/provider';

import type { RootState } from '../../modules';
import { createSearchIndexOpened } from '../../modules/search-indexes';
import { getAtlasSearchIndexesLink } from '../../utils/atlas-search-indexes-link';
import { createIndexOpened } from '../../modules/create-index';
import type { IndexView } from '../../modules/index-view';
import { indexViewChanged } from '../../modules/index-view';
Expand All @@ -46,9 +49,11 @@ const createIndexButtonContainerStyles = css({
});

type IndexesToolbarProps = {
namespace: string;
indexView: IndexView;
errorMessage: string | null;
hasTooManyIndexes: boolean;
showAtlasSearchLink: boolean;
isRefreshing: boolean;
onRefreshIndexes: () => void;
onIndexViewChanged: (newView: IndexView) => void;
Expand All @@ -64,6 +69,7 @@ type IndexesToolbarProps = {
};

export const IndexesToolbar: React.FunctionComponent<IndexesToolbarProps> = ({
namespace,
indexView,
errorMessage,
isReadonlyView,
Expand All @@ -73,12 +79,14 @@ export const IndexesToolbar: React.FunctionComponent<IndexesToolbarProps> = ({
isRefreshing,
writeStateDescription,
hasTooManyIndexes,
showAtlasSearchLink,
isSearchIndexesSupported,
onRefreshIndexes,
onIndexViewChanged,
readOnly, // preferences readOnly.
}) => {
const isSearchManagementActive = usePreference('enableAtlasSearchIndexes');
const { atlasMetadata } = useConnectionInfo();
const showInsights = usePreference('showInsights') && !errorMessage;
const showCreateIndexButton = !isReadonlyView && !readOnly && !errorMessage;
const refreshButtonIcon = isRefreshing ? (
Expand Down Expand Up @@ -124,6 +132,18 @@ export const IndexesToolbar: React.FunctionComponent<IndexesToolbarProps> = ({
>
Refresh
</Button>
{showAtlasSearchLink && atlasMetadata && (
<Link
href={getAtlasSearchIndexesLink({
clusterName: atlasMetadata.clusterName,
namespace,
})}
hideExternalIcon
arrowAppearance="persist"
>
Manage your search indexes
</Link>
)}
{showInsights && hasTooManyIndexes && (
<SignalPopover
signals={PerformanceSignals.get('too-many-indexes')}
Expand Down Expand Up @@ -263,6 +283,7 @@ export const CreateIndexButton: React.FunctionComponent<
};

const mapState = ({
namespace,
isWritable,
isReadonlyView,
isSearchIndexesSupported,
Expand All @@ -271,6 +292,7 @@ const mapState = ({
searchIndexes,
indexView,
}: RootState) => ({
namespace,
isWritable,
isReadonlyView,
isSearchIndexesSupported,
Expand Down
36 changes: 28 additions & 8 deletions packages/compass-indexes/src/components/indexes/indexes.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,24 +48,28 @@ const containerStyles = css({
flexGrow: 1,
});

const linkTitle = 'Atlas Search.';
const linkTitle = 'Search and Vector Search.';

const DISMISSED_SEARCH_INDEXES_BANNER_LOCAL_STORAGE_KEY =
'mongodb_compass_dismissedSearchIndexesBanner' as const;

const AtlasIndexesBanner = ({ namespace }: { namespace: string }) => {
const AtlasIndexesBanner = ({
namespace,
dismissed,
onDismissClick,
}: {
namespace: string;
dismissed: boolean;
onDismissClick: () => void;
}) => {
const { atlasMetadata } = useConnectionInfo();
const [dismissed, setDismissed] = usePersistedState(
DISMISSED_SEARCH_INDEXES_BANNER_LOCAL_STORAGE_KEY,
false
);

if (!atlasMetadata || dismissed) {
return null;
}

return (
<Banner variant="info" dismissible onClose={() => setDismissed(true)}>
<Banner variant="info" dismissible onClose={onDismissClick}>
<Body weight="medium">Looking for search indexes?</Body>
These indexes can be created and viewed under{' '}
{atlasMetadata ? (
Expand Down Expand Up @@ -117,6 +121,11 @@ export function Indexes({
refreshRegularIndexes,
refreshSearchIndexes,
}: IndexesProps) {
const [atlasBannerDismissed, setDismissed] = usePersistedState(
DISMISSED_SEARCH_INDEXES_BANNER_LOCAL_STORAGE_KEY,
false
);

const errorMessage =
currentIndexesView === 'regular-indexes'
? regularIndexes.error
Expand Down Expand Up @@ -147,12 +156,23 @@ export function Indexes({
hasTooManyIndexes={hasTooManyIndexes}
isRefreshing={isRefreshing}
onRefreshIndexes={onRefreshIndexes}
showAtlasSearchLink={
!isReadonlyView &&
!enableAtlasSearchIndexes &&
atlasBannerDismissed
}
/>
}
>
<div className={indexesContainersStyles}>
{!isReadonlyView && !enableAtlasSearchIndexes && (
<AtlasIndexesBanner namespace={namespace} />
<AtlasIndexesBanner
namespace={namespace}
dismissed={atlasBannerDismissed}
onDismissClick={() => {
setDismissed(true);
}}
/>
)}
{!isReadonlyView && currentIndexesView === 'regular-indexes' && (
<RegularIndexesTable />
Expand Down
Loading