[Workplace Search] Add a technical preview of connecting GitHub via GitHub apps #119764

yakhinvadim · 2021-11-26T00:39:50Z

Summary

This PR introduces a technical preview of connecting GitHub via Github apps.

The new connection flows are available by opening these URLs directly:
http://localhost:5601/iud/app/enterprise_search/workplace_search/sources/add/github_via_app and
http://localhost:5601/iud/app/enterprise_search/workplace_search/sources/add/github_enterprise_server_via_app

As always, best to review commit-by-commit.
Unit tests and i18n were intentionally skipped in this PR.

Please note that this PR only works with the backend on branch chenhui/new-github-service-type.

github_via_app

Screen.Cast.2021-12-02.at.3.07.14.PM.mp4

DLP is not available on Basic license:

github_enterprise_server_via_app

Screen.Cast.2021-12-02.at.3.10.29.PM.mp4

DLP is not available on Basic license:

Checklist

Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

Intentionally skipped in this PR

Unit or functional tests were updated or added to match the most common scenarios
Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support

For maintainers

This was checked for breaking API changes and was labeled appropriately

Render the new github_via_app component on the new routes (added in future commits). Use isGithubEnterpriseServer prop as differentiator between github and github enterprise server

…b apps Also rename github_app to github_via_app to match service_type on backend

not available for GitHub apps which are configured on a source level

new source types. Add new "secret" field to ContentSourceFullData and mocks

…nstants

...ch/public/applications/workplace_search/views/content_sources/components/source_settings.tsx

...cations/workplace_search/views/content_sources/components/add_source/github_via_app_logic.ts

yakhinvadim · 2021-12-03T15:22:14Z

I will also add an icon to the new service types.

scottybollinger

Just a few NITs. LGTM overall. Will watch for changes mentioned in comments.

...applications/workplace_search/views/content_sources/components/add_source/github_via_app.tsx

...cations/workplace_search/views/content_sources/components/add_source/github_via_app_logic.ts

x-pack/plugins/enterprise_search/public/applications/workplace_search/types.ts

Rely on explicit parameter instead

yakhinvadim · 2021-12-03T22:26:53Z

Good points, Scotty, all addressed in this commit: b16630d

yakhinvadim · 2021-12-03T22:26:59Z

@elasticmachine merge upstream

scottybollinger

Latest changes LGTM! Great work, Vadim 🎉

yakhinvadim · 2021-12-03T22:42:01Z

Not merging yet. I need to add icons to new service types, but can't verify that it works, as the backend stopped creating sources after the last rebase. Will revisit on Monday.

scottybollinger · 2021-12-06T16:12:56Z

@elasticmachine merge upstream

The solution copied from the add_source component.

… into github-app-connection

yakhinvadim · 2021-12-06T21:09:45Z

@elasticmachine merge upstream

kibana-ci · 2021-12-06T22:25:00Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`enterpriseSearch`	1336	1339	+3

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	+4.1KB

History

💔 Build #11513 failed 83ca1ec
💚 Build #11414 succeeded 6b68b77
💚 Build #11122 succeeded 1ce54d0
💚 Build #10830 succeeded 16b1813
💚 Build #10557 succeeded d4fa028e904a75037f0af26b740e6b77dd88e869

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

