diff --git a/package-lock.json b/package-lock.json index 0c78df46169..52f4cae325e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -54391,7 +54391,8 @@ "electron": "^45.3.2", "lodash": "^4.18.1", "mongodb-connection-string-url": "^7.0.3", - "react": "^18.3.1" + "react": "^18.3.1", + "zod": "^4.6.7" }, "devDependencies": { "@mongodb-js/eslint-config-compass": "^1.4.33", diff --git a/packages/compass-components/src/components/select-list-with-groups.spec.tsx b/packages/compass-components/src/components/select-list-with-groups.spec.tsx new file mode 100644 index 00000000000..5d227fedc8b --- /dev/null +++ b/packages/compass-components/src/components/select-list-with-groups.spec.tsx @@ -0,0 +1,148 @@ +import { render, screen, userEvent } from '@mongodb-js/testing-library-compass'; +import { expect } from 'chai'; +import React from 'react'; +import sinon from 'sinon'; +import { SelectListWithGroups } from './select-list-with-groups'; + +type TestItem = { + id: string; + selected: boolean; + disabled?: boolean; + label: string; +}; + +const label = { displayLabelKey: 'label' as const, name: 'Connections' }; + +function ariaChecked(testId: string) { + return screen + .getByTestId(testId) + .closest('input') + ?.getAttribute('aria-checked'); +} + +function click(testId: string) { + userEvent.click(screen.getByTestId(testId), undefined, { + skipPointerEventsCheck: true, + }); +} + +describe('SelectListWithGroups', function () { + let groups: { id: string; name: string; items: TestItem[] }[]; + let onChange: sinon.SinonStub; + + beforeEach(function () { + groups = [ + { + id: 'g1', + name: 'Group 1', + items: [ + { id: 'a', selected: true, label: 'A' }, + { id: 'b', selected: false, label: 'B' }, + ], + }, + { + id: 'g2', + name: 'Group 2', + items: [{ id: 'c', selected: true, label: 'C' }], + }, + ]; + onChange = sinon.stub(); + }); + + function renderList(disabled?: boolean) { + render( + + ); + } + + it('renders group names, items and counts', function () { + renderList(); + expect(screen.getByText('Group 1')).to.be.visible; + expect(screen.getByLabelText('B')).to.be.visible; + expect( + screen.getByTestId('select-list-group-g1-count').textContent + ).to.equal('1 / 2'); + expect( + screen.getByTestId('select-list-group-g2-count').textContent + ).to.equal('1 / 1'); + }); + + it('reflects selection state on the all and group checkboxes', function () { + renderList(); + expect(ariaChecked('select-list-all-checkbox')).to.equal('mixed'); + expect(ariaChecked('select-list-group-g1-checkbox')).to.equal('mixed'); + expect(ariaChecked('select-list-group-g2-checkbox')).to.equal('true'); + }); + + it('disables the group checkbox when all its items are disabled', function () { + groups[1].items[0].disabled = true; + renderList(); + expect( + screen.getByTestId('select-list-group-g2-checkbox').closest('input') + ?.ariaDisabled + ).to.equal('true'); + expect( + screen.getByTestId('select-list-all-checkbox').closest('input') + ?.ariaDisabled + ).to.not.equal('true'); + }); + + it('disables everything when the component is disabled', function () { + renderList(true); + for (const id of [ + 'select-list-all-checkbox', + 'select-list-group-g1-checkbox', + 'select-a', + ]) { + expect(screen.getByTestId(id).closest('input')?.ariaDisabled).to.equal( + 'true' + ); + } + }); + + it('select all affects every enabled item and returns a flat list in order', function () { + groups[0].items[1].disabled = true; + renderList(); + click('select-list-all-checkbox'); + expect(onChange).to.have.been.calledWith([ + { id: 'a', selected: true, label: 'A' }, + { id: 'b', selected: false, disabled: true, label: 'B' }, + { id: 'c', selected: true, label: 'C' }, + ]); + }); + + it('group select all affects only that group', function () { + renderList(); + click('select-list-group-g1-checkbox'); + expect(onChange).to.have.been.calledWith([ + { id: 'a', selected: true, label: 'A' }, + { id: 'b', selected: true, label: 'B' }, + { id: 'c', selected: true, label: 'C' }, + ]); + }); + + it('group deselect all affects only that group', function () { + renderList(); + click('select-list-group-g2-checkbox'); + expect(onChange).to.have.been.calledWith([ + { id: 'a', selected: true, label: 'A' }, + { id: 'b', selected: false, label: 'B' }, + { id: 'c', selected: false, label: 'C' }, + ]); + }); + + it('toggles a single item', function () { + renderList(); + click('select-b'); + expect(onChange).to.have.been.calledWith([ + { id: 'a', selected: true, label: 'A' }, + { id: 'b', selected: true, label: 'B' }, + { id: 'c', selected: true, label: 'C' }, + ]); + }); +}); diff --git a/packages/compass-components/src/components/select-list-with-groups.tsx b/packages/compass-components/src/components/select-list-with-groups.tsx new file mode 100644 index 00000000000..60391ec9ebc --- /dev/null +++ b/packages/compass-components/src/components/select-list-with-groups.tsx @@ -0,0 +1,204 @@ +import React from 'react'; +import { spacing } from '@leafygreen-ui/tokens'; +import { css, cx } from '@leafygreen-ui/emotion'; +import { palette } from '@leafygreen-ui/palette'; +import { useDarkMode } from '../hooks/use-theme'; +import { Checkbox } from './leafygreen'; +import { + checkboxStyles, + checkboxSelectAllStyles, + containerStyles, + listHeaderStyles, + listBodyStyles, + selectAllLabelStyles, +} from './select-list'; +import type { SelectItem } from './select-list'; + +const groupsStyles = css({ + display: 'flex', + flexDirection: 'column', + gap: spacing[300] + spacing[100], + paddingTop: spacing[200], +}); + +const groupStyles = css({ + display: 'flex', + flexDirection: 'column', + border: `1px solid ${palette.gray.light2}`, + borderRadius: spacing[200], + overflow: 'hidden', + flexShrink: 0, +}); +const groupStylesDark = css({ borderColor: palette.gray.dark2 }); + +const groupHeaderStyles = css({ + display: 'flex', + alignItems: 'center', + // Matches the LG checkbox-to-label gap. + gap: spacing[200], + padding: `${spacing[200]}px ${spacing[300]}px`, + fontWeight: 700, + backgroundColor: palette.gray.light3, +}); +const groupHeaderStylesDark = css({ backgroundColor: palette.gray.dark3 }); + +const groupNameStyles = css({ + display: 'flex', + alignItems: 'center', + gap: spacing[100], + flex: 1, +}); + +const groupCountStyles = css({ + fontSize: 11, + fontWeight: 600, + color: palette.gray.dark1, +}); + +const groupItemStyles = css({ + padding: `${spacing[200]}px ${spacing[300]}px`, + paddingLeft: spacing[300] + spacing[600], + borderTop: `1px solid ${palette.gray.light2}`, +}); +const groupItemStylesDark = css({ borderColor: palette.gray.dark2 }); + +export type SelectGroup = { + id: string; + name: string | JSX.Element; + icon?: React.ReactNode; + items: T[]; +}; + +type SelectListWithGroupsProps = { + groups: SelectGroup[]; + label: { + displayLabelKey: string & keyof T; + ariaLabelKey?: string & keyof T; + name: string | JSX.Element; + }; + onChange: (newList: T[]) => void; + disabled?: boolean; + className?: string; +}; + +function selectionState(items: T[]) { + const all = items.every((item) => item.selected); + const none = items.every((item) => !item.selected); + return { + checked: all, + indeterminate: !all && !none, + allDisabled: items.every((item) => item.disabled), + selectedCount: items.filter((item) => item.selected).length, + }; +} + +export function SelectListWithGroups( + props: SelectListWithGroupsProps +): React.ReactElement { + const { groups, label, disabled, onChange } = props; + const isDarkMode = useDarkMode(); + + const items = groups.flatMap((group) => group.items); + const allState = selectionState(items); + + const setSelected = (predicate: (item: T) => boolean, selected: boolean) => { + onChange( + items.map((item) => + predicate(item) && !item.disabled ? { ...item, selected } : item + ) + ); + }; + + return ( +
+
+ setSelected(() => true, e.target.checked)} + checked={allState.checked} + indeterminate={allState.indeterminate} + disabled={disabled || allState.allDisabled} + /> +
{label.name}
+
+
+ {groups.map((group) => { + const groupState = selectionState(group.items); + return ( +
+
+ + setSelected( + (item) => group.items.some((i) => i.id === item.id), + e.target.checked + ) + } + checked={groupState.checked} + indeterminate={groupState.indeterminate} + disabled={disabled || groupState.allDisabled} + /> +
+ {group.icon} + {group.name} +
+
+ {groupState.selectedCount} / {group.items.length} +
+
+ {group.items.map((item) => ( +
+ + setSelected((i) => i.id === item.id, e.target.checked) + } + checked={item.selected} + disabled={item.disabled || disabled} + /> +
+ ))} +
+ ); + })} +
+
+ ); +} diff --git a/packages/compass-components/src/components/select-list.tsx b/packages/compass-components/src/components/select-list.tsx index e9de700bf03..7578b737dfa 100644 --- a/packages/compass-components/src/components/select-list.tsx +++ b/packages/compass-components/src/components/select-list.tsx @@ -5,13 +5,13 @@ import { palette } from '@leafygreen-ui/palette'; import { useDarkMode } from '../hooks/use-theme'; import { Checkbox } from './leafygreen'; -const checkboxStyles = css({ +export const checkboxStyles = css({ padding: spacing[100], }); -const checkboxSelectAllStyles = css({ paddingRight: 0 }); +export const checkboxSelectAllStyles = css({ paddingRight: 0 }); -const containerStyles = css({ +export const containerStyles = css({ display: 'flex', flexDirection: 'column', }); @@ -19,7 +19,7 @@ const containerStyles = css({ const evenRowStylesDark = css({ backgroundColor: palette.gray.dark3 }); const evenRowStylesLight = css({ backgroundColor: palette.gray.light3 }); -const listHeaderStyles = css({ +export const listHeaderStyles = css({ display: 'flex', alignItems: 'center', fontWeight: 600, @@ -27,16 +27,16 @@ const listHeaderStyles = css({ flexShrink: 0, padding: `${spacing[100]}px 0px`, }); -const listBodyStyles = css({ +export const listBodyStyles = css({ overflow: 'auto', }); const listItemStyles = css({ padding: `${spacing[100]}px 0px`, }); -const selectAllLabelStyles = css({ lineHeight: '16px' }); +export const selectAllLabelStyles = css({ lineHeight: '16px' }); -type SelectItem = { +export type SelectItem = { id: string; selected: boolean; disabled?: boolean; diff --git a/packages/compass-components/src/index.ts b/packages/compass-components/src/index.ts index c6326324ee8..852792673b1 100644 --- a/packages/compass-components/src/index.ts +++ b/packages/compass-components/src/index.ts @@ -235,6 +235,8 @@ export { type ItemRenderer as VirtualListItemRenderer, } from './components/virtual-list'; export { SelectList } from './components/select-list'; +export { SelectListWithGroups } from './components/select-list-with-groups'; +export type { SelectGroup } from './components/select-list-with-groups'; export { ParagraphSkeleton } from '@leafygreen-ui/skeleton-loader'; export { InsightsChip } from './components/insights-chip'; export * from './components/drawer-portal'; diff --git a/packages/compass-connection-import-export/src/components/export-modal.spec.tsx b/packages/compass-connection-import-export/src/components/export-modal.spec.tsx new file mode 100644 index 00000000000..331650b2e9c --- /dev/null +++ b/packages/compass-connection-import-export/src/components/export-modal.spec.tsx @@ -0,0 +1,79 @@ +import React from 'react'; +import { expect } from 'chai'; +import type { ConnectionInfo } from '@mongodb-js/connection-storage/provider'; +import { InMemoryFolderStorage } from '@mongodb-js/connection-storage/provider'; +import { render, screen, within } from '@mongodb-js/testing-library-compass'; +import { ExportConnectionsModal } from './export-modal'; + +function connection(id: string, name: string): ConnectionInfo { + return { + id, + connectionOptions: { connectionString: 'mongodb://localhost:27017' }, + favorite: { name }, + savedConnectionType: 'favorite', + }; +} + +const connections = [ + connection('id1', 'name1'), + connection('id2', 'name2'), + connection('id3', 'name3'), +]; + +function renderModal({ + enableConnectionFolders = true, +}: { enableConnectionFolders?: boolean } = {}) { + return render( {}} />, { + connections, + preferences: { enableConnectionFolders }, + folderStorage: new InMemoryFolderStorage({ + folders: [ + { id: 'f-zeta', name: 'Zeta' }, + { id: 'f-alpha', name: 'alpha' }, + { id: 'f-empty', name: 'Empty' }, + ], + assignments: { id1: 'f-zeta', id2: 'f-alpha', id3: 'f-deleted' }, + }), + }); +} + +function groupIds() { + return Array.from( + document.querySelectorAll( + '[data-testid^="select-list-group-"]:not([data-testid$="-checkbox"]):not([data-testid$="-count"])' + ), + (el) => el.dataset.testid + ); +} + +describe('ExportConnectionsModal', function () { + it('groups connections by folder, sorted, with uncategorized last', async function () { + renderModal(); + + await screen.findByTestId('select-list-group-f-alpha'); + expect(groupIds()).to.deep.equal([ + 'select-list-group-f-alpha', + 'select-list-group-f-zeta', + 'select-list-group-select-list-no-group', + ]); + expect( + within(screen.getByTestId('select-list-group-f-alpha')).getByTestId( + 'select-id2' + ) + ).to.exist; + expect( + within( + screen.getByTestId('select-list-group-select-list-no-group') + ).getByTestId('select-id3') + ).to.exist; + }); + + it('renders a flat list when folders are disabled', function () { + renderModal({ enableConnectionFolders: false }); + + expect(screen.getByTestId('select-id1')).to.exist; + expect( + screen.queryByTestId('select-list-group-select-list-no-group') + ).to.equal(null); + }); +}); diff --git a/packages/compass-connection-import-export/src/components/export-modal.tsx b/packages/compass-connection-import-export/src/components/export-modal.tsx index 346a5957a95..352581121b9 100644 --- a/packages/compass-connection-import-export/src/components/export-modal.tsx +++ b/packages/compass-connection-import-export/src/components/export-modal.tsx @@ -1,4 +1,4 @@ -import React, { useCallback } from 'react'; +import React, { useCallback, useMemo } from 'react'; import { ipcRenderer } from '@mongodb-js/hadron-ipc'; import { Banner, @@ -8,17 +8,20 @@ import { FormModal, openToast, SelectList, + SelectListWithGroups, ToastBody, } from '@mongodb-js/compass-components'; import { usePreference } from '@mongodb-js/compass-preferences-model/provider'; +import { useFolders } from '@mongodb-js/compass-connections/provider'; import type { ImportExportResult } from '../hooks/common'; import { useOpenModalThroughIpc } from '../hooks/common'; import { useExportConnections } from '../hooks/use-export-connections'; import { FileInput } from './file-input'; import { Passphrase } from './passphrase'; +import { groupByFolder } from './group-by-folder'; const tableStyles = css({ - maxHeight: '24vh', + maxHeight: '50vh', overflow: 'auto', }); @@ -27,6 +30,11 @@ const SelectListLabel = { name: 'Connection Name', } as const; +const SelectListWithGroupsLabel = { + ...SelectListLabel, + name: 'Folder & connection Name', +} as const; + export function ExportConnectionsModal({ open, setOpen, @@ -91,6 +99,23 @@ export function ExportConnectionsModal({ trackingProps, }); + const enableConnectionFolders = usePreference('enableConnectionFolders'); + const { folders, folderAssignments } = useFolders(); + const groups = useMemo( + () => + enableConnectionFolders + ? groupByFolder(connectionList, folders, folderAssignments) + : null, + [enableConnectionFolders, folders, folderAssignments, connectionList] + ); + + const listProps = { + className: tableStyles, + label: groups ? SelectListWithGroupsLabel : SelectListLabel, + disabled: inProgress, + onChange: onChangeConnectionList, + }; + return ( - + {groups ? ( + + ) : ( + + )} ( + items: T[], + folders: Pick[], + folderAssignments: Record +) { + // Same order as the sidebar. + const sortedFolders = folders + .slice() + .sort((a, b) => + a.name.toLocaleLowerCase().localeCompare(b.name.toLocaleLowerCase()) + ); + const folderIds = new Set(folders.map((folder) => folder.id)); + return [ + ...sortedFolders.map((folder) => ({ + id: folder.id, + name: folder.name, + icon: , + items: items.filter((item) => folderAssignments[item.id] === folder.id), + })), + { + id: 'select-list-no-group', + name: 'Uncategorized', + items: items.filter((item) => !folderIds.has(folderAssignments[item.id])), + }, + ].filter((group) => group.items.length > 0); +} diff --git a/packages/compass-connection-import-export/src/components/import-modal.spec.tsx b/packages/compass-connection-import-export/src/components/import-modal.spec.tsx index 58e4ab5cc74..076c3141a3e 100644 --- a/packages/compass-connection-import-export/src/components/import-modal.spec.tsx +++ b/packages/compass-connection-import-export/src/components/import-modal.spec.tsx @@ -13,6 +13,7 @@ import { userEvent, waitFor, fireEvent, + within, } from '@mongodb-js/testing-library-compass'; import { ImportConnectionsModal } from './import-modal'; @@ -36,9 +37,15 @@ describe('ImportConnectionsModal', function () { function renderModal({ open = true, connections = [], - }: { open?: boolean; connections?: ConnectionInfo[] } = {}) { + enableConnectionFolders = false, + }: { + open?: boolean; + connections?: ConnectionInfo[]; + enableConnectionFolders?: boolean; + } = {}) { return render(, { connections, + preferences: { enableConnectionFolders }, wrapper: ({ children }) => ( @@ -136,6 +143,52 @@ describe('ImportConnectionsModal', function () { expect(screen.getByTestId('select-id1')).to.have.property('checked', true); }); + it("groups connections by the file's folders", async function () { + await fs.writeFile( + exampleFile, + JSON.stringify({ + folders: [{ id: 'f1', name: 'Work' }], + folderAssignments: { id1: 'f1' }, + }) + ); + const { connectionStorage } = renderModal({ + enableConnectionFolders: true, + }); + sandbox + .stub(connectionStorage, 'deserializeConnections') + .resolves([connection('id1', 'name1'), connection('id2', 'name2')]); + + await selectFile(); + + expect( + within(screen.getByTestId('select-list-group-f1')).getByTestId( + 'select-id1' + ) + ).to.exist; + expect( + within( + screen.getByTestId('select-list-group-select-list-no-group') + ).getByTestId('select-id2') + ).to.exist; + }); + + it('lists everything as uncategorized when the file has no folders', async function () { + const { connectionStorage } = renderModal({ + enableConnectionFolders: true, + }); + sandbox + .stub(connectionStorage, 'deserializeConnections') + .resolves([connection('id1', 'name1')]); + + await selectFile(); + + expect( + within( + screen.getByTestId('select-list-group-select-list-no-group') + ).getByTestId('select-id1') + ).to.exist; + }); + it('marks already saved connections and warns when they are selected', async function () { const existing = connection('id1', 'name1'); const { connectionStorage } = renderModal({ connections: [existing] }); diff --git a/packages/compass-connection-import-export/src/components/import-modal.tsx b/packages/compass-connection-import-export/src/components/import-modal.tsx index 0ae61c6893a..8da26530130 100644 --- a/packages/compass-connection-import-export/src/components/import-modal.tsx +++ b/packages/compass-connection-import-export/src/components/import-modal.tsx @@ -8,17 +8,20 @@ import { spacing, openToast, SelectList, + SelectListWithGroups, } from '@mongodb-js/compass-components'; +import { usePreference } from '@mongodb-js/compass-preferences-model/provider'; import type { ImportExportResult } from '../hooks/common'; import { useOpenModalThroughIpc } from '../hooks/common'; import { useImportConnections } from '../hooks/use-import-connections'; import { Passphrase } from './passphrase'; import { FileInput } from './file-input'; +import { groupByFolder } from './group-by-folder'; const TOAST_TIMEOUT_MS = 5000; const tableStyles = css({ - maxHeight: '24vh', + maxHeight: '50vh', overflow: 'auto', }); @@ -79,6 +82,7 @@ export function ImportConnectionsModal({ connectionList, filename, passphrase, + fileFolders, }, } = useImportConnections({ finish, @@ -109,6 +113,26 @@ export function ImportConnectionsModal({ ]; }, [connectionList]); + const enableConnectionFolders = usePreference('enableConnectionFolders'); + const groups = useMemo( + () => + enableConnectionFolders + ? groupByFolder( + displayConnectionList, + fileFolders.folders, + fileFolders.folderAssignments + ) + : null, + [enableConnectionFolders, displayConnectionList, fileFolders] + ); + + const listProps = { + className: tableStyles, + label: SelectListLabel, + disabled: inProgress, + onChange: onChangeConnectionList, + }; + return ( - {connectionList.length > 0 && ( - - )} + {connectionList.length > 0 && + (groups ? ( + + ) : ( + + ))} {(error && !passphraseRequired && ( Error: {error} )) || diff --git a/packages/compass-connection-import-export/src/hooks/use-import-connections.ts b/packages/compass-connection-import-export/src/hooks/use-import-connections.ts index eb94a34e823..b7ed698a3e1 100644 --- a/packages/compass-connection-import-export/src/hooks/use-import-connections.ts +++ b/packages/compass-connection-import-export/src/hooks/use-import-connections.ts @@ -3,6 +3,8 @@ import { promises as fs } from 'node:fs'; import { useCallback, useEffect, useState } from 'react'; import { type ConnectionStorage, + type ExportedFolders, + deserializeFolders, useConnectionStorageContext, } from '@mongodb-js/connection-storage/provider'; // This plugin is an exception from the rule @@ -28,12 +30,14 @@ type ConnectionImportInfo = ConnectionShortInfo & { type ImportConnectionsState = CommonImportExportState & { passphraseRequired: boolean; fileContents: string; + fileFolders: ExportedFolders; }; const INITIAL_STATE: Readonly = Object.freeze({ ...COMMON_INITIAL_STATE, passphraseRequired: false, fileContents: '', + fileFolders: { folders: [], folderAssignments: {} }, }); async function loadFile( @@ -78,12 +82,14 @@ async function loadFile( return { fileContents, connectionList, + fileFolders: deserializeFolders(fileContents), error: '', }; } catch (err: any) { return { fileContents: '', connectionList: [], + fileFolders: INITIAL_STATE.fileFolders, error: err.message, ...(err.passphraseRequired && { passphraseRequired: true }), }; diff --git a/packages/compass-connections/src/stores/connections-store-redux.ts b/packages/compass-connections/src/stores/connections-store-redux.ts index d8c1b76d6b2..f67cc83d28b 100644 --- a/packages/compass-connections/src/stores/connections-store-redux.ts +++ b/packages/compass-connections/src/stores/connections-store-redux.ts @@ -2456,6 +2456,7 @@ export const importConnections = (options: { if (connectionStorage.importConnections) { await connectionStorage.importConnections(options); connections = await connectionStorage.loadAll(); + await dispatch(loadFolders()); } } catch (err) { error = err; diff --git a/packages/compass/src/main/application.ts b/packages/compass/src/main/application.ts index 0b485f72ae0..457d0c036d4 100644 --- a/packages/compass/src/main/application.ts +++ b/packages/compass/src/main/application.ts @@ -158,8 +158,12 @@ class CompassApplication { } ); - initCompassMainConnectionStorage(); - initCompassMainFolderStorage(); + const folderStorage = initCompassMainFolderStorage(); + initCompassMainConnectionStorage(undefined, undefined, false, () => + this.preferences.getPreferences().enableConnectionFolders + ? folderStorage + : undefined + ); if (mode === 'CLI') { return; diff --git a/packages/connection-storage/package.json b/packages/connection-storage/package.json index bb93845936c..3b81f070f23 100644 --- a/packages/connection-storage/package.json +++ b/packages/connection-storage/package.json @@ -65,7 +65,8 @@ "electron": "^45.3.2", "lodash": "^4.18.1", "mongodb-connection-string-url": "^7.0.3", - "react": "^18.3.1" + "react": "^18.3.1", + "zod": "^4.6.7" }, "devDependencies": { "@mongodb-js/eslint-config-compass": "^1.4.33", diff --git a/packages/connection-storage/src/compass-main-connection-storage.spec.ts b/packages/connection-storage/src/compass-main-connection-storage.spec.ts index 239819e8475..1358ebbb949 100644 --- a/packages/connection-storage/src/compass-main-connection-storage.spec.ts +++ b/packages/connection-storage/src/compass-main-connection-storage.spec.ts @@ -16,6 +16,7 @@ import { type ConnectionWithLegacyProps, type ConnectionStorageIPCMain, } from './compass-main-connection-storage'; +import { InMemoryFolderStorage } from './in-memory-folder-storage'; function getConnectionFilePath(tmpDir: string, id: string): string { const connectionsDir = path.join(tmpDir, 'Connections'); @@ -666,6 +667,80 @@ describe('ConnectionStorage', function () { const expectedConnections = await connectionStorage.loadAll(); expect(expectedConnections).to.deep.equal([CONNECTIONS[1]]); }); + + it('exports and imports folders', async function () { + const workFolder = { id: new UUID().toString(), name: 'Work' }; + const exportingStorage = initCompassMainConnectionStorage( + tmpDir, + ipcMain, + true, + () => + new InMemoryFolderStorage({ + folders: [workFolder], + assignments: { [CONNECTIONS[0].id]: workFolder.id }, + }) + ); + const exported = await exportingStorage.exportConnections(); + + const importingFolders = new InMemoryFolderStorage(); + const importingStorage = initCompassMainConnectionStorage( + tmpDir, + ipcMain, + true, + () => importingFolders + ); + await importingStorage.importConnections({ content: exported }); + + const { folders, assignments } = await importingFolders.load(); + expect(folders.map(({ name }) => name)).to.deep.equal(['Work']); + expect(folders[0].id).to.not.equal(workFolder.id); + expect({ ...assignments }).to.deep.equal({ + [CONNECTIONS[0].id]: folders[0].id, + }); + }); + + it('keeps imported connections when saving folders fails', async function () { + const exported = await connectionStorage.exportConnections(); + await Promise.all( + CONNECTIONS.map(({ id }) => connectionStorage.delete({ id })) + ); + const folderStorage = new InMemoryFolderStorage(); + Sinon.stub(folderStorage, 'save').rejects(new Error('disk full')); + const importingStorage = initCompassMainConnectionStorage( + tmpDir, + ipcMain, + true, + () => folderStorage + ); + + await importingStorage.importConnections({ content: exported }); + + expect(sortBy(await importingStorage.loadAll(), 'id')).to.deep.equal( + sortBy(CONNECTIONS, 'id') + ); + }); + + it('aborts the import without saving connections when folders are invalid', async function () { + const exported = JSON.parse(await connectionStorage.exportConnections()); + await Promise.all( + CONNECTIONS.map(({ id }) => connectionStorage.delete({ id })) + ); + const importingStorage = initCompassMainConnectionStorage( + tmpDir, + ipcMain, + true, + () => new InMemoryFolderStorage() + ); + + const error = await importingStorage + .importConnections({ + content: JSON.stringify({ ...exported, folders: [{ id: 'f1' }] }), + }) + .catch((e) => e); + + expect(error.message).to.equal('Input file contains invalid folders'); + expect(await importingStorage.loadAll()).to.deep.equal([]); + }); }); describe('supports connections from older version of compass', function () { diff --git a/packages/connection-storage/src/compass-main-connection-storage.ts b/packages/connection-storage/src/compass-main-connection-storage.ts index 072b80813f8..f8d96c96b8e 100644 --- a/packages/connection-storage/src/compass-main-connection-storage.ts +++ b/packages/connection-storage/src/compass-main-connection-storage.ts @@ -11,6 +11,11 @@ import { createLogger } from '@mongodb-js/compass-logging'; import { mergeSecrets, extractSecrets } from '@mongodb-js/connection-info'; import { FileUserData, z } from '@mongodb-js/compass-user-data'; import { deleteCompassAppNameParam } from './utils'; +import type { FolderStorage } from './folder-storage'; +import { + deserializeFolders, + mergeImportedFolders, +} from './import-export-folders'; import { serializeConnections, deserializeConnections, @@ -83,8 +88,14 @@ class CompassMainConnectionStorage implements ConnectionStorage { private readonly version = 1; private readonly maxAllowedRecentConnections = 10; private readonly ipcMain: ConnectionStorageIPCMain; - constructor(ipcMain: ConnectionStorageIPCMain, basePath?: string) { + private readonly getFolderStorage: () => FolderStorage | undefined; + constructor( + ipcMain: ConnectionStorageIPCMain, + basePath?: string, + getFolderStorage: () => FolderStorage | undefined = () => undefined + ) { this.ipcMain = ipcMain; + this.getFolderStorage = getFolderStorage; this.userData = new FileUserData(ConnectionSchema, 'Connections', { basePath, }); @@ -355,10 +366,34 @@ class CompassMainConnectionStorage implements ConnectionStorage { } ); + const folderStorage = this.getFolderStorage(); + const folderOrganization = + folderStorage && + mergeImportedFolders( + await folderStorage.load(), + deserializeFolders(content), + connections.map(({ id }) => id) + ); + await Promise.all( connections.map((connectionInfo) => this.save({ connectionInfo, signal })) ); + // Connections are already saved at this point, so failing the import here + // would report an error for an import that has mostly succeeded. + try { + if (folderOrganization) { + await folderStorage?.save({ folderOrganization }); + } + } catch (err) { + log.error( + mongoLogId(1_001_000_460), + 'Connection Import', + 'Failed to save imported folders', + { message: (err as Error).message } + ); + } + log.info( mongoLogId(1_001_000_150), 'Connection Import', @@ -384,7 +419,10 @@ class CompassMainConnectionStorage implements ConnectionStorage { ? connections.filter((x) => filterConnectionIds.includes(x.id)) : connections.filter((x) => x.favorite?.name); - return serializeConnections(exportConnections, restOfOptions); + return serializeConnections(exportConnections, { + ...restOfOptions, + folderOrganization: await this.getFolderStorage()?.load(), + }); } private async getConnections(): Promise { @@ -469,7 +507,9 @@ let mainConnectionStorage: CompassMainConnectionStorage | null = null; export const initCompassMainConnectionStorage = ( basePath?: string, __TEST_IPC_MAIN?: ConnectionStorageIPCMain, - __TEST_IGNORE_SINGLETON?: boolean + __TEST_IGNORE_SINGLETON?: boolean, + /** Returns undefined while folders are disabled. */ + getFolderStorage?: () => FolderStorage | undefined ): CompassMainConnectionStorage => { let ipcMainToBeUsed: ConnectionStorageIPCMain | undefined = ipcMain; if (process.env.NODE_ENV === 'test' && __TEST_IPC_MAIN) { @@ -485,7 +525,8 @@ export const initCompassMainConnectionStorage = ( if (!mainConnectionStorage || __TEST_IGNORE_SINGLETON) { mainConnectionStorage = new CompassMainConnectionStorage( ipcMainToBeUsed, - basePath + basePath, + getFolderStorage ); } diff --git a/packages/connection-storage/src/import-export-connection.spec.ts b/packages/connection-storage/src/import-export-connection.spec.ts index be053bee7c9..242cffefcdc 100644 --- a/packages/connection-storage/src/import-export-connection.spec.ts +++ b/packages/connection-storage/src/import-export-connection.spec.ts @@ -1,6 +1,7 @@ import { expect } from 'chai'; import type { ConnectionInfo } from '@mongodb-js/connection-info'; import { cloneDeep } from 'lodash'; +import { EJSON } from 'bson'; import { serializeConnections, deserializeConnections, @@ -40,6 +41,54 @@ describe('Connection serialization', function () { ); }); + it('exports only folders and assignments used by exported connections', async function () { + const serialized = await serializeConnections([CONNECTIONS[0]], { + folderOrganization: { + folders: [ + { id: 'f1', name: 'used', lastModifiedAt: new Date() }, + { id: 'f2', name: 'unused' }, + ], + assignments: { id1: 'f1', id2: 'f2' }, + }, + }); + const { folders, folderAssignments } = EJSON.parse(serialized); + expect(folders).to.deep.equal([{ id: 'f1', name: 'used' }]); + expect(folderAssignments).to.deep.equal({ id1: 'f1' }); + }); + + it('writes no folder keys without a folder organization', async function () { + const parsed = EJSON.parse(await serializeConnections(CONNECTIONS)); + expect(parsed).to.not.have.property('folders'); + expect(parsed).to.not.have.property('folderAssignments'); + }); + + describe('version compatibility - folders', function () { + const folderOrganization = { + folders: [{ id: 'f1', name: 'one' }], + assignments: { id1: 'f1' }, + }; + + it('supports both file formats with and without folder keys', async function () { + const withFolders = await serializeConnections(CONNECTIONS, { + folderOrganization, + }); + const withoutFolders = await serializeConnections(CONNECTIONS); + expect(await deserializeConnections(withFolders)).to.deep.equal( + await deserializeConnections(withoutFolders) + ); + }); + + it('reads files from versions that predate folders', async function () { + const legacyFile = EJSON.stringify( + { type: 'Compass Connections', version: 1, connections: CONNECTIONS }, + { relaxed: false } + ); + expect(await deserializeConnections(legacyFile)).to.deep.equal( + CONNECTIONS + ); + }); + }); + it('without secrets', async function () { const serializedConnections = await serializeConnections(CONNECTIONS, { removeSecrets: true, diff --git a/packages/connection-storage/src/import-export-connection.ts b/packages/connection-storage/src/import-export-connection.ts index eda2a09cbc4..3b35ed8e995 100644 --- a/packages/connection-storage/src/import-export-connection.ts +++ b/packages/connection-storage/src/import-export-connection.ts @@ -8,6 +8,8 @@ import { extractSecrets, mergeSecrets } from '@mongodb-js/connection-info'; import { createLogger } from '@mongodb-js/compass-logging'; import { createIpcTrack } from '@mongodb-js/compass-telemetry'; import { Decrypter, Encrypter } from './encrypt'; +import type { FolderOrganization } from './folder'; +import { pickExportedFolders } from './import-export-folders'; type ConfigurableOptionsSpec = { [key: string]: true | ConfigurableOptionsSpec; @@ -74,6 +76,7 @@ export interface ImportConnectionOptions { export interface ExportConnectionOptions extends ImportConnectionOptions { removeSecrets?: boolean; + folderOrganization?: FolderOrganization; } export async function serializeConnections( @@ -84,6 +87,7 @@ export async function serializeConnections( passphrase = '', removeSecrets = false, trackingProps = undefined, + folderOrganization, } = options; if (passphrase && removeSecrets) { @@ -131,6 +135,8 @@ export async function serializeConnections( type: kFileTypeDescription, version: kCurrentVersion, connections: exportConnections, + ...(folderOrganization && + pickExportedFolders(folderOrganization, exportConnections)), }; return EJSON.stringify(exportResult, undefined, 2, { relaxed: false }); diff --git a/packages/connection-storage/src/import-export-folders.spec.ts b/packages/connection-storage/src/import-export-folders.spec.ts new file mode 100644 index 00000000000..ac60644602e --- /dev/null +++ b/packages/connection-storage/src/import-export-folders.spec.ts @@ -0,0 +1,59 @@ +import { expect } from 'chai'; +import { + deserializeFolders, + mergeImportedFolders, +} from './import-export-folders'; + +describe('mergeImportedFolders', function () { + const imported = { + folders: [ + { id: 'file-work', name: 'Work' }, + { id: 'file-new', name: 'New' }, + ], + folderAssignments: { c1: 'file-work', c2: 'file-new', c3: 'missing' }, + }; + + it('reuses same-name folders, creates the rest, and drops unknown folder references', function () { + const merged = mergeImportedFolders( + { + folders: [{ id: 'local-work', name: 'Work' }], + assignments: { c0: 'local-work' }, + }, + imported, + ['c1', 'c2', 'c3'] + ); + + const newFolder = merged.folders.find(({ name }) => name === 'New'); + expect(merged.folders).to.have.lengthOf(2); + expect(newFolder?.id).to.not.equal('file-new'); + expect({ ...merged.assignments }).to.deep.equal({ + c0: 'local-work', + c1: 'local-work', + c2: newFolder?.id, + }); + }); + + it('only assigns the imported connections', function () { + const merged = mergeImportedFolders( + { folders: [], assignments: {} }, + imported, + ['c1'] + ); + expect(merged.folders.map(({ name }) => name)).to.deep.equal(['Work']); + expect(Object.keys(merged.assignments)).to.deep.equal(['c1']); + }); +}); + +describe('deserializeFolders', function () { + for (const [name, content] of Object.entries({ + 'folders is not an array': { folders: {} }, + 'a folder has no name': { folders: [{ id: 'f1' }] }, + 'an assignment is not a string': { folderAssignments: { c1: 1 } }, + })) { + it(`throws when ${name}`, function () { + expect(() => deserializeFolders(JSON.stringify(content))).to.throw( + 'Input file contains invalid folders' + ); + }); + } +}); diff --git a/packages/connection-storage/src/import-export-folders.ts b/packages/connection-storage/src/import-export-folders.ts new file mode 100644 index 00000000000..71af7151dcd --- /dev/null +++ b/packages/connection-storage/src/import-export-folders.ts @@ -0,0 +1,69 @@ +import { UUID } from 'bson'; +import { z } from 'zod'; +import type { ConnectionInfo } from '@mongodb-js/connection-info'; +import type { Folder, FolderOrganization } from './folder'; + +export type ExportedFolders = { + folders: Pick[]; + folderAssignments: Record; +}; + +export function pickExportedFolders( + { folders, assignments }: FolderOrganization, + connections: ConnectionInfo[] +): ExportedFolders { + const folderAssignments: Record = Object.create(null); + for (const { id } of connections) { + if (assignments[id]) { + folderAssignments[id] = assignments[id]; + } + } + const usedFolderIds = new Set(Object.values(folderAssignments)); + return { + folders: folders + .filter(({ id }) => usedFolderIds.has(id)) + .map(({ id, name }) => ({ id, name })), + folderAssignments, + }; +} + +const ExportedFoldersSchema = z.object({ + folders: z.array(z.object({ id: z.string(), name: z.string() })).default([]), + folderAssignments: z.record(z.string(), z.string()).default({}), +}); + +/** Files exported before folders existed have neither key. */ +export function deserializeFolders(content: string): ExportedFolders { + const result = ExportedFoldersSchema.safeParse(JSON.parse(content)); + if (!result.success) { + throw new Error('Input file contains invalid folders'); + } + return result.data; +} + +export function mergeImportedFolders( + local: FolderOrganization, + imported: ExportedFolders, + connectionIds: string[] +): FolderOrganization { + const folders = [...local.folders]; + const assignments: Record = Object.assign( + Object.create(null), + local.assignments + ); + for (const connectionId of connectionIds) { + const importedFolder = imported.folders.find( + ({ id }) => id === imported.folderAssignments[connectionId] + ); + if (!importedFolder) { + continue; + } + let folder = folders.find(({ name }) => name === importedFolder.name); + if (!folder) { + folder = { id: new UUID().toString(), name: importedFolder.name }; + folders.push(folder); + } + assignments[connectionId] = folder.id; + } + return { folders, assignments }; +} diff --git a/packages/connection-storage/src/provider.ts b/packages/connection-storage/src/provider.ts index 2e2f6952f75..03b2e34ae33 100644 --- a/packages/connection-storage/src/provider.ts +++ b/packages/connection-storage/src/provider.ts @@ -14,6 +14,8 @@ import { import { InMemoryFolderStorage } from './in-memory-folder-storage'; export { InMemoryConnectionStorage, InMemoryFolderStorage }; +export { deserializeFolders } from './import-export-folders'; +export type { ExportedFolders } from './import-export-folders'; export type { ConnectionStorage, ConnectionInfo, AtlasClusterMetadata }; export type { Folder, FolderOrganization, FolderStorage };