Skip to content

feat: DM inline field name edit COMPASS-9798 #7454

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: DM inline field name edit COMPASS-9798 #7454

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
66ba6cf
feat: DM inline field name edit COMPASS-9798
paula-stacho Oct 14, 2025
9de1146
add e2e
paula-stacho Oct 16, 2025
21a168d
update name
paula-stacho Oct 17, 2025
fadefa6
improve field test
paula-stacho Oct 17, 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
10 changes: 10 additions & 0 deletions packages/compass-data-modeling/src/components/diagram-editor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import {
createNewRelationship,
addCollection,
selectField,
renameField,
} from '../store/diagram';
import type { EdgeProps, NodeProps } from '@mongodb-js/compass-components';
import {
Expand Down Expand Up @@ -136,6 +137,11 @@ const DiagramContent: React.FunctionComponent<{
onCollectionSelect: (namespace: string) => void;
onRelationshipSelect: (rId: string) => void;
onFieldSelect: (namespace: string, fieldPath: FieldPath) => void;
onRenameField: (
namespace: string,
fieldPath: FieldPath,
newName: string
) => void;
onDiagramBackgroundClicked: () => void;
selectedItems: SelectedItems;
onCreateNewRelationship: ({
Expand All @@ -160,6 +166,7 @@ const DiagramContent: React.FunctionComponent<{
onCollectionSelect,
onRelationshipSelect,
onFieldSelect,
onRenameField,
onDiagramBackgroundClicked,
onCreateNewRelationship,
onRelationshipDrawn,
Expand Down Expand Up @@ -346,6 +353,7 @@ const DiagramContent: React.FunctionComponent<{
onPaneClick,
onEdgeClick,
onFieldClick,
onFieldNameChange: onRenameField,
onNodeDragStop,
onConnect,
}),
Expand All @@ -360,6 +368,7 @@ const DiagramContent: React.FunctionComponent<{
onPaneClick,
onEdgeClick,
onFieldClick,
onRenameField,
onNodeDragStop,
onConnect,
Comment on lines 368 to 373
Copy link

Copilot AI Oct 16, 2025

Choose a reason for hiding this comment

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

onRenameField is included in this dependency array but (based on the diff) does not appear to be referenced inside the corresponding memoized callback. Remove it if unused to avoid unnecessary recalculations.

Copilot uses AI. Check for mistakes.

]
Expand Down Expand Up @@ -422,6 +431,7 @@ const ConnectedDiagramContent = connect(
onCollectionSelect: selectCollection,
onRelationshipSelect: selectRelationship,
onFieldSelect: selectField,
onRenameField: renameField,
onDiagramBackgroundClicked: selectBackground,
onCreateNewRelationship: createNewRelationship,
}
Expand Down
50 changes: 49 additions & 1 deletion packages/compass-data-modeling/src/utils/nodes-and-edges.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,29 @@ describe('getFieldsFromSchema', function () {
expect(result).to.deep.equal([]);
});

it('returns fields for a simple schema', function () {
it('returns fields for a simple schema, with non editable _id', function () {
const result = getFieldsFromSchema({
jsonSchema: {
bsonType: 'object',
properties: {
_id: { bsonType: 'objectId' },
name: { bsonType: 'string' },
age: { bsonType: 'int' },
},
},
});
expect(result).to.deep.equal([
{
name: '_id',
id: ['_id'],
type: 'objectId',
depth: 0,
glyphs: ['key'],
selectable: true,
selected: false,
variant: undefined,
editable: false,
},
{
name: 'name',
id: ['name'],
Expand All @@ -28,6 +40,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'age',
Expand All @@ -38,6 +51,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
]);
});
Expand All @@ -60,6 +74,7 @@ describe('getFieldsFromSchema', function () {
selected: false,
type: ['int', 'string'],
variant: undefined,
editable: true,
});
});

Expand All @@ -85,6 +100,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'age',
Expand All @@ -95,6 +111,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: 'preview',
editable: true,
},
{
name: 'profession',
Expand All @@ -105,6 +122,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
]);
});
Expand All @@ -131,6 +149,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'age',
Expand All @@ -141,6 +160,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: 'preview',
editable: true,
},
{
name: 'profession',
Expand All @@ -151,6 +171,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: 'preview',
editable: true,
},
]);
});
Expand Down Expand Up @@ -188,6 +209,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'name',
Expand All @@ -198,6 +220,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'address',
Expand All @@ -208,6 +231,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'street',
Expand All @@ -218,6 +242,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'city',
Expand All @@ -228,6 +253,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
]);
});
Expand Down Expand Up @@ -264,6 +290,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'name',
Expand All @@ -274,6 +301,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'address',
Expand All @@ -284,6 +312,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'street',
Expand All @@ -294,6 +323,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: 'preview',
editable: true,
},
{
name: 'city',
Expand All @@ -304,6 +334,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
]);
});
Expand Down Expand Up @@ -350,6 +381,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'name',
Expand All @@ -360,6 +392,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'address',
Expand All @@ -370,6 +403,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'street',
Expand All @@ -380,6 +414,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: 'preview',
editable: true,
},
{
name: 'city',
Expand All @@ -390,6 +425,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'billingAddress',
Expand All @@ -400,6 +436,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'street',
Expand All @@ -410,6 +447,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'city',
Expand All @@ -420,6 +458,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: 'preview',
editable: true,
},
]);
});
Expand Down Expand Up @@ -452,6 +491,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'title',
Expand All @@ -462,6 +502,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'completed',
Expand All @@ -472,6 +513,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
]);
});
Expand Down Expand Up @@ -506,6 +548,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
});
expect(result[1]).to.deep.equal({
name: 'first',
Expand All @@ -516,6 +559,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
});
expect(result[2]).to.deep.equal({
name: 'last',
Expand All @@ -526,6 +570,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
});
});

Expand Down Expand Up @@ -562,6 +607,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'title',
Expand All @@ -572,6 +618,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
{
name: 'completed',
Expand All @@ -582,6 +629,7 @@ describe('getFieldsFromSchema', function () {
selectable: true,
selected: false,
variant: undefined,
editable: true,
},
]);
});
Expand Down
3 changes: 2 additions & 1 deletion packages/compass-data-modeling/src/utils/nodes-and-edges.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import type {
Relationship,
} from '../services/data-model-storage';
import { traverseSchema } from './schema-traversal';
import { areFieldPathsEqual } from './utils';
import { areFieldPathsEqual, isIdField } from './utils';

const NO_HIGHLIGHTED_FIELDS = {};

Expand Down Expand Up @@ -100,6 +100,7 @@ export const getFieldsFromSchema = ({
selected:
!!selectedField?.length &&
areFieldPathsEqual(fieldPath, selectedField),
editable: !isIdField(fieldPath),
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are we sure we want to exclude _id from edits? We obviously can't do that for individual documents, but as a data modeling operation, it kind of seems fine/like something that one would actually want to do

variant:
highlightedFields.length &&
highlightedFields.some((highlightedField) =>
Expand Down
Loading
Loading