feat(gen-ai): use chatbot api for queries COMPASS-10081 #7623

mabaasit · 2025-12-03T12:44:09Z

Description

Checklist

New tests and/or benchmarks are included
Documentation is changed or added
If this change updates the UI, screenshots/videos are added and a design review is requested
If this change could impact the load on the MongoDB cluster, please describe the expected and worst case impact
I have signed the MongoDB Contributor License Agreement (https://www.mongodb.com/legal/contributor-agreement)

Motivation and Context

Bugfix
New feature
Dependency update
Misc

Open Questions

Dependents

Types of changes

Backport Needed
Patch (non-breaking change which fixes an issue)
Minor (non-breaking change which adds functionality)
Major (fix or feature that would cause existing functionality to change)

…s://github.com/mongodb-js/compass into COMPASS-10082-add-mms-prompts-and-feature-flag

…PASS-10081-switch-to-edu-api

Copilot

Pull request overview

This PR integrates the chatbot API for generative AI query functionality in MongoDB Compass, replacing the previous implementation with a new endpoint. The changes introduce XML response parsing, update authentication headers for service requests, and add comprehensive E2E testing for the new chatbot integration.

Key Changes:

Introduces new chatbot API client using OpenAI SDK to generate MongoDB queries
Adds XML-to-JSON response parser to handle chatbot responses
Updates service providers with request origin headers for tracking

Reviewed changes

Copilot reviewed 13 out of 14 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
packages/compass/src/app/components/entrypoint.tsx	Adds 'X-Request-Origin' header for Compass desktop
packages/compass-web/src/entrypoint.tsx	Adds 'X-Request-Origin' header for Atlas Data Explorer
packages/compass-generative-ai/src/utils/xml-to-mms-response.ts	Implements XML parsing logic to convert chatbot responses to expected format
packages/compass-generative-ai/src/utils/xml-to-mms-response.spec.ts	Adds comprehensive test coverage for XML parser
packages/compass-generative-ai/src/utils/gen-ai-response.ts	Implements chatbot API response streaming handler
packages/compass-generative-ai/src/utils/gen-ai-prompt.ts	Renames parameter from 'userPrompt' to 'userInput' for consistency
packages/compass-generative-ai/src/utils/gen-ai-prompt.spec.ts	Updates tests to reflect parameter rename
packages/compass-generative-ai/src/chatbot-errors.ts	Defines error classes for chatbot API failures
packages/compass-generative-ai/src/atlas-ai-service.ts	Integrates chatbot client and adds feature flag for new endpoint
packages/compass-generative-ai/src/atlas-ai-service.spec.ts	Updates mock service with assistant endpoint method
packages/compass-generative-ai/package.json	Moves mongodb-query-parser to dependencies and adds AI SDK packages
packages/compass-e2e-tests/tests/collection-ai-query.test.ts	Adds E2E tests for chatbot-based query generation
packages/compass-e2e-tests/helpers/assistant-service.ts	Fixes header order in mock server response

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/compass-generative-ai/src/utils/xml-to-mms-response.ts

packages/compass-generative-ai/src/atlas-ai-service.ts

packages/compass-e2e-tests/helpers/assistant-service.ts

codeowners-service-app · 2025-12-04T07:46:14Z

Assigned gagik for team compass-developers because gribnoysup is out of office.

packages/compass-generative-ai/src/utils/gen-ai-response.ts

gagik · 2025-12-04T11:10:51Z

packages/compass-generative-ai/src/utils/gen-ai-response.ts

+import type { LanguageModel } from 'ai';
+import { streamText } from 'ai';
+
+export async function getAiQueryResponse(


I know packages/compass-assistant/src/docs-provider-transport.ts is in entirely different path of code but wondering if one or the other should live closer together since there is some tie-in there.
I'm fine as is too though

Yes, good point. Initially I adopted that here as well and then remove it in clean up transport. I want to do a follow-up when this project ends and use the class removed in clean up transport commit. That will be exported by this package and will be used by the assistant.

gagik · 2025-12-04T11:12:23Z

packages/compass-generative-ai/src/utils/xml-to-mms-response.ts

+import type { Logger } from '@mongodb-js/compass-logging';
+import parse, { toJSString } from 'mongodb-query-parser';
+
+export function parseXmlToMmsJsonResponse(xmlString: string, logger: Logger) {


MmsJsonResponse feels like a technical detail to me; without context of the old assistant API I wouldn't understand what this meant.
Can we also add add a return type to this?

added in add type

gribnoysup

A few nits, but otherwise LGTM. We're planning to re-export the transport later down the road so that compass-assistant can depend on it isntead of having a copy, is that right?

gribnoysup · 2025-12-08T08:00:33Z

packages/compass-generative-ai/src/utils/gen-ai-prompt.ts

 export type UserPromptForQueryOptions = {
-  userPrompt: string;
+  userInput: string;


Nit: naming is slightly inconsistent, if you're changing userPrompt to userInput, then the type name should also change maybe?

gribnoysup · 2025-12-08T08:09:33Z

packages/compass-generative-ai/src/utils/gen-ai-response.ts

+  const reader = response.getReader();
+  while (!done) {


Nit: the for await loop would be a more idiomatic way to deal with an async iterator I think

Suggested change

const reader = response.getReader();

while (!done) {

for await (const chunk of response) {

gribnoysup · 2025-12-08T08:10:20Z

packages/compass-generative-ai/src/utils/xml-to-mms-response.spec.ts

+import { parseXmlToMmsJsonResponse } from './xml-to-mms-response';
+import type { Logger } from '@mongodb-js/compass-logging';
+
+const loggerMock = {


Nit: this is what we have createNoopLogger for

gribnoysup · 2025-12-08T08:26:40Z

packages/compass-generative-ai/src/utils/xml-to-mms-response.ts

+  for (const tag of expectedTags) {
+    const regex = new RegExp(`<${tag}>([\\s\\S]*?)<\\/${tag}>`, 'i');
+    const match = xmlString.match(regex);


Probably fine to roll our own "parser" here, but just FYI DOMParser browser API exists

Added this in clean up error, names. This however requires me to add top-level tag to the string so that its parsable.

gribnoysup · 2025-12-08T08:28:44Z

packages/compass-generative-ai/src/chatbot-errors.ts

+
+export class AiChatbotInvalidResponseError extends AiChatbotError {
+  constructor(message: string) {
+    super(500, message, 'INVALID_RESPONSE');


Wouldn't we want to preserve the original server response code instead of hardcoding 500?

This is a bit tricky one. This is thrown when the server returns an error while streaming. I was unable to recreate this use-case locally and I am not how the server responds with error in this case (what's contained in chunk.errorText). I think its fine if we throw 500 because we are not streaming response to the query bar.

gribnoysup · 2025-12-08T08:34:15Z

packages/compass-generative-ai/src/chatbot-errors.ts

@@ -0,0 +1,20 @@
+export class AiChatbotError extends Error {


Is this a copy of AtlasServiceError that we export from the atlas-service package? This package depends on service already, can we just import it?

gribnoysup · 2025-12-08T09:05:04Z

packages/compass-generative-ai/src/utils/parse-xml-response.spec.ts

Naming nit: we don't usually use mms for naming in the codebase, it's an outdated term that is not really relevant here, especially as strictly speaking I guess this is not even an "mms response", it's just xml with selected fields parsed to json. There's probably a better name for that

mabaasit · 2025-12-08T20:39:22Z

We're planning to re-export the transport later down the road so that compass-assistant can depend on it isntead of having a copy, is that right?

Yes that's correct. I addressed the comments. Regarding using DOMParser I also added that and it required me to wrap the string in top-level node so that parsing does now throw.

mabaasit · 2025-12-09T08:24:22Z

@gribnoysup I'll merge it for now and if there's something more that needs to be addressed, I'll handle that in upcoming PR.

mabaasit and others added 19 commits November 25, 2025 12:16

add feature flag

1295d51

migrate prompts to compass

7a44de4

Merge branch 'main' into COMPASS-10082-add-mms-prompts-and-feature-flag

2e2defe

co-pilot feedback

d524682

Merge branch 'COMPASS-10082-add-mms-prompts-and-feature-flag' of http…

f9212fb

…s://github.com/mongodb-js/compass into COMPASS-10082-add-mms-prompts-and-feature-flag

clean up

c96161b

Merge branch 'main' into COMPASS-10082-add-mms-prompts-and-feature-flag

f499026

use edu api for gen ai

f4d05a7

clean up a bit

1763531

fix url for test and ensure aggregations have content

d5e2c84

tests

0781580

fix error handling

058e950

clean up transport

7d54d4d

Merge branch 'main' of https://github.com/mongodb-js/compass into COM…

0aa7ff5

…PASS-10081-switch-to-edu-api

changes in field name

309335a

use query parser

feacddc

fix check

c321983

fix test

f5a34df

clean up

91b17d5

mabaasit requested a review from a team as a code owner December 3, 2025 12:44

mabaasit requested review from Copilot and gribnoysup December 3, 2025 12:44

github-actions bot added the feat label Dec 3, 2025

mabaasit added feature flagged PRs labeled with this label will not be included in the release notes of the next release no release notes Fix or feature not for release notes labels Dec 3, 2025

Copilot AI reviewed Dec 3, 2025

View reviewed changes

packages/compass-generative-ai/src/utils/xml-to-mms-response.ts Outdated Show resolved Hide resolved

packages/compass-generative-ai/src/atlas-ai-service.ts Outdated Show resolved Hide resolved

packages/compass-generative-ai/src/atlas-ai-service.ts Show resolved Hide resolved

mabaasit added 3 commits December 3, 2025 15:53

copilot feedback

ea4dfdf

fix log id

f8a4c43

fix cors issue on e2e tests

8190219

github-advanced-security bot found potential problems Dec 4, 2025

View reviewed changes

packages/compass-e2e-tests/helpers/assistant-service.ts Dismissed Show dismissed Hide dismissed

codeowners-service-app bot requested a review from gagik December 4, 2025 07:46

gagik reviewed Dec 4, 2025

View reviewed changes

mabaasit added 2 commits December 4, 2025 15:07

more tests

c444cb9

add type

6eec8db

gribnoysup approved these changes Dec 8, 2025

View reviewed changes

gribnoysup reviewed Dec 8, 2025

View reviewed changes

gagik approved these changes Dec 8, 2025

View reviewed changes

mabaasit and others added 4 commits December 8, 2025 15:22

use noop logger and clean up api response handling

77a0eea

remove mms from name

aafe769

clean up error, names

089b30c

Merge branch 'main' into COMPASS-10081-switch-to-edu-api

0d2ab07

mabaasit merged commit 76e37ab into main Dec 9, 2025
107 of 109 checks passed

mabaasit deleted the COMPASS-10081-switch-to-edu-api branch December 9, 2025 08:24

	const reader = response.getReader();
	while (!done) {
	for await (const chunk of response) {

feat(gen-ai): use chatbot api for queries COMPASS-10081 #7623

feat(gen-ai): use chatbot api for queries COMPASS-10081 #7623

Uh oh!

Conversation

mabaasit commented Dec 3, 2025

Description

Checklist

Motivation and Context

Open Questions

Dependents

Types of changes

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!

codeowners-service-app bot commented Dec 4, 2025

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!

gribnoysup left a comment

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!

mabaasit commented Dec 8, 2025

Uh oh!

mabaasit commented Dec 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants