feat(compass-collection): Process schema into format for LLM submission for Mock Data Generator – CLOUDP-337090 #7205

jcobis · 2025-08-15T21:35:32Z

Description

Converts MongoDB raw schema analysis object into a flat, LLM-friendly format for the Mock Data Generator feature.

Nested documents are represented with dot notation (e.g., user.profile.name)
Uses bracket notation for arrays (e.g., users[], matrix[][])
Maintains field sample values

Notation examples:

Nested documents: user.profile.name (dot notation)
Array: users[] (bracket notation)
Nested arrays: matrix[][] (multiple brackets)
Nested array of documents fields: users[].name (brackets + dots)

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

Motivation and Context

The existing mongodb-schema structure is overly verbose for our feature and contains nested structures that are both difficult for LLMs to parse and do not correspond to the requirements of LLM structured outputs (eg. no optional fields).

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)

…90_v2

… CLOUDP-337090_v2

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

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

kpamaran · 2025-08-19T18:01:14Z

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

+
+    const result = processSchema(schema);
+
+    expect(result).to.deep.equal({


ah this is a good example of how the dot notation combined with the constraints we've placed simplifies the parsing and surface area for the LLM to write to

kpamaran · 2025-08-19T18:09:44Z

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

+                    {
+                      name: 'Array',
+                      bsonType: 'Array',
+                      path: ['cube'],


To confirm my understanding, the path stays as ['cube'] because the named field/path captures arrays-within-arrays at all levels (and until there's a document)?

Yes, from my understanding

kpamaran · 2025-08-19T18:12:03Z

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

+
+    const result = processSchema(schema);
+
+    expect(result).to.deep.equal({


good example here and below 👍🏼

kpamaran · 2025-08-19T18:17:04Z

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

+  fieldProbability?: number,
+  arraySampleValues?: unknown[]
+): void {
+  if (type.name === 'Array' || type.bsonType === 'Array') {


Should use the type-predicate validators like isArraySchemaType in compass-schema/src/components/field.tsx

Type guards will give you the branch in a program enough type information to prevent casts like type as ArraySchemaType

See https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates

kpamaran · 2025-08-19T18:27:50Z

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

+
+    const arrayPath = `${currentPath}[]`;
+    const sampleValues =
+      arraySampleValues || getSampleValues(arrayType).slice(0, 3); // Limit full-context array sample values to 3


nit: instead of the magic 3, use a constant

kpamaran

had some minor feedback; lgtm overall

ncarbon · 2025-08-19T19:02:37Z

packages/compass-collection/src/schema-analysis-types.ts

@@ -30,9 +29,16 @@ export type SchemaAnalysisErrorState = {
  error: SchemaAnalysisError;
 };

+export interface FieldInfo {
+  type: string; // MongoDB type (eg. String, Double, Array, Document)


could type be a string union type?

…90_v2

kpamaran · 2025-08-20T19:49:46Z

packages/compass-collection/package.json

@@ -66,7 +66,8 @@
    "react": "^17.0.2",
    "react-redux": "^8.1.3",
    "redux": "^4.2.1",
-    "redux-thunk": "^2.4.2"
+    "redux-thunk": "^2.4.2",
+    "bson": "^6.10.1"


since bson is only used for its types, it should be a dev dependency so it doesn't get bundled to prod

The dependency checker was still complaining even with using import type.

I tried adding 'bson' to the ignores in packages/compass-collection/.depcheckrc. But not sure

kpamaran · 2025-08-20T19:53:06Z

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

+
+function isPrimitiveSchemaType(type: SchemaType): type is PrimitiveSchemaType {
+  return (
+    !isConstantSchemaType(type) &&


[nit] null and undefined classify as primitives too

Basing off here: https://github.com/mongodb-js/mongodb-schema/blob/6f22cb72aaaf97a0bbbb6ae92a4fdadc4290db67/src/schema-analyzer.ts#L67

weird, let's go with consistency then. I disagree with that source's typing but it may be working around some type issue

Anemy

Left a comment on where this helper lands. Not really a blocker. Approving incase this blocks other work, but it would be nice to have this in the shared spot if possible and y'all think its worth having there.

Anemy · 2025-08-21T18:09:17Z

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

+ * Transforms a raw mongodb-schema Schema into a flat Record<string, FieldInfo>
+ * using dot notation for nested fields and bracket notation for arrays.
+ */
+export function processSchema(schema: Schema): Record<string, FieldInfo> {


Should we add this to the https://github.com/mongodb-js/mongodb-schema package?
That way places like the VSCode extension, and other parts of Compass can use it more easily.

Looks like there's already a getSchemaPaths we have on the schema analysis that we're using in Compass' import-export already. It's similar but not the same.
https://github.com/mongodb-js/mongodb-schema/blob/6f22cb72aaaf97a0bbbb6ae92a4fdadc4290db67/src/schema-analyzer.ts#L640

In import-export:

compass/packages/compass-import-export/src/export/gather-fields.ts

Line 75 in 8f183d0

async function _gatherFields({

Maybe we add some options to the getSchemaPaths or have it as a separate function on the SchemaAnalyzer?

That's a good idea. How does this sound: if/when this code could be re-used effectively, we can consider whether moving it to the https://github.com/mongodb-js/mongodb-schema package would be good. (Note also that we are releasing this feature as an experiment (A/B test) that we may iterate on)

jcobis and others added 22 commits August 8, 2025 11:46

WIP

8f9d83f

WIP

a0b79e0

Re order buttons

15ff5d3

WIP

6f3f320

Rename datatest-id

8935d22

Merge branch 'main' into CLOUDP-333847

777ab8b

Move state to redux

5163ed7

Update tests per comments

f13950b

Merge branch 'main' of github.com:mongodb-js/compass into CLOUDP-333847

ceefa80

Fix import

e0d431f

Test file

6abe239

Tests cleanup

7d3b7fb

Add tests

7b3c4ba

Rename actions; Remove action wrapper

607ff03

Merge branch 'main' of github.com:mongodb-js/compass into CLOUDP-333847

ff4ce2d

Address comments

bcff32e

WIP

f2151f4

WIP

8d0d47f

Merge branch 'main' of github.com:mongodb-js/compass into CLOUDP-333847

ff558cd

Merge branch 'main' into CLOUDP-333847

920df5f

Merge branch 'main' of github.com:mongodb-js/compass into CLOUDP-333847

6d9061c

Process schema

9fedf3f

This was referenced Aug 15, 2025

feat(compass-collection): Collection Header Experimentation Integration for Mock Data Generator – CLOUDP-333847 #7181

Merged

WIP Confirmation Screen #7204

Draft

Base automatically changed from CLOUDP-333847 to main August 18, 2025 16:18

jcobis added 5 commits August 18, 2025 13:52

WIP

f81571e

WIP

456225c

WIP

1a70ed3

Merge branch 'main' of github.com:mongodb-js/compass into CLOUDP-3370…

0dbab78

…90_v2

WIP

891b707

jcobis requested a review from a team as a code owner August 19, 2025 17:10

jcobis added 2 commits August 19, 2025 13:24

WIP

b50e797

Merge branch 'CLOUDP-337090_v2' of github.com:mongodb-js/compass into…

6e5318f

… CLOUDP-337090_v2

kpamaran reviewed Aug 19, 2025

View reviewed changes

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

Copilot AI reviewed Aug 19, 2025

View reviewed changes

kpamaran reviewed Aug 19, 2025

View reviewed changes

kpamaran approved these changes Aug 19, 2025

View reviewed changes

ncarbon reviewed Aug 19, 2025

View reviewed changes

jcobis added 9 commits August 19, 2025 18:42

WIP

a0415c2

Add more test

0a6f9c1

Merge branch 'main' of github.com:mongodb-js/compass into CLOUDP-3370…

054176e

…90_v2

Use type predicate validators

55088ba

Constants validator

1524be4

Create constant value

c502a78

Package lock update

f221923

Types

03f3cd8

Package Lock

476d003

kpamaran reviewed Aug 20, 2025

View reviewed changes

kpamaran approved these changes Aug 20, 2025

View reviewed changes

Address comment

e4db17c

kpamaran approved these changes Aug 21, 2025

View reviewed changes

jcobis requested a review from ncarbon August 21, 2025 17:39

Anemy approved these changes Aug 21, 2025

View reviewed changes

jcobis merged commit 97a35b4 into main Aug 21, 2025
57 of 59 checks passed

jcobis deleted the CLOUDP-337090_v2 branch August 21, 2025 19:31


		const result = processSchema(schema);

		expect(result).to.deep.equal({

feat(compass-collection): Process schema into format for LLM submission for Mock Data Generator – CLOUDP-337090 #7205

feat(compass-collection): Process schema into format for LLM submission for Mock Data Generator – CLOUDP-337090 #7205

Uh oh!

Conversation

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

Uh oh!

Description

Checklist

Motivation and Context

Types of changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

kpamaran Aug 19, 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 Aug 19, 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!

kpamaran Aug 19, 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 Aug 19, 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!

kpamaran left a comment

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!

jcobis Aug 20, 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 Aug 20, 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!

kpamaran Aug 20, 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!

Anemy left a comment

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!

Uh oh!

jcobis commented Aug 15, 2025 •

edited

Loading

kpamaran Aug 19, 2025 •

edited

Loading

kpamaran Aug 19, 2025 •

edited

Loading

kpamaran Aug 19, 2025 •

edited

Loading

kpamaran Aug 19, 2025 •

edited

Loading

jcobis Aug 20, 2025 •

edited

Loading

kpamaran Aug 20, 2025 •

edited

Loading

kpamaran Aug 20, 2025 •

edited

Loading