…itHub apps (elastic#119764) * Add new routes Render the new github_via_app component on the new routes (added in future commits). Use isGithubEnterpriseServer prop as differentiator between github and github enterprise server * Add readUploadedFileAsText * Add new view and logic for creating a GitHub content source via GitHub apps Also rename github_app to github_via_app to match service_type on backend * Make editPath (path to connector settings) optional as it is not available for GitHub apps which are configured on a source level * Update source_settings and source_logic to include configuration for new source types. Add new "secret" field to ContentSourceFullData and mocks * Rename indexPermissions to index_permissions * Extract handlePrivateKeyUpload into a utility function * Extract `github_via_app` and `github_enterprise_server_via_app` to constants * Add a basic validation: submit button is disabled if fields are empty * Address PR feedback * Do not rely on baseUrl field emptyness to define the service type Rely on explicit parameter instead * Add icons to the new GitHub service types * Fix a bug where indexPermissionsValue was true even on basic license. The solution copied from the add_source component. Co-authored-by: Kibana Machine <[email protected]>

kibanamachine · 2021-12-06T22:28:05Z

💚 Backport successful

Status	Branch	Result
✅	8.0

This backport PR will be merged automatically after passing CI.

…itHub apps (#119764) (#120553) * Add new routes Render the new github_via_app component on the new routes (added in future commits). Use isGithubEnterpriseServer prop as differentiator between github and github enterprise server * Add readUploadedFileAsText * Add new view and logic for creating a GitHub content source via GitHub apps Also rename github_app to github_via_app to match service_type on backend * Make editPath (path to connector settings) optional as it is not available for GitHub apps which are configured on a source level * Update source_settings and source_logic to include configuration for new source types. Add new "secret" field to ContentSourceFullData and mocks * Rename indexPermissions to index_permissions * Extract handlePrivateKeyUpload into a utility function * Extract `github_via_app` and `github_enterprise_server_via_app` to constants * Add a basic validation: submit button is disabled if fields are empty * Address PR feedback * Do not rely on baseUrl field emptyness to define the service type Rely on explicit parameter instead * Add icons to the new GitHub service types * Fix a bug where indexPermissionsValue was true even on basic license. The solution copied from the add_source component. Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Vadim Yakhin <[email protected]>

…-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

…itHub apps (elastic#119764) * Add new routes Render the new github_via_app component on the new routes (added in future commits). Use isGithubEnterpriseServer prop as differentiator between github and github enterprise server * Add readUploadedFileAsText * Add new view and logic for creating a GitHub content source via GitHub apps Also rename github_app to github_via_app to match service_type on backend * Make editPath (path to connector settings) optional as it is not available for GitHub apps which are configured on a source level * Update source_settings and source_logic to include configuration for new source types. Add new "secret" field to ContentSourceFullData and mocks * Rename indexPermissions to index_permissions * Extract handlePrivateKeyUpload into a utility function * Extract `github_via_app` and `github_enterprise_server_via_app` to constants * Add a basic validation: submit button is disabled if fields are empty * Address PR feedback * Do not rely on baseUrl field emptyness to define the service type Rely on explicit parameter instead * Add icons to the new GitHub service types * Fix a bug where indexPermissionsValue was true even on basic license. The solution copied from the add_source component. Co-authored-by: Kibana Machine <[email protected]>

This comment has been minimized.

Sign in to view

Vadim Yakhin added 2 commits December 2, 2021 13:34

Add new routes

60cefa8

Render the new github_via_app component on the new routes (added in future commits). Use isGithubEnterpriseServer prop as differentiator between github and github enterprise server

Add readUploadedFileAsText

a408a04

yakhinvadim force-pushed the github-app-connection branch from f31a4f6 to b57ecf4 Compare December 2, 2021 21:52

Add new view and logic for creating a GitHub content source via GitHu…

5b839e9

…b apps Also rename github_app to github_via_app to match service_type on backend

yakhinvadim force-pushed the github-app-connection branch 2 times, most recently from 5af1a37 to 67d12c5 Compare December 2, 2021 22:49

Vadim Yakhin added 5 commits December 2, 2021 14:51

Make editPath (path to connector settings) optional as it is

14397e4

not available for GitHub apps which are configured on a source level

Update source_settings and source_logic to include configuration for

5ef8ab8

new source types. Add new "secret" field to ContentSourceFullData and mocks

Rename indexPermissions to index_permissions

0a558c4

Extract handlePrivateKeyUpload into a utility function

bb8e262

Extract github_via_app and github_enterprise_server_via_app to co…

16b1813

…nstants

yakhinvadim force-pushed the github-app-connection branch from 67d12c5 to 16b1813 Compare December 2, 2021 22:52

yakhinvadim changed the title ~~WIP~~ [Workplace Search] Add a technical preview of connecting GitHub via GitHub apps Dec 2, 2021

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

yakhinvadim marked this pull request as ready for review December 2, 2021 23:17

yakhinvadim requested a review from a team December 2, 2021 23:17

yakhinvadim commented Dec 2, 2021

View reviewed changes

...ch/public/applications/workplace_search/views/content_sources/components/source_settings.tsx Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

yakhinvadim commented Dec 3, 2021

View reviewed changes

...cations/workplace_search/views/content_sources/components/add_source/github_via_app_logic.ts Outdated Show resolved Hide resolved

scottybollinger approved these changes Dec 3, 2021

View reviewed changes

Vadim Yakhin added 3 commits December 3, 2021 13:27

Add a basic validation: submit button is disabled if fields are empty

9dcebdf

Address PR feedback

b16630d

Do not rely on baseUrl field emptyness to define the service type

f4d1b71

Rely on explicit parameter instead

Merge branch 'main' into github-app-connection

1ce54d0

scottybollinger approved these changes Dec 3, 2021

View reviewed changes

kibanamachine and others added 4 commits December 6, 2021 11:12

Merge branch 'main' into github-app-connection

6b68b77

Add icons to the new GitHub service types

f2c218d

Fix a bug where indexPermissionsValue was true even on basic license.

89e7b70

The solution copied from the add_source component.

Merge branch 'github-app-connection' of github.com:yakhinvadim/kibana…

83ca1ec

… into github-app-connection

yakhinvadim enabled auto-merge (squash) December 6, 2021 19:37

Merge branch 'main' into github-app-connection

9057ed4

yakhinvadim merged commit 60f463a into elastic:main Dec 6, 2021

kibanamachine mentioned this pull request Dec 6, 2021

[8.0] [Workplace Search] Add a technical preview of connecting GitHub via GitHub apps (#119764) #120553

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workplace Search] Add a technical preview of connecting GitHub via GitHub apps #119764

[Workplace Search] Add a technical preview of connecting GitHub via GitHub apps #119764

yakhinvadim commented Nov 26, 2021 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

yakhinvadim commented Dec 3, 2021

scottybollinger left a comment

yakhinvadim commented Dec 3, 2021

yakhinvadim commented Dec 3, 2021

scottybollinger left a comment

yakhinvadim commented Dec 3, 2021 •

edited

Loading

scottybollinger commented Dec 6, 2021

yakhinvadim commented Dec 6, 2021

kibana-ci commented Dec 6, 2021

kibanamachine commented Dec 6, 2021

[Workplace Search] Add a technical preview of connecting GitHub via GitHub apps #119764

[Workplace Search] Add a technical preview of connecting GitHub via GitHub apps #119764

Conversation

yakhinvadim commented Nov 26, 2021 • edited Loading

Summary

github_via_app

github_enterprise_server_via_app

Checklist

Intentionally skipped in this PR

For maintainers

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

yakhinvadim commented Dec 3, 2021

scottybollinger left a comment

Choose a reason for hiding this comment

yakhinvadim commented Dec 3, 2021

yakhinvadim commented Dec 3, 2021

scottybollinger left a comment

Choose a reason for hiding this comment

yakhinvadim commented Dec 3, 2021 • edited Loading

scottybollinger commented Dec 6, 2021

yakhinvadim commented Dec 6, 2021

kibana-ci commented Dec 6, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

History

kibanamachine commented Dec 6, 2021

💚 Backport successful

yakhinvadim commented Nov 26, 2021 •

edited

Loading

yakhinvadim commented Dec 3, 2021 •

edited

Loading