[Workplace Search] Add API Keys view to replace Access tokens #120147

scottybollinger · 2021-12-01T18:29:14Z

closes https://github.com/elastic/workplace-search-team/issues/2185
closes https://github.com/elastic/workplace-search-team/issues/2186
closes https://github.com/elastic/workplace-search-team/issues/2188

Summary

As of 8.0, Workplace Search is replacing user-level Access Tokens with account-level API keys. This PR removes the Access Tokens from the UI and adds a new feature for API keys.

Please note that this PR only works with the backend on branch davishmcclurg/frito-pie-api-token.

Removal of Access Tokens

Custom source created confirmation

Before	After

Custom source overview page

Before	After

API.keys.mp4

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)

This is done on both the Source overview and Custom source confirmation. Also removed the unused constants and translations

This was introduced in elastic#119256

Also updates casing for nav label

Link address taken from https://github.com/elastic/workplace-search-team/issues/2189#issuecomment-978114915

- ApiKeyFlyout - ApiKey - ApiKeysList

CI said this was needed due to core changes

Was mistaken that we use the ID, when we actually use the name. Logic was already correct in the frontend code.

scottybollinger · 2021-12-02T20:17:42Z

@elasticmachine merge upstream

kibanamachine · 2021-12-02T20:17:44Z

merge conflict between base and head

lukeelmers

Doclinks updates lgtm

This was missed because I copied App Search and it was an included there. Once I had an API, I realized I needed to have the confirm modal, as deleting the API key is destructive

The delete confirm modal would still be visible on error. This always hides the modal

This method does more than show the modal.

yakhinvadim

LGTM! 👍

I found only 1 minor issue during testing, that I don't think we need to fix.

On a separate note, I think the best way to organize similar PRs in the future is to do what we did for the migration to Kibana PRs: have a single copy-paste commit and then do the modifications after it.

yakhinvadim · 2021-12-03T19:51:36Z

...rise_search/public/applications/workplace_search/views/api_keys/components/api_keys_list.tsx

+      pagination={{
+        ...convertMetaToPagination(meta),
+        hidePerPageOptions: true,
+      }}
+      onChange={handlePageChange(onPaginate)}


How many items do we expect on 1 page? I thought it's 10, but when I created 20+ items, I still had only 1 page:

Nice catch! This doesn't work for App Search either. Will do some digging and see if it's an easy fix.

Looks like its an issue with the API, or at least how the UI sends a request to the API:

I think it's fine TBH. The pagination will only hurt. With all keys on one page, you can Ctrl+F to search for a key. If we introduce pagination, users would have to open page by page to find the key.

Agreed. Thanks, Vadim! Will wait to merge until backend lands.

Great work on this!

scottybollinger · 2021-12-06T16:10:37Z

@elasticmachine merge upstream

kibana-ci · 2021-12-06T17:24:21Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`enterpriseSearch`	1336	1344	+8

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`enterpriseSearch`	1.3MB	1.3MB	+9.3KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`core`	275.5KB	275.6KB	+55.0B
`enterpriseSearch`	15.5KB	15.7KB	+133.0B
total			+188.0B

History

💚 Build #11030 succeeded f8e112c
💚 Build #10859 succeeded e52e145
💛 Build #10784 was flaky 01476a8
💚 Build #10501 succeeded 41285c1
💔 Build #10482 failed 4c22c94
💔 Build #10472 failed 4f8f12b

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

kibanamachine · 2021-12-07T02:43:03Z

💔 Backport failed

Status	Branch	Result
❌	8.0	Commit could not be cherrypicked due to conflicts

To backport manually run:
node scripts/backport --pr 120147

…c#120147) # Conflicts: # docs/development/core/public/kibana-plugin-core-public.doclinksstart.md

