Merge pull request #96 from grafana/health-check-separate-enabled

llms: separate health and enabled methods

src/llms/openai.test.ts

@@ -0,0 +1,37 @@
+import { enabled } from './openai';
+import { LLM_PLUGIN_ROUTE } from './constants';
+import { getBackendSrv } from '@grafana/runtime';
+
+jest.mock('@grafana/runtime', () => ({
+  getBackendSrv: jest.fn(),
+}));
+
+describe('enabled', () => {
+  it('should return false if not configured', async () => {
+    (getBackendSrv as jest.Mock).mockImplementation(() => ({
+      get: jest.fn().mockReturnValue(Promise.resolve({ enabled: false })),
+    }));
+
+    // Call the enabled function
+    const result = await enabled();
+    expect(result).toBe(false);
+  });
+
+  it('should return true if configured', async () => {
+    (getBackendSrv as jest.Mock).mockImplementation(() => ({
+      get: jest.fn().mockImplementation((url: string) => {
+        if (url === `${LLM_PLUGIN_ROUTE}/settings`) {
+          return Promise.resolve({ enabled: true });
+        } else if (url === `${LLM_PLUGIN_ROUTE}/health`) {
+          return Promise.resolve({ details: { openAI: { configured: true, ok: true } } });
+        }
+        // raise an error if we get here
+        throw new Error('unexpected url');
+      }),
+    }));
+
+    // Call the enabled function
+    const result = await enabled();
+    expect(result).toBe(true);
+  });
+});

src/llms/openai.ts

@@ -347,7 +347,7 @@ export function streamChatCompletions(request: ChatCompletionsRequest): Observab
 let loggedWarning = false;
 
 /** Check if the OpenAI API is enabled via the LLM plugin. */
-export const enabled = async (): Promise<OpenAIHealthDetails> => {
+export const health = async (): Promise<OpenAIHealthDetails> => {
   // First check if the plugin is enabled.
   try {
     const settings = await getBackendSrv().get(`${LLM_PLUGIN_ROUTE}/settings`, undefined, undefined, {
@@ -391,6 +391,11 @@ export const enabled = async (): Promise<OpenAIHealthDetails> => {
     details.openAI;
 }
 
+export const enabled = async (): Promise<boolean> => {
+  const healthDetails = await health();
+  return healthDetails.configured && healthDetails.ok;
+}
+
 /**
  * Enum representing different states for a stream.
  * @enum {string}
@@ -482,10 +487,7 @@ export function useOpenAIStream(
     [notifyError]
   );
 
-  const { error: enabledError, value: isEnabled } = useAsync(
-    async () => await enabled().then((response) => response.ok),
-    [enabled]
-  );
+  const { error: enabledError, value: isEnabled } = useAsync(async () => await enabled(), [enabled]);
 
   const { error: asyncError, value } = useAsync(async () => {
     if (!isEnabled || !messages.length) {

src/llms/vector.test.ts

@@ -0,0 +1,37 @@
+import { enabled } from './vector';
+import { LLM_PLUGIN_ROUTE } from './constants';
+import { getBackendSrv } from '@grafana/runtime';
+
+jest.mock('@grafana/runtime', () => ({
+  getBackendSrv: jest.fn(),
+}));
+
+describe('enabled', () => {
+  it('should return false if not configured', async () => {
+    (getBackendSrv as jest.Mock).mockImplementation(() => ({
+      get: jest.fn().mockReturnValue(Promise.resolve({ enabled: false })),
+    }));
+
+    // Call the enabled function
+    const result = await enabled();
+    expect(result).toBe(false);
+  });
+
+  it('should return true if configured', async () => {
+    (getBackendSrv as jest.Mock).mockImplementation(() => ({
+      get: jest.fn().mockImplementation((url: string) => {
+        if (url === `${LLM_PLUGIN_ROUTE}/settings`) {
+          return Promise.resolve({ enabled: true });
+        } else if (url === `${LLM_PLUGIN_ROUTE}/health`) {
+          return Promise.resolve({ details: { vector: { enabled: true, ok: true } } });
+        }
+        // raise an error if we get here
+        throw new Error('unexpected url');
+      }),
+    }));
+
+    // Call the enabled function
+    const result = await enabled();
+    expect(result).toBe(true);
+  });
+});

src/llms/vector.ts

@@ -78,7 +78,7 @@ export async function search<T extends SearchResultPayload>(request: SearchReque
 let loggedWarning = false;
 
 /** Check if the vector API is enabled and configured via the LLM plugin. */
-export const enabled = async (): Promise<VectorHealthDetails> => {
+export const health = async (): Promise<VectorHealthDetails> => {
   // First check if the plugin is enabled.
   try {
     const settings = await getBackendSrv().get(`${LLM_PLUGIN_ROUTE}/settings`, undefined, undefined, {
@@ -123,3 +123,8 @@ export const enabled = async (): Promise<VectorHealthDetails> => {
     { enabled: details.vector, ok: details.vector } :
     details.vector;
 };
+
+export const enabled = async (): Promise<boolean> => {
+  const healthDetails = await health();
+  return healthDetails.enabled && healthDetails.ok;
+}