Add some more error handling to RAG UI Modal

RoadieHQ · Oct 3, 2024 · 74c738f · 74c738f
1 parent 7ea5c6e
commit 74c738f
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 20 deletions.
diff --git a/.changeset/good-vans-remain.md b/.changeset/good-vans-remain.md
@@ -0,0 +1,5 @@
+---
+'@roadiehq/rag-ai': patch
+---
+
+Add some error handling for better messages on RAG AI modal.
diff --git a/plugins/frontend/rag-ai/src/api/client.ts b/plugins/frontend/rag-ai/src/api/client.ts
@@ -67,26 +67,43 @@ export class RoadieRagAiClient implements RagAiApi {
   async *ask(question: string, source: string): AsyncGenerator<ParsedEvent> {
     const { token } = await this.identityApi.getCredentials();
 
-    const stream = await this.fetch(`query/${source}`, {
-      body: JSON.stringify({
-        query: question,
-      }),
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json',
-        Authorization: `Bearer ${token}`,
-      },
-    });
+    try {
+      const stream = await this.fetch(`query/${source}`, {
+        body: JSON.stringify({
+          query: question,
+        }),
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+          Authorization: `Bearer ${token}`,
+        },
+      });
+      if (stream) {
+        const reader = stream
+          .pipeThrough(new TextDecoderStream())
+          .pipeThrough(new EventSourceParserStream())
+          .getReader();
 
-    const reader = stream
-      .pipeThrough(new TextDecoderStream())
-      .pipeThrough(new EventSourceParserStream())
-      .getReader();
-
-    while (true) {
-      const { done, value } = await reader.read();
-      if (done) break;
-      yield value;
+        while (true) {
+          const { done, value } = await reader.read();
+          if (done) break;
+          yield value;
+        }
+      } else {
+        yield {
+          data: 'No response received from the LLM',
+          event: 'message',
+          type: 'event',
+        };
+      }
+    } catch (e: any) {
+      // eslint-disable-next-line
+      console.error(e.message);
+      yield {
+        data: `Failed to receive response from the backend endpoint.`,
+        event: 'error',
+        type: 'event',
+      };
     }
   }
 }
diff --git a/plugins/frontend/rag-ai/src/components/RagModal/RagModal.tsx b/plugins/frontend/rag-ai/src/components/RagModal/RagModal.tsx
@@ -33,6 +33,7 @@ import { ragAiApiRef } from '../../api';
 import { useApi } from '@backstage/core-plugin-api';
 import { ResponseEmbedding } from '../../types';
 import { Thinking } from './Thinking';
+import { WarningPanel } from '@backstage/core-components';
 
 export type RagModalProps = {
   title?: string;
@@ -88,11 +89,13 @@ export const ControlledRagModal = ({
   const [thinking, setThinking] = useState(false);
   const [questionResult, setQuestionResult] = useState('');
   const [embeddings, setEmbeddings] = useState<ResponseEmbedding[]>([]);
+  const [warning, setWarning] = useState<string | undefined>();
   const ragApi = useApi(ragAiApiRef);
   const askLlm = useCallback(
     async (question: string, source: string) => {
       setThinking(true);
       setQuestionResult('');
+      setWarning(undefined);
       setEmbeddings([]);
 
       for await (const chunk of ragApi.ask(question, source)) {
@@ -105,6 +108,10 @@ export const ControlledRagModal = ({
             setEmbeddings(JSON.parse(chunk.data));
             break;
           }
+          case 'error': {
+            setWarning(chunk.data);
+            break;
+          }
           default:
             throw new Error(`Unknown event type: ${chunk.event}`);
         }
@@ -148,7 +155,8 @@ export const ControlledRagModal = ({
             }}
           />
         </Box>
-        {thinking && !questionResult ? (
+        {warning && <WarningPanel severity="warning" message={warning} />}
+        {thinking && !questionResult && !warning ? (
           <Box p={6} display="flex" justifyContent="center" alignItems="center">
             <Thinking />
           </Box>