chore(compass-assistant): add explain plan entry point COMPASS-9606 #7208
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -5,29 +5,73 @@ import { createContext, useContext } from 'react'; | |||||
| import { registerCompassPlugin } from '@mongodb-js/compass-app-registry'; | ||||||
| import { atlasServiceLocator } from '@mongodb-js/atlas-service/provider'; | ||||||
| import { DocsProviderTransport } from './docs-provider-transport'; | ||||||
| import { useDrawerActions } from '@mongodb-js/compass-components'; | ||||||
| import { buildExplainPlanPrompt } from './prompts'; | ||||||
| import { usePreference } from 'compass-preferences-model/provider'; | ||||||
|
|
||||||
| export const ASSISTANT_DRAWER_ID = 'compass-assistant-drawer'; | ||||||
|
|
||||||
| export type AssistantMessage = UIMessage & { | ||||||
| metadata?: { | ||||||
| /** The text to display instead of the message text. */ | ||||||
| displayText?: string; | ||||||
| }; | ||||||
| }; | ||||||
|
|
||||||
| type AssistantContextType = Chat<AssistantMessage>; | ||||||
|
|
||||||
| export const AssistantContext = createContext<AssistantContextType | null>( | ||||||
| null | ||||||
| ); | ||||||
|
|
||||||
| type AssistantActionsContextType = { | ||||||
| interpretExplainPlan: ({ | ||||||
| namespace, | ||||||
| explainPlan, | ||||||
| }: { | ||||||
| namespace: string; | ||||||
| explainPlan: string; | ||||||
| }) => void; | ||||||
| }; | ||||||
| export const AssistantActionsContext = | ||||||
| createContext<AssistantActionsContextType>({ | ||||||
| interpretExplainPlan: () => {}, | ||||||
| }); | ||||||
|
|
||||||
| export function useAssistantActions(): AssistantActionsContextType & { | ||||||
| isAssistantEnabled: boolean; | ||||||
| } { | ||||||
| const isAssistantEnabled = usePreference('enableAIAssistant'); | ||||||
|
|
||||||
| return { | ||||||
| ...useContext(AssistantActionsContext), | ||||||
| isAssistantEnabled, | ||||||
| }; | ||||||
| } | ||||||
|
|
||||||
| export const AssistantProvider: React.FunctionComponent< | ||||||
| PropsWithChildren<{ | ||||||
| chat: Chat<AssistantMessage>; | ||||||
| }> | ||||||
| > = ({ chat, children }) => { | ||||||
| const assistantActionsContext = useRef<AssistantActionsContextType>({ | ||||||
| interpretExplainPlan: ({ explainPlan }) => { | ||||||
| openDrawer(ASSISTANT_DRAWER_ID); | ||||||
| const { prompt, displayText } = buildExplainPlanPrompt({ | ||||||
| explainPlan, | ||||||
| }); | ||||||
| void chat.sendMessage( | ||||||
|
There was a problem hiding this comment. [nitpick] Using 'void' to ignore the promise is acceptable here, but consider adding error handling for the sendMessage call to provide better user feedback if the operation fails.
Suggested change
Contributor
Author
There was a problem hiding this comment. this will be followed up later and handled with |
||||||
| { | ||||||
| text: prompt, | ||||||
| metadata: { | ||||||
| displayText, | ||||||
| }, | ||||||
| }, | ||||||
| {} | ||||||
| ); | ||||||
| }, | ||||||
| }); | ||||||
| const { openDrawer } = useDrawerActions(); | ||||||
|
|
||||||
| return ( | ||||||
| <AssistantContext.Provider value={chat}> | ||||||
|
|
@@ -45,7 +89,7 @@ export const CompassAssistantProvider = registerCompassPlugin( | |||||
| chat, | ||||||
| children, | ||||||
| }: PropsWithChildren<{ | ||||||
| chat?: Chat<AssistantMessage>; | ||||||
| }>) => { | ||||||
| if (!chat) { | ||||||
| throw new Error('Chat was not provided by the state'); | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| export { CompassAssistantProvider } from './compass-assistant-provider'; | ||
| export { CompassAssistantDrawer } from './compass-assistant-drawer'; | ||
| export { useAssistantActions } from './compass-assistant-provider'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| export const buildExplainPlanPrompt = ({ | ||
| explainPlan, | ||
| }: { | ||
| explainPlan: string; | ||
| }) => { | ||
| return { | ||
| prompt: `Given the MongoDB explain plan output below, provide a concise human readable explanation that explains the query execution plan and highlights aspects of the plan that might impact query performance. Respond with as much concision and clarity as possible. | ||
| If a clear optimization should be made, please suggest the optimization and describe how it can be accomplished in MongoDB Compass. Do not advise users to create indexes without weighing the pros and cons. | ||
|
Contributor
There was a problem hiding this comment. I'm so skeptical about this 😆 |
||
| Explain output: | ||
| ${explainPlan}`, | ||
| displayText: 'Provide an explanation of this explain plan.', | ||
| }; | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,17 @@ | ||
| import { Chat } from '../src/@ai-sdk/react/chat-react'; | ||
| import sinon from 'sinon'; | ||
| import type { AssistantMessage } from '../src/compass-assistant-provider'; | ||
|
|
||
| export const createMockChat = ({ | ||
| messages, | ||
| }: { | ||
| messages: AssistantMessage[]; | ||
| }) => { | ||
| const newChat = new Chat<AssistantMessage>({ | ||
| messages, | ||
| }); | ||
| sinon.replace(newChat, 'sendMessage', sinon.stub()); | ||
| return newChat as unknown as Chat<AssistantMessage> & { | ||
| sendMessage: sinon.SinonStub; | ||
| }; | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The display logic uses a complex ternary expression that could be simplified for better readability. Consider extracting this into a helper function or variable to make the intent clearer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personally I would do this, but it is indeed nitpicky.