chore: add import/export telemetry COMPASS-5199 (#2547)

Also adds infrastructure that enables us to easily observe these events
in the end-to-end test suite.

Author: addaleax

packages/compass-e2e-tests/helpers/commands/index.js

@@ -32,4 +32,5 @@ exports.addCommands = function (app) {
   add('setValidation', './set-validation');
   add('waitForAnimations', './wait-for-animations');
   add('setOrClearValue', './set-or-clear-value');
+  add('listenForTelemetryEvents', './listen-for-telemetry-events');
 };

packages/compass-e2e-tests/helpers/commands/listen-for-telemetry-events.js

@@ -0,0 +1,29 @@
+module.exports = function (app) {
+  return async function (telemetry) {
+    const existingEventCount = telemetry.events().length;
+    const { client } = app;
+
+    function lookupNewEvent(eventName) {
+      const newEvents = telemetry.events().slice(existingEventCount);
+      return newEvents.find((entry) => entry.event === eventName);
+    }
+
+    return async (eventName) => {
+      await client.waitUntil(
+        async () => {
+          await client.execute(() => {
+            const { ipcRenderer } = require('electron');
+            ipcRenderer.send('compass:usage:flush');
+          });
+          return !!lookupNewEvent(eventName);
+        },
+        { timeout: 20000 }
+      );
+
+      const ev = lookupNewEvent(eventName);
+      const properties = { ...ev.properties };
+      delete properties.compass_version;
+      return properties;
+    };
+  };
+};

packages/compass-e2e-tests/tests/smoke.test.js

@@ -3,6 +3,7 @@ const { promises: fs } = require('fs');
 const _ = require('lodash');
 const chai = require('chai');
 const chaiAsPromised = require('chai-as-promised');
+const { startTelemetryServer } = require('../helpers/telemetry');
 
 const { expect } = chai;
 
@@ -25,16 +26,19 @@ describe('Smoke tests', function () {
   /** @type {import('../helpers/compass').ExtendedApplication} */
   let compass;
   let client;
+  let telemetry;
 
   before(async function () {
+    telemetry = await startTelemetryServer();
     compass = await beforeTests();
     client = compass.client;
 
     await client.connectWithConnectionString('mongodb://localhost:27018/test');
   });
 
-  after(function () {
-    return afterTests(compass);
+  after(async function () {
+    await afterTests(compass);
+    await telemetry.stop();
   });
 
   afterEach(async function () {
@@ -504,6 +508,7 @@ describe('Smoke tests', function () {
     });
 
     it('supports collection to CSV with a query filter', async function () {
+      const telemetryEntry = await client.listenForTelemetryEvents(telemetry);
       await client.runFindOperation('Documents', '{ i: 5 }');
       await client.clickVisible(Selectors.ExportCollectionButton);
       const exportModal = await client.$(Selectors.ExportModal);
@@ -581,6 +586,15 @@ describe('Smoke tests', function () {
       const fields = lines[1].split(',');
       // first field is an id, so always different
       expect(fields[1]).to.equal('5');
+
+      const exportCompletedEvent = await telemetryEntry('Export Completed');
+      expect(exportCompletedEvent).to.deep.equal({
+        all_docs: false,
+        file_type: 'csv',
+        all_fields: true,
+        number_of_docs: 1,
+        success: true,
+      });
     });
 
     it('supports full collection to CSV');

packages/compass-import-export/src/modules/export.js

@@ -16,7 +16,9 @@ import createLoggerAndTelemetry from '@mongodb-js/compass-logging';
 import { createCSVFormatter, createJSONFormatter } from '../utils/formatters';
 import { loadFields, getSelectableFields } from './load-fields';
 
-const { log, mongoLogId, debug } = createLoggerAndTelemetry('COMPASS-IMPORT-EXPORT-UI');
+const { log, mongoLogId, debug, track } = createLoggerAndTelemetry(
+  'COMPASS-IMPORT-EXPORT-UI'
+);
 
 const PREFIX = 'import-export/export';
 
@@ -367,6 +369,7 @@ const fetchDocumentCount = async(dataService, ns, query) => {
  */
 export const openExport = (count) => {
   return async(dispatch, getState) => {
+    track('Export Opened');
     const {
       ns,
       exportData,
@@ -490,6 +493,15 @@ export const startExport = () => {
     debug('executing pipeline');
     dispatch(onStarted(source, dest, numDocsToExport));
     stream.pipeline(source, progress, formatter, dest, function(err) {
+      track('Export Completed', {
+        all_docs: exportData.isFullCollection,
+        file_type: exportData.fileType,
+        all_fields: Object.values(exportData.fields).every(
+          (checked) => checked === 1
+        ),
+        number_of_docs: numDocsToExport,
+        success: !err,
+      });
       if (err) {
         log.error(mongoLogId(1001000085), 'Export', 'Export failed', {
           ns,

packages/compass-import-export/src/modules/import.js

@@ -46,7 +46,9 @@ import { transformProjectedTypesStream } from '../utils/import-apply-types-and-p
 
 import createLoggerAndTelemetry from '@mongodb-js/compass-logging';
 
-const { log, mongoLogId, debug } = createLoggerAndTelemetry('COMPASS-IMPORT-EXPORT-UI');
+const { log, mongoLogId, debug, track } = createLoggerAndTelemetry(
+  'COMPASS-IMPORT-EXPORT-UI'
+);
 
 /**
  * ## Action names
@@ -278,6 +280,13 @@ export const startImport = () => {
       dest,
       function onStreamEnd(err) {
         console.timeEnd('import');
+        track('Import Completed', {
+          file_type: fileType,
+          all_fields: exclude.length === 0,
+          stop_on_error_selected: stopOnErrors,
+          number_of_docs: dest.docsWritten,
+          success: !err,
+        });
 
         /**
          * Refresh data (docs, aggregations) regardless of whether we have a
@@ -623,9 +632,12 @@ export const setIgnoreBlanks = ignoreBlanks => ({
  * Open the import modal.
  * @api public
  */
-export const openImport = () => ({
-  type: OPEN
-});
+export const openImport = () => {
+  track('Import Opened');
+  return {
+    type: OPEN,
+  };
+};
 
 /**
  * Close the import modal.

packages/compass-logging/src/index.ts

@@ -21,7 +21,7 @@ export function createLoggerAndTelemetry(component: string): {
   log: ReturnType<MongoLogWriter['bindComponent']>;
   mongoLogId: typeof mongoLogId;
   debug: ReturnType<typeof createDebug>;
-  track: (event: string, properties: Record<string, any>) => void;
+  track: (event: string, properties?: Record<string, any>) => void;
 } {
   // This application may not be running in an Node.js/Electron context.
   const ipc: HadronIpcRenderer | null = isElectronRenderer
@@ -43,7 +43,7 @@ export function createLoggerAndTelemetry(component: string): {
   } as Writable;
   const writer = new MongoLogWriter('', null, target);
 
-  const track = (event: string, properties: Record<string, any>): void => {
+  const track = (event: string, properties: Record<string, any> = {}): void => {
     emit(ipc, 'compass:track', { event, properties });
   };
 

packages/compass/src/main/telemetry.ts

@@ -104,6 +104,11 @@ class CompassTelemetry {
       this.state = 'disabled';
     });
 
+    // only used in tests
+    ipcMain.respondTo('compass:usage:flush', () => {
+      this.analytics?.flush();
+    });
+
     if (telemetryCapableEnvironment) {
       this.analytics = new Analytics(SEGMENT_API_KEY, { host: SEGMENT_HOST });