refactor: separate telemetry package COMPASS-8019 (#5940)

Co-authored-by: Maurizio Casimirri <[email protected]>
Co-authored-by: Sergey Petushkov <[email protected]>

Author: 3 people

configs/eslint-config-compass/plugin.js

@@ -18,6 +18,7 @@ module.exports = {
     '@typescript-eslint/no-restricted-imports': [
       'error',
       restrictedProviderImport('@mongodb-js/compass-logging'),
+      restrictedProviderImport('@mongodb-js/compass-telemetry'),
       restrictedProviderImport('@mongodb-js/compass-app-stores'),
       restrictedProviderImport('@mongodb-js/my-queries-storage'),
       restrictedProviderImport('@mongodb-js/atlas-service'),

package-lock.json

@@ -75,6 +75,7 @@
   "dependencies": {
     "@mongodb-js/compass-components": "^1.25.1",
     "@mongodb-js/compass-logging": "^1.3.0",
+    "@mongodb-js/compass-telemetry": "^1.0.0",
     "@mongodb-js/compass-user-data": "^0.2.0",
     "@mongodb-js/compass-utils": "^0.6.4",
     "@mongodb-js/devtools-connect": "^2.6.3",

packages/atlas-service/package.json

@@ -3,7 +3,7 @@ import Sinon from 'sinon';
 import { AtlasService } from './atlas-service';
 import type { PreferencesAccess } from 'compass-preferences-model';
 import { createSandboxFromDefaultPreferences } from 'compass-preferences-model';
-import { createNoopLoggerAndTelemetry } from '@mongodb-js/compass-logging/provider';
+import { createNoopLogger } from '@mongodb-js/compass-logging/provider';
 import { CompassAtlasAuthService } from './compass-atlas-auth-service';
 
 const ATLAS_CONFIG = {
@@ -27,7 +27,7 @@ function getAtlasService(
   const atlasService = new AtlasService(
     authService,
     preferences,
-    createNoopLoggerAndTelemetry()
+    createNoopLogger()
   );
   atlasService['config'] = ATLAS_CONFIG;
   return atlasService;

packages/atlas-service/src/atlas-service.spec.ts

@@ -6,7 +6,7 @@ import {
   throwIfNetworkTrafficDisabled,
   throwIfNotOk,
 } from './util';
-import type { LoggerAndTelemetry } from '@mongodb-js/compass-logging';
+import type { Logger } from '@mongodb-js/compass-logging';
 import type { PreferencesAccess } from 'compass-preferences-model';
 
 export type AtlasServiceOptions = {
@@ -18,7 +18,7 @@ export class AtlasService {
   constructor(
     private readonly authService: AtlasAuthService,
     private readonly preferences: PreferencesAccess,
-    private readonly logger: LoggerAndTelemetry,
+    private readonly logger: Logger,
     private readonly options?: AtlasServiceOptions
   ) {
     this.config = getAtlasConfig(preferences);

packages/atlas-service/src/atlas-service.ts

@@ -20,17 +20,16 @@ import type { IntrospectInfo, AtlasUserInfo, AtlasServiceConfig } from './util';
 import { throwIfAborted } from '@mongodb-js/compass-utils';
 import type { HadronIpcMain } from 'hadron-ipc';
 import { ipcMain } from 'hadron-ipc';
-import {
-  createLoggerAndTelemetry,
-  mongoLogId,
-} from '@mongodb-js/compass-logging';
+import { createLogger, mongoLogId } from '@mongodb-js/compass-logging';
 import type { PreferencesAccess } from 'compass-preferences-model';
 import { SecretStore } from './secret-store';
 import { OidcPluginLogger } from './oidc-plugin-logger';
 import { spawn } from 'child_process';
 import { getAtlasConfig } from './util';
+import { createIpcTrack } from '@mongodb-js/compass-telemetry';
 
-const { log, track } = createLoggerAndTelemetry('COMPASS-ATLAS-SERVICE');
+const { log } = createLogger('COMPASS-ATLAS-SERVICE');
+const track = createIpcTrack();
 
 const redirectRequestHandler = oidcServerRequestHandler.bind(null, {
   productName: 'Compass',

packages/atlas-service/src/main.ts

@@ -2,7 +2,7 @@ import React, { createContext, useContext, useMemo } from 'react';
 import type { AtlasAuthService } from './atlas-auth-service';
 import { AtlasService, type AtlasServiceOptions } from './atlas-service';
 import { preferencesLocator } from 'compass-preferences-model/provider';
-import { useLoggerAndTelemetry } from '@mongodb-js/compass-logging/provider';
+import { useLogger } from '@mongodb-js/compass-logging/provider';
 import {
   createServiceLocator,
   createServiceProvider,
@@ -33,7 +33,7 @@ export const AtlasServiceProvider: React.FC<{
   options,
   children,
 }) {
-  const logger = useLoggerAndTelemetry('ATLAS-SERVICE');
+  const logger = useLogger('ATLAS-SERVICE');
   const preferences = preferencesLocator();
   const authService = atlasAuthServiceLocator();
 

packages/atlas-service/src/provider.tsx

@@ -71,6 +71,7 @@
     "@mongodb-js/compass-field-store": "^9.7.0",
     "@mongodb-js/compass-generative-ai": "^0.15.0",
     "@mongodb-js/compass-logging": "^1.3.0",
+    "@mongodb-js/compass-telemetry": "^1.0.0",
     "@mongodb-js/compass-utils": "^0.6.4",
     "@mongodb-js/compass-workspaces": "^0.13.0",
     "@mongodb-js/explain-plan-helper": "^1.1.12",

packages/compass-aggregations/package.json

@@ -12,12 +12,12 @@ import {
   SearchInput,
 } from '@mongodb-js/compass-components';
 import { connect } from 'react-redux';
-import { useLoggerAndTelemetry } from '@mongodb-js/compass-logging/provider';
 import { toggleSidePanel } from '../../modules/side-panel';
 import { STAGE_WIZARD_USE_CASES } from './stage-wizard-use-cases';
 import { FeedbackLink } from './feedback-link';
 import { addWizard } from '../../modules/pipeline-builder/stage-editor';
 import { UseCaseCard } from './stage-wizard-use-cases';
+import { useTelemetry } from '@mongodb-js/compass-telemetry/provider';
 
 const containerStyles = css({
   height: '100%',
@@ -78,7 +78,7 @@ export const AggregationSidePanel = ({
   onCloseSidePanel,
   onSelectUseCase,
 }: AggregationSidePanelProps) => {
-  const { track } = useLoggerAndTelemetry('COMPASS-AGGREGATIONS-UI');
+  const track = useTelemetry();
   const [searchText, setSearchText] = useState<string>('');
   const darkMode = useDarkMode();
 

packages/compass-aggregations/src/components/aggregation-side-panel/index.tsx

@@ -10,9 +10,9 @@ import {
   TextInput,
 } from '@mongodb-js/compass-components';
 import { createView, changeViewName, close } from '../../modules/create-view';
-import type { LoggerAndTelemetry } from '@mongodb-js/compass-logging/provider';
-import { withLoggerAndTelemetry } from '@mongodb-js/compass-logging/provider';
 import type { CreateViewRootState } from '../../stores/create-view';
+import { withTelemetry } from '@mongodb-js/compass-telemetry/provider';
+import type { TrackFunction } from '@mongodb-js/compass-telemetry';
 
 const progressContainerStyles = css({
   display: 'flex',
@@ -31,7 +31,7 @@ type CreateViewModalProps = {
   pipeline?: unknown[];
   isRunning?: boolean;
   error: Error | null;
-  logger: LoggerAndTelemetry;
+  track: TrackFunction;
 };
 
 class CreateViewModal extends PureComponent<CreateViewModalProps> {
@@ -46,7 +46,7 @@ class CreateViewModal extends PureComponent<CreateViewModalProps> {
 
   componentDidUpdate(prevProps: CreateViewModalProps) {
     if (prevProps.isVisible !== this.props.isVisible && this.props.isVisible) {
-      this.props.logger.track('Screen', { name: 'create_view_modal' });
+      this.props.track('Screen', { name: 'create_view_modal' });
     }
   }
 
@@ -113,13 +113,12 @@ const mapStateToProps = (state: CreateViewRootState) => ({
  * Connect the redux store to the component.
  * (dispatch)
  */
-const MappedCreateViewModal = withLoggerAndTelemetry(
+const MappedCreateViewModal = withTelemetry(
   connect(mapStateToProps, {
     createView,
     changeViewName,
     closeModal: close,
-  })(CreateViewModal),
-  'COMPASS-CREATE-VIEW-UI'
+  })(CreateViewModal)
 );
 
 export default MappedCreateViewModal;