Skip to content

feat(gen-ai): enable chatbot-gen-ai feature COMPASS-10125 #7650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mabaasit merged 4 commits into from
Dec 16, 2025
Merged

feat(gen-ai): enable chatbot-gen-ai feature COMPASS-10125 #7650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
730e907
enable feature
mabaasit Dec 15, 2025
a2c4323
clean up
mabaasit Dec 15, 2025
06c4d94
clean up use of feature flag in tests
mabaasit Dec 15, 2025
ceb5e0d
Merge branch 'main' of https://github.com/mongodb-js/compass into COM…
mabaasit Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
169 changes: 3 additions & 166 deletions packages/compass-e2e-tests/tests/collection-ai-query.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
import { expect } from 'chai';

import type { CompassBrowser } from '../helpers/compass-browser';
import { startTelemetryServer } from '../helpers/telemetry';
import type { Telemetry } from '../helpers/telemetry';
import {
init,
cleanup,
Expand All @@ -13,167 +11,8 @@ import {
import type { Compass } from '../helpers/compass';
import * as Selectors from '../helpers/selectors';
import { createNumbersCollection } from '../helpers/insert-data';
import { startMockAtlasServiceServer } from '../helpers/mock-atlas-service';
import type { MockAtlasServerResponse } from '../helpers/mock-atlas-service';
import { startMockAssistantServer } from '../helpers/assistant-service';

describe('Collection ai query (with mocked backend)', function () {
let compass: Compass;
let browser: CompassBrowser;
let telemetry: Telemetry;
let setMockAtlasServerResponse: (response: MockAtlasServerResponse) => void;
let stopMockAtlasServer: () => Promise<void>;
let getRequests: () => any[];
let clearRequests: () => void;

before(async function () {
// Start a mock server to pass an ai response.
const {
endpoint,
getRequests: _getRequests,
clearRequests: _clearRequests,
setMockAtlasServerResponse: _setMockAtlasServerResponse,
stop,
} = await startMockAtlasServiceServer();

stopMockAtlasServer = stop;
getRequests = _getRequests;
clearRequests = _clearRequests;
setMockAtlasServerResponse = _setMockAtlasServerResponse;

telemetry = await startTelemetryServer();
compass = await init(this.test?.fullTitle());
browser = compass.browser;

await browser.setEnv(
'COMPASS_ATLAS_SERVICE_UNAUTH_BASE_URL_OVERRIDE',
endpoint
);

await browser.setFeature('enableGenAIFeatures', true);
await browser.setFeature('enableGenAISampleDocumentPassing', true);
await browser.setFeature('optInGenAIFeatures', true);

await browser.setupDefaultConnections();
});

beforeEach(async function () {
await createNumbersCollection();
await browser.disconnectAll();
await browser.connectToDefaults();
await browser.navigateToCollectionTab(
DEFAULT_CONNECTION_NAME_1,
'test',
'numbers',
'Documents'
);
});

after(async function () {
await stopMockAtlasServer();

await cleanup(compass);
await telemetry.stop();
});

afterEach(async function () {
clearRequests();
await screenshotIfFailed(compass, this.currentTest);
});

describe('when the ai model response is valid', function () {
beforeEach(function () {
setMockAtlasServerResponse({
status: 200,
body: {
content: {
query: {
filter: '{i: {$gt: 50}}',
},
},
},
});
});

it('makes request to the server and updates the query bar with the response', async function () {
// Click the ai entry button.
await browser.clickVisible(Selectors.GenAIEntryButton);

// Enter the ai prompt.
await browser.clickVisible(Selectors.GenAITextInput);

const testUserInput = 'find all documents where i is greater than 50';
await browser.setValueVisible(Selectors.GenAITextInput, testUserInput);

// Click generate.
await browser.clickVisible(Selectors.GenAIGenerateQueryButton);

// Wait for the ipc events to succeed.
await browser.waitUntil(async function () {
// Make sure the query bar was updated.
const queryBarFilterContent = await browser.getCodemirrorEditorText(
Selectors.queryBarOptionInputFilter('Documents')
);
return queryBarFilterContent === '{i: {$gt: 50}}';
});

// Check that the request was made with the correct parameters.
const requests = getRequests();
expect(requests.length).to.equal(1);

const queryRequest = requests[0];
const queryURL = new URL(
queryRequest.req.url,
`http://${queryRequest.req.headers.host}`
);
expect([...new Set(queryURL.searchParams.keys())].length).to.equal(1);
const requestId = queryURL.searchParams.get('request_id');
expect((requestId?.match(/-/g) || []).length).to.equal(4); // Is uuid like.
expect(queryRequest.content.userInput).to.equal(testUserInput);
expect(queryRequest.content.collectionName).to.equal('numbers');
expect(queryRequest.content.databaseName).to.equal('test');
expect(queryRequest.content.schema).to.exist;

// Run it and check that the correct documents are shown.
await browser.runFind('Documents', true);
const modifiedResult = await browser.getFirstListDocument();
expect(modifiedResult.i).to.be.equal('51');
});
});

describe('when the Atlas service request errors', function () {
beforeEach(function () {
setMockAtlasServerResponse({
status: 500,
body: {
content: 'error',
},
});
});

it('the error is shown to the user', async function () {
// Click the ai entry button.
await browser.clickVisible(Selectors.GenAIEntryButton);

// Enter the ai prompt.
await browser.clickVisible(Selectors.GenAITextInput);

const testUserInput = 'find all documents where i is greater than 50';
await browser.setValueVisible(Selectors.GenAITextInput, testUserInput);

// Click generate.
await browser.clickVisible(Selectors.GenAIGenerateQueryButton);

// Check that the error is shown.
const errorBanner = browser.$(Selectors.GenAIErrorMessageBanner);
await errorBanner.waitForDisplayed();
expect(await errorBanner.getText()).to.equal(
'Sorry, we were unable to generate the query, please try again. If the error persists, try changing your prompt.'
);
});
});
});

async function setup(
browser: CompassBrowser,
dbName: string,
Expand All @@ -189,13 +28,12 @@ async function setup(
'Documents'
);

await browser.setFeature('enableChatbotEndpointForGenAI', true);
await browser.setFeature('enableGenAIFeatures', true);
await browser.setFeature('enableGenAISampleDocumentPassing', true);
await browser.setFeature('optInGenAIFeatures', true);
}

describe('Collection ai query with chatbot (with mocked backend)', function () {
describe('Collection ai query (with mocked backend)', function () {
const dbName = 'test';
const collName = 'numbers';
let compass: Compass;
Expand Down Expand Up @@ -266,9 +104,8 @@ describe('Collection ai query with chatbot (with mocked backend)', function () {

const queryRequest = requests[0];
expect(queryRequest.req.headers).to.have.property('x-client-request-id');
// TODO(COMPASS-10125): Switch the model to `mongodb-slim-latest` when
// enabling this feature.
expect(queryRequest.content.model).to.equal('mongodb-chat-latest');
expect(queryRequest.req.headers).to.have.property('entrypoint');
expect(queryRequest.content.model).to.equal('mongodb-slim-latest');
expect(queryRequest.content.instructions).to.be.string;
expect(queryRequest.content.metadata).to.have.property('userId');
expect(queryRequest.content.metadata.store).to.have.equal('true');
Expand Down
Loading
Loading