Skip to content
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

Jump to bottom

[Security solution] Assistant telemetry conversation id fix #173794

Merged
merged 2 commits into from
Dec 21, 2023
Merged

[Security solution] Assistant telemetry conversation id fix #173794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd0bf0f
fix
stephmilovic Dec 20, 2023
40b30cd
fix typo
stephmilovic Dec 20, 2023
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
17 changes: 9 additions & 8 deletions x-pack/packages/kbn-elastic-assistant/impl/assistant/assistant_overlay/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ export const AssistantOverlay = React.memo(() => {
WELCOME_CONVERSATION_TITLE
);
const [promptContextId, setPromptContextId] = useState<string | undefined>();
const { assistantTelemetry, setShowAssistantOverlay, localStorageLastConversationId } =
useAssistantContext();
const { assistantTelemetry, setShowAssistantOverlay, getConversationId } = useAssistantContext();

// Bind `showAssistantOverlay` in SecurityAssistantContext to this modal instance
const showOverlay = useCallback(
Expand All @@ -44,16 +43,18 @@ export const AssistantOverlay = React.memo(() => {
promptContextId: pid,
conversationId: cid,
}: ShowAssistantOverlayProps) => {
const newConversationId = getConversationId(cid);
if (so)
assistantTelemetry?.reportAssistantInvoked({
conversationId: cid ?? 'unknown',
conversationId: newConversationId,
invokedBy: 'click',
});

setIsModalVisible(so);
setPromptContextId(pid);
setConversationId(cid);
setConversationId(newConversationId);
},
[assistantTelemetry]
[assistantTelemetry, getConversationId]
);
useEffect(() => {
setShowAssistantOverlay(showOverlay);
Expand All @@ -63,15 +64,15 @@ export const AssistantOverlay = React.memo(() => {
const handleShortcutPress = useCallback(() => {
// Try to restore the last conversation on shortcut pressed
if (!isModalVisible) {
setConversationId(localStorageLastConversationId ?? WELCOME_CONVERSATION_TITLE);
setConversationId(getConversationId());
assistantTelemetry?.reportAssistantInvoked({
invokedBy: 'shortcut',
conversationId: localStorageLastConversationId ?? WELCOME_CONVERSATION_TITLE,
conversationId: getConversationId(),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for ensuring all code paths return a consistent id with the new getConversationId() function!

The expected conversation id is included when the assistant is launched from the:
💹 Alerts flyout / page
💹 Data quality results / page
💹 Cases page
💹 Timeline
...and other contexts.

💹 The expected conversation ID is included for both default (e.g. Alert summary) and Custom conversations

});
}

setIsModalVisible(!isModalVisible);
}, [assistantTelemetry, isModalVisible, localStorageLastConversationId]);
}, [assistantTelemetry, isModalVisible, getConversationId]);

// Register keyboard listener to show the modal when cmd + ; is pressed
const onKeyDown = useCallback(
Expand Down
9 changes: 2 additions & 7 deletions x-pack/packages/kbn-elastic-assistant/impl/assistant/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ const AssistantComponent: React.FC<Props> = ({
http,
promptContexts,
setLastConversationId,
localStorageLastConversationId,
getConversationId,
title,
allSystemPrompts,
} = useAssistantContext();
Expand Down Expand Up @@ -113,12 +113,7 @@ const AssistantComponent: React.FC<Props> = ({
);

const [selectedConversationId, setSelectedConversationId] = useState<string>(
isAssistantEnabled
? // if a conversationId has been provided, use that
// if not, check local storage
// last resort, go to welcome conversation
conversationId ?? localStorageLastConversationId ?? WELCOME_CONVERSATION_TITLE
: WELCOME_CONVERSATION_TITLE
isAssistantEnabled ? getConversationId(conversationId) : WELCOME_CONVERSATION_TITLE
);

useEffect(() => {
Expand Down
23 changes: 23 additions & 0 deletions x-pack/packages/kbn-elastic-assistant/impl/assistant_context/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ import { AssistantProvider, useAssistantContext } from '.';
import { httpServiceMock } from '@kbn/core-http-browser-mocks';
import { actionTypeRegistryMock } from '@kbn/triggers-actions-ui-plugin/public/application/action_type_registry.mock';
import { AssistantAvailability } from '../..';
import { useLocalStorage } from 'react-use';

jest.mock('react-use', () => ({
useLocalStorage: jest.fn().mockReturnValue(['456', jest.fn()]),
}));
const actionTypeRegistry = actionTypeRegistryMock.create();
const mockGetInitialConversations = jest.fn(() => ({}));
const mockGetComments = jest.fn(() => []);
Expand Down Expand Up @@ -70,4 +74,23 @@ describe('AssistantContext', () => {

expect(mockHttp.fetch).toBeCalledWith(path);
});

test('getConversationId defaults to provided id', async () => {
const { result } = renderHook(useAssistantContext, { wrapper: ContextWrapper });
const id = result.current.getConversationId('123');
expect(id).toEqual('123');
});

test('getConversationId uses local storage id when no id is provided ', async () => {
const { result } = renderHook(useAssistantContext, { wrapper: ContextWrapper });
const id = result.current.getConversationId();
expect(id).toEqual('456');
});

test('getConversationId defaults to Welcome when no local storage id and no id is provided ', async () => {
(useLocalStorage as jest.Mock).mockReturnValue([undefined, jest.fn()]);
const { result } = renderHook(useAssistantContext, { wrapper: ContextWrapper });
const id = result.current.getConversationId();
expect(id).toEqual('Welcome');
});
});
15 changes: 12 additions & 3 deletions x-pack/packages/kbn-elastic-assistant/impl/assistant_context/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import type { IToasts } from '@kbn/core-notifications-browser';
import { ActionTypeRegistryContract } from '@kbn/triggers-actions-ui-plugin/public';
import { useLocalStorage } from 'react-use';
import type { DocLinksStart } from '@kbn/core-doc-links-browser';
import { WELCOME_CONVERSATION_TITLE } from '../assistant/use_conversation/translations';
import { updatePromptContexts } from './helpers';
import type {
PromptContext,
Expand Down Expand Up @@ -136,7 +137,7 @@ export interface UseAssistantContext {
}) => EuiCommentProps[];
http: HttpSetup;
knowledgeBase: KnowledgeBaseConfig;
localStorageLastConversationId: string | undefined;
getConversationId: (id?: string) => string;
promptContexts: Record<string, PromptContext>;
modelEvaluatorEnabled: boolean;
nameSpace: string;
Expand Down Expand Up @@ -292,6 +293,14 @@ export const AssistantProvider: React.FC<AssistantProviderProps> = ({
[setConversations]
);

const getConversationId = useCallback(
// if a conversationId has been provided, use that
// if not, check local storage
// last resort, go to welcome conversation
(id?: string) => id ?? localStorageLastConversationId ?? WELCOME_CONVERSATION_TITLE,
[localStorageLastConversationId]
);

const value = useMemo(
() => ({
actionTypeRegistry,
Expand Down Expand Up @@ -334,7 +343,7 @@ export const AssistantProvider: React.FC<AssistantProviderProps> = ({
title,
toasts,
unRegisterPromptContext,
localStorageLastConversationId,
getConversationId,
setLastConversationId: setLocalStorageLastConversationId,
}),
[
Expand All @@ -358,7 +367,7 @@ export const AssistantProvider: React.FC<AssistantProviderProps> = ({
getComments,
http,
localStorageKnowledgeBase,
localStorageLastConversationId,
getConversationId,
localStorageQuickPrompts,
localStorageSystemPrompts,
modelEvaluatorEnabled,
Expand Down
Loading