feat(compass-collection): Connect schema redux state to modal and filter collections based on nesting depth - CLOUDP-342665 #7283

jcobis · 2025-09-04T14:33:24Z

Description

Connects Redux hasData state to collection-header-actions component to disable Mock Data Generator button for empty collections
Filters deeply nested collections: The Mock Data Generator button now only appears for collections with a maximum nesting depth of 3 levels or fewer. Collections with 4 or more levels of nested documents or arrays will not show the button
Gates schema analysis action behind experiment check

Collection Has Data - Button Displayed and Enabled

Empty Collection - Button Disabled

Button Opens Modal

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)

Copilot

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

kpamaran · 2025-09-04T14:50:19Z

packages/compass-collection/src/components/collection-header/collection-header.tsx

  editViewName?: string;
  sourcePipeline?: unknown[];
  onOpenMockDataModal: () => void;
+  hasData: boolean;


Rename hasData to hasSchemaAnalysisData and maxNestingDepth to something like analyzedSchemaDepth (see my other comment)

kpamaran · 2025-09-04T14:52:34Z

packages/compass-collection/src/components/collection-header/collection-header.tsx

+  return {
+    hasData:
+      schemaAnalysis.status === SCHEMA_ANALYSIS_STATE_COMPLETE &&
+      schemaAnalysis.processedSchema &&


[nit] Remove the check for schemaAnalysis.processedSchema. The typing of schemaAnalysis dictates if the status is complete then processedSchema will always exist. This suggestion applies to schemaAnalysis.schemaMetadata as well

kpamaran · 2025-09-04T15:03:33Z

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

-
-  const hasData = true; // TODO: CLOUDP-337090
+    !sourceName && // sourceName indicates it's a view
+    maxNestingDepth < 4; // Filter out overly nested collections (4+ levels)


The name maxNestingDepth sounds like a configuration that should be holding the 4, but maxNestingDepth is computed from calculateSchemaDepth . It should be renamed to schemaDepth while the name maxNestingDepth should be re-purposed *(or renamed using "limit") to hold the magic value

edit*

...mpass-collection/src/components/collection-header-actions/collection-header-actions.spec.tsx

ncarbon · 2025-09-04T16:41:46Z

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

-
-  const hasData = true; // TODO: CLOUDP-337090
+    !sourceName && // sourceName indicates it's a view
+    analyzedSchemaDepth < MAX_COLLECTION_NESTING_DEPTH; // Filter out overly nested collections


q - Do we care about observing when analyzedSchemaDepth < MAX_COLLECTION_NESTING_DEPTH ? If so, might be worth doing this check in the thunk and logging it there.

Interesting thought. I can ask analytics

In the meantime, if we do decide on this, how about we include this change as part of the analytics ticket?

kpamaran · 2025-09-04T17:09:40Z

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

-
-  const hasData = true; // TODO: CLOUDP-337090
+    !sourceName && // sourceName indicates it's a view
+    analyzedSchemaDepth < MAX_COLLECTION_NESTING_DEPTH; // Filter out overly nested collections


nit: max is an inclusive term so use <= and change to 3 instead

kpamaran · 2025-09-04T17:23:03Z

lgtm. did a line by line level review and tests seems consistent with the repo's code style. of course, deferring to compass-developers for final approval

Anemy · 2025-09-08T15:26:49Z

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

-
-  const hasData = true; // TODO: CLOUDP-337090
+    !sourceName && // sourceName indicates it's a view
+    analyzedSchemaDepth <= MAX_COLLECTION_NESTING_DEPTH; // Filter out overly nested collections


Filters deeply nested collections: The Mock Data Generator button now only appears for collections with a maximum nesting depth of 3 levels or fewer. Collections with 4 or more levels of nested documents or arrays will not show the button

Have we considered instead keeping the button and having it disabled with a tooltip? As a user I could see it being confusing why its showing up on one collection and not another. Additionally if the button is showing and then vanishes.

I'm also a bit curious on this requirement, what is the cause of this limitation? Maybe we can mention that in a comment.

Good question, this was something that I brought up to Designs as well, and where they decided to hide the button. (See Kevin's question about the same thing)

Left a comment in that thread, I think we should bring it back up with design with the considerations. Right now this would be introducing some confusing UX for users and some UI that asynchronously disappears without indication.

Got the okay from design in the thread, not too sure on the text though, left a suggestion but feel free to interpret it in a way that makes sense to you!

At this time we are unable to generate mock data for collections with documents that have a deeply nested schema.

Responded in the Figma thread with a few slight copy suggestions!

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

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

Anemy · 2025-09-08T17:48:06Z

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

+        }
+      };
+
+      void shouldRunSchemaAnalysis().then((shouldRun) => {


We want to cancel or skip the analysis if the tab is closed / plugin is deactivated and the cleanup method is called. One way other places in Compass do this is with an abort controller which is passed to methods that take it, like sample() in analyzeCollectionSchema(). We can use the addCleanup helper and abort then.

Here's an example:

compass/packages/compass-schema/src/stores/store.ts

Line 96 in 0d862f2

addCleanup(() => store.dispatch(cancelExportSchema()));

Anemy

Nice! Thanks for also addressing the analysis being run without the experiment here!

jcobis added 2 commits September 4, 2025 08:46

WIP

a298132

WIP

a3052fc

Copilot AI review requested due to automatic review settings September 4, 2025 14:33

jcobis requested a review from a team as a code owner September 4, 2025 14:33

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

Merge branch 'main' into CLOUDP-342665

fb8505b

jcobis added the no release notes Fix or feature not for release notes label Sep 4, 2025

Copilot AI reviewed Sep 4, 2025

View reviewed changes

jcobis requested review from kpamaran and ncarbon September 4, 2025 14:44

Merge branch 'main' into CLOUDP-342665

031c2a3

kpamaran reviewed Sep 4, 2025

View reviewed changes

jcobis added 3 commits September 4, 2025 10:20

Handle undefined

4050da7

Comments

5a4fbfc

Move tests

a133e0a

jcobis requested a review from kpamaran September 4, 2025 16:21

ncarbon reviewed Sep 4, 2025

View reviewed changes

kpamaran reviewed Sep 4, 2025

View reviewed changes

kpamaran approved these changes Sep 4, 2025

View reviewed changes

jcobis and others added 2 commits September 4, 2025 12:39

Address comment

0a0ab7b

Merge branch 'main' into CLOUDP-342665

18c4d75

jcobis requested a review from ncarbon September 4, 2025 17:47

Merge branch 'main' into CLOUDP-342665

932193f

Anemy reviewed Sep 8, 2025

View reviewed changes

jcobis added 2 commits September 8, 2025 13:22

Add getAssignment to experimentation interface

fc34475

Dependency updates

137267c

Anemy reviewed Sep 8, 2025

View reviewed changes

jcobis and others added 2 commits September 8, 2025 14:19

Hide button tooltip while analysis in progress

73e7a45

Merge branch 'main' into CLOUDP-342665

73cb0b1

jcobis added 2 commits September 8, 2025 16:31

Address comment to add tooltip

e37fc16

Add thunk action abort signal cancellation

e0c9a0a

Anemy approved these changes Sep 8, 2025

View reviewed changes

jcobis merged commit d8a0d16 into main Sep 9, 2025
56 of 60 checks passed

jcobis deleted the CLOUDP-342665 branch September 9, 2025 13:28

jcobis mentioned this pull request Sep 9, 2025

feat(compass-collection): gate experiment feature behind redux state check instead of hook call - CLOUDP-344022 #7298

Draft

7 tasks

kpamaran mentioned this pull request Sep 9, 2025

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

Merged

12 tasks

feat(compass-collection): Connect schema redux state to modal and filter collections based on nesting depth - CLOUDP-342665 #7283

feat(compass-collection): Connect schema redux state to modal and filter collections based on nesting depth - CLOUDP-342665 #7283

Uh oh!

Conversation

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

Uh oh!

Description

Collection Has Data - Button Displayed and Enabled

Empty Collection - Button Disabled

Button Opens Modal

Types of changes

Uh oh!

Copilot AI 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!

kpamaran Sep 4, 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!

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 4, 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 4, 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!

jcobis Sep 8, 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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Anemy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jcobis commented Sep 4, 2025 •

edited

Loading

kpamaran Sep 4, 2025 •

edited

Loading

kpamaran Sep 4, 2025 •

edited

Loading

kpamaran commented Sep 4, 2025 •

edited

Loading

jcobis Sep 8, 2025 •

edited

Loading