feat(compass-collection): Preview Screen for Mock Data Generator CLOUDP-333857 #7433

jcobis · 2025-10-08T20:17:53Z

Description

Implements the Preview Screen for the Mock Data Generator feature.

Basing partially off this old draft PR, restarting due to lots of changes to main branch since

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)

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)

…or API - Change 'sample_values' to 'sampleValues' in FieldInfo interface to match backend API expectations - Update all test files to use the new field name - Resolves 400 Bad Request error when generating faker mappings The backend API expects 'sampleValues' (camelCase) but frontend was sending 'sample_values' (snake_case), causing the LLM request to fail with 'Invalid request' error. Fixes CLOUDP-350280

…creen-2

mabaasit · 2025-10-09T09:23:30Z

.../compass-collection/src/components/mock-data-generator-modal/script-generation-utils.spec.ts

+      expect(document).to.be.an('object');
+      expect(document).to.have.property('tags');
+      expect(document.tags).to.be.an('array').with.length(2);
+      (document.tags as string[]).forEach((tag: string) => {


[nit]: for (const tag of document.tags) makes it a bit more readable. Same at other places

mabaasit · 2025-10-09T09:32:07Z

packages/compass-collection/src/components/mock-data-generator-modal/script-generation-utils.ts

+        // Default to 1.0 for invalid probability values
+        let probability = 1.0;
+        if (
+          mapping.probability !== undefined &&


[nit]: we can remove this extra guard in favour of number check?

mabaasit · 2025-10-09T09:41:06Z

packages/compass-collection/src/components/mock-data-generator-modal/script-generation-utils.ts

+        if (probability < 1.0) {
+          // Use Math.random for conditional field inclusion
+          if (Math.random() < probability) {
+            const fakerValue = generateFakerValue(mapping);
+            if (fakerValue !== undefined) {
+              result[fieldName] = fakerValue;
+            }
+          }
+        } else {
+          // Normal field inclusion
+          const fakerValue = generateFakerValue(mapping);
+          if (fakerValue !== undefined) {
+            result[fieldName] = fakerValue;
+          }
+        }


This make it slightly more readable

Suggested change

if (probability < 1.0) {

// Use Math.random for conditional field inclusion

if (Math.random() < probability) {

const fakerValue = generateFakerValue(mapping);

if (fakerValue !== undefined) {

result[fieldName] = fakerValue;

}

}

} else {

// Normal field inclusion

const fakerValue = generateFakerValue(mapping);

if (fakerValue !== undefined) {

result[fieldName] = fakerValue;

}

}

const shouldIncludeField = probability >= 1.0 || Math.random() < probability;

const fakerValue = generateFakerValue(mapping);

if (fakerValue !== undefined && shouldIncludeField) {

result[fieldName] = fakerValue;

}

mabaasit · 2025-10-09T10:02:43Z

packages/compass-collection/src/components/mock-data-generator-modal/script-generation-utils.ts

+    try {
+      if ('mongoType' in elementType) {
+        // Array of primitives
+        const mapping = elementType as FakerFieldMapping;
+        const value = generateFakerValue(mapping);
+        if (value !== undefined) {
+          result.push(value);
+        }
+      } else if ('type' in elementType && elementType.type === 'array') {
+        // Nested array (e.g., matrix[][]) - append another [] to the path
+        const fieldPath = currentFieldPath + '[]';
+        const nestedArrayValue = constructArrayValues(
+          elementType as ArrayStructure,
+          fieldName,
+          arrayLengthMap,
+          fieldPath
+        );
+        result.push(nestedArrayValue);
+      } else {
+        // Array of objects
+        const objectValue = constructDocumentValues(
+          elementType as DocumentStructure,
+          arrayLengthMap,
+          currentFieldPath
+        );
+        result.push(objectValue);
+      }
+    } catch {
+      continue;
+    }


Why can not we reuse constructDocumentValues here to get the data for the array? Array eventually will be a list of scalar or nested array or document - which is all handled by constructDocumentValues?

I looked into this, but to reuse constructDocumentValues, we'd have to wrap elements in a temporary structure like { element: elementType } and then also extract the result after calling. This creates extra object overhead, and we'd have to break it up by case anyway due to having to conditionally construct the temp structures

addaleax · 2025-10-09T10:32:26Z

packages/compass-collection/src/components/mock-data-generator-modal/preview-screen.tsx

+        script
+      </Body>
+      <Code language="javascript" copyable={false}>
+        {JSON.stringify(sampleDocuments, null, 2)}


JSON can't represent a lot of BSON values, you probably don't ever want to use JSON.stringify() to display BSON documents.

Using EJSON.stringify() is the lazy workaround for that, but practically speaking, we would strongly prefer something like using DocumentList from compass-components instead.

@jcobis If you really want to stick to EJSON.stringify() for now, can you leave a TODO item + JIRA ticket to use DocumentList instead?

...es/compass-collection/src/components/mock-data-generator-modal/mock-data-generator-modal.tsx

…godb-js/compass into mock-data-generator-preview-screen-2

Copilot

Pull Request Overview

Implements the Preview Screen for the Mock Data Generator feature by updating schema field property naming and adding document generation capabilities.

Updated field property naming from sample_values to sampleValues for consistency with JavaScript naming conventions
Implemented document generation functionality with generateDocument function and related utilities
Added PreviewScreen component to display sample generated documents

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
transform-schema-to-field-info.ts	Updated property name from `sample_values` to `sampleValues`
transform-schema-to-field-info.spec.ts	Updated test expectations to use `sampleValues` property
schema-analysis-types.ts	Updated type definition and documentation to use `sampleValues`
to-simplified-field-info.spec.ts	Updated test data to use `sampleValues` property
script-generation-utils.ts	Added document generation functions and faker execution utilities
script-generation-utils.spec.ts	Added comprehensive tests for document generation functionality
preview-screen.tsx	New component that displays generated sample documents
mock-data-generator-modal.tsx	Integrated PreviewScreen component into modal workflow
mock-data-generator-modal.spec.tsx	Updated test data to use `sampleValues` property
collection-header.spec.tsx	Updated test data to use `sampleValues` property

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

jcobis added 6 commits October 8, 2025 15:58

WIP

7db2f1c

WIP

1be3845

Revert comment

3b307d4

Revert comment

8eb00a2

jcobis changed the base branch from main to CLOUDP-350280-clean October 8, 2025 21:10

jcobis added no release notes Fix or feature not for release notes feat labels Oct 8, 2025

Merge branch 'CLOUDP-350280-clean' into mock-data-generator-preview-s…

50969d8

…creen-2

jcobis marked this pull request as ready for review October 8, 2025 21:30

jcobis requested a review from a team as a code owner October 8, 2025 21:30

jcobis requested review from ivandevp and kpamaran and removed request for a team October 8, 2025 21:30

mabaasit reviewed Oct 9, 2025

View reviewed changes

addaleax reviewed Oct 9, 2025

View reviewed changes

Base automatically changed from CLOUDP-350280-clean to main October 9, 2025 15:25

kpamaran reviewed Oct 9, 2025

View reviewed changes

...es/compass-collection/src/components/mock-data-generator-modal/mock-data-generator-modal.tsx Show resolved Hide resolved

jcobis added 4 commits October 9, 2025 12:15

For of instead of foreach

236e40f

Remove undefined check

b62de6e

Refactor for readability

d662069

EJSON

69a4693

jcobis requested review from addaleax and mabaasit October 9, 2025 17:01

Merge branch 'mock-data-generator-preview-screen-2' of github.com:mon…

665d29a

…godb-js/compass into mock-data-generator-preview-screen-2

Copilot AI review requested due to automatic review settings October 9, 2025 17:44

Copilot AI reviewed Oct 9, 2025

View reviewed changes

Merge branch 'main' into mock-data-generator-preview-screen-2

ae408c8

jcobis requested a review from kpamaran October 9, 2025 17:47

jcobis changed the title ~~feat(compass-collection): Preview Screen for Mock Data Generator – CLOUDP-333857~~ feat(compass-collection): Preview Screen for Mock Data Generator CLOUDP-333857 Oct 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(compass-collection): Preview Screen for Mock Data Generator CLOUDP-333857 #7433

feat(compass-collection): Preview Screen for Mock Data Generator CLOUDP-333857 #7433

Uh oh!

jcobis commented Oct 8, 2025 •

edited

Loading

Uh oh!

mabaasit Oct 9, 2025

Uh oh!

mabaasit Oct 9, 2025

Uh oh!

mabaasit Oct 9, 2025

Uh oh!

jcobis Oct 9, 2025

Uh oh!

mabaasit Oct 9, 2025

Uh oh!

jcobis Oct 9, 2025

Uh oh!

addaleax Oct 9, 2025

Uh oh!

addaleax Oct 10, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

feat(compass-collection): Preview Screen for Mock Data Generator CLOUDP-333857 #7433

Are you sure you want to change the base?

feat(compass-collection): Preview Screen for Mock Data Generator CLOUDP-333857 #7433

Uh oh!

Conversation

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

Uh oh!

Description

Checklist

Types of changes

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

jcobis commented Oct 8, 2025 •

edited

Loading