… (#120565) # Conflicts: # docs/development/core/public/kibana-plugin-core-public.doclinksstart.md

…-chromium-before-compiling-pdf * 'main' of github.com:elastic/kibana: (121 commits) FTR should use the new kibana_system user (elastic#120436) [Lens] Temporarily exclude Mosaic/Waffle from the suggestions list (elastic#120488) [Reporting] Fix slow CSV with large max size bytes (elastic#120365) [CTI] Threat Intel Card on Overview page needs to accommodate Fleet TI integrations - (elastic#120459) [Dashboard] Added KibanaThemeProvider. (elastic#120122) add more rule_registry unit tests (elastic#120323) [Lens] update xpack.lens.pie.smallValuesWarningMessage text (elastic#120478) [Fleet] Simplified package policy create API, enriching default values (elastic#119739) mock `elastic-apm-node` in `@kbn/test` jest preset (elastic#120324) [RAC] Rename occurrences of alert_type to rule_type in Infra (elastic#120455) [Security Solutions] Removes tech debt of exporting all from linter rule for timeline plugin (elastic#120437) [Workplace Search] Add API Keys view to replace Access tokens (elastic#120147) [Security Solutions] Removes tech debt of exporting all from linter rule for cases plugin in the server section (elastic#120411) Add support for threat.feed.name (elastic#120250) [Rule Registry] Rewrite APM registry rules for Observability (elastic#117740) [docs] Fix artifact layout formatting (elastic#119386) [Workplace Search] Add a technical preview of connecting GitHub via GitHub apps (elastic#119764) add osquery notes for 7.16 (elastic#120407) chore(NA): splits types from code on @kbn/docs-utils (elastic#120533) [Reporting] Decouple screenshotting plugin from the reporting (elastic#120110) ... # Conflicts: # x-pack/plugins/reporting/server/browsers/chromium/driver_factory/index.test.ts # x-pack/plugins/reporting/server/browsers/chromium/driver_factory/index.ts # x-pack/plugins/reporting/server/lib/screenshots/observable.test.ts # x-pack/plugins/reporting/server/lib/screenshots/observable.ts # x-pack/plugins/reporting/server/test_helpers/create_mock_browserdriverfactory.ts

…c#120147)

scottybollinger added 9 commits December 1, 2021 11:57

Add route and nav item for APK keys

613cf46

Add SourceIdentifier component

1ae72dd

Update cards to remove access token and show Source ID

41437e7

This is done on both the Source overview and Custom source confirmation. Also removed the unused constants and translations

Fix lbrary path

26c03c5

This was introduced in elastic#119256

Add type and constants

7874e38

Also updates casing for nav label

Add documentation link

f4588d5

Link address taken from https://github.com/elastic/workplace-search-team/issues/2189#issuecomment-978114915

Add api keys routes

ad2fa08

Add components and constants

fbc4c8d

- ApiKeyFlyout - ApiKey - ApiKeysList

Add view

b04b6df

scottybollinger added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes auto-backport Deprecated - use backport:version if exact versions are needed v8.1.0 labels Dec 1, 2021

Add logic file

4f8f12b

scottybollinger force-pushed the scottybollinger/api-keys branch from 04a410c to 4f8f12b Compare December 1, 2021 18:34

scottybollinger added 3 commits December 1, 2021 12:59

Update API documentation and the API review file

4c22c94

CI said this was needed due to core changes

Fix failing test

41285c1

Update server to correctly label param as tokenName

20fbc69

Was mistaken that we use the ID, when we actually use the name. Logic was already correct in the frontend code.

Merge branch 'main' into scottybollinger/api-keys

01476a8

scottybollinger marked this pull request as ready for review December 3, 2021 00:32

scottybollinger requested a review from a team December 3, 2021 00:32

scottybollinger requested a review from a team as a code owner December 3, 2021 00:32

scottybollinger requested a review from a team December 3, 2021 00:32

lukeelmers approved these changes Dec 3, 2021

View reviewed changes

scottybollinger changed the title ~~[Workplace Search] Add Api Keys view to replace Access tokens~~ [Workplace Search] Add API Keys view to replace Access tokens Dec 3, 2021

scottybollinger added 3 commits December 2, 2021 23:28

Add Confirm modal when deleting

e52e145

This was missed because I copied App Search and it was an included there. Once I had an API, I realized I needed to have the confirm modal, as deleting the API key is destructive

Refactor to always hide modal

c6c06f3

The delete confirm modal would still be visible on error. This always hides the modal

Better method name

f8e112c

This method does more than show the modal.

yakhinvadim approved these changes Dec 3, 2021

View reviewed changes

Merge branch 'main' into scottybollinger/api-keys

0d3fefa

scottybollinger merged commit 062be17 into elastic:main Dec 7, 2021

scottybollinger added a commit to scottybollinger/kibana that referenced this pull request Dec 7, 2021

[Workplace Search] Add API Keys view to replace Access tokens (elasti…

5e8574f

…c#120147) # Conflicts: # docs/development/core/public/kibana-plugin-core-public.doclinksstart.md

scottybollinger mentioned this pull request Dec 7, 2021

[8.0] [Workplace Search] Add API Keys view to replace Access tokens (#120147) #120565

Merged

scottybollinger added a commit that referenced this pull request Dec 7, 2021

[Workplace Search] Add API Keys view to replace Access tokens (#120147)…

a07e827

… (#120565) # Conflicts: # docs/development/core/public/kibana-plugin-core-public.doclinksstart.md

TinLe pushed a commit to TinLe/kibana that referenced this pull request Dec 22, 2021

[Workplace Search] Add API Keys view to replace Access tokens (elasti…

94f5f02

…c#120147)

scottybollinger deleted the scottybollinger/api-keys branch March 15, 2022 15:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workplace Search] Add API Keys view to replace Access tokens #120147

[Workplace Search] Add API Keys view to replace Access tokens #120147

scottybollinger commented Dec 1, 2021 •

edited

Loading

scottybollinger commented Dec 2, 2021

kibanamachine commented Dec 2, 2021

lukeelmers left a comment

yakhinvadim left a comment

yakhinvadim Dec 3, 2021

scottybollinger Dec 3, 2021

scottybollinger Dec 3, 2021

yakhinvadim Dec 3, 2021

scottybollinger Dec 3, 2021

yakhinvadim Dec 3, 2021

scottybollinger commented Dec 6, 2021

kibana-ci commented Dec 6, 2021

kibanamachine commented Dec 7, 2021

[Workplace Search] Add API Keys view to replace Access tokens #120147

[Workplace Search] Add API Keys view to replace Access tokens #120147

Conversation

scottybollinger commented Dec 1, 2021 • edited Loading

Summary

Removal of Access Tokens

Checklist

scottybollinger commented Dec 2, 2021

kibanamachine commented Dec 2, 2021

lukeelmers left a comment

Choose a reason for hiding this comment

yakhinvadim left a comment

Choose a reason for hiding this comment

yakhinvadim Dec 3, 2021

Choose a reason for hiding this comment

scottybollinger Dec 3, 2021

Choose a reason for hiding this comment

scottybollinger Dec 3, 2021

Choose a reason for hiding this comment

yakhinvadim Dec 3, 2021

Choose a reason for hiding this comment

scottybollinger Dec 3, 2021

Choose a reason for hiding this comment

yakhinvadim Dec 3, 2021

Choose a reason for hiding this comment

scottybollinger commented Dec 6, 2021

kibana-ci commented Dec 6, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

kibanamachine commented Dec 7, 2021

💔 Backport failed

scottybollinger commented Dec 1, 2021 •

edited

Loading