chore: improve types and documentation for telemetry (#6176)

* chore: improve types and documentation for telemetry * fix test and mixed up branches * add is_favorite and document identify traits * improve modeForTelemetry type * remove unnecessary as const
mongodb-js · Sep 10, 2024 · bea9599 · bea9599
1 parent 1e040df
commit bea9599
Show file tree

Hide file tree

Showing 13 changed files with 1,219 additions and 286 deletions.
diff --git a/packages/compass-aggregations/src/components/stage-editor/stage-editor.spec.tsx b/packages/compass-aggregations/src/components/stage-editor/stage-editor.spec.tsx
@@ -23,7 +23,7 @@ describe('StageEditor [Component]', function () {
         syntaxError={null}
         serverError={null}
         num_stages={0}
-        editor_view_type=""
+        editor_view_type="text"
       />
     );
   });

diff --git a/packages/compass-aggregations/src/components/stage-editor/stage-editor.tsx b/packages/compass-aggregations/src/components/stage-editor/stage-editor.tsx
@@ -77,7 +77,7 @@ type StageEditorProps = {
   syntaxError: PipelineParserError | null;
   serverError: MongoServerError | null;
   num_stages: number;
-  editor_view_type: string;
+  editor_view_type: 'text' | 'stage' | 'focus';
   className?: string;
   onChange: (index: number, value: string) => void;
   editorRef?: React.Ref<EditorRef>;

diff --git a/packages/compass-connections/src/stores/connections-store-redux.ts b/packages/compass-connections/src/stores/connections-store-redux.ts
@@ -1521,9 +1521,6 @@ export const connect = (
         'Connection Attempt',
         {
           is_favorite: connectionInfo.savedConnectionType === 'favorite',
-          is_recent:
-            !!connectionInfo.lastUsed &&
-            connectionInfo.savedConnectionType !== 'favorite',
           is_new: isNewConnection(getState(), connectionInfo.id),
         },
         connectionInfo

diff --git a/packages/compass-crud/src/stores/crud-store.ts b/packages/compass-crud/src/stores/crud-store.ts
@@ -489,7 +489,7 @@ class CrudStoreImpl
    * to update if the labels change at some point.
    */
   modeForTelemetry() {
-    return this.state.view.toLowerCase();
+    return this.state.view.toLowerCase() as Lowercase<DocumentView>;
   }
 
   /**

diff --git a/packages/compass-e2e-tests/tests/logging.test.ts b/packages/compass-e2e-tests/tests/logging.test.ts
@@ -89,7 +89,6 @@ describe('Logging and Telemetry integration', function () {
           .events()
           .find((entry) => entry.event === 'Connection Attempt');
         expect(connectionAttempt.properties.is_favorite).to.equal(false);
-        expect(connectionAttempt.properties.is_recent).to.equal(false);
         expect(connectionAttempt.properties.is_new).to.equal(true);
       });
 

diff --git a/packages/compass-export-to-language/src/components/modal.tsx b/packages/compass-export-to-language/src/components/modal.tsx
@@ -146,51 +146,67 @@ const ExportToLanguageModal: React.FunctionComponent<
   const [wasOpen, setWasOpen] = useState(false);
 
   useEffect(() => {
-    const trackingEvent =
-      mode === 'Update Query'
-        ? 'Update Export Opened'
-        : mode === 'Delete Query'
-        ? 'Delete Export Opened'
-        : mode === 'Query'
-        ? 'Query Export Opened'
-        : 'Aggregation Export Opened';
-
     if (modalOpen && !wasOpen) {
       const connectionInfo = connectionInfoAccess.getCurrentConnectionInfo();
-      track(
-        trackingEvent,
-        {
-          ...stageCountForTelemetry(inputExpression),
-        },
-        connectionInfo
-      );
+
+      if (mode === 'Query') {
+        track('Query Export Opened', {}, connectionInfo);
+      } else if (mode === 'Delete Query') {
+        track('Delete Export Opened', {}, connectionInfo);
+      } else if (mode === 'Update Query') {
+        track('Update Export Opened', {}, connectionInfo);
+      } else if (mode === 'Pipeline') {
+        track(
+          'Aggregation Export Opened',
+          {
+            ...stageCountForTelemetry(inputExpression),
+          },
+          connectionInfo
+        );
+      }
+
       track('Screen', { name: 'export_to_language_modal' }, connectionInfo);
     }
 
     setWasOpen(modalOpen);
   }, [modalOpen, wasOpen, mode, inputExpression, track, connectionInfoAccess]);
 
   const trackCopiedOutput = useCallback(() => {
-    const trackingEvent =
-      mode === 'Update Query'
-        ? 'Update Exported'
-        : mode === 'Delete Query'
-        ? 'Delete Exported'
-        : mode === 'Query'
-        ? 'Query Exported'
-        : 'Aggregation Exported';
-
-    track(
-      trackingEvent,
-      {
-        language: outputLanguage,
-        with_import_statements: includeImports,
-        with_drivers_syntax: includeDrivers,
-        with_builders: useBuilders,
-        ...stageCountForTelemetry(inputExpression),
-      },
-      connectionInfoAccess.getCurrentConnectionInfo()
-    );
+    const commonProps = {
+      language: outputLanguage,
+      with_import_statements: includeImports,
+      with_drivers_syntax: includeDrivers,
+      with_builders: useBuilders,
+    };
+
+    if (mode === 'Update Query') {
+      track(
+        'Update Exported',
+        commonProps,
+        connectionInfoAccess.getCurrentConnectionInfo()
+      );
+    } else if (mode === 'Delete Query') {
+      track(
+        'Delete Exported',
+        commonProps,
+        connectionInfoAccess.getCurrentConnectionInfo()
+      );
+    } else if (mode === 'Query') {
+      track(
+        'Query Exported',
+        commonProps,
+        connectionInfoAccess.getCurrentConnectionInfo()
+      );
+    } else if (mode === 'Pipeline') {
+      track(
+        'Aggregation Exported',
+        {
+          ...commonProps,
+          ...stageCountForTelemetry(inputExpression),
+        },
+        connectionInfoAccess.getCurrentConnectionInfo()
+      );
+    }
   }, [
     track,
     connectionInfoAccess,

diff --git a/packages/compass-import-export/src/modules/import.ts b/packages/compass-import-export/src/modules/import.ts
@@ -358,7 +358,7 @@ export const startImport = (): ImportThunkAction<Promise<void>> => {
           file_type: fileType,
           all_fields: exclude.length === 0,
           stop_on_error_selected: stopOnErrors,
-          number_of_docs: err.result.docsWritten,
+          number_of_docs: err.result?.docsWritten,
           success: !err,
           aborted: abortSignal.aborted,
           ignore_empty_strings: fileType === 'csv' ? ignoreBlanks : undefined,
@@ -369,7 +369,7 @@ export const startImport = (): ImportThunkAction<Promise<void>> => {
       log.error(mongoLogId(1001000081), 'Import', 'Import failed', {
         ns,
         errorLogFilePath,
-        docsWritten: err.result.docsWritten,
+        docsWritten: err.result?.docsWritten,
         error: err.message,
       });
       debug('Error while importing:', err.stack);

diff --git a/packages/compass-telemetry/src/index.ts b/packages/compass-telemetry/src/index.ts
@@ -1,3 +1,3 @@
 export { createIpcTrack, createIpcSendTrack } from './ipc-track';
 export type { TelemetryServiceOptions } from './generic-track';
-export type { TrackFunction } from './types';
+export type { TrackFunction, IdentifyTraits } from './types';