-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Workplace Search] Add API Keys view to replace Access tokens (#120147)
- Loading branch information
1 parent
233aa7d
commit 062be17
Showing
35 changed files
with
2,001 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/development/core/public/kibana-plugin-core-public.doclinksstart.md
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
102 changes: 102 additions & 0 deletions
102
...s/enterprise_search/public/applications/workplace_search/views/api_keys/api_keys.test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| /* | ||
| * 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__/kea_logic'; | ||
| import { unmountHandler } from '../../../__mocks__/shallow_useeffect.mock'; | ||
|
|
||
| import React from 'react'; | ||
|
|
||
| import { shallow } from 'enzyme'; | ||
|
|
||
| import { EuiEmptyPrompt, EuiCopy } from '@elastic/eui'; | ||
|
|
||
| import { DEFAULT_META } from '../../../shared/constants'; | ||
| import { externalUrl } from '../../../shared/enterprise_search_url'; | ||
|
|
||
| import { ApiKeys } from './api_keys'; | ||
| import { ApiKeyFlyout } from './components/api_key_flyout'; | ||
| import { ApiKeysList } from './components/api_keys_list'; | ||
|
|
||
| describe('ApiKeys', () => { | ||
| const fetchApiKeys = jest.fn(); | ||
| const resetApiKeys = jest.fn(); | ||
| const showApiKeysForm = jest.fn(); | ||
| const apiToken = { | ||
| id: '1', | ||
| name: 'test', | ||
| key: 'foo', | ||
| }; | ||
|
|
||
| const values = { | ||
| apiKeyFormVisible: false, | ||
| meta: DEFAULT_META, | ||
| dataLoading: false, | ||
| apiTokens: [apiToken], | ||
| }; | ||
|
|
||
| beforeEach(() => { | ||
| jest.clearAllMocks(); | ||
| setMockValues(values); | ||
| setMockActions({ | ||
| fetchApiKeys, | ||
| resetApiKeys, | ||
| showApiKeysForm, | ||
| }); | ||
| }); | ||
|
|
||
| it('renders', () => { | ||
| const wrapper = shallow(<ApiKeys />); | ||
|
|
||
| expect(wrapper.find(ApiKeysList)).toHaveLength(1); | ||
| }); | ||
|
|
||
| it('renders EuiEmptyPrompt when no api keys present', () => { | ||
| setMockValues({ ...values, apiTokens: [] }); | ||
| const wrapper = shallow(<ApiKeys />); | ||
|
|
||
| expect(wrapper.find(ApiKeysList)).toHaveLength(0); | ||
| expect(wrapper.find(EuiEmptyPrompt)).toHaveLength(1); | ||
| }); | ||
|
|
||
| it('fetches data on mount', () => { | ||
| shallow(<ApiKeys />); | ||
|
|
||
| expect(fetchApiKeys).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it('calls resetApiKeys on unmount', () => { | ||
| shallow(<ApiKeys />); | ||
| unmountHandler(); | ||
|
|
||
| expect(resetApiKeys).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it('renders the API endpoint and a button to copy it', () => { | ||
| externalUrl.enterpriseSearchUrl = 'http://localhost:3002'; | ||
| const copyMock = jest.fn(); | ||
| const wrapper = shallow(<ApiKeys />); | ||
| // We wrap children in a div so that `shallow` can render it. | ||
| const copyEl = shallow(<div>{wrapper.find(EuiCopy).props().children(copyMock)}</div>); | ||
|
|
||
| expect(copyEl.find('EuiButtonIcon').props().onClick).toEqual(copyMock); | ||
| expect(copyEl.text().replace('<EuiButtonIcon />', '')).toEqual('http://localhost:3002'); | ||
| }); | ||
|
|
||
| it('will render ApiKeyFlyout if apiKeyFormVisible is true', () => { | ||
| setMockValues({ ...values, apiKeyFormVisible: true }); | ||
| const wrapper = shallow(<ApiKeys />); | ||
|
|
||
| expect(wrapper.find(ApiKeyFlyout)).toHaveLength(1); | ||
| }); | ||
|
|
||
| it('will NOT render ApiKeyFlyout if apiKeyFormVisible is false', () => { | ||
| setMockValues({ ...values, apiKeyFormVisible: false }); | ||
| const wrapper = shallow(<ApiKeys />); | ||
|
|
||
| expect(wrapper.find(ApiKeyFlyout)).toHaveLength(0); | ||
| }); | ||
| }); |
109 changes: 109 additions & 0 deletions
109
...lugins/enterprise_search/public/applications/workplace_search/views/api_keys/api_keys.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| /* | ||
| * 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, { useEffect } from 'react'; | ||
|
|
||
| import { useActions, useValues } from 'kea'; | ||
|
|
||
| import { | ||
| EuiButton, | ||
| EuiTitle, | ||
| EuiPanel, | ||
| EuiCopy, | ||
| EuiButtonIcon, | ||
| EuiSpacer, | ||
| EuiEmptyPrompt, | ||
| } from '@elastic/eui'; | ||
|
|
||
| import { docLinks } from '../../../shared/doc_links'; | ||
| import { externalUrl } from '../../../shared/enterprise_search_url/external_url'; | ||
|
|
||
| import { WorkplaceSearchPageTemplate } from '../../components/layout'; | ||
| import { NAV, API_KEYS_TITLE } from '../../constants'; | ||
|
|
||
| import { ApiKeysLogic } from './api_keys_logic'; | ||
| import { ApiKeyFlyout } from './components/api_key_flyout'; | ||
| import { ApiKeysList } from './components/api_keys_list'; | ||
| import { | ||
| API_KEYS_EMPTY_TITLE, | ||
| API_KEYS_EMPTY_BODY, | ||
| API_KEYS_EMPTY_BUTTON_LABEL, | ||
| CREATE_KEY_BUTTON_LABEL, | ||
| ENDPOINT_TITLE, | ||
| COPIED_TOOLTIP, | ||
| COPY_API_ENDPOINT_BUTTON_LABEL, | ||
| } from './constants'; | ||
|
|
||
| export const ApiKeys: React.FC = () => { | ||
| const { fetchApiKeys, resetApiKeys, showApiKeyForm } = useActions(ApiKeysLogic); | ||
|
|
||
| const { meta, dataLoading, apiKeyFormVisible, apiTokens } = useValues(ApiKeysLogic); | ||
|
|
||
| useEffect(() => { | ||
| fetchApiKeys(); | ||
| return resetApiKeys; | ||
| }, [meta.page.current]); | ||
|
|
||
| const hasApiKeys = apiTokens.length > 0; | ||
|
|
||
| const addKeyButton = ( | ||
| <EuiButton fill onClick={showApiKeyForm}> | ||
| {CREATE_KEY_BUTTON_LABEL} | ||
| </EuiButton> | ||
| ); | ||
|
|
||
| const emptyPrompt = ( | ||
| <EuiEmptyPrompt | ||
| iconType="editorStrike" | ||
| title={<h2>{API_KEYS_EMPTY_TITLE}</h2>} | ||
| body={API_KEYS_EMPTY_BODY} | ||
| actions={ | ||
| <EuiButton | ||
| size="s" | ||
| target="_blank" | ||
| iconType="popout" | ||
| href={docLinks.workplaceSearchApiKeys} | ||
| > | ||
| {API_KEYS_EMPTY_BUTTON_LABEL} | ||
| </EuiButton> | ||
| } | ||
| /> | ||
| ); | ||
|
|
||
| return ( | ||
| <WorkplaceSearchPageTemplate | ||
| pageChrome={[NAV.API_KEYS]} | ||
| pageHeader={{ | ||
| pageTitle: API_KEYS_TITLE, | ||
| rightSideItems: [addKeyButton], | ||
| }} | ||
| isLoading={dataLoading} | ||
| emptyState={!hasApiKeys && emptyPrompt} | ||
| > | ||
| {apiKeyFormVisible && <ApiKeyFlyout />} | ||
| <EuiPanel color="subdued" className="eui-textCenter"> | ||
| <EuiTitle size="s"> | ||
| <h2>{ENDPOINT_TITLE}</h2> | ||
| </EuiTitle> | ||
| <EuiCopy textToCopy={externalUrl.enterpriseSearchUrl} afterMessage={COPIED_TOOLTIP}> | ||
| {(copy) => ( | ||
| <> | ||
| <EuiButtonIcon | ||
| onClick={copy} | ||
| iconType="copyClipboard" | ||
| aria-label={COPY_API_ENDPOINT_BUTTON_LABEL} | ||
| /> | ||
| {externalUrl.enterpriseSearchUrl} | ||
| </> | ||
| )} | ||
| </EuiCopy> | ||
| </EuiPanel> | ||
| <EuiSpacer size="xxl" /> | ||
| <EuiPanel hasBorder>{hasApiKeys ? <ApiKeysList /> : emptyPrompt}</EuiPanel> | ||
| </WorkplaceSearchPageTemplate> | ||
| ); | ||
| }; |
Oops, something went wrong.