[8.14] [Playground] Propagate Error message into FE (#182201) (#182250)

# Backport This will backport the following commits from `main` to `8.14`: - [[Playground] Propagate Error message into FE (#182201)](https://github.com/elastic/kibana/pull/182201)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)
2025-04-24 09:48:58 -04:00 · 2024-05-01 12:00:21 -04:00 · 2024-05-01 12:00:21 -04:00 · a37a090da8
commit a37a090da8
parent eb58ab6f5f
4 changed files with 184 additions and 4 deletions
--- a/x-pack/plugins/search_playground/mocks/router.mock.ts
+++ b/x-pack/plugins/search_playground/mocks/router.mock.ts
@ -0,0 +1,95 @@
+/*
+ * 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 {
+  IRouter,
+  KibanaRequest,
+  RequestHandlerContext,
+  RouteValidatorConfig,
+} from '@kbn/core/server';
+import { httpServiceMock, httpServerMock } from '@kbn/core/server/mocks';
+
+/**
+ * Test helper that mocks Kibana's router and DRYs out various helper (callRoute, schema validation)
+ */
+
+type MethodType = 'get' | 'post' | 'put' | 'patch' | 'delete';
+type PayloadType = 'params' | 'query' | 'body';
+
+interface IMockRouter {
+  method: MethodType;
+  path: string;
+  context?: jest.Mocked<RequestHandlerContext>;
+}
+interface IMockRouterRequest {
+  body?: object;
+  query?: object;
+  params?: object;
+}
+type MockRouterRequest = KibanaRequest | IMockRouterRequest;
+
+export class MockRouter {
+  public router!: jest.Mocked<IRouter>;
+  public method: MethodType;
+  public path: string;
+  public context: jest.Mocked<RequestHandlerContext>;
+  public payload?: PayloadType;
+  public response = httpServerMock.createResponseFactory();
+
+  constructor({ method, path, context = {} as jest.Mocked<RequestHandlerContext> }: IMockRouter) {
+    this.createRouter();
+    this.method = method;
+    this.path = path;
+    this.context = context;
+  }
+
+  public createRouter = () => {
+    this.router = httpServiceMock.createRouter();
+  };
+
+  public callRoute = async (request: MockRouterRequest) => {
+    const route = this.findRouteRegistration();
+    const [, handler] = route;
+    await handler(this.context, httpServerMock.createKibanaRequest(request as any), this.response);
+  };
+
+  /**
+   * Schema validation helpers
+   */
+
+  public validateRoute = (request: MockRouterRequest) => {
+    const route = this.findRouteRegistration();
+    const [config] = route;
+    const validate = config.validate as RouteValidatorConfig<{}, {}, {}>;
+    const payloads = Object.keys(request) as PayloadType[];
+
+    payloads.forEach((payload: PayloadType) => {
+      const payloadValidation = validate[payload] as { validate(request: KibanaRequest): void };
+      const payloadRequest = request[payload] as KibanaRequest;
+
+      payloadValidation.validate(payloadRequest);
+    });
+  };
+
+  public shouldValidate = (request: MockRouterRequest) => {
+    expect(() => this.validateRoute(request)).not.toThrow();
+  };
+
+  public shouldThrow = (request: MockRouterRequest) => {
+    expect(() => this.validateRoute(request)).toThrow();
+  };
+
+  private findRouteRegistration = () => {
+    const routerCalls = this.router[this.method].mock.calls as any[];
+    if (!routerCalls.length) throw new Error('No routes registered.');
+
+    const route = routerCalls.find(([router]: any) => router.path === this.path);
+    if (!route) throw new Error('No matching registered routes found - check method/path keys');
+
+    return route;
+  };
+}
--- a/x-pack/plugins/search_playground/server/routes.test.ts
+++ b/x-pack/plugins/search_playground/server/routes.test.ts
@ -5,7 +5,19 @@
 * 2.0.
 */

-import { createRetriever } from './routes';
+import { loggingSystemMock } from '@kbn/core-logging-server-mocks';
+import { RequestHandlerContext } from '@kbn/core/server';
+import { coreMock } from '@kbn/core/server/mocks';
+import { MockRouter } from '../__mocks__/router.mock';
+import { ConversationalChain } from './lib/conversational_chain';
+import { getChatParams } from './lib/get_chat_params';
+import { createRetriever, defineRoutes } from './routes';
+
+jest.mock('./lib/get_chat_params', () => ({
+  getChatParams: jest.fn(),
+}));
+
+jest.mock('./lib/conversational_chain');

 describe('createRetriever', () => {
  test('works when the question has quotes', () => {
@ -18,3 +30,75 @@ describe('createRetriever', () => {
    expect(result).toEqual({ query: { match: { text: 'How can I "do something" with quotes?' } } });
  });
 });
+
+describe('Search Playground routes', () => {
+  let mockRouter: MockRouter;
+  const mockClient = {
+    asCurrentUser: {},
+  };
+
+  const mockCore = {
+    elasticsearch: { client: mockClient },
+  };
+  const mockLogger = loggingSystemMock.createLogger().get();
+
+  describe('POST - Chat Messages', () => {
+    const mockData = {
+      connector_id: 'open-ai',
+      indices: 'my-index',
+      prompt: 'You are an assistant',
+      citations: true,
+      elasticsearch_query: {},
+      summarization_model: 'GPT-4',
+      doc_size: 3,
+      source_fields: '{}',
+    };
+
+    const mockRequestBody = {
+      data: mockData,
+    };
+
+    beforeEach(() => {
+      jest.clearAllMocks();
+
+      const coreStart = coreMock.createStart();
+
+      const context = {
+        core: Promise.resolve(mockCore),
+      } as unknown as jest.Mocked<RequestHandlerContext>;
+
+      mockRouter = new MockRouter({
+        context,
+        method: 'post',
+        path: '/internal/search_playground/chat',
+      });
+
+      defineRoutes({
+        logger: mockLogger,
+        router: mockRouter.router,
+        getStartServices: jest.fn().mockResolvedValue([coreStart, {}, {}]),
+      });
+    });
+
+    it('responds with error message if stream throws an error', async () => {
+      (getChatParams as jest.Mock).mockResolvedValue({ model: 'open-ai' });
+      (ConversationalChain as jest.Mock).mockImplementation(() => {
+        return {
+          stream: jest
+            .fn()
+            .mockRejectedValue(new Error('Unexpected API error - Some Open AI error message')),
+        };
+      });
+
+      await mockRouter.callRoute({
+        body: mockRequestBody,
+      });
+
+      expect(mockRouter.response.badRequest).toHaveBeenCalledWith({
+        body: {
+          message: 'Unexpected API error - Some Open AI error message',
+        },
+      });
+    });
+  });
+});
--- a/x-pack/plugins/search_playground/server/routes.ts
+++ b/x-pack/plugins/search_playground/server/routes.ts
@ -131,10 +131,10 @@ export function defineRoutes({
      } catch (e) {
        logger.error('Failed to create the chat stream', e);

-        if (typeof e === 'string') {
+        if (typeof e === 'object') {
          return response.badRequest({
            body: {
-              message: e,
+              message: e.message,
            },
          });
        }
--- a/x-pack/plugins/search_playground/tsconfig.json
+++ b/x-pack/plugins/search_playground/tsconfig.json
@ -35,7 +35,8 @@
    "@kbn/triggers-actions-ui-plugin",
    "@kbn/elastic-assistant-common",
    "@kbn/logging",
-    "@kbn/doc-links"
+    "@kbn/doc-links",
+    "@kbn/core-logging-server-mocks"
  ],
  "exclude": [
    "target/**/*",