Skip to content

feat(sidebar): filter both databases and collections with dot notation #6912

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 3 commits into from
Jun 12, 2025
Merged

feat(sidebar): filter both databases and collections with dot notation #6912

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e18c41f
feat(sidebar): filter both databases and collections with dot notation
ooorayray May 11, 2025
06ebee8
chore(sidebar): fix regex in test for dot notation filter
ooorayray May 19, 2025
9ea35ea
Merge branch 'main' into filter-by-dot-notation
gribnoysup Jun 12, 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
37 changes: 37 additions & 0 deletions packages/compass-sidebar/src/components/use-filtered-connections.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ const sidebarConnections: SidebarConnection[] = [
pipeline: [],
isNonExistent: false,
},
{
_id: 'coll_ready_1_1_2',
name: 'coll_ready_shared_name',
type: 'collection',
sourceName: '',
pipeline: [],
isNonExistent: false,
},
],
collectionsLength: 1,
collectionsStatus: 'ready',
Expand All @@ -70,6 +78,14 @@ const sidebarConnections: SidebarConnection[] = [
pipeline: [],
isNonExistent: false,
},
{
_id: 'coll_ready_1_2_2',
name: 'coll_ready_shared_name',
type: 'collection',
sourceName: '',
pipeline: [],
isNonExistent: false,
},
],
collectionsLength: 1,
collectionsStatus: 'ready',
Expand Down Expand Up @@ -626,6 +642,27 @@ describe('useFilteredConnections', function () {
});
});

it('should filter collection items and database items using dot notation', async function () {
const { result } = renderHookWithContext(useFilteredConnections, {
initialProps: {
connections: mockSidebarConnections,
filter: {
regex: new RegExp('ready_1_1.coll_ready_shared_name', 'i'), // this matches only coll_ready_shared_name collection in ready_1_1 database
Copy link
Contributor

@kraenhansen kraenhansen May 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

While this works, the . has special meaning in the regular expression and I believe it should be escaped here to capture the intent of the change, to mean a literal "." (dot).

Suggested change
regex: new RegExp('ready_1_1.coll_ready_shared_name', 'i'), // this matches only coll_ready_shared_name collection in ready_1_1 database
regex: new RegExp('ready_1_1\.coll_ready_shared_name', 'i'), // this matches only coll_ready_shared_name collection in ready_1_1 database

Copy link
Contributor Author

@ooorayray ooorayray May 19, 2025

Choose a reason for hiding this comment

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

Fixed!

excludeInactive: false,
},
fetchAllCollections: fetchAllCollectionsStub,
onDatabaseExpand: onDatabaseExpandStub,
},
});

await waitFor(() => {
expect(
(result.current.filtered?.[0] as SidebarConnectedConnection)
.databases[0].collections
).to.have.length(1); // the result has 1 collection
});
});

it('as expanded, it should return an object containing an expanded object for the matching items', async function () {
const { result } = renderHookWithContext(useFilteredConnections, {
initialProps: {
Expand Down
10 changes: 7 additions & 3 deletions packages/compass-sidebar/src/components/use-filtered-connections.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ const filterDatabases = (
const results: FilteredDatabase[] = [];
for (const db of databases) {
const isMatch = !regex || regex.test(db.name);
const childMatches = filterCollections(db.collections, regex);
const childMatches = filterCollections(db.collections, regex, db.name);

if (isMatch || childMatches.length) {
// If the db doesn't match, we want to use just the matching collections.
Expand All @@ -111,10 +111,14 @@ const filterDatabases = (

const filterCollections = (
collections: SidebarCollection[],
regex: RegExp | null
regex: RegExp | null,
dbName: string
): FilteredCollection[] => {
return collections
.filter(({ name }) => !regex || regex.test(name))
.filter(
({ name }) =>
!regex || regex.test(name) || regex.test(`${dbName}.${name}`)
)
.map((collection) => ({ ...collection, isMatch: true }));
};

Expand Down
Loading