feat(lightspeed): align with road-core API endpoints (#666)

* feat(lightspeed): align with road-core API endpoints

* fix e2e tests

* add inline error messages

Author: karthikjeeyar

workspaces/lightspeed/.changeset/shy-carrots-jog.md

@@ -0,0 +1,5 @@
+---
+'@red-hat-developer-hub/backstage-plugin-lightspeed': minor
+---
+
+Align with road-core service API response

workspaces/lightspeed/packages/app/e2e-tests/fixtures/responses.ts

@@ -39,21 +39,26 @@ export const defaultConversation = {
 export const conversations = [
   {
     conversation_id: 'user:development/guest+Av8Fax73D4XPx5Ls',
-    summary: 'Conversation 1',
-    lastMessageTimestamp: createdAt,
+    topic_summary: 'Conversation 1',
+    last_message_timestamp: createdAt,
+  },
+  {
+    conversation_id: 'temp-conversation-id',
+    topic_summary: 'Temporary conversation',
+    last_message_timestamp: createdAt,
   },
 ];
 
 export const moreConversations = [
   {
     conversation_id: 'user:development/guest+Av8Fax73D4XPx5Ls',
-    summary: 'Conversation 1',
-    lastMessageTimestamp: createdAt,
+    topic_summary: 'Conversation 1',
+    last_message_timestamp: createdAt,
   },
   {
     conversation_id: 'user:development/guest+Av8Fax73D4XPx5La',
-    summary: 'New Conversation',
-    lastMessageTimestamp: createdAt,
+    topic_summary: 'New Conversation',
+    last_message_timestamp: createdAt,
   },
 ];
 
@@ -62,24 +67,20 @@ export const contents = [
     lc: 1,
     type: 'constructor',
     id: ['langchain_core', 'messages', 'HumanMessage'],
-    kwargs: {
-      content: 'New conversation',
-      response_metadata: {
-        created_at: createdAt,
-      },
-      additional_kwargs: {},
+    content: 'New conversation',
+    response_metadata: {
+      created_at: createdAt,
     },
+    additional_kwargs: {},
   },
   {
     lc: 1,
     type: 'constructor',
     id: ['langchain_core', 'messages', 'AIMessage'],
-    kwargs: {
-      content: 'Still a placeholder message',
-      response_metadata: {
-        created_at: createdAt,
-        model: models[1].id,
-      },
+    content: 'Still a placeholder message',
+    response_metadata: {
+      created_at: createdAt,
+      model: models[1].id,
       tool_calls: [],
       invalid_tool_calls: [],
       additional_kwargs: {},
@@ -90,12 +91,32 @@ export const contents = [
 export const botResponse = `This is a placeholder message`;
 
 export const generateQueryResponse = (conversationId: string) => {
-  let body = '';
+  const tokens = botResponse.match(/(\s+|[^\s]+)/g) || [];
+
+  const events: {
+    event: string;
+    data?: Record<string, any>;
+    done?: boolean;
+  }[] = [];
+
+  events.push({
+    event: 'start',
+    data: { conversation_id: conversationId },
+  });
+
+  tokens.forEach((token, index) => {
+    events.push({
+      event: 'token',
+      data: { id: index, token },
+    });
+  });
 
-  for (const token of botResponse.split(' ')) {
-    body += `{"conversation_id":"${conversationId}","response":{"lc":1,"type":"constructor","id":["langchain_core","messages","AIMessageChunk"],"kwargs":{"content":" ${token}","tool_call_chunks":[],"additional_kwargs":{},"id":"chatcmpl-890","tool_calls":[],"invalid_tool_calls":[],"response_metadata":{"prompt":0,"completion":0,"created_at":1736332476031,"model":"${models[1].id}"}}}}`;
-  }
-  body += `{"conversation_id":"${conversationId}","response":{"lc":1,"type":"constructor","id":["langchain_core","messages","AIMessageChunk"],"kwargs":{"content":"","tool_call_chunks":[],"additional_kwargs":{},"id":"chatcmpl-890","tool_calls":[],"invalid_tool_calls":[],"response_metadata":{"prompt":0,"completion":0,"finish_reason":"stop","system_fingerprint":"fp_ollama","created_at":1736332476031,"model":"${models[1].id}"}}}}`;
+  events.push({
+    event: 'end',
+    done: true,
+  });
 
-  return body;
+  return `${events
+    .map(({ event, data }) => `data: ${JSON.stringify({ event, data })}\n\n`)
+    .join('')}\n`;
 };

workspaces/lightspeed/packages/app/e2e-tests/lightspeed.test.ts

@@ -27,6 +27,8 @@ import {
 } from './fixtures/responses';
 import { openLightspeed, sendMessage } from './utils/testHelper';
 
+const botQuery = 'Please respond';
+
 test.beforeEach(async ({ page }) => {
   await page.route(`${modelBaseUrl}/v1/models`, async route => {
     const json = { object: 'list', data: models };
@@ -37,20 +39,19 @@ test.beforeEach(async ({ page }) => {
       const json = [];
       await route.fulfill({ json });
     }
-    if (route.request().method() === 'POST') {
-      const json = defaultConversation;
-      await route.fulfill({ json });
-    }
   });
   await page.route(`${modelBaseUrl}/conversations/user*`, async route => {
     const json = [];
     await route.fulfill({ json });
   });
   await page.route(`${modelBaseUrl}/v1/query`, async route => {
     const payload = route.request().postDataJSON();
-    conversations[0].conversation_id = payload.conversation_id;
-    contents[0].kwargs.content = payload.query;
-    const body = generateQueryResponse(payload.conversation_id);
+
+    const body = generateQueryResponse(
+      payload.query === botQuery
+        ? (conversations[1].conversation_id = payload.conversation_id)
+        : conversations[0].conversation_id,
+    );
     await route.fulfill({ body });
   });
 
@@ -82,27 +83,26 @@ test.describe('Conversation', () => {
   test.beforeEach(async ({ page }) => {
     await page.route(`${modelBaseUrl}/conversations`, async route => {
       if (route.request().method() === 'GET') {
-        const json = conversations;
+        const json = { conversations };
         await route.fulfill({ json });
       } else {
         await route.fulfill();
       }
     });
     await page.route(`${modelBaseUrl}/conversations/user*`, async route => {
-      const json = contents;
+      const json = { chat_history: contents };
       await route.fulfill({ json });
     });
   });
 
   test('Bot responds', async ({ page }) => {
-    const inputText = 'Please respond';
-    await sendMessage(inputText, page);
+    await sendMessage(botQuery, page);
 
     const userMessage = page.locator('.pf-chatbot__message--user');
     const botMessage = page.locator('.pf-chatbot__message--bot');
 
     await expect(userMessage).toBeVisible();
-    await expect(userMessage).toContainText(inputText);
+    await expect(userMessage).toContainText(botQuery);
     await expect(botMessage).toBeVisible();
     await expect(botMessage).toContainText(botResponse);
   });
@@ -123,7 +123,7 @@ test.describe('Conversation', () => {
   test('Filter and switch conversations', async ({ page }) => {
     await page.route(`${modelBaseUrl}/conversations`, async route => {
       if (route.request().method() === 'GET') {
-        const json = moreConversations;
+        const json = { conversations: moreConversations };
         await route.fulfill({ json });
       } else {
         await route.fulfill();
@@ -133,7 +133,7 @@ test.describe('Conversation', () => {
     const sidePanel = page.locator('.pf-v6-c-drawer__panel');
 
     const currentChat = sidePanel.locator('li.pf-chatbot__menu-item--active');
-    await expect(currentChat).toHaveText(moreConversations[0].summary);
+    await expect(currentChat).toHaveText(moreConversations[0].topic_summary);
 
     const chats = sidePanel.locator('li.pf-chatbot__menu-item');
     await expect(chats).toHaveCount(2);
@@ -143,14 +143,14 @@ test.describe('Conversation', () => {
     );
     await searchBox.fill('new');
     await expect(chats).toHaveCount(1);
-    await expect(chats).toHaveText(moreConversations[1].summary);
+    await expect(chats).toHaveText(moreConversations[1].topic_summary);
 
     await chats.click();
 
     const userMessage = page.locator('.pf-chatbot__message--user');
     const botMessage = page.locator('.pf-chatbot__message--bot');
 
-    await expect(userMessage).toContainText(contents[0].kwargs.content);
-    await expect(botMessage).toContainText(contents[1].kwargs.content);
+    await expect(userMessage).toContainText(contents[0].content);
+    await expect(botMessage).toContainText(contents[1].content);
   });
 });

workspaces/lightspeed/plugins/lightspeed/src/api/LightspeedApiClient.ts

@@ -16,6 +16,7 @@
 
 import { ConfigApi, FetchApi } from '@backstage/core-plugin-api';
 
+import { TEMP_CONVERSATION_ID } from '../const';
 import { LightspeedAPI } from './api';
 
 export type Options = {
@@ -56,11 +57,15 @@ export class LightspeedApiClient implements LightspeedAPI {
         'Content-Type': 'application/json',
       },
       body: JSON.stringify({
-        conversation_id,
-        serverURL: this.getServerUrl(),
+        conversation_id:
+          conversation_id === TEMP_CONVERSATION_ID
+            ? undefined
+            : conversation_id,
         model: selectedModel,
+        provider: this.configApi
+          .getConfigArray('lightspeed.servers')[0]
+          .getOptionalString('id'), // Currently supports a single llm server
         query: prompt,
-        historyLength: 10,
       }),
     });
 
@@ -69,9 +74,19 @@ export class LightspeedApiClient implements LightspeedAPI {
     }
 
     if (!response.ok) {
-      throw new Error(
-        `failed to fetch data, status ${response.status}: ${response.statusText}`,
-      );
+      const body = await response.body.getReader();
+      const reader = body.read();
+      const decoder = new TextDecoder('utf-8');
+      const text = await reader.then(({ done, value }) => {
+        if (done) {
+          return '';
+        }
+        return decoder.decode(value);
+      });
+      const errorMessage = JSON.parse(text);
+      if (errorMessage?.error) {
+        throw new Error(`failed to create message: ${errorMessage.error}`);
+      }
     }
     return response.body.getReader();
   }
@@ -93,45 +108,46 @@ export class LightspeedApiClient implements LightspeedAPI {
   async getAllModels() {
     const baseUrl = await this.getBaseUrl();
     const result = await this.fetcher(`${baseUrl}/v1/models`);
+
+    if (!result.ok) {
+      throw new Error(
+        `failed to get models, status ${result.status}: ${result.statusText}`,
+      );
+    }
+
     const response = await result.json();
     return response?.data ? response.data : [];
   }
 
   async getConversationMessages(conversation_id: string) {
+    if (conversation_id === TEMP_CONVERSATION_ID) {
+      return [];
+    }
     const baseUrl = await this.getBaseUrl();
     const result = await this.fetcher(
       `${baseUrl}/conversations/${encodeURIComponent(conversation_id)}`,
     );
-    return await result.json();
+    if (!result.ok) {
+      throw new Error(
+        `failed to get conversation messages, status ${result.status}: ${result.statusText}`,
+      );
+    }
+    const response = await result.json();
+    return response.chat_history ?? [];
   }
 
   async getConversations() {
     const baseUrl = await this.getBaseUrl();
     const result = await this.fetcher(`${baseUrl}/conversations`);
-    return await result.json();
-  }
 
-  async createConversation() {
-    const baseUrl = await this.getBaseUrl();
-
-    const response = await this.fetchApi.fetch(`${baseUrl}/conversations`, {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      body: JSON.stringify({}),
-    });
-
-    if (!response.body) {
-      throw new Error('Something went wrong.');
-    }
-
-    if (!response.ok) {
+    if (!result.ok) {
       throw new Error(
-        `failed to create conversation, status ${response.status}: ${response.statusText}`,
+        `failed to get conversation, status ${result.status}: ${result.statusText}`,
       );
     }
-    return await response.json();
+
+    const response = await result.json();
+    return response.conversations ?? [];
   }
 
   async deleteConversation(conversation_id: string) {

workspaces/lightspeed/plugins/lightspeed/src/api/api.ts

@@ -23,7 +23,6 @@ import { BaseMessage, ConversationList } from '../types';
 export type LightspeedAPI = {
   getAllModels: () => Promise<OpenAI.Models.Model[]>;
   getConversationMessages: (conversation_id: string) => Promise<BaseMessage[]>;
-  createConversation: () => Promise<{ conversation_id: string }>;
   createMessage: (
     prompt: string,
     selectedModel: string,