Skip to content

[8.x] update knowledge base installation flow (#214133) #218058

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

Closed
arturoliduena wants to merge 2 commits into from
Closed

[8.x] update knowledge base installation flow (#214133) #218058

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
c4bbbed
update knowledge base installation flow (#214133)
arturoliduena Apr 9, 2025
c5a79b4
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Apr 14, 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
122 changes: 0 additions & 122 deletions x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/knowledge_base_callout.tsx
View file
Open in desktop

This file was deleted.

6 changes: 5 additions & 1 deletion x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/welcome_message.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import type { ActionConnector } from '@kbn/triggers-actions-ui-plugin/public';
import { GenerativeAIForObservabilityConnectorFeatureId } from '@kbn/actions-plugin/common';
import { isSupportedConnectorType } from '@kbn/inference-common';
import { AssistantBeacon } from '@kbn/ai-assistant-icon';
import { KnowledgeBaseState } from '@kbn/observability-ai-assistant-plugin/public';
import type { UseKnowledgeBaseResult } from '../hooks/use_knowledge_base';
import type { UseGenAIConnectorsResult } from '../hooks/use_genai_connectors';
import { Disclaimer } from './disclaimer';
Expand Down Expand Up @@ -61,7 +62,10 @@ export function WelcomeMessage({
connectors.reloadConnectors();
}

if (!knowledgeBase.status.value || knowledgeBase.status.value?.ready === false) {
if (
!knowledgeBase.status.value ||
knowledgeBase.status.value?.kbState === KnowledgeBaseState.NOT_INSTALLED
) {
knowledgeBase.install();
}
};
Expand Down
127 changes: 107 additions & 20 deletions ...latform/packages/shared/kbn-ai-assistant/src/chat/welcome_message_knowledge_base.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import React from 'react';
import { act, render, screen } from '@testing-library/react';
import { KnowledgeBaseState } from '@kbn/observability-ai-assistant-plugin/public';

import { WelcomeMessageKnowledgeBase } from './welcome_message_knowledge_base';
import type { UseKnowledgeBaseResult } from '../hooks/use_knowledge_base';
Expand All @@ -21,12 +22,13 @@ describe('WelcomeMessageKnowledgeBase', () => {
): UseKnowledgeBaseResult {
return {
isInstalling: partial.isInstalling ?? false,
isPolling: partial.isPolling ?? false,
install: partial.install ?? jest.fn(),
installError: partial.installError,
status: partial.status ?? {
value: {
ready: false,
enabled: true,
errorMessage: undefined,
kbState: KnowledgeBaseState.NOT_INSTALLED,
},
loading: false,
error: undefined,
Expand All @@ -40,7 +42,18 @@ describe('WelcomeMessageKnowledgeBase', () => {
}

it('renders install message if isInstalling', () => {
const kb = createMockKnowledgeBase({ isInstalling: true });
const kb = createMockKnowledgeBase({
isInstalling: true,
status: {
value: {
enabled: true,
endpoint: { inference_id: 'inference_id' },
kbState: KnowledgeBaseState.PENDING_MODEL_DEPLOYMENT,
},
loading: false,
refresh: jest.fn(),
},
});
renderComponent(kb);

expect(screen.getByText(/We are setting up your knowledge base/i)).toBeInTheDocument();
Expand All @@ -51,23 +64,32 @@ describe('WelcomeMessageKnowledgeBase', () => {
// 1) Start in an installing state
let kb = createMockKnowledgeBase({
isInstalling: true,
isPolling: true,
status: {
value: { enabled: true, kbState: KnowledgeBaseState.NOT_INSTALLED },
loading: false,
refresh: jest.fn(),
},
});
const { rerender } = renderComponent(kb);

// Should not see success banner initially
expect(screen.queryByText(/Knowledge base successfully installed/i)).toBeNull();

// 2) Transition to isInstalling = false, no installError
kb = {
...kb,
isInstalling: false,
isPolling: false,
status: {
...kb.status,
value: {
...kb.status.value,
ready: true,
enabled: true,
endpoint: { inference_id: 'inference_id' },
kbState: KnowledgeBaseState.READY,
},
loading: false,
refresh: jest.fn(),
},
};

Expand All @@ -79,16 +101,70 @@ describe('WelcomeMessageKnowledgeBase', () => {
expect(screen.getByText(/Knowledge base successfully installed/i)).toBeInTheDocument();
});

it('renders "not set up" if installError is present', () => {
it('renders "We are setting up your knowledge base" with the inspect button', () => {
const kb = createMockKnowledgeBase({
installError: new Error('model deployment failed'),
isInstalling: false,
isPolling: true,
status: {
value: {
enabled: true,
endpoint: { inference_id: 'inference_id' },
kbState: KnowledgeBaseState.DEPLOYING_MODEL,
modelStats: {
deployment_stats: {
state: 'starting',
deployment_id: 'deployment_id',
model_id: 'model_id',
nodes: [],
peak_throughput_per_minute: 0,
priority: 'normal',
start_time: 0,
},
},
},
loading: false,
refresh: jest.fn(),
},
});
renderComponent(kb);

expect(screen.getByText(/Your Knowledge base hasn't been set up/i)).toBeInTheDocument();
expect(screen.getByText(/Install Knowledge base/i)).toBeInTheDocument();
// Because we have an installError, we also see "Inspect issues" button
expect(screen.getByText(/Inspect issues/i)).toBeInTheDocument();
expect(screen.getByText(/We are setting up your knowledge base/i)).toBeInTheDocument();
expect(screen.getByText(/Inspect/i)).toBeInTheDocument();
});

it('renders "Base setup failed" with inspect issues', () => {
const kb = createMockKnowledgeBase({
isInstalling: false,
isPolling: true,
status: {
value: {
enabled: true,
endpoint: { inference_id: 'inference_id' },
kbState: KnowledgeBaseState.ERROR,
modelStats: {
deployment_stats: {
reason: 'model deployment failed',
state: 'failed',
deployment_id: 'deployment_id',
model_id: 'model_id',
nodes: [],
peak_throughput_per_minute: 0,
priority: 'normal',
start_time: 0,
},
},
},
loading: false,
refresh: jest.fn(),
},
});
renderComponent(kb);

expect(
screen.getByText(/Knowledge Base setup failed. Check 'Inspect' for details./i)
).toBeInTheDocument();
// Because we have an reason error, we also see "Inspect" button
expect(screen.getAllByText(/Inspect/i)).toHaveLength(2);
});

it('renders "not set up" if server returns errorMessage (no endpoint exists) but user hasnt started installing', () => {
Expand All @@ -97,11 +173,10 @@ describe('WelcomeMessageKnowledgeBase', () => {
// automatically called
const kb = createMockKnowledgeBase({
isInstalling: false,
installError: undefined,
status: {
value: {
ready: false,
enabled: true,
kbState: KnowledgeBaseState.NOT_INSTALLED,
errorMessage: 'no endpoint',
},
loading: false,
Expand All @@ -112,18 +187,30 @@ describe('WelcomeMessageKnowledgeBase', () => {

expect(screen.getByText(/Your Knowledge base hasn't been set up/i)).toBeInTheDocument();
expect(screen.getByText(/Install Knowledge base/i)).toBeInTheDocument();
expect(screen.queryByText(/Inspect issues/i)).toBeNull();
expect(screen.queryByText(/Inspect/i)).toBeNull();
});

it('renders "not set up" if model is not ready (but no errorMessage because endpoint exists)', () => {
// This could happen if the user manually stopped the model in ML,
// so we have no install error, but ready = false
const kb = createMockKnowledgeBase({
isInstalling: false,
isPolling: true,
status: {
value: {
endpoint: {},
ready: false,
endpoint: { inference_id: 'inference_id' },
kbState: KnowledgeBaseState.DEPLOYING_MODEL,
modelStats: {
deployment_stats: {
reason: 'model deployment failed',
deployment_id: 'deployment_id',
model_id: 'model_id',
nodes: [],
peak_throughput_per_minute: 0,
priority: 'normal',
start_time: 0,
},
},
enabled: true,
},
loading: false,
Expand All @@ -133,16 +220,16 @@ describe('WelcomeMessageKnowledgeBase', () => {
});
renderComponent(kb);

expect(screen.getByText(/Your Knowledge base hasn't been set up/i)).toBeInTheDocument();
expect(screen.getByText(/Install Knowledge base/i)).toBeInTheDocument();
expect(screen.getByText(/Inspect issues/i)).toBeInTheDocument();
expect(screen.getByText(/We are setting up your knowledge base/i)).toBeInTheDocument();
expect(screen.getByText(/Inspect/i)).toBeInTheDocument();
});

it('renders nothing if the knowledge base is already installed', () => {
const kb = createMockKnowledgeBase({
status: {
value: {
ready: true,
kbState: KnowledgeBaseState.READY,
endpoint: { inference_id: 'inference_id' },
enabled: true,
errorMessage: undefined,
},
Expand Down
Loading