feat: Core authentication plugins #1180

mofojed · 2023-03-28T19:50:20Z

Add authentication plugins framework
Add core plugins (Pre-shared key, Parent, and anonymous authentication)
Fixes Support plugins for authentication #1058
Refactored app initialization so embed-grid and embed-chart share the same logic
- Allows embed-grid/embed-chart to display a login screen if necessary
- embed-grid/embed-chart now also authorize

codecov · 2023-03-28T19:57:05Z

Codecov Report

Merging #1180 (6882a2f) into main (2f9c020) will increase coverage by 0.52%.
The diff coverage is 53.11%.

@@            Coverage Diff             @@
##             main    #1180      +/-   ##
==========================================
+ Coverage   45.14%   45.67%   +0.52%     
==========================================
  Files         460      473      +13     
  Lines       33637    33703      +66     
  Branches     8462     8455       -7     
==========================================
+ Hits        15186    15394     +208     
+ Misses      18401    18258     -143     
- Partials       50       51       +1

Flag	Coverage Δ
unit	`45.67% <53.11%> (+0.52%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
packages/app-utils/src/components/useConnection.ts	`0.00% <0.00%> (ø)`
packages/app-utils/src/components/usePlugins.ts	`0.00% <0.00%> (ø)`
packages/app-utils/src/plugins/loadRemoteModule.ts	`100.00% <ø> (ø)`
...s/app-utils/src/plugins/remote-component.config.ts	`100.00% <ø> (ø)`
packages/auth-plugins/src/AuthPlugin.ts	`0.00% <0.00%> (ø)`
packages/code-studio/src/AppRoot.tsx	`0.00% <ø> (ø)`
packages/code-studio/src/index.tsx	`0.00% <0.00%> (ø)`
packages/code-studio/src/main/AppInit.tsx	`0.00% <0.00%> (ø)`
packages/code-studio/src/main/AppMainContainer.tsx	`34.84% <0.00%> (-0.13%)`	⬇️
...ages/code-studio/src/styleguide/StyleGuideRoot.tsx	`0.00% <ø> (ø)`
... and 30 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

packages/code-studio/src/main/AppInit.tsx

- Load AuthPlugins from the server before logging in - Find the appropriate auth plugin and login with it

- Add core plugins for Pre-shared Key, Parent, and Anonymous types of authentication - Will create an example for authclock login in the deephaven-js-plugins repo

- Include an example in the auth-plugin/README - Add tests for the core plugin types - Cleanup some of the AppInit stuff

- Forgot to check that bit

niloc132

Manual testing of PSK and anonymous login work great, also tested by creating my own auth wiring for keycloak and loading it through the plugins mechanism.

- Resolved conflicts in AppInit.tsx - Moved requestParentLoginOptions call to AuthPluginParent

- Will be used by embed-grid and embed-chart as well

- Added types to @deephaven/plugin-utils - Reference those types in @deephaven/redux

- Move SessionUtils into jsapi-utils package - Move PluginUtils and some of the app loading stuff into app-utils package

- Will be needed for all the apps

- Now it should be easier for other apps to initialize (like the embedded apps)

- All unit tests pass - Need to fix embed-grid and embed-chart apps

- Update readme - Delete AppRootBootstrap (unused)

- Wasn't proxying the plugins URL

packages/app-utils/src/plugins/RemoteComponent.ts

packages/code-studio/src/serviceWorker.ts

- Rename 'utils.ts' to 'ConnectUtils.ts' - Wrap styleguide in a FontBootstrap

packages/app-utils/package.json

packages/app-utils/src/components/useClient.ts

packages/app-utils/src/components/usePlugins.ts

packages/app-utils/src/components/AuthBootstrap.tsx

packages/auth-core-plugins/src/AuthPluginPsk.tsx

packages/auth-core-plugins/src/AuthPluginParent.tsx

packages/auth-core-plugins/src/AuthPluginParent.test.tsx

packages/code-studio/src/main/AppInit.tsx

packages/jsapi-utils/src/SessionUtils.ts

packages/app-utils/src/components/AppBootstrap.tsx

packages/auth-plugins/src/AuthPlugin.ts

- Tests the full AppBootstrapping procedure

mattrunyon

Looking pretty good. There's a few unresolved conversations I commented on in this last round, so address those (just adding a comment or creating follow up tickets) and then this should be good to merge

packages/app-utils/src/components/AppBootstrap.test.tsx

mattrunyon

Tested w/ psk and anonymous locally

We should maybe do a follow up to improve psk by adding a prompt if it's not in the URL. Just a little better user experience

mofojed · 2023-04-20T21:19:51Z

Yea I've had some discussions with @dsmmcken about that. I don't think we settled on exactly how we want to prompt for it. #1240

mofojed changed the title ~~Core authentication plugins~~ feat: Core authentication plugins Mar 28, 2023

mofojed requested a review from niloc132 March 28, 2023 19:50

niloc132 reviewed Mar 28, 2023

View reviewed changes

packages/code-studio/src/main/AppInit.tsx Outdated Show resolved Hide resolved

packages/code-studio/src/main/AppInit.tsx Outdated Show resolved Hide resolved

mofojed requested review from niloc132 and vbabich March 29, 2023 16:03

mofojed self-assigned this Mar 29, 2023

mofojed marked this pull request as ready for review March 29, 2023 16:03

mofojed added 6 commits March 29, 2023 14:53

Add support for AuthPlugins

0859753

- Load AuthPlugins from the server before logging in - Find the appropriate auth plugin and login with it

Pass the auth config values to the login plugin

a6065ff

Add core auth plugins to UI

c128f82

- Add core plugins for Pre-shared Key, Parent, and Anonymous types of authentication - Will create an example for authclock login in the deephaven-js-plugins repo

Add some documentation to auth-plugin about usage

0ef2deb

Add tests for auth plugins, examples to docs

8269b59

- Include an example in the auth-plugin/README - Add tests for the core plugin types - Cleanup some of the AppInit stuff

Only allow AuthPluginParent when authProvider=parent set

4f68c04

- Forgot to check that bit

mofojed force-pushed the auth-plugins branch from 4a1e7cd to 4f68c04 Compare March 29, 2023 18:54

niloc132 previously approved these changes Mar 31, 2023

View reviewed changes

mofojed mentioned this pull request Apr 4, 2023

feat: Display workerName and processInfoId in the console status bar #1173

Merged

mofojed added 2 commits April 11, 2023 12:04

Merge remote-tracking branch 'origin/main' into auth-plugins

cffc364

- Resolved conflicts in AppInit.tsx - Moved requestParentLoginOptions call to AuthPluginParent

WIP add a TODO to login in the embedded apps

7cce112

mofojed dismissed niloc132’s stale review via 7cce112 April 11, 2023 20:40

mofojed added 10 commits April 17, 2023 15:26

Pull plugins into their own package, plugin-utils

3361741

- Will be used by embed-grid and embed-chart as well

Move loading plugins into it's own util function

231e0ef

- Added types to @deephaven/plugin-utils - Reference those types in @deephaven/redux

Merge remote-tracking branch 'origin/main' into auth-plugins

a3750af

Fix up conflicts after merging latest main

77e6cff

Refactor some of the app initialization code

716dd7c

- Move SessionUtils into jsapi-utils package - Move PluginUtils and some of the app loading stuff into app-utils package

Move getClientOptions to the app-utils package

54521f5

- Will be needed for all the apps

Added initialization bootstrap to app-utils

c1f89f9

- Now it should be easier for other apps to initialize (like the embedded apps)

Fix up unit tests and style guide

0959b1d

- All unit tests pass - Need to fix embed-grid and embed-chart apps

Add AppBootstrap to embed-grid application

fde0dea

Update embed-chart to use AppBootstrap

f5a1c92

mofojed added 2 commits April 19, 2023 14:21

Clean up app-utils based on self-review

9ac1104

- Update readme - Delete AppRootBootstrap (unused)

Fix plugins loading in embed-grid and embed-chart

e5a8fea

- Wasn't proxying the plugins URL

mofojed commented Apr 19, 2023

View reviewed changes

packages/app-utils/src/plugins/RemoteComponent.ts Show resolved Hide resolved

mofojed commented Apr 19, 2023

View reviewed changes

packages/code-studio/src/serviceWorker.ts Outdated Show resolved Hide resolved

More cleanup on self-review

8cb5884

- Rename 'utils.ts' to 'ConnectUtils.ts' - Wrap styleguide in a FontBootstrap

mofojed requested a review from mattrunyon April 19, 2023 19:16

mattrunyon requested changes Apr 20, 2023

View reviewed changes

mofojed added 3 commits April 20, 2023 10:03

Cleanup after review

6964acc

Fix failing tests

4f7c5c4

Add authentication keyword

2a689a6

mofojed mentioned this pull request Apr 20, 2023

feat: Auth keycloak plugin deephaven/deephaven-js-plugins#19

Merged

mofojed requested a review from mattrunyon April 20, 2023 17:28

Merge remote-tracking branch 'origin/main' into auth-plugins

671a083

mattrunyon requested changes Apr 20, 2023

View reviewed changes

packages/app-utils/src/components/AppBootstrap.tsx Show resolved Hide resolved

packages/auth-plugins/src/AuthPlugin.ts Outdated Show resolved Hide resolved

packages/auth-plugins/src/AuthPlugin.ts Outdated Show resolved Hide resolved

Add some unit tests for AppBootstrap

0eac926

- Tests the full AppBootstrapping procedure

mofojed requested a review from mattrunyon April 20, 2023 19:55

mattrunyon requested changes Apr 20, 2023

View reviewed changes

packages/app-utils/src/components/AppBootstrap.test.tsx Show resolved Hide resolved

This was referenced Apr 20, 2023

Add a useAsyncEffect hook for setting async values #1238

Open

Add support for logging out #1239

Closed

Add a comment explaining why using useContext instead of usePlugins

6882a2f

mofojed requested a review from mattrunyon April 20, 2023 20:54

mattrunyon approved these changes Apr 20, 2023

View reviewed changes

mofojed merged commit 1624309 into deephaven:main Apr 20, 2023

mofojed deleted the auth-plugins branch April 20, 2023 21:19

github-actions bot locked and limited conversation to collaborators Apr 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Core authentication plugins #1180

feat: Core authentication plugins #1180

mofojed commented Mar 28, 2023 •

edited

Loading

codecov bot commented Mar 28, 2023 •

edited

Loading

niloc132 left a comment

mattrunyon left a comment

mattrunyon left a comment

mofojed commented Apr 20, 2023 •

edited

Loading

feat: Core authentication plugins #1180

feat: Core authentication plugins #1180

Conversation

mofojed commented Mar 28, 2023 • edited Loading

codecov bot commented Mar 28, 2023 • edited Loading

Codecov Report

niloc132 left a comment

Choose a reason for hiding this comment

mattrunyon left a comment

Choose a reason for hiding this comment

mattrunyon left a comment

Choose a reason for hiding this comment

mofojed commented Apr 20, 2023 • edited Loading

mofojed commented Mar 28, 2023 •

edited

Loading

codecov bot commented Mar 28, 2023 •

edited

Loading

mofojed commented Apr 20, 2023 •

edited

Loading