feat(data-modeling): show collection name / relationship label in drawer header; show item associated actions in header COMPASS-9653 #7176
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| import React, { useState } from 'react'; | ||
| import { render, screen, waitFor } from '@mongodb-js/testing-library-compass'; | ||
| import { | ||
| DrawerContentProvider, | ||
| DrawerSection, | ||
| DrawerAnchor, | ||
| } from './drawer-portal'; | ||
| import { expect } from 'chai'; | ||
|
|
||
| describe('DrawerSection', function () { | ||
| it('renders DrawerSection in the portal and updates the content when it updates', async function () { | ||
| let setCount; | ||
|
|
||
| function TestDrawer() { | ||
| const [count, _setCount] = useState(0); | ||
| setCount = _setCount; | ||
| return ( | ||
| <DrawerContentProvider> | ||
| <DrawerAnchor> | ||
| <DrawerSection | ||
| id="test-section" | ||
| label="Test section" | ||
| title={`Test section: ${count}`} | ||
| glyph="Trash" | ||
| autoOpen | ||
| > | ||
| This is a test section and the count is {count} | ||
| </DrawerSection> | ||
| </DrawerAnchor> | ||
| </DrawerContentProvider> | ||
| ); | ||
| } | ||
|
|
||
| render(<TestDrawer></TestDrawer>); | ||
|
|
||
| await waitFor(() => { | ||
| expect(screen.getByText('Test section: 0')).to.be.visible; | ||
| expect(screen.getByText('This is a test section and the count is 0')).to | ||
| .be.visible; | ||
| }); | ||
|
|
||
| setCount(42); | ||
|
|
||
| await waitFor(() => { | ||
| expect(screen.getByText('Test section: 42')).to.be.visible; | ||
| expect(screen.getByText('This is a test section and the count is 42')).to | ||
| .be.visible; | ||
| }); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,9 +39,13 @@ export const DrawerToolbarLayoutContainer = forwardRef< | |
| ) => { | ||
| const { openDrawer, closeDrawer, getActiveDrawerContent, isDrawerOpen } = | ||
| useDrawerToolbarContext(); | ||
| const { id } = getActiveDrawerContent() || {}; | ||
| const lgIds = getLgIds(dataLgId); | ||
| const hasData = toolbarData && toolbarData.length > 0; | ||
| const { title, content } = | ||
gribnoysup marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| toolbarData.find((data) => { | ||
| return data.id === id; | ||
| }) ?? {}; | ||
|
Comment on lines
+42
to
+48
Collaborator
Author
There was a problem hiding this comment. This is like a super minimal version of the fix that LG team did in this patch, mapping their changes on top of our vendored package was tricky due to naming (and seems like code was generally shifted around more there), but we can be sure that when this is not vendored anymore, this will continue working
Collaborator
Author
There was a problem hiding this comment. Actually, I promised a test for this, let me add that |
||
|
|
||
| const handleOnClose = (event: React.MouseEvent<HTMLButtonElement>) => { | ||
| onClose?.(event); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,162 @@ | ||
| import React, { useMemo } from 'react'; | ||
| import { connect } from 'react-redux'; | ||
| import type { DataModelingState } from '../../store/reducer'; | ||
| import { | ||
| css, | ||
| DrawerSection, | ||
| ItemActionControls, | ||
| } from '@mongodb-js/compass-components'; | ||
| import CollectionDrawerContent from './collection-drawer-content'; | ||
| import RelationshipDrawerContent from './relationship-drawer-content'; | ||
| import { | ||
| deleteRelationship, | ||
| selectCurrentModelFromState, | ||
| } from '../../store/diagram'; | ||
| import { getDefaultRelationshipName } from '../../utils'; | ||
|
|
||
| export const DATA_MODELING_DRAWER_ID = 'data-modeling-drawer'; | ||
|
|
||
| const drawerTitleStyles = css({ | ||
| display: 'flex', | ||
| width: '100%', | ||
| }); | ||
|
|
||
| const drawerTitleTextStyles = css({ | ||
| flex: 1, | ||
| whiteSpace: 'nowrap', | ||
| overflow: 'hidden', | ||
| textOverflow: 'ellipsis', | ||
| }); | ||
|
|
||
| const drawerTitleActionGroupStyles = css({}); | ||
|
|
||
| type DiagramEditorSidePanelProps = { | ||
| selectedItems: { | ||
| id: string; | ||
| type: 'relationship' | 'collection'; | ||
| label: string; | ||
| } | null; | ||
| onDeleteRelationship: (rId: string) => void; | ||
| }; | ||
|
|
||
| function DiagramEditorSidePanel({ | ||
| selectedItems, | ||
| onDeleteRelationship, | ||
| }: DiagramEditorSidePanelProps) { | ||
| const { content, label, actions, handleAction } = useMemo(() => { | ||
| if (selectedItems?.type === 'collection') { | ||
| return { | ||
| label: selectedItems.label, | ||
| content: ( | ||
| <CollectionDrawerContent | ||
| key={selectedItems.id} | ||
| namespace={selectedItems.id} | ||
| ></CollectionDrawerContent> | ||
| ), | ||
| actions: [], | ||
| handleAction: () => {}, | ||
| }; | ||
| } | ||
|
|
||
| if (selectedItems?.type === 'relationship') { | ||
| return { | ||
| label: selectedItems.label, | ||
| content: ( | ||
| <RelationshipDrawerContent | ||
| key={selectedItems.id} | ||
| relationshipId={selectedItems.id} | ||
| ></RelationshipDrawerContent> | ||
| ), | ||
| actions: [ | ||
| { action: 'delete', label: 'Delete', icon: 'Trash' as const }, | ||
| ], | ||
| handleAction: (actionName: string) => { | ||
| if (actionName === 'delete') { | ||
| onDeleteRelationship(selectedItems.id); | ||
| } | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| return { content: null }; | ||
gribnoysup marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }, [selectedItems, onDeleteRelationship]); | ||
|
|
||
| if (!content) { | ||
| return null; | ||
| } | ||
|
|
||
| return ( | ||
| <DrawerSection | ||
| id={DATA_MODELING_DRAWER_ID} | ||
| title={ | ||
| <div className={drawerTitleStyles}> | ||
| <span className={drawerTitleTextStyles} title={label}> | ||
| {label} | ||
| </span> | ||
|
|
||
| <ItemActionControls | ||
| actions={actions} | ||
| iconSize="small" | ||
| onAction={handleAction} | ||
| className={drawerTitleActionGroupStyles} | ||
| // Because the close button here is out of our control, we have do | ||
| // adjust the actions rendering in a bit of an unconventional way: | ||
| // if there's more than one action available, collapse it to "...", | ||
| // if it's just one, make sure button is not collapsed by setting | ||
| // collapseAfter to >0 | ||
| collapseAfter={actions.length > 1 ? 0 : 1} | ||
| ></ItemActionControls> | ||
| </div> | ||
| } | ||
| label={label} | ||
| glyph="Wrench" | ||
| autoOpen | ||
| > | ||
| {content} | ||
| </DrawerSection> | ||
| ); | ||
| } | ||
|
|
||
| export default connect( | ||
| (state: DataModelingState) => { | ||
| const selected = state.diagram?.selectedItems; | ||
|
|
||
| if (!selected) { | ||
| return { | ||
| selectedItems: null, | ||
| }; | ||
| } | ||
|
|
||
| if (selected.type === 'collection') { | ||
| return { | ||
| selectedItems: { | ||
| ...selected, | ||
| label: selected.id, | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| if (selected.type === 'relationship') { | ||
| const model = selectCurrentModelFromState(state); | ||
| const relationship = model.relationships.find((relationship) => { | ||
| return relationship.id === selected.id; | ||
| }); | ||
|
|
||
| if (!relationship) { | ||
| throw new Error( | ||
| 'Can not find corresponding relationship when rendering DiagramEditorSidePanel' | ||
| ); | ||
| } | ||
|
|
||
| return { | ||
| selectedItems: { | ||
| ...selected, | ||
| label: getDefaultRelationshipName(relationship.relationship), | ||
| }, | ||
| }; | ||
| } | ||
| }, | ||
| { | ||
| onDeleteRelationship: deleteRelationship, | ||
| } | ||
| )(DiagramEditorSidePanel); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hoping to get a ticket number from this Slack thread