-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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.
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
[Obs AI Assistant] fix knowledge base installation state #206130
Merged
neptunian
merged 12 commits into
elastic:main
from
neptunian:205970-fix-kb-install-status
Jan 15, 2025
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
77362bf
fix install status
neptunian 0e5d496
update state
neptunian bd26ec6
unit tests
neptunian 5faea80
fix translation
neptunian 656f7cf
Merge branch 'main' into 205970-fix-kb-install-status
neptunian b23e701
Merge branch 'main' into 205970-fix-kb-install-status
neptunian f9482f5
remove connector length check, update tests, change model in progress…
neptunian 8e8f101
move connector check to parent
neptunian ea007ca
Update x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/welc…
neptunian 1ac26c6
Update x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/welc…
neptunian 846ce1c
Update x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/welc…
neptunian cc14aae
Update x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/welc…
neptunian File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
266 changes: 266 additions & 0 deletions
266
...latform/packages/shared/kbn-ai-assistant/src/chat/welcome_message_knowledge_base.test.tsx
This file contains 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,266 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License | ||
* 2.0; you may not use this file except in compliance with the Elastic License | ||
* 2.0. | ||
*/ | ||
|
||
import React from 'react'; | ||
import { act, render, screen } from '@testing-library/react'; | ||
|
||
import { WelcomeMessageKnowledgeBase } from './welcome_message_knowledge_base'; | ||
import type { UseGenAIConnectorsResult } from '../hooks/use_genai_connectors'; | ||
import type { UseKnowledgeBaseResult } from '../hooks/use_knowledge_base'; | ||
|
||
describe('WelcomeMessageKnowledgeBase', () => { | ||
afterEach(() => { | ||
jest.clearAllMocks(); | ||
}); | ||
type StatusType = NonNullable<UseKnowledgeBaseResult['status']['value']>; | ||
type EndpointType = StatusType['endpoint']; | ||
const endpoint: EndpointType = { | ||
inference_id: 'obs_ai_assistant_kb_inference', | ||
task_type: 'sparse_embedding', | ||
service: 'elasticsearch', | ||
service_settings: { | ||
num_threads: 1, | ||
model_id: '.elser_model_2', | ||
adaptive_allocations: { | ||
enabled: true, | ||
min_number_of_allocations: 1, | ||
}, | ||
}, | ||
}; | ||
const initKnowledgeBase: UseKnowledgeBaseResult = { | ||
isInstalling: false, | ||
install: jest.fn(), | ||
installError: undefined, | ||
status: { | ||
value: { | ||
ready: false, | ||
enabled: true, | ||
errorMessage: 'error', | ||
}, | ||
loading: false, | ||
refresh: jest.fn(), | ||
}, | ||
}; | ||
const defaultConnectors: UseGenAIConnectorsResult = { | ||
connectors: [ | ||
{ | ||
id: 'default-connector-id', | ||
actionTypeId: 'action-type-id', | ||
name: 'Default Connector', | ||
isPreconfigured: false, | ||
isDeprecated: false, | ||
isSystemAction: false, | ||
referencedByCount: 0, | ||
}, | ||
], | ||
selectedConnector: undefined, | ||
loading: false, | ||
error: undefined, | ||
selectConnector: jest.fn(), | ||
reloadConnectors: jest.fn(), | ||
}; | ||
function renderComponent({ | ||
knowledgeBase, | ||
connectors, | ||
}: { | ||
knowledgeBase: Partial<UseKnowledgeBaseResult>; | ||
connectors: Partial<UseGenAIConnectorsResult>; | ||
}) { | ||
const mergedKnowledgeBase: UseKnowledgeBaseResult = { | ||
...initKnowledgeBase, | ||
...knowledgeBase, | ||
status: { | ||
...initKnowledgeBase.status, | ||
...knowledgeBase.status, | ||
}, | ||
}; | ||
|
||
return render( | ||
<WelcomeMessageKnowledgeBase | ||
knowledgeBase={mergedKnowledgeBase} | ||
connectors={defaultConnectors} | ||
/> | ||
); | ||
} | ||
|
||
it('renders "Setting up Knowledge base" message while inference endpoint is installing', () => { | ||
renderComponent({ | ||
knowledgeBase: { | ||
isInstalling: true, | ||
}, | ||
connectors: defaultConnectors, | ||
}); | ||
|
||
expect( | ||
screen.getByText('We are setting up your knowledge base', { exact: false }) | ||
).toBeInTheDocument(); | ||
|
||
expect(screen.getByText('Setting up Knowledge base', { exact: false })).toBeInTheDocument(); | ||
}); | ||
it('renders "Setting up Knowledge base" message while model is being deployed without deployment or allocation state yet being reported', () => { | ||
renderComponent({ | ||
knowledgeBase: { | ||
isInstalling: false, | ||
status: { | ||
value: { | ||
endpoint, | ||
ready: false, | ||
enabled: true, | ||
model_stats: { allocation_count: 0 }, | ||
}, | ||
loading: false, | ||
refresh: jest.fn(), | ||
}, | ||
}, | ||
connectors: defaultConnectors, | ||
}); | ||
expect( | ||
screen.getByText('We are setting up your knowledge base', { exact: false }) | ||
).toBeInTheDocument(); | ||
}); | ||
it('renders "Setting up Knowledge base" message while model is being deployed and starting', () => { | ||
renderComponent({ | ||
knowledgeBase: { | ||
isInstalling: false, | ||
status: { | ||
value: { | ||
endpoint, | ||
ready: false, | ||
enabled: true, | ||
model_stats: { | ||
deployment_state: 'starting', | ||
allocation_state: 'starting', | ||
}, | ||
}, | ||
loading: false, | ||
refresh: jest.fn(), | ||
}, | ||
}, | ||
connectors: defaultConnectors, | ||
}); | ||
|
||
expect( | ||
screen.getByText('We are setting up your knowledge base', { exact: false }) | ||
).toBeInTheDocument(); | ||
}); | ||
it('displays success message after installation and hides it after timeout', async () => { | ||
jest.useFakeTimers(); | ||
|
||
// Step 1: Initially not installed | ||
const { rerender } = renderComponent({ | ||
knowledgeBase: { | ||
isInstalling: true, | ||
}, | ||
connectors: defaultConnectors, | ||
}); | ||
|
||
// Step 2: Now it's ready | ||
await act(async () => { | ||
rerender( | ||
<WelcomeMessageKnowledgeBase | ||
knowledgeBase={{ | ||
...initKnowledgeBase, | ||
status: { | ||
...initKnowledgeBase.status, | ||
value: { | ||
ready: true, | ||
enabled: true, | ||
model_stats: { deployment_state: 'started', allocation_state: 'started' }, | ||
}, | ||
}, | ||
}} | ||
connectors={defaultConnectors} | ||
/> | ||
); | ||
}); | ||
|
||
// the success message should appear | ||
expect(screen.queryByText(/Knowledge base successfully installed/i)).toBeInTheDocument(); | ||
|
||
// fast-forward until the success message would disappear | ||
await act(async () => { | ||
jest.runOnlyPendingTimers(); | ||
}); | ||
|
||
// now it should be gone | ||
expect(screen.queryByText('Knowledge base successfully installed')).toBeNull(); | ||
}); | ||
|
||
it('renders no install messages when model has been installed and ready', () => { | ||
// component should render nothing in this state (null) | ||
renderComponent({ | ||
knowledgeBase: { | ||
isInstalling: false, | ||
status: { | ||
...initKnowledgeBase.status, | ||
value: { | ||
ready: true, | ||
enabled: true, | ||
model_stats: { deployment_state: 'started', allocation_state: 'started' }, | ||
}, | ||
}, | ||
}, | ||
connectors: defaultConnectors, | ||
}); | ||
expect(screen.queryByText(/We are setting up your knowledge base/i)).not.toBeInTheDocument(); | ||
expect(screen.queryByText(/Your Knowledge base hasn't been set up./i)).not.toBeInTheDocument(); | ||
}); | ||
|
||
it('renders knowledge base install and model state inspect when not installing and the inference endpoint installation has an error', () => { | ||
renderComponent({ | ||
knowledgeBase: { | ||
isInstalling: false, | ||
installError: new Error('inference endpoint failed to install'), | ||
}, | ||
connectors: defaultConnectors, | ||
}); | ||
expect( | ||
screen.getByText("Your Knowledge base hasn't been set up", { exact: false }) | ||
).toBeInTheDocument(); | ||
expect(screen.getByText('Install Knowledge base', { exact: false })).toBeInTheDocument(); | ||
expect(screen.getByText('Inspect issues', { exact: false })).toBeInTheDocument(); | ||
}); | ||
|
||
it('renders knowledge base install and model state inspect when not installing and no errors', () => { | ||
// this can happen when you have a preconfigured connector, | ||
// we don't automatically install in this case and just show the same UI as if there was an issue/error | ||
renderComponent({ | ||
knowledgeBase: { | ||
isInstalling: false, | ||
}, | ||
connectors: defaultConnectors, | ||
}); | ||
expect( | ||
screen.getByText("Your Knowledge base hasn't been set up", { exact: false }) | ||
).toBeInTheDocument(); | ||
expect(screen.getByText('Install Knowledge base', { exact: false })).toBeInTheDocument(); | ||
expect(screen.getByText('Inspect issues', { exact: false })).toBeInTheDocument(); | ||
}); | ||
|
||
it('renders knowledge base install and model state inspect when not installing and model is not ready', () => { | ||
// this state can occur if the model is having a deployment problem | ||
renderComponent({ | ||
knowledgeBase: { | ||
isInstalling: false, | ||
status: { | ||
...initKnowledgeBase.status, | ||
value: { | ||
ready: false, | ||
enabled: true, | ||
model_stats: { deployment_state: 'failed', allocation_state: 'started' }, | ||
}, | ||
}, | ||
}, | ||
connectors: defaultConnectors, | ||
}); | ||
expect( | ||
screen.getByText("Your Knowledge base hasn't been set up", { exact: false }) | ||
).toBeInTheDocument(); | ||
expect(screen.getByText('Install Knowledge base', { exact: false })).toBeInTheDocument(); | ||
expect(screen.getByText('Inspect issues', { exact: false })).toBeInTheDocument(); | ||
}); | ||
}); | ||
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.
Thanks for adding a very thorough test!