[App Search] API logs: Add log detail flyout (elastic#96162)

* Set up helper for showing JSON request/response bodies

* Set up mock API log obj for tests to use

* Add ApiLogLogic file for flyout handling

* Add ApiLogFlyout component

* Update views to load flyout

* Update table to open flyout

* Update x-pack/plugins/enterprise_search/public/applications/app_search/components/api_logs/utils.ts

* PR feedback: comments

Co-authored-by: Byron Hulcher <[email protected]>

Co-authored-by: Byron Hulcher <[email protected]>
Co-authored-by: Kibana Machine <[email protected]>

x-pack/plugins/enterprise_search/public/applications/app_search/components/api_logs/__mocks__/api_log.mock.ts

@@ -0,0 +1,17 @@
+/*
+ * 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.
+ */
+
+export const mockApiLog = {
+  timestamp: '1970-01-01T12:00:00.000Z',
+  http_method: 'POST',
+  status: 200,
+  user_agent: 'Mozilla/5.0',
+  full_request_path: '/api/as/v1/engines/national-parks-demo/search.json',
+  request_body: '{"query":"test search"}',
+  response_body:
+    '{"meta":{"page":{"current":1,"total_pages":0,"total_results":0,"size":20}},"results":[]}',
+};

x-pack/plugins/enterprise_search/public/applications/app_search/components/api_logs/api_log/api_log_flyout.test.tsx

@@ -0,0 +1,62 @@
+/*
+ * 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 { setMockValues, setMockActions } from '../../../../__mocks__';
+import { mockApiLog } from '../__mocks__/api_log.mock';
+
+import React from 'react';
+
+import { shallow } from 'enzyme';
+
+import { EuiFlyout, EuiBadge } from '@elastic/eui';
+
+import { ApiLogFlyout, ApiLogHeading } from './api_log_flyout';
+
+describe('ApiLogFlyout', () => {
+  const values = {
+    isFlyoutOpen: true,
+    apiLog: mockApiLog,
+  };
+  const actions = {
+    closeFlyout: jest.fn(),
+  };
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    setMockValues(values);
+    setMockActions(actions);
+  });
+
+  it('renders', () => {
+    const wrapper = shallow(<ApiLogFlyout />);
+
+    expect(wrapper.find('h2').text()).toEqual('Request details');
+    expect(wrapper.find(ApiLogHeading).last().dive().find('h3').text()).toEqual('Response body');
+    expect(wrapper.find(EuiBadge).prop('children')).toEqual('POST');
+  });
+
+  it('closes the flyout', () => {
+    const wrapper = shallow(<ApiLogFlyout />);
+
+    wrapper.find(EuiFlyout).simulate('close');
+    expect(actions.closeFlyout).toHaveBeenCalled();
+  });
+
+  it('does not render if the flyout is not open', () => {
+    setMockValues({ ...values, isFlyoutOpen: false });
+    const wrapper = shallow(<ApiLogFlyout />);
+
+    expect(wrapper.isEmptyRender()).toBe(true);
+  });
+
+  it('does not render if a current apiLog has not been set', () => {
+    setMockValues({ ...values, apiLog: null });
+    const wrapper = shallow(<ApiLogFlyout />);
+
+    expect(wrapper.isEmptyRender()).toBe(true);
+  });
+});

x-pack/plugins/enterprise_search/public/applications/app_search/components/api_logs/api_log/api_log_flyout.tsx

@@ -0,0 +1,137 @@
+/*
+ * 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.
+ */
+/*
+ * 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 React from 'react';
+
+import { useActions, useValues } from 'kea';
+
+import {
+  EuiPortal,
+  EuiFlyout,
+  EuiFlyoutHeader,
+  EuiTitle,
+  EuiFlyoutBody,
+  EuiFlexGroup,
+  EuiFlexItem,
+  EuiSpacer,
+  EuiBadge,
+  EuiHealth,
+  EuiText,
+  EuiCode,
+  EuiCodeBlock,
+} from '@elastic/eui';
+import { i18n } from '@kbn/i18n';
+
+import { getStatusColor, attemptToFormatJson } from '../utils';
+
+import { ApiLogLogic } from './';
+
+export const ApiLogFlyout: React.FC = () => {
+  const { isFlyoutOpen, apiLog } = useValues(ApiLogLogic);
+  const { closeFlyout } = useActions(ApiLogLogic);
+
+  if (!isFlyoutOpen) return null;
+  if (!apiLog) return null;
+
+  return (
+    <EuiPortal>
+      <EuiFlyout ownFocus onClose={closeFlyout} aria-labelledby="apiLogFlyout">
+        <EuiFlyoutHeader hasBorder>
+          <EuiTitle size="m">
+            <h2 id="apiLogFlyout">
+              {i18n.translate('xpack.enterpriseSearch.appSearch.engine.apiLogs.flyout.title', {
+                defaultMessage: 'Request details',
+              })}
+            </h2>
+          </EuiTitle>
+        </EuiFlyoutHeader>
+        <EuiFlyoutBody>
+          <EuiFlexGroup>
+            <EuiFlexItem>
+              <ApiLogHeading>
+                {i18n.translate('xpack.enterpriseSearch.appSearch.engine.apiLogs.methodTitle', {
+                  defaultMessage: 'Method',
+                })}
+              </ApiLogHeading>
+              <div>
+                <EuiBadge color="primary">{apiLog.http_method}</EuiBadge>
+              </div>
+            </EuiFlexItem>
+            <EuiFlexItem>
+              <ApiLogHeading>
+                {i18n.translate('xpack.enterpriseSearch.appSearch.engine.apiLogs.statusTitle', {
+                  defaultMessage: 'Status',
+                })}
+              </ApiLogHeading>
+              <EuiHealth color={getStatusColor(apiLog.status)}>{apiLog.status}</EuiHealth>
+            </EuiFlexItem>
+            <EuiFlexItem>
+              <ApiLogHeading>
+                {i18n.translate('xpack.enterpriseSearch.appSearch.engine.apiLogs.timestampTitle', {
+                  defaultMessage: 'Timestamp',
+                })}
+              </ApiLogHeading>
+              {apiLog.timestamp}
+            </EuiFlexItem>
+          </EuiFlexGroup>
+          <EuiSpacer />
+
+          <ApiLogHeading>
+            {i18n.translate('xpack.enterpriseSearch.appSearch.engine.apiLogs.userAgentTitle', {
+              defaultMessage: 'User agent',
+            })}
+          </ApiLogHeading>
+          <EuiText>
+            <EuiCode>{apiLog.user_agent}</EuiCode>
+          </EuiText>
+          <EuiSpacer />
+
+          <ApiLogHeading>
+            {i18n.translate('xpack.enterpriseSearch.appSearch.engine.apiLogs.requestPathTitle', {
+              defaultMessage: 'Request path',
+            })}
+          </ApiLogHeading>
+          <EuiText>
+            <EuiCode>{apiLog.full_request_path}</EuiCode>
+          </EuiText>
+          <EuiSpacer />
+
+          <ApiLogHeading>
+            {i18n.translate('xpack.enterpriseSearch.appSearch.engine.apiLogs.requestBodyTitle', {
+              defaultMessage: 'Request body',
+            })}
+          </ApiLogHeading>
+          <EuiCodeBlock language="json" paddingSize="m">
+            {attemptToFormatJson(apiLog.request_body)}
+          </EuiCodeBlock>
+          <EuiSpacer />
+
+          <ApiLogHeading>
+            {i18n.translate('xpack.enterpriseSearch.appSearch.engine.apiLogs.responseBodyTitle', {
+              defaultMessage: 'Response body',
+            })}
+          </ApiLogHeading>
+          <EuiCodeBlock language="json" paddingSize="m">
+            {attemptToFormatJson(apiLog.response_body)}
+          </EuiCodeBlock>
+        </EuiFlyoutBody>
+      </EuiFlyout>
+    </EuiPortal>
+  );
+};
+
+export const ApiLogHeading: React.FC = ({ children }) => (
+  <EuiTitle size="xs">
+    <h3>{children}</h3>
+  </EuiTitle>
+);

x-pack/plugins/enterprise_search/public/applications/app_search/components/api_logs/api_log/api_log_logic.test.tsx

@@ -0,0 +1,57 @@
+/*
+ * 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 { LogicMounter } from '../../../../__mocks__';
+import { mockApiLog } from '../__mocks__/api_log.mock';
+
+import { ApiLogLogic } from './';
+
+describe('ApiLogLogic', () => {
+  const { mount } = new LogicMounter(ApiLogLogic);
+
+  const DEFAULT_VALUES = {
+    isFlyoutOpen: false,
+    apiLog: null,
+  };
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('has expected default values', () => {
+    mount();
+    expect(ApiLogLogic.values).toEqual(DEFAULT_VALUES);
+  });
+
+  describe('actions', () => {
+    describe('openFlyout', () => {
+      it('sets isFlyoutOpen to true & sets the current apiLog', () => {
+        mount({ isFlyoutOpen: false, apiLog: null });
+        ApiLogLogic.actions.openFlyout(mockApiLog);
+
+        expect(ApiLogLogic.values).toEqual({
+          ...DEFAULT_VALUES,
+          isFlyoutOpen: true,
+          apiLog: mockApiLog,
+        });
+      });
+    });
+
+    describe('closeFlyout', () => {
+      it('sets isFlyoutOpen to false & resets the current apiLog', () => {
+        mount({ isFlyoutOpen: true, apiLog: mockApiLog });
+        ApiLogLogic.actions.closeFlyout();
+
+        expect(ApiLogLogic.values).toEqual({
+          ...DEFAULT_VALUES,
+          isFlyoutOpen: false,
+          apiLog: null,
+        });
+      });
+    });
+  });
+});

x-pack/plugins/enterprise_search/public/applications/app_search/components/api_logs/api_log/api_log_logic.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 { kea, MakeLogicType } from 'kea';
+
+import { ApiLog } from '../types';
+
+interface ApiLogValues {
+  isFlyoutOpen: boolean;
+  apiLog: ApiLog | null;
+}
+
+interface ApiLogActions {
+  openFlyout(apiLog: ApiLog): { apiLog: ApiLog };
+  closeFlyout(): void;
+}
+
+export const ApiLogLogic = kea<MakeLogicType<ApiLogValues, ApiLogActions>>({
+  path: ['enterprise_search', 'app_search', 'api_log_logic'],
+  actions: () => ({
+    openFlyout: (apiLog) => ({ apiLog }),
+    closeFlyout: true,
+  }),
+  reducers: () => ({
+    isFlyoutOpen: [
+      false,
+      {
+        openFlyout: () => true,
+        closeFlyout: () => false,
+      },
+    ],
+    apiLog: [
+      null,
+      {
+        openFlyout: (_, { apiLog }) => apiLog,
+        closeFlyout: () => null,
+      },
+    ],
+  }),
+});

x-pack/plugins/enterprise_search/public/applications/app_search/components/api_logs/api_log/index.ts

@@ -0,0 +1,9 @@
+/*
+ * 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.
+ */
+
+export { ApiLogFlyout } from './api_log_flyout';
+export { ApiLogLogic } from './api_log_logic';

x-pack/plugins/enterprise_search/public/applications/app_search/components/api_logs/api_logs.tsx

@@ -26,6 +26,7 @@ import { Loading } from '../../../shared/loading';
 
 import { LogRetentionCallout, LogRetentionTooltip, LogRetentionOptions } from '../log_retention';
 
+import { ApiLogFlyout } from './api_log';
 import { ApiLogsTable, NewApiEventsPrompt } from './components';
 import { API_LOGS_TITLE, RECENT_API_EVENTS } from './constants';
 
@@ -75,6 +76,7 @@ export const ApiLogs: React.FC<Props> = ({ engineBreadcrumb }) => {
           <EuiSpacer size="m" />
 
           <ApiLogsTable hasPagination />
+          <ApiLogFlyout />
         </EuiPageContentBody>
       </EuiPageContent>
     </>

x-pack/plugins/enterprise_search/public/applications/app_search/components/api_logs/api_logs_logic.test.ts

@@ -6,6 +6,7 @@
  */
 
 import { LogicMounter, mockHttpValues, mockFlashMessageHelpers } from '../../../__mocks__';
+import { mockApiLog } from './__mocks__/api_log.mock';
 import '../../__mocks__/engine_logic.mock';
 
 import { nextTick } from '@kbn/test/jest';
@@ -29,17 +30,7 @@ describe('ApiLogsLogic', () => {
   };
 
   const MOCK_API_RESPONSE = {
-    results: [
-      {
-        timestamp: '1970-01-01T12:00:00.000Z',
-        http_method: 'POST',
-        status: 200,
-        user_agent: 'some browser agent string',
-        full_request_path: '/api/as/v1/engines/national-parks-demo/search.json',
-        request_body: '{"someMockRequest":"hello"}',
-        response_body: '{"someMockResponse":"world"}',
-      },
-    ],
+    results: [mockApiLog, mockApiLog],
     meta: {
       page: {
         current: 1,

x-pack/plugins/enterprise_search/public/applications/app_search/components/api_logs/components/api_logs_table.test.tsx

@@ -53,6 +53,7 @@ describe('ApiLogsTable', () => {
   };
   const actions = {
     onPaginate: jest.fn(),
+    openFlyout: jest.fn(),
   };
 
   beforeEach(() => {
@@ -86,7 +87,7 @@ describe('ApiLogsTable', () => {
 
     expect(wrapper.find(EuiButtonEmpty)).toHaveLength(3);
     wrapper.find('[data-test-subj="ApiLogsTableDetailsButton"]').first().simulate('click');
-    // TODO: API log details flyout
+    expect(actions.openFlyout).toHaveBeenCalled();
   });
 
   it('renders an empty prompt if no items are passed', () => {