chore: fix telemetry

Author: gagik

packages/compass-assistant/src/compass-assistant-provider.spec.tsx

@@ -10,6 +10,7 @@ import {
 } from '@mongodb-js/testing-library-compass';
 import {
   CompassAssistantProvider,
+  createDefaultChat,
   useAssistantActions,
   type AssistantMessage,
 } from './compass-assistant-provider';
@@ -24,8 +25,10 @@ import {
 import type { AtlasAuthService } from '@mongodb-js/atlas-service/provider';
 import type { AtlasService } from '@mongodb-js/atlas-service/provider';
 import { CompassAssistantDrawer } from './compass-assistant-drawer';
-import { createMockChat } from '../test/utils';
+import { createBrokenTransport, createMockChat } from '../test/utils';
 import type { AtlasAiService } from '@mongodb-js/compass-generative-ai/provider';
+import type { TrackFunction } from '@mongodb-js/compass-telemetry';
+import { createLogger } from '@mongodb-js/compass-logging';
 
 function createMockProvider({
   mockAtlasService,
@@ -463,6 +466,44 @@ describe('CompassAssistantProvider', function () {
       expect(screen.queryByText('Hello assistant!')).to.not.exist;
     });
 
+    describe('error handling with default chat', function () {
+      it('fires a telemetry event and displays error banner an when error occurs', async function () {
+        const track = sinon.stub();
+        const chat = createDefaultChat({
+          options: {
+            transport: createBrokenTransport(),
+          },
+          originForPrompt: 'mongodb-compass',
+          appNameForPrompt: 'MongoDB Compass',
+          atlasService: {
+            assistantApiEndpoint: sinon
+              .stub()
+              .returns('https://localhost:3000'),
+          } as unknown as AtlasService,
+          logger: createLogger('COMPASS-ASSISTANT-TEST'),
+          track: track as unknown as TrackFunction,
+        });
+        await renderOpenAssistantDrawer({
+          chat,
+        });
+
+        // Send a message
+        userEvent.type(
+          screen.getByPlaceholderText('Ask a question'),
+          'Hello assistant!'
+        );
+        userEvent.click(screen.getByLabelText('Send message'));
+
+        await waitFor(() => {
+          expect(screen.getByText(/Test connection error/)).to.exist;
+        });
+
+        expect(track).to.have.been.calledWith('Assistant Response Failed', {
+          error_name: 'ConnectionError',
+        });
+      });
+    });
+
     describe('clear chat button', function () {
       it('is hidden when the chat is empty', async function () {
         const mockChat = createMockChat({ messages: [] });
@@ -613,49 +654,47 @@ describe('CompassAssistantProvider', function () {
     });
   });
 
-  describe('CompassAssistantProvider', function () {
-    it('uses the Atlas Service assistantApiEndpoint', async function () {
-      const mockAtlasService = {
-        assistantApiEndpoint: sinon
-          .stub()
-          .returns('https://example.com/assistant/api/v1'),
-      };
+  it('uses the Atlas Service assistantApiEndpoint', async function () {
+    const mockAtlasService = {
+      assistantApiEndpoint: sinon
+        .stub()
+        .returns('https://example.com/assistant/api/v1'),
+    };
 
-      const mockAtlasAiService = {
-        ensureAiFeatureAccess: sinon.stub().callsFake(() => {
-          return Promise.resolve();
-        }),
-      };
+    const mockAtlasAiService = {
+      ensureAiFeatureAccess: sinon.stub().callsFake(() => {
+        return Promise.resolve();
+      }),
+    };
 
-      const mockAtlasAuthService = {};
+    const mockAtlasAuthService = {};
 
-      const MockedProvider = CompassAssistantProvider.withMockServices({
-        atlasService: mockAtlasService as unknown as AtlasService,
-        atlasAiService: mockAtlasAiService as unknown as AtlasAiService,
-        atlasAuthService: mockAtlasAuthService as unknown as AtlasAuthService,
-      });
+    const MockedProvider = CompassAssistantProvider.withMockServices({
+      atlasService: mockAtlasService as unknown as AtlasService,
+      atlasAiService: mockAtlasAiService as unknown as AtlasAiService,
+      atlasAuthService: mockAtlasAuthService as unknown as AtlasAuthService,
+    });
 
-      render(
-        <DrawerContentProvider>
-          <DrawerAnchor />
-          <MockedProvider
-            originForPrompt="mongodb-compass"
-            appNameForPrompt="MongoDB Compass"
-          />
-        </DrawerContentProvider>,
-        {
-          preferences: {
-            enableAIAssistant: true,
-            enableGenAIFeatures: true,
-            enableGenAIFeaturesAtlasOrg: true,
-            cloudFeatureRolloutAccess: { GEN_AI_COMPASS: true },
-          },
-        }
-      );
+    render(
+      <DrawerContentProvider>
+        <DrawerAnchor />
+        <MockedProvider
+          originForPrompt="mongodb-compass"
+          appNameForPrompt="MongoDB Compass"
+        />
+      </DrawerContentProvider>,
+      {
+        preferences: {
+          enableAIAssistant: true,
+          enableGenAIFeatures: true,
+          enableGenAIFeaturesAtlasOrg: true,
+          cloudFeatureRolloutAccess: { GEN_AI_COMPASS: true },
+        },
+      }
+    );
 
-      await waitFor(() => {
-        expect(mockAtlasService.assistantApiEndpoint.calledOnce).to.be.true;
-      });
+    await waitFor(() => {
+      expect(mockAtlasService.assistantApiEndpoint.calledOnce).to.be.true;
     });
   });
 });

packages/compass-assistant/src/compass-assistant-provider.tsx

@@ -8,6 +8,7 @@ import {
 } from '@mongodb-js/compass-app-registry';
 import {
   atlasAuthServiceLocator,
+  type AtlasService,
   atlasServiceLocator,
 } from '@mongodb-js/atlas-service/provider';
 import { DocsProviderTransport } from './docs-provider-transport';
@@ -23,9 +24,16 @@ import {
   useIsAIFeatureEnabled,
   usePreference,
 } from 'compass-preferences-model/provider';
-import { createLoggerLocator } from '@mongodb-js/compass-logging/provider';
+import {
+  createLoggerLocator,
+  type Logger,
+} from '@mongodb-js/compass-logging/provider';
 import type { ConnectionInfo } from '@mongodb-js/connection-info';
-import { useTelemetry } from '@mongodb-js/compass-telemetry/provider';
+import {
+  telemetryLocator,
+  type TrackFunction,
+  useTelemetry,
+} from '@mongodb-js/compass-telemetry/provider';
 import type { AtlasAiService } from '@mongodb-js/compass-generative-ai/provider';
 import { atlasAiServiceLocator } from '@mongodb-js/compass-generative-ai/provider';
 import { buildConversationInstructionsPrompt } from './prompts';
@@ -280,29 +288,20 @@ export const CompassAssistantProvider = registerCompassPlugin(
         </AssistantProvider>
       );
     },
-    activate: (initialProps, { atlasService, atlasAiService, logger }) => {
+    activate: (
+      { chat: initialChat, originForPrompt, appNameForPrompt },
+      { atlasService, atlasAiService, logger, track }
+    ) => {
       const chat =
-        initialProps.chat ??
-        new Chat({
-          transport: new DocsProviderTransport({
-            origin: initialProps.originForPrompt,
-            instructions: buildConversationInstructionsPrompt({
-              target: initialProps.appNameForPrompt,
-            }),
-            model: createOpenAI({
-              baseURL: atlasService.assistantApiEndpoint(),
-              apiKey: '',
-            }).responses('mongodb-chat-latest'),
-          }),
-          onError: (err: Error) => {
-            logger.log.error(
-              logger.mongoLogId(1_001_000_370),
-              'Assistant',
-              'Failed to send a message',
-              { err }
-            );
-          },
+        initialChat ??
+        createDefaultChat({
+          originForPrompt,
+          appNameForPrompt,
+          atlasService,
+          logger,
+          track,
         });
+
       return {
         store: { state: { chat, atlasAiService } },
         deactivate: () => {},
@@ -313,6 +312,51 @@ export const CompassAssistantProvider = registerCompassPlugin(
     atlasService: atlasServiceLocator,
     atlasAiService: atlasAiServiceLocator,
     atlasAuthService: atlasAuthServiceLocator,
+    track: telemetryLocator,
     logger: createLoggerLocator('COMPASS-ASSISTANT'),
   }
 );
+
+export function createDefaultChat({
+  originForPrompt,
+  appNameForPrompt,
+  atlasService,
+  logger,
+  track,
+  options,
+}: {
+  originForPrompt: string;
+  appNameForPrompt: string;
+  atlasService: AtlasService;
+  logger: Logger;
+  track: TrackFunction;
+  options?: {
+    transport: Chat<AssistantMessage>['transport'];
+  };
+}): Chat<AssistantMessage> {
+  return new Chat({
+    transport:
+      options?.transport ??
+      new DocsProviderTransport({
+        origin: originForPrompt,
+        instructions: buildConversationInstructionsPrompt({
+          target: appNameForPrompt,
+        }),
+        model: createOpenAI({
+          baseURL: atlasService.assistantApiEndpoint(),
+          apiKey: '',
+        }).responses('mongodb-chat-latest'),
+      }),
+    onError: (err: Error) => {
+      logger.log.error(
+        logger.mongoLogId(1_001_000_370),
+        'Assistant',
+        'Failed to send a message',
+        { err }
+      );
+      track('Assistant Response Failed', {
+        error_name: err.name,
+      });
+    },
+  });
+}