chore: add query tracking COMPASS-5196 (#2555)

Author: addaleax

package-lock.json

@@ -2,6 +2,8 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { ViewSwitcher, Tooltip } from 'hadron-react-components';
 import { AnimatedIconTextButton, IconButton } from 'hadron-react-buttons';
+import { createLoggerAndTelemetry } from '@mongodb-js/compass-logging';
+const { track } = createLoggerAndTelemetry('COMPASS-CRUD-UI');
 
 const BASE_CLASS = 'document-list';
 const ACTION_BAR_CLASS = `${BASE_CLASS}-action-bar`;
@@ -22,6 +24,7 @@ class Toolbar extends React.Component {
    * Handle refreshing the document list.
    */
   handleRefreshDocuments() {
+    track('Query Results Refreshed');
     this.props.refreshDocuments();
   }
 

packages/compass-crud/src/components/toolbar.jsx

@@ -173,16 +173,28 @@ describe('Smoke tests', function () {
     });
 
     it('supports simple find operations', async function () {
+      const telemetryEntry = await client.listenForTelemetryEvents(telemetry);
       await client.runFindOperation('Documents', '{ i: 5 }');
 
       const documentListActionBarMessageElement = await client.$(
         Selectors.DocumentListActionBarMessage
       );
       const text = await documentListActionBarMessageElement.getText();
       expect(text).to.equal('Displaying documents 1 - 1 of 1');
+      const queryExecutedEvent = await telemetryEntry('Query Executed');
+      expect(queryExecutedEvent).to.deep.equal({
+        changed_maxtimems: false,
+        collection_type: 'collection',
+        has_collation: false,
+        has_limit: false,
+        has_projection: false,
+        has_skip: false,
+        used_regex: false,
+      });
     });
 
     it('supports advanced find operations', async function () {
+      const telemetryEntry = await client.listenForTelemetryEvents(telemetry);
       await client.runFindOperation('Documents', '{ i: { $gt: 5 } }', {
         project: '{ _id: 0 }',
         sort: '{ i: -1 }',
@@ -195,6 +207,16 @@ describe('Smoke tests', function () {
       );
       const text = await documentListActionBarMessageElement.getText();
       expect(text).to.equal('Displaying documents 1 - 20 of 50');
+      const queryExecutedEvent = await telemetryEntry('Query Executed');
+      expect(queryExecutedEvent).to.deep.equal({
+        changed_maxtimems: false,
+        collection_type: 'collection',
+        has_collation: false,
+        has_limit: true,
+        has_projection: true,
+        has_skip: true,
+        used_regex: false,
+      });
     });
 
     it('supports cancelling a find and then running another query', async function () {

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

@@ -7,6 +7,7 @@ import PropTypes from 'prop-types';
 
 import styles from './export-modal.module.less';
 import { createLoggerAndTelemetry } from '@mongodb-js/compass-logging';
+import { countAggregationStagesInString } from '../../modules/count-aggregation-stages-in-string';
 const { track } = createLoggerAndTelemetry('COMPASS-EXPORT-TO-LANGUAGE-UI');
 
 class ExportModal extends PureComponent {
@@ -36,6 +37,9 @@ class ExportModal extends PureComponent {
   };
 
   showHandler = () => {
+    track(this.props.mode === 'Query' ? 'Query Export Opened' : 'Aggregation Export Opened', {
+      ...this.stageCountForTelemetry()
+    });
     track('Screen', { name: 'export_to_language_modal' });
   };
 
@@ -57,6 +61,40 @@ class ExportModal extends PureComponent {
     this.props.runTranspiler(this.props.inputExpression);
   };
 
+  stageCountForTelemetry = () => {
+    if (this.props.mode === 'Query') {
+      return {};
+    }
+
+    try {
+      return {
+        num_stages: countAggregationStagesInString(this.props.inputExpression.aggregation)
+      };
+    } catch (ignore) {
+      // Things like [{ $match: { x: NumberInt(10) } }] do not evaluate in any kind of context
+      return { num_stages: -1 };
+    }
+  };
+
+  copySuccessChanged = (field) => {
+    if (field === 'output') {
+      let event;
+      if (this.props.mode === 'Query') {
+        event = 'Query Exported';
+      } else {
+        event = 'Aggregation Exported';
+      }
+      track(event, {
+        language: this.props.outputLang,
+        with_import_statements: this.props.showImports,
+        with_builders: this.props.builders,
+        with_drivers_syntax: this.props.driver,
+        ...this.stageCountForTelemetry()
+      });
+    }
+    this.props.copySuccessChanged(field);
+  };
+
   renderBuilderCheckbox = () => {
     if (this.props.outputLang === 'java' && this.props.mode === 'Query') {
       return (
@@ -90,7 +128,7 @@ class ExportModal extends PureComponent {
         </Modal.Header>
 
         <Modal.Body data-test-id="export-to-lang-modal-body">
-          <ExportForm {...this.props} from={this.props.mode === 'Query' ? this.props.inputExpression.filter : this.props.inputExpression.aggregation}/>
+          <ExportForm {...this.props} copySuccessChanged={this.copySuccessChanged} from={this.props.mode === 'Query' ? this.props.inputExpression.filter : this.props.inputExpression.aggregation}/>
           <div className={classnames(styles['export-to-lang-modal-checkbox-imports'])}>
             <Checkbox data-test-id="export-to-lang-checkbox-imports" onClick={this.importsHandler} defaultChecked={this.props.showImports}>
                Include Import Statements

packages/compass-export-to-language/src/components/export-modal/export-modal.jsx

@@ -0,0 +1,29 @@
+import vm from 'vm';
+
+let dummySandbox;
+
+// We do want to report the number of stages in an aggregation
+// for telemetry, but we only receive them as a string from
+// the consumers of this package. Instead, we evaluate
+// the code in a dummy sandbox environment and just count
+// the number of stages in the result. This is a little inefficient,
+// but ultimately a simpler solution than pulling in a query
+// parser here.
+export function countAggregationStagesInString(str) {
+  if (!dummySandbox) {
+    dummySandbox = vm.createContext(Object.create(null), {
+      codeGeneration: { strings: false, wasm: false },
+      microtaskMode: 'afterEvaluate'
+    });
+    vm.runInContext([
+      'BSONRegExp', 'DBRef', 'Decimal128', 'Double', 'Int32',
+      'Long', 'Int64', 'MaxKey', 'MinKey', 'ObjectID', 'ObjectId',
+      'BSONSymbol', 'Timestamp', 'Code', 'Buffer', 'Binary'
+    ].map(name => `function ${name}() {}`).join('\n'), dummySandbox);
+  }
+
+  return vm.runInContext(
+    '(' + str + ')',
+    dummySandbox,
+    { timeout: 100 }).length;
+}

packages/compass-export-to-language/src/modules/count-aggregation-stages-in-string.js

@@ -148,6 +148,7 @@
     "xvfb-maybe": "^0.2.1"
   },
   "dependencies": {
+    "@mongodb-js/compass-logging": "^0.3.0",
     "lodash": "^4.17.15",
     "mongodb-query-util": "^0.2.1"
   }

packages/compass-query-bar/package.json

@@ -0,0 +1,10 @@
+export function objectContainsRegularExpression(obj) {
+  // This assumes that the input is not circular.
+  if (obj === null || typeof obj !== 'object') {
+    return false;
+  }
+  if (Object.prototype.toString.call(obj) === '[object RegExp]') {
+    return true;
+  }
+  return Object.values(obj).some(objectContainsRegularExpression);
+}

packages/compass-query-bar/src/modules/utils.js

@@ -28,6 +28,7 @@ import {
 import { bsonEqual, hasDistinctValue } from 'mongodb-query-util';
 import QUERY_PROPERTIES from '../constants/query-properties';
 import mergeGeoFilter from '../modules/merge-geo-filter';
+import { objectContainsRegularExpression } from '../modules/utils';
 import {
   USER_TYPING_DEBOUNCE_MS,
   APPLY_STATE,
@@ -44,11 +45,11 @@ import {
 } from '../constants/query-bar-store';
 import configureQueryChangedStore from './query-changed-store';
 
-const debug = require('debug')('mongodb-compass:stores:query-bar');
+import { createLoggerAndTelemetry } from '@mongodb-js/compass-logging';
+const { track, debug } = createLoggerAndTelemetry('COMPASS-QUERY-BAR-UI');
 
 const QUERY_CHANGED_STORE = 'Query.ChangedStore';
 
-
 /**
  * Configure the query bar store.
  *
@@ -64,10 +65,11 @@ const configureStore = (options = {}) => {
     /*
      * listen to Namespace store and reset if ns changes.
      */
-    onCollectionChanged(ns, isTimeSeries) {
+    onCollectionChanged(ns, isTimeSeries, isReadonly) {
       const newState = this.getInitialState();
       newState.ns = ns;
       newState.isTimeSeries = isTimeSeries;
+      newState.isReadonly = isReadonly;
       this.setState(newState);
     },
 
@@ -166,6 +168,7 @@ const configureStore = (options = {}) => {
         // set the namespace
         ns: '',
         isTimeSeries: false,
+        isReadonly: false,
 
         serverVersion: '3.6.0',
 
@@ -660,6 +663,15 @@ const configureStore = (options = {}) => {
      */
     apply() {
       if (this._validateQuery()) {
+        track('Query Executed', {
+          has_projection: !!this.state.project && Object.keys(this.state.project).length > 0,
+          has_skip: this.state.skip > 0,
+          has_limit: this.state.limit > 0,
+          has_collation: !!this.state.collation,
+          changed_maxtimems: this.state.maxTimeMS !== DEFAULT_MAX_TIME_MS,
+          collection_type: this.state.isTimeSeries ? 'time-series' : this.state.isReadonly ? 'readonly' : 'collection',
+          used_regex: objectContainsRegularExpression(this.state.filter)
+        });
         const registry = this.localAppRegistry;
         if (registry) {
           const newState = {
@@ -710,6 +722,8 @@ const configureStore = (options = {}) => {
       if (this.state.valid) {
         const newState = this.getInitialState();
         newState.ns = this.state.ns;
+        newState.isTimeSeries = this.state.isTimeSeries;
+        newState.isReadonly = this.state.isReadonly;
         newState.autoPopulated = true;
         this.setState(omit(newState, 'expanded'));
       }
@@ -755,7 +769,7 @@ const configureStore = (options = {}) => {
   }
 
   if (options.namespace) {
-    store.onCollectionChanged(options.namespace, options.isTimeSeries);
+    store.onCollectionChanged(options.namespace, options.isTimeSeries, options.isReadonly);
   }
 
   if (options.serverVersion) {

packages/compass-query-bar/src/stores/query-bar-store.js

@@ -0,0 +1,13 @@
+import { objectContainsRegularExpression } from '../../src/modules/utils';
+
+describe('objectContainsRegularExpression', () => {
+  it('tells whether an object contains a regular expression', function() {
+    expect(objectContainsRegularExpression(null)).to.equal(false);
+    expect(objectContainsRegularExpression(undefined)).to.equal(false);
+    expect(objectContainsRegularExpression(1)).to.equal(false);
+    expect(objectContainsRegularExpression('str')).to.equal(false);
+    expect(objectContainsRegularExpression({})).to.equal(false);
+    expect(objectContainsRegularExpression({ x: 1 })).to.equal(false);
+    expect(objectContainsRegularExpression({ x: /re/ })).to.equal(true);
+  });
+});

packages/compass-query-bar/test/modules/utils.spec.js

@@ -67,6 +67,7 @@ describe('QueryBarStore [Store]', function() {
       expanded: false,
       ns: '',
       isTimeSeries: false,
+      isReadonly: false,
       schemaFields: []
     });
   });