Merge remote-tracking branch 'origin/main' into beta-releases

Author: github-actions[bot]

THIRD-PARTY-NOTICES.md

@@ -1,5 +1,5 @@
 The following third-party software is used by and included in **Mongodb Compass**.
-This document was automatically generated on Mon Mar 10 2025.
+This document was automatically generated on Sun Mar 16 2025.
 
 ## List of dependencies
 

docs/tracking-plan.md

@@ -7,7 +7,7 @@
 > the tracking plan for the specific Compass version you can use the following
 > URL: `https://github.com/mongodb-js/compass/blob/<compass version>/docs/tracking-plan.md`
 
-Generated on Mon, Mar 10, 2025
+Generated on Sun, Mar 16, 2025
 
 ## Table of Contents
 
@@ -162,6 +162,7 @@ Generated on Mon, Mar 10, 2025
 - [Schema Validation Added](#event--SchemaValidationAddedEvent)
 - [Schema Validation Edited](#event--SchemaValidationEditedEvent)
 - [Schema Validation Updated](#event--SchemaValidationUpdatedEvent)
+- [Schema Validation Generated](#event--SchemaValidationGeneratedEvent)
 
 ### Settings
 - [Theme Changed](#event--ThemeChangedEvent)
@@ -1995,6 +1996,22 @@ This event is fired when user saves validation rules.
 - **connection_id** (optional): `string | undefined`
   - The id of the connection associated to this event.
 
+<a name="event--SchemaValidationGeneratedEvent"></a>
+
+### Schema Validation Generated
+
+This event is fired when user generates validation rules.
+
+**Properties**:
+
+- **variable_type_count** (required): `number`
+- **optional_field_count** (required): `number`
+  - The count of fields that don't appear on all documents.
+This is only calculated for the top level fields, not nested fields and arrays.
+- **is_compass_web** (optional): `true | undefined`
+- **connection_id** (optional): `string | undefined`
+  - The id of the connection associated to this event.
+
 
 ## Settings
 

packages/compass-schema-validation/src/modules/rules-generation.ts

@@ -4,6 +4,12 @@ import { enableEditRules } from './edit-mode';
 import type { MongoError } from 'mongodb';
 import type { Action, AnyAction, Reducer } from 'redux';
 import { validationLevelChanged, validatorChanged } from './validation';
+import {
+  type analyzeSchema as analyzeSchemaType,
+  calculateSchemaMetadata,
+} from '@mongodb-js/compass-schema';
+import type { TrackFunction } from '@mongodb-js/compass-telemetry';
+import type { ConnectionInfoRef } from '@mongodb-js/compass-connections/provider';
 
 export function isAction<A extends AnyAction>(
   action: AnyAction,
@@ -150,6 +156,29 @@ export const stopRulesGeneration = (): SchemaValidationThunkAction<void> => {
   };
 };
 
+const _trackRulesGenerated = async ({
+  schemaAccessor,
+  track,
+  connectionInfoRef,
+}: {
+  schemaAccessor: Awaited<ReturnType<typeof analyzeSchemaType>>;
+  track: TrackFunction;
+  connectionInfoRef: ConnectionInfoRef;
+}) => {
+  const internalSchema = await schemaAccessor?.getInternalSchema();
+  if (!internalSchema) return;
+  const { variable_type_count, optional_field_count } =
+    await calculateSchemaMetadata(internalSchema);
+  track(
+    'Schema Validation Generated',
+    {
+      variable_type_count,
+      optional_field_count,
+    },
+    connectionInfoRef.current
+  );
+};
+
 /**
  * Get $jsonSchema from schema analysis
  * @returns
@@ -166,6 +195,8 @@ export const generateValidationRules = (): SchemaValidationThunkAction<
       preferences,
       rulesGenerationAbortControllerRef,
       analyzeSchema,
+      track,
+      connectionInfoRef,
     }
   ) => {
     dispatch({ type: RulesGenerationActions.generationStarted });
@@ -214,6 +245,12 @@ export const generateValidationRules = (): SchemaValidationThunkAction<
       dispatch(enableEditRules());
       dispatch({ type: RulesGenerationActions.generationFinished });
       dispatch(zeroStateChanged(false));
+
+      void _trackRulesGenerated({
+        schemaAccessor,
+        connectionInfoRef,
+        track,
+      });
     } catch (error) {
       if (abortSignal.aborted) {
         dispatch({ type: RulesGenerationActions.generationFinished });

packages/compass-schema-validation/src/modules/validation.spec.ts

@@ -9,15 +9,13 @@ import reducer, {
   validationFetched,
   validationCanceled,
   validationSaveFailed,
-  syntaxErrorOccurred,
   validationFromCollection,
   VALIDATOR_CHANGED,
   VALIDATION_CANCELED,
   VALIDATION_SAVE_FAILED,
   VALIDATION_FETCHED,
   VALIDATION_ACTION_CHANGED,
   VALIDATION_LEVEL_CHANGED,
-  SYNTAX_ERROR_OCCURRED,
 } from './validation';
 
 describe('validation module', function () {
@@ -119,15 +117,6 @@ describe('validation module', function () {
     });
   });
 
-  describe('#syntaxErrorOccurred', function () {
-    it('returns the SYNTAX_ERROR_OCCURRED action', function () {
-      expect(syntaxErrorOccurred({ message: 'Syntax Error!' })).to.deep.equal({
-        type: SYNTAX_ERROR_OCCURRED,
-        syntaxError: { message: 'Syntax Error!' },
-      });
-    });
-  });
-
   describe('validationFromCollection', function () {
     context('when an error occurs listing the collection', function () {
       it('includes the error', function () {
@@ -324,23 +313,5 @@ describe('validation module', function () {
         });
       });
     });
-
-    context('when the action is syntaxErrorOccurred', function () {
-      it('returns the new state', function () {
-        const validation = reducer(
-          undefined,
-          syntaxErrorOccurred({ message: 'Syntax Error!' })
-        );
-
-        expect(validation).to.deep.equal({
-          validator: '',
-          validationAction: 'error',
-          validationLevel: 'strict',
-          isChanged: true,
-          syntaxError: { message: 'Syntax Error!' },
-          error: null,
-        });
-      });
-    });
   });
 });

packages/compass-schema-validation/src/modules/validation.ts

@@ -75,23 +75,13 @@ interface ValidationLevelChangedAction {
   validationLevel: ValidationLevel;
 }
 
-/**
- * Syntax error occurred action name.
- */
-export const SYNTAX_ERROR_OCCURRED = `${PREFIX}/SYNTAX_ERROR_OCCURRED` as const;
-interface SyntaxErrorOccurredAction {
-  type: typeof SYNTAX_ERROR_OCCURRED;
-  syntaxError: null | { message: string };
-}
-
 export type ValidationAction =
   | ValidatorChangedAction
   | ValidationCanceledAction
   | ValidationSaveFailedAction
   | ValidationFetchedAction
   | ValidationActionChangedAction
-  | ValidationLevelChangedAction
-  | SyntaxErrorOccurredAction;
+  | ValidationLevelChangedAction;
 
 export interface Validation {
   validator: string;
@@ -178,18 +168,6 @@ const changeValidator = (
   };
 };
 
-/**
- * Sets syntax error.
- */
-const setSyntaxError = (
-  state: ValidationState,
-  action: SyntaxErrorOccurredAction
-): ValidationState => ({
-  ...state,
-  isChanged: true,
-  syntaxError: action.syntaxError,
-});
-
 /**
  * Set validation.
  */
@@ -291,7 +269,6 @@ const MAPPINGS: {
   [VALIDATION_SAVE_FAILED]: setError,
   [VALIDATION_ACTION_CHANGED]: changeValidationAction,
   [VALIDATION_LEVEL_CHANGED]: changeValidationLevel,
-  [SYNTAX_ERROR_OCCURRED]: setSyntaxError,
 };
 
 /**
@@ -372,16 +349,6 @@ export const validationSaveFailed = (error: {
   error,
 });
 
-/**
- * Action creator for syntax error occurred events.
- */
-export const syntaxErrorOccurred = (
-  syntaxError: null | { message: string }
-): SyntaxErrorOccurredAction => ({
-  type: SYNTAX_ERROR_OCCURRED,
-  syntaxError,
-});
-
 export const fetchValidation = (namespace: {
   database: string;
   collection: string;

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

@@ -82,6 +82,11 @@ const schemaAccessor = {
       setTimeout(() => resolve({ required: ['prop1'] }), 100); // waiting to give abort a chance
     });
   },
+  getInternalSchema: () => {
+    return new Promise((resolve) => {
+      setTimeout(() => resolve({ required: ['prop1'] }), 100); // waiting to give abort a chance
+    });
+  },
 };
 
 describe('Schema Validation Store', function () {

packages/compass-telemetry/src/telemetry-events.ts

@@ -1906,6 +1906,27 @@ type SchemaValidationUpdatedEvent = ConnectionScopedEvent<{
   };
 }>;
 
+/**
+ * This event is fired when user generates validation rules.
+ *
+ * @category Schema Validation
+ */
+type SchemaValidationGeneratedEvent = ConnectionScopedEvent<{
+  name: 'Schema Validation Generated';
+  payload: {
+    /* The count of fields with multiple types in a given schema (not counting undefined).
+     * This is only calculated for the top level fields, not nested fields and arrays.
+     */
+    variable_type_count: number;
+
+    /**
+     * The count of fields that don't appear on all documents.
+     * This is only calculated for the top level fields, not nested fields and arrays.
+     */
+    optional_field_count: number;
+  };
+}>;
+
 /**
  * This event is fired when user adds validation rules.
  *
@@ -2754,6 +2775,7 @@ export type TelemetryEvent =
   | SchemaValidationAddedEvent
   | SchemaValidationEditedEvent
   | SchemaValidationUpdatedEvent
+  | SchemaValidationGeneratedEvent
   | ScreenEvent
   | ShellEvent
   | SignalActionButtonClickedEvent

packages/compass/src/app/index.tsx

@@ -10,7 +10,7 @@ import { globalAppRegistry } from 'hadron-app-registry';
 import { defaultPreferencesInstance } from 'compass-preferences-model';
 import semver from 'semver';
 import { CompassElectron } from './components/entrypoint';
-import { openToast } from '@mongodb-js/compass-components';
+import { openToast, ToastBody } from '@mongodb-js/compass-components';
 
 // https://github.com/nodejs/node/issues/40537
 dns.setDefaultResultOrder('ipv4first');
@@ -324,6 +324,28 @@ const app = {
     ipcRenderer?.on('compass:open-import', () => {
       globalAppRegistry.emit('open-active-namespace-import');
     });
+    ipcRenderer?.on('download-finished', (event, { path }) => {
+      openToast('file-download-complete', {
+        title: 'Success',
+        description: (
+          <ToastBody
+            statusMessage="File download complete"
+            actionHandler={() => ipcRenderer?.send('show-file', path)}
+            actionText="show file"
+          />
+        ),
+        variant: 'success',
+      });
+    });
+    ipcRenderer?.on('download-failed', (event, { filename }) => {
+      openToast('file-download-failed', {
+        title: 'Failure',
+        description: filename
+          ? `Failed to download ${filename}`
+          : 'Download failed',
+        variant: 'warning',
+      });
+    });
     // Autoupdate handlers
     ipcRenderer?.on(
       'autoupdate:download-update-externally',

packages/compass/src/main/application.ts

@@ -470,6 +470,23 @@ class CompassApplication {
     // Accessing defaultSession is not allowed when app is not ready
     await app.whenReady();
 
+    session.defaultSession.on(
+      'will-download',
+      function (event, item, webContents) {
+        item.once('done', (event, state) => {
+          if (state === 'completed') {
+            webContents.send('download-finished', {
+              path: item.getSavePath(),
+            });
+          } else if (state === 'interrupted') {
+            webContents.send('download-failed', {
+              filename: item.getFilename(),
+            });
+          }
+        });
+      }
+    );
+
     session.defaultSession.webRequest.onBeforeSendHeaders(
       allowedCloudEndpoints,
       (details, callback) => {