chore(compass-assistant): add compass AI assistant with placeholders COMPASS-9603 #7189

gagik · 2025-08-12T10:09:24Z

This adds a new Compass plugin for the AI Assistant. It is feature flagged and currently uses placeholders in place of Leafygreen chat components to allow us to test out the assistant right away and iterate on non-aesthetic features while progress is being made towards the Leafygreen components update.

This includes a vendored subset of @ai-sdk/react hooks

(This does not much designs and is just used as a functional placeholder)

gagik · 2025-08-12T10:10:08Z

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

+  onSendMessage?: (message: string) => void;
+}
+
+export const AsisstantChat: React.FunctionComponent<AsisstantChatProps> = ({


AI-generated placeholders for now...

packages/compass-assistant/src/@ai-sdk/react/chat.react.ts

gagik · 2025-08-12T10:42:56Z

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

+  const CompassAssistant = CompassAssistantProvider.withMockServices({});
+
+  it('renders a Plugin', function () {
+    render(<CompassAssistant></CompassAssistant>);


not sure what kind of tests, if any, are worth the effort at the moment, especially with the placeholders

I mean, visuals are visuals, but we still expect, for example, an input field that you should be able to input text in, submit it, see it in the output, get the response, etc. If you follow some of these best practices from testing library docs, I think you can already write some pretty good tests that wouldn't need to change much when we swap the placeholder UI

But also you know, take this advice with a grain of salt 🙂 If it really doesn't make sense to you still, we can omit until we have more code here, just seems like a lot of it is already functional stuff

gagik · 2025-08-12T11:23:38Z

packages/compass-assistant/package.json

+  },
+  "devDependencies": {
+    "react-dom": "^17.0.2",
+    "throttleit": "^2.1.0",


depcheck forced me to move this throttleit to dev dependencies... not sure how right that is, could add that to depcheckrc ignores

Hmmm, it shouldn't if the dependency is used in the source code, can you share the error you're seeing?

Maybe @ in the filepath trips up the check, maybe worth removing it from the name and trying again

didn't help, very weird..

Tried it locally, it's not depcheck, it's our check-peer-deps script, seems like something is tripping up the module resolution logic there so it doesn't pick up the ./chat.react file for parsing (and so misses the throttleit import). Looking

packages/compass-web/package.json

Copilot

Pull Request Overview

This PR adds a new AI Assistant feature to Compass as a feature-flagged plugin. It provides a chat interface for MongoDB-related queries, using placeholder components while Leafygreen UI updates are in development.

Introduces the @mongodb-js/compass-assistant package with AI chat functionality
Adds feature flag enableAIAssistant for controlled rollout
Integrates the assistant provider into both desktop and web Compass applications

Reviewed Changes

Copilot reviewed 20 out of 21 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
packages/compass/src/app/utils/csp.ts	Adds CSP entries for MongoDB knowledge base endpoints
packages/compass/src/app/components/home.tsx	Wraps application with CompassAssistantProvider
packages/compass-web/src/entrypoint.tsx	Integrates assistant provider in web version
packages/compass-web/package.json	Adds compass-assistant dependency
packages/compass-preferences-model/src/feature-flags.ts	Adds enableAIAssistant feature flag
packages/compass-assistant/	New package with chat components and AI SDK integration

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

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

packages/compass-assistant/src/docs-provider-transport.ts

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

…rmatting

lerouxb · 2025-08-12T15:21:04Z

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

+  const handleMessageSend = useCallback(
+    (messageBody: string) => {
+      /** Telemetry, etc. */
+      void sendMessage({ text: messageBody });


Wondering if we should be swallowing this potential error. Should we not at least log it?

we'd probably want to use onError on the useChat hook. I'd say this should be followed up with more proper error handling in general, I'll create a ticket

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

lerouxb · 2025-08-12T15:31:07Z

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

+  return useContext(AssistantActionsContext);
+}
+
+export const AssistantProvider: React.FunctionComponent<


This is super nitpicky, I don't know why this bothers me because, sure the top-level thing it returns IS a provider, but it is also kinda the drawer section. Just wondering if there's a better name.

(but also feel free to just ignore me)

it's a provider since we're eventually wrapping other elements in it. otherwise it'd seem like Compass is wrapped inside a drawer section

No strong opinion, but I think you can just call the public export CompassAssistant without mentioning either drawer or provider 🙂

To me it is almost more about the filename than the export. But really this is SUPER nitpicky and I can live with any of this :)

addaleax · 2025-08-12T15:39:06Z

packages/compass-assistant/src/docs-provider-transport.ts

+      messages: convertToModelMessages(messages),
+      abortSignal: abortSignal,
+      headers: {
+        origin: 'https://knowledge.staging.corp.mongodb.com',


Is the .staging part indicating that this is something temporary? Should this origin eventually be something that indicates it's coming from Compass?

The new chatbot is only on staging so far and hasn't been employed to production. I imagine we'll have to change it over before this feature lands.

addaleax · 2025-08-12T15:39:30Z

packages/compass-assistant/src/docs-provider-transport.ts

+import { createOpenAI } from '@ai-sdk/openai';
+
+const openai = createOpenAI({
+  baseURL: 'https://knowledge.staging.corp.mongodb.com/api/v1',


Should this be overridable through e.g. an environment variable?

gribnoysup · 2025-08-13T08:32:53Z

packages/compass-assistant/src/docs-provider-transport.ts

+      messages: convertToModelMessages(messages),
+      abortSignal: abortSignal,
+      headers: {
+        origin: 'https://knowledge.staging.corp.mongodb.com',


Browser won't propagate origin header to the actual request and won't allow you to override the one it sets, this is not really doing anything

gribnoysup · 2025-08-13T08:34:51Z

packages/compass-assistant/src/docs-provider-transport.ts

+import { createOpenAI } from '@ai-sdk/openai';
+
+const openai = createOpenAI({
+  baseURL: 'https://knowledge.staging.corp.mongodb.com/api/v1',


This might not be using atlas service directly for fetching, but I think we should still at least have this url as part of AtlasServiceConfig (and so similarly dynamically accessed from it)

this has a dependency on the preferences object right? could I dynamically access it inside registerCompassPlugin activate?

ah, I suppose with

import { atlasServiceLocator } from '@mongodb-js/atlas-service/provider';

You might need to reshuffle components a bit to make sure that atlas service is above this one, but otherwise yeah: use a locator, get a config value from it in activate, pass it to the transport (a bit of an advanced pattern: if you want to create a "service" for the transport, you can package all this logic inside of it, you can look at some usage of createServiceProvider method for something like this, but also no need to complicate it too much, just an idea)

gribnoysup · 2025-08-13T08:44:26Z

packages/compass-assistant/src/index.tsx

+  {
+    transport: () => docsProviderTransport,
+  }


This needs to be a specially created service locator fuction if you want to inject it, but also doesn't look like you're actually using it? Not a bad idea though, while we will be using the same instance in all runtimes, it will still allow you to override it in tests for example

gagik · 2025-08-13T12:02:02Z

packages/compass-assistant/src/index.tsx

+        ? atlasService.assistantApiEndpoint()
+        : 'https://knowledge.staging.corp.mongodb.com/api/v1';
+      const chat = new Chat({
+        transport: new DocsProviderTransport({


@gribnoysup moved the transport inside the activate, I was originally exposing it for mocking (which I didn't end up doing) but I don't need to mock at such a low-level anyhow.. Not sure if the defaulting to staging bit for now is fine, just figured it'd be good to make this simple with the feature flag.

I think it's fine to default to it if we have to, but I'd rather we just do this in the config (mentioned this in #7189 (comment))

gribnoysup

Looks good! Left a few small comments

packages/compass-assistant/src/docs-provider-transport.ts

packages/compass-assistant/src/index.tsx

gribnoysup · 2025-08-13T13:23:40Z

Oh, and some of the failures are legit, so please take a look!

lerouxb · 2025-08-13T14:59:38Z

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

+
+  return (
+    <AssistantActionsContext.Provider value={contextActions.current}>
+      <DrawerSection


This is what I was talking about in slack: Just move this somewhere lower down in the render tree, keeping <AssistantActionsContext.Provider where it is.

Then <AssistantChat should easily be able to use the connections and figure out if it should display some warning banner, but connections and every other component can still use the assistant context.

(Obviously not necessary for this PR, though)

gagik commented Aug 12, 2025

View reviewed changes

gribnoysup reviewed Aug 12, 2025

View reviewed changes

packages/compass-assistant/src/@ai-sdk/react/chat.react.ts Outdated Show resolved Hide resolved

gagik commented Aug 12, 2025

View reviewed changes

gagik changed the title ~~WIP chore(compass-assistant): add compass AI assistant with placeholders~~ chore(compass-assistant): add compass AI assistant with placeholders Aug 12, 2025

gagik added 4 commits August 12, 2025 12:45

chore: generate workspace

a9f31a7

chore(compass-assistant): add compass AI assistant with placeholders

2688960

chore: add apache license header

2cb2cca

chore: add feature flag and fix lint

989329b

gagik force-pushed the gagik/compass-ai-plugin-placeholder branch from 4fc9f43 to 989329b Compare August 12, 2025 10:46

gagik added 2 commits August 12, 2025 13:07

chore: add missing dependency

27fe44a

chore: fix check

9fc210d

gagik force-pushed the gagik/compass-ai-plugin-placeholder branch from bc3ac19 to 9fc210d Compare August 12, 2025 11:20

gagik commented Aug 12, 2025

View reviewed changes

gagik marked this pull request as ready for review August 12, 2025 11:25

Copilot AI review requested due to automatic review settings August 12, 2025 11:25

gagik requested a review from a team as a code owner August 12, 2025 11:25

gagik changed the title ~~chore(compass-assistant): add compass AI assistant with placeholders~~ chore(compass-assistant): add compass AI assistant with placeholders COMPASS-9603 Aug 12, 2025

Copilot AI reviewed Aug 12, 2025

View reviewed changes

gagik force-pushed the gagik/compass-ai-plugin-placeholder branch from 0c73abf to b18904a Compare August 12, 2025 11:33

chore: fix check, add whiteSpace: 'pre-wrap' for nicer placeholder fo…

95ddec6

…rmatting

gagik force-pushed the gagik/compass-ai-plugin-placeholder branch from b18904a to 95ddec6 Compare August 12, 2025 11:34

Anemy added the feature flagged PRs labeled with this label will not be included in the release notes of the next release label Aug 12, 2025

lerouxb reviewed Aug 12, 2025

View reviewed changes

packages/compass-assistant/src/assistant-provider.tsx Outdated Show resolved Hide resolved

lerouxb reviewed Aug 12, 2025

View reviewed changes

addaleax reviewed Aug 12, 2025

View reviewed changes

feat: add some tests

9ab5ebb

gribnoysup reviewed Aug 13, 2025

View reviewed changes

gagik added 2 commits August 13, 2025 13:34

chore: refactor to use atlas service and other feedback changes

20e985e

chore: fix check

354afd6

gagik force-pushed the gagik/compass-ai-plugin-placeholder branch from 2facc35 to 354afd6 Compare August 13, 2025 11:58

gagik commented Aug 13, 2025

View reviewed changes

gribnoysup approved these changes Aug 13, 2025

View reviewed changes

packages/compass-assistant/src/docs-provider-transport.ts Outdated Show resolved Hide resolved

packages/compass-assistant/src/docs-provider-transport.ts Outdated Show resolved Hide resolved

packages/compass-assistant/src/index.tsx Outdated Show resolved Hide resolved

chore: fix dependencies

ac6fb52

lerouxb reviewed Aug 13, 2025

View reviewed changes

gagik added 4 commits August 13, 2025 17:41

chore: remove eslint disables, fix types on plugin props

f5436f2

chore: add compass-assistant dependency

41cb841

chore: simplify endpoint resolution

dbdee46

chore: move to dev dependency

6212cb1

lerouxb approved these changes Aug 14, 2025

View reviewed changes

gagik merged commit 349f0c3 into main Aug 14, 2025
59 checks passed

gagik deleted the gagik/compass-ai-plugin-placeholder branch August 14, 2025 10:44

chore(compass-assistant): add compass AI assistant with placeholders COMPASS-9603 #7189

chore(compass-assistant): add compass AI assistant with placeholders COMPASS-9603 #7189

Uh oh!

Conversation

gagik commented Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gagik Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gribnoysup Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gagik commented Aug 12, 2025 •

edited

Loading

gagik Aug 12, 2025 •

edited

Loading

gribnoysup Aug 13, 2025 •

edited

Loading

lerouxb Aug 13, 2025 •

edited

Loading