DO NOT MERGE: feat(ai): ensure data is stored correctly for gen-ai COMPASS-10314 by mabaasit · Pull Request #7772 · mongodb-js/compass

mabaasit · 2026-02-05T13:08:34Z

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)

Copilot

Pull request overview

Updates GenAI request metadata so OpenAI “store” is sent as a proper boolean and forwarded correctly, improving consistency of stored/returned items.

Changes:

Switch store metadata from string ('true'|'false') to boolean (true|false) across prompt building and tests.
Forward store explicitly in the OpenAI provider options for query responses.
Add assistant-side logic to disable storage in certain cases and a workaround to avoid itemId-based message compaction.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
packages/compass-generative-ai/src/utils/gen-ai-response.ts	Forwards `store` into OpenAI provider options to ensure storage behavior is applied.
packages/compass-generative-ai/src/utils/gen-ai-prompt.ts	Changes `store` type/value to boolean in prompt metadata.
packages/compass-generative-ai/src/utils/gen-ai-prompt.spec.ts	Updates expectations for boolean `store`.
packages/compass-generative-ai/src/atlas-ai-service.spec.ts	Adjusts request assertions for `store` handling and payload shape.
packages/compass-e2e-tests/tests/collection-ai-query.test.ts	Updates E2E assertions to validate boolean `store` at the request root (not metadata).
packages/compass-assistant/src/docs-provider-transport.ts	Adds storage-disabling logic + message transformation to avoid `itemId` compaction issues.
packages/compass-assistant/src/components/assistant-chat.tsx	Sets per-message “disable storage” metadata based on CSFLE connection detection.
packages/compass-assistant/src/compass-assistant-provider.tsx	Extends Assistant message metadata to carry the “disable storage” flag.

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

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

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

Copilot · 2026-02-09T09:03:04Z

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

+    const disbleStorage = filteredMessages.some(
+      (message) => message.metadata?.disbleStorage
+    );


This computes the storage flag based on any message in history. The metadata field is documented as applying to “this message”, so a single earlier disableStorage would unintentionally force store: false for subsequent messages. Prefer basing this on the outgoing message only (e.g., lastMessage.metadata?.disableStorage) or otherwise scoping it explicitly to the message(s) you intend to affect.

Suggested change

const disbleStorage = filteredMessages.some(

(message) => message.metadata?.disbleStorage

);

const disbleStorage = !!lastMessage.metadata?.disbleStorage;

No, we want to disable storage for the whole conversation if any of the messages has disableStorage set.

Copilot · 2026-02-09T09:03:04Z

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

      providerOptions: {
        openai: {
-          store: process.env.COMPASS_ASSISTANT_STORE === 'true' ? true : false,
+          store: !disbleStorage,


This change removes the previous environment-based gate (COMPASS_ASSISTANT_STORE) and makes storage enabled by default whenever disableStorage is not set. If the env var is still intended as a global kill-switch/config, combine both controls (e.g., env allows storage AND the message doesn’t disable it) rather than dropping the env check.

I don't think we still need that flag, cc @lerouxb

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

lerouxb · 2026-02-10T12:01:16Z

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

      const trimmedMessageBody = text.trim();
      if (trimmedMessageBody) {
        await chat.stop();
+        const isConnectedToCsfleCluster = activeConnections.some(


This is only the code for when a user manually sends a chat message. What about entrypoints? (ie. other places that also use ensureOptInAndSend)

Good point, i'll handle those as well

added in 3fc12a6

lerouxb · 2026-02-10T12:02:27Z

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

+
+    // EAI-1506 The chatbot API never forwards `store: true` to the OpenAI, as a
+    // result even when `store: true` is set the API response does not include a
+    // valid `itemId`. On client side (check openai > convertToOpenAIResponsesInput),


You can probably just add a link to https://github.com/vercel/ai/blob/610b98ed4764407d5cc2bfe64b9ad27b740e1cf9/packages/openai/src/responses/convert-to-openai-responses-input.ts#L171-L175 ?

lerouxb · 2026-02-10T12:04:06Z

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

+              case 'tool-call':
+              case 'tool-result':
+              case 'reasoning':
+              case 'file': {


Is it safe to hardcode this list of types? why not just check for part.providerOptions?.openai?.itemId and ignore part.type completely? types still get added all the time at the speed that AI's been advancing.

addaleax · 2026-02-11T13:45:53Z

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

+            metadata: {
+              sendContext: true,
+              ...metadata,
+              disableStorage: isConnectedToCsfleCluster,


Let's not call this CSFLE if it also covers QE (which it does)

…b.com/mongodb-js/compass into COMPASS-10314-correctly-store-prompts

ensure data is stored correctly for gen-ai

b8f2895

github-actions bot added the feat label Feb 5, 2026

mabaasit added the release notes label Feb 5, 2026

mabaasit added 5 commits February 5, 2026 15:53

enable assistant storage

7679b4d

remove console

a1a9496

fix for EAI-1506

659f726

clean up 'store'

c38cbe5

fix test

4418dad

mabaasit marked this pull request as ready for review February 9, 2026 09:01

mabaasit requested a review from a team as a code owner February 9, 2026 09:01

mabaasit requested review from Copilot and lerouxb February 9, 2026 09:01

Copilot AI reviewed Feb 9, 2026

View reviewed changes

mabaasit and others added 2 commits February 9, 2026 10:11

fix typo

16c9b14

Merge branch 'main' into COMPASS-10314-correctly-store-prompts

752e7d9

mabaasit changed the title ~~feat(ai): ensure data is stored correctly for gen-ai COMPASS-10314~~ DO NOT MERGE: feat(ai): ensure data is stored correctly for gen-ai COMPASS-10314 Feb 10, 2026

lerouxb reviewed Feb 10, 2026

View reviewed changes

addaleax reviewed Feb 11, 2026

View reviewed changes

mabaasit and others added 5 commits February 11, 2026 14:52

handle entrypoints and address PR feedback

3fc12a6

add e2e tests

4920e33

Merge branch 'main' into COMPASS-10314-correctly-store-prompts

c7275d2

wait for request

de413c7

Merge branch 'COMPASS-10314-correctly-store-prompts' of https://githu…

d3e09e7

…b.com/mongodb-js/compass into COMPASS-10314-correctly-store-prompts

mabaasit requested a review from lerouxb February 13, 2026 09:57

lerouxb approved these changes Feb 13, 2026

View reviewed changes

Conversation

mabaasit commented Feb 5, 2026

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!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants