feat(compass-collection): finish contents of mock data generator confirmation screen CLOUDP-333852 #7299

kpamaran · 2025-09-09T18:47:24Z

Description

Jira: https://jira.mongodb.org/browse/CLOUDP-333852
Figma (link)

The confirmation screen allows the user to preview and confirm to the contents sent to the LLM, which respects the setting for whether Generative AI features should send sample data.

Edit: New screenshots using compass Document component instead of leafygreen Code. The result is closer to the Figma

Sample Documents Variant

chat-sample-doc-component-sample-doc-expanded

Schema-only Variant

chat-sample-doc-component-schema-only-collapsed

You will notice that there is no syntax highlighting based on the mongo type in the schema-only variant. That may be viable with the customKeywords prop on the leafygreen Code component, but that requires 4 major version upgrades and may introduce breaking changes.

Checklist

New tests and/or benchmarks are included
Documentation is changed or added
If this change updates the UI, screenshots/videos are added and a design review is requested
I have signed the MongoDB Contributor License Agreement (https://www.mongodb.com/legal/contributor-agreement)

Motivation and Context

Bugfix
New feature
Dependency update
Misc

Open Questions

Dependents

Types of changes

Backport Needed
Patch (non-breaking change which fixes an issue)
Minor (non-breaking change which adds functionality)
Major (fix or feature that would cause existing functionality to change)

…screen

jcobis · 2025-09-09T18:54:02Z

...mpass-collection/src/components/mock-data-generator-modal/raw-schema-confirmation-screen.tsx

+    ? 'A sample of document values from your collection will be sent to an LLM for processing.'
+    : 'We have identified the following schema from your documents. This schema will be sent to an LLM for processing.';
+
+  // todo: should establish if unfinished schema analysis edge case should be handled within the modal or


Alternatively, we could just disabled button

I lean towards disabling the button plus updating the hover tooltip. It would be awkward to have a modal open and the user isn't able to act on anything but wait

Feel free to go ahead and do so. We can make the tooltip copy "Schema analysis in progress" for now

Net diffs is high in this PR. I think I can weave the tooltip into CLOUDP-333853 which is already small in scope

...mpass-collection/src/components/mock-data-generator-modal/raw-schema-confirmation-screen.tsx

jcobis

Looks great Kevin! My one note is to perhaps add unit tests for RawSchemaConfirmationScreen

kpamaran · 2025-09-09T19:46:20Z

perhaps add unit tests for RawSchemaConfirmationScreen

@jcobis I made another diff test to organize the confirmation tests better. Can you re-review the test suite under on the schema confirmation step? They test the component's actual connection to redux and props usage; testing it as an unconnected unit would not provide additional coverage

…screen

...es/compass-collection/src/components/collection-header-actions/collection-header-actions.tsx

addaleax · 2025-09-09T22:36:17Z

...mpass-collection/src/components/mock-data-generator-modal/raw-schema-confirmation-screen.tsx

+    : 'Document Schema Identified';
+
+  const descriptionText = enableSampleDocumentPassing
+    ? 'A sample of document values from your collection will be sent to an LLM for processing.'


I realize this is from Figma, but just going to say, the wording here seems odd, "document value" is somewhat clear but it's definitely not standard terminology. Can this be

Suggested change

? 'A sample of document values from your collection will be sent to an LLM for processing.'

? 'A sample of documens from your collection will be sent to an LLM for processing.'

?

addaleax · 2025-09-09T22:38:14Z

...mpass-collection/src/components/mock-data-generator-modal/raw-schema-confirmation-screen.tsx

+          <Body className={descriptionStyles}>{descriptionText}</Body>
+          <Code language="javascript" copyable={false} className={codeStyles}>
+            {enableSampleDocumentPassing
+              ? JSON.stringify(schemaAnalysis.sampleDocument, null, 4)


What happens with types that are not representible in JSON?

The Figma designs seem to be aiming for something like our DocumentListView component rather than JSON

Changed to the Document component. I don't think there should be any more representation issues on the schema-only or sample-doc variants

addaleax · 2025-09-09T22:39:56Z

packages/compass-collection/src/transform-schema-to-field-info.ts

+    }
+
+    if (part.replaceAll('[]', '') === '') {
+      throw Error("expected fieldPath to have a non-empty part before '[]'");


The test is stricter than the error message here. Also, maybe not strictly necessary, but in JS you'd generally use

Suggested change

throw Error("expected fieldPath to have a non-empty part before '[]'");

throw new Error("expected fieldPath to have a non-empty part before '[]'");

addaleax · 2025-09-09T22:40:18Z

packages/compass-collection/src/transform-schema-to-field-info.ts

+ * inputs are required to simulate these unlikely errors.
+ */
+function validateFieldPath(fieldPath: string) {
+  const parts = fieldPath.split('.');


What happens if a field path element contains a .?

Discussed this with @jcobis. I acknowledge that this is possible even if the official docs actively discourage it. We're going to disable the "Generate Mock Data" button in this case with a corresponding tooltip and info-log for now

edit: we're still discussing (link) how to handle this across the whole flow (including the API)

This also has me thinking about fields whose names specifically end in []. Another edge case to consider

Started a Slack Thread

gribnoysup · 2025-09-10T08:05:57Z

You will notice that there is no syntax highlighting based on the mongo type in the schema-only variant. That may be viable with the customKeywords prop on the leafygreen Code component, but that requires 4 major version upgrades and may introduce breaking changes.

Any reason you are not using our code editor component in read only mode? It gives a better highlight, more performant, and visualizes large schemas in a more convenient way by collapsing most of the nested fields automatically. This is also more consistent with the rest of the application EDIT: Oh, Anna is right, what you have in the designs looks more like the Document component, not like a code view, but anyway not a leafygreen Code component

ncarbon · 2025-09-09T23:54:07Z

...mpass-collection/src/components/mock-data-generator-modal/mock-data-generator-modal.spec.tsx

+        )
+      ).to.exist;
+      // fragment from { "name": "John" }
+      expect(screen.queryByText('"John"')).to.exist;


Can we use getBy* instead of queryBy* where we check that an element does exist? queryBy* will not throw an error if it doesn't find the element, potentially failing silently.

ncarbon · 2025-09-10T00:08:57Z

...mpass-collection/src/components/mock-data-generator-modal/raw-schema-confirmation-screen.tsx

+    <div data-testid="raw-schema-confirmation">
+      {schemaAnalysis.status === 'complete' ? (
+        <>
+          <Body className={namespaceStyles}>{namespace}</Body>


Looks like we want to show the namespace on all screens according to Figma. This should probably go in mock-data-generator-modal.tsx so it's shared between all the screens.

kpamaran · 2025-09-10T22:31:06Z

@addaleax @gribnoysup @ncarbon I addressed latest round of diffs and updated the screenshots. There is a separate thread (link) for any additional design feedback from Maria, which I consider to be a non-blocker and can be followed up on.

jcobis · 2025-09-10T22:36:21Z

packages/compass-collection/src/transform-schema-to-field-info.ts

+      );
+    }
+
+    // Check that [] only appears as complete pairs and only at the end of the part


This may be overly stringent actually.

Relating to this comment right? #7299 (comment)

I'll remove for now

…screen

kpamaran · 2025-09-10T23:34:26Z

On the Evergreen failures. There's one cyclic dependency to resolve due to adding compass-crud as a dep to compass-collection for Document

@mongodb-js/compass-query-bar depends on @mongodb-js/compass-collection
@mongodb-js/compass-collection depends on @mongodb-js/compass-crud
@mongodb-js/compass-crud depends on @mongodb-js/compass-query-bar

The 1st dep is solely used to re-use a type. One naive way to resolve would be to delete the import and duplicate this type.

import type { CollectionTabPluginMetadata } from '@mongodb-js/compass-collection';

The 2nd dep was introduced this PR. Touching the 3rd dep is out of question. I reviewed Document's implementation and it's not quite something that can be moved to compass-components easily

Maybe there's a better alternative I'm not seeing.

gribnoysup · 2025-09-11T09:30:06Z

@kpamaran good catch, I'll open a ticket to move the document card completely out of crud, but in the meantime I think you should be able to use DocumentList.Document from @mongodb-js/compass-components instead, that's the main part that visualizes the document, everything else there is indeed actions that are mostly relevant for crud only (maybe with the exception of copy button that you can add with DocumentList.DocumentActionsGroup if you care about it)

…screen

gribnoysup · 2025-09-12T06:32:22Z

...mpass-collection/src/components/mock-data-generator-modal/raw-schema-confirmation-screen.tsx

-  borderRadius: spacing[400],
-});
+// note: the "> div" selector works around the lack of a className prop on HadronDocument
+const documentContainerStyles = css`


We prefer object notation over template literals, do you mind changing this back? Also if you want to add a className prop support to the component, feel free to do so

went the className prop route

packages/compass-collection/src/transform-schema-to-field-info.ts

jcobis

Great work Kevin!

gribnoysup

Let's remove unneeded branching logic in the action, otherwise LGTM

packages/compass-collection/src/modules/collection-tab.ts

…screen

kpamaran added 3 commits September 8, 2025 17:23

implement raw schema confirmation screen

3cf163e

Merge branch 'main' into mock-data-generator-raw-schema-confirmation-…

b4d1784

…screen

shorthand schema render logic in confirmation step

7fbb335

kpamaran requested review from ncarbon and jcobis September 9, 2025 18:47

kpamaran requested a review from a team as a code owner September 9, 2025 18:47

kpamaran added the no release notes Fix or feature not for release notes label Sep 9, 2025

github-actions bot added the feat label Sep 9, 2025

jcobis reviewed Sep 9, 2025

View reviewed changes

...mpass-collection/src/components/mock-data-generator-modal/raw-schema-confirmation-screen.tsx Outdated Show resolved Hide resolved

nit

2dfa720

jcobis reviewed Sep 9, 2025

View reviewed changes

kpamaran added 3 commits September 9, 2025 15:19

move tests

0518349

revert

be20bc1

nit

7873b6e

kpamaran requested a review from jcobis September 9, 2025 19:47

kpamaran added 3 commits September 9, 2025 16:04

Merge branch 'main' into mock-data-generator-raw-schema-confirmation-…

780c398

…screen

nit

3ce421a

nit

adf4eac

addaleax reviewed Sep 9, 2025

View reviewed changes

ncarbon reviewed Sep 10, 2025

View reviewed changes

kpamaran added 6 commits September 10, 2025 16:42

address smaller feedback

05aa795

nit

5c8e35c

rename

cf25bab

define and handle unsupported state

c13f44b

nit

833fd37

downgrade log severity

78e3f5a

add compass-crud as a dep to compass-collection

ef9dfc8

jcobis reviewed Sep 10, 2025

View reviewed changes

kpamaran added 2 commits September 10, 2025 18:36

Merge branch 'main' into mock-data-generator-raw-schema-confirmation-…

f0d817a

…screen

remove validation

65b9a9e

kpamaran added 3 commits September 11, 2025 12:07

avoid cyclical dep

e411dd9

increase readability given multipel tooltip messages

df6c2a6

Merge branch 'main' into mock-data-generator-raw-schema-confirmation-…

2b2cc7d

…screen

kpamaran requested review from addaleax, ncarbon, jcobis and a team September 11, 2025 17:11

gribnoysup reviewed Sep 12, 2025

View reviewed changes

add className prop to HadronDocument

3634213

kpamaran requested a review from gribnoysup September 12, 2025 14:47

ncarbon reviewed Sep 12, 2025

View reviewed changes

packages/compass-collection/src/transform-schema-to-field-info.ts Outdated Show resolved Hide resolved

kpamaran mentioned this pull request Sep 12, 2025

feat(generative-ai): parse faker mappings from LLM CLOUDP-341206 #7259

Closed

12 tasks

fix grammar

d178f00

kpamaran requested a review from ncarbon September 12, 2025 19:28

jcobis approved these changes Sep 12, 2025

View reviewed changes

gribnoysup approved these changes Sep 15, 2025

View reviewed changes

packages/compass-collection/src/modules/collection-tab.ts Outdated Show resolved Hide resolved

kpamaran added 3 commits September 15, 2025 10:37

Remove error handling branch

90ef737

Merge branch 'main' into mock-data-generator-raw-schema-confirmation-…

a74d752

…screen

fix sentence

e0181f0

kpamaran merged commit 0626ec8 into main Sep 15, 2025
57 of 58 checks passed

kpamaran deleted the mock-data-generator-raw-schema-confirmation-screen branch September 15, 2025 17:40

	? 'A sample of document values from your collection will be sent to an LLM for processing.'
	? 'A sample of documens from your collection will be sent to an LLM for processing.'

	throw Error("expected fieldPath to have a non-empty part before '[]'");
	throw new Error("expected fieldPath to have a non-empty part before '[]'");

feat(compass-collection): finish contents of mock data generator confirmation screen CLOUDP-333852 #7299

feat(compass-collection): finish contents of mock data generator confirmation screen CLOUDP-333852 #7299

Uh oh!

Conversation

kpamaran commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Motivation and Context

Open Questions

Dependents

Types of changes

Uh oh!

jcobis Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kpamaran Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jcobis left a comment

Choose a reason for hiding this comment

Uh oh!

kpamaran commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kpamaran Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gribnoysup commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kpamaran commented Sep 10, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kpamaran Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kpamaran commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gribnoysup commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kpamaran Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kpamaran commented Sep 9, 2025 •

edited

Loading

jcobis Sep 9, 2025 •

edited

Loading

kpamaran Sep 9, 2025 •

edited

Loading

kpamaran commented Sep 9, 2025 •

edited

Loading

kpamaran Sep 10, 2025 •

edited

Loading

gribnoysup commented Sep 10, 2025 •

edited

Loading

kpamaran Sep 10, 2025 •

edited

Loading

kpamaran commented Sep 10, 2025 •

edited

Loading

gribnoysup commented Sep 11, 2025 •

edited

Loading

kpamaran Sep 12, 2025 •

edited

Loading