Add a way to manage API keys #1136

Karakatiza666 · 2023-12-13T19:17:41Z

Is this a user-visible change (yes/no): yes
Fix #1103

github-actions · 2023-12-13T19:22:44Z

🤖 Meticulous spotted visual differences in 1 of 6 screens tested: view and approve differences detected.

_{Last updated for commit b80d8d0. This comment will update as new commits are pushed.}

lalithsuresh

Regarding the side bar. I don't think "ecosystem" is the right section for these settings.

API key generation should only be exposed by the UI when using authentication. It should be part of the user profile drop down on the top right.

lalithsuresh · 2023-12-13T19:37:50Z

crates/pipeline_manager/src/api/auth_api.rs

@@ -8,7 +8,7 @@ use super::{ManagerError, ServerState};

 /// Get authentication provider configuration
 #[utoipa::path(
-    path="/config/authentication",
+    path="/../config/authentication",


Why is this change required? This was fixed to /config/authentication as part of #1084. ../ also looks sloppy in the API documentation.

Otherwise TypeScript generates a url /v0/config/authentication for this action, which is wrong. I understand this path is relative (a subpath), hence the issue?

Ah, now I see why you need this.

Our use of a Servers variable is the issue: https://github.com/feldera/feldera/blob/main/crates/pipeline_manager/src/api/mod.rs#L63

I'll see if I can find a quick workaround so you don't need this change. Basically, we need the /v0 prefix only for the authenticated APIs.

@Karakatiza666 btw, I've been using the authentication code from the UI just fine. What workflow breaks without the relative pathing?

You are just using previous, correct UI code. I generated latest UI OpenAPI bindings and there this issue popped up, so I had to add '/../' to get generated code to behave as before.
I think I added this previously too, actually.

Ack. I've opened #1139. See if that fixes your problem. If so, let's merge that and rebase this PR on top of it.

lalithsuresh · 2023-12-13T19:40:46Z

web-console/src/lib/components/settings/CreateApiKeyDialog.tsx

+              <br />
+              You will not be able to view API key secret afterwards.
+              <br />
+              You should store generated API key yourself.


You will be shown the generated API key only once. You will not be able view it afterwards. Please store it securely.

Karakatiza666 · 2023-12-13T19:54:13Z

Would it make sense to leave API keys view on the settings page and only show it when authenticated?
I am wary of moving the entire list to account dropdown.

Karakatiza666 · 2023-12-13T19:56:15Z

We will need settings page at some point anyway

lalithsuresh · 2023-12-13T20:26:08Z

Would it make sense to leave API keys view on the settings page and only show it when authenticated? I am wary of moving the entire list to account dropdown.

I'm fine with that too.

lalithsuresh

LGTM from my side.

gz · 2023-12-14T17:25:47Z

this goes to an empty page for me? is it because I have no auth (in that case the link should not show up in the first place with no auth)?

API key generation should only be exposed by the UI when using authentication. It should be part of the user profile drop down on the top right.

I felt this would be a good place to put this (fwiw in github it's also under user)

gz · 2023-12-14T17:28:04Z

web-console/src/lib/components/settings/ApiKeyList.tsx

+      <Stack spacing={4}>
+        {title}
+        <Box sx={{ display: 'flex', alignItems: 'center', gap: 2 }}>
+          <Icon270RingWithBg></Icon270RingWithBg>fetching keys...


Suggested change

<Icon270RingWithBg></Icon270RingWithBg>fetching keys...

<Icon270RingWithBg></Icon270RingWithBg>Fetching keys...

gz · 2023-12-14T17:28:14Z

web-console/src/lib/components/settings/ApiKeyList.tsx

+    return (
+      <Stack spacing={4}>
+        {title}
+        No api keys generated


Suggested change

No api keys generated

No API keys generated

gz · 2023-12-14T17:30:45Z

I can't see it right now in the browser, but judging from the screenshots I don't think there is need to have a scrollbar here?

Karakatiza666 · 2023-12-14T17:32:39Z

The scrollbar only appears to scroll through more than 4 keys

Karakatiza666 · 2023-12-15T19:47:29Z

@gz yes, the keys should only be accessible when auth is enabled. Authentication is the only section in settings, but only temporarily. There is no point to add code to hide the page when it will get filled with content relatively soon

Signed-off-by: George <bulakh.96@gmail.com>

Karakatiza666 added enhancement New feature or request Web Console Related to the browser based UI javascript Pull requests that update Javascript code User-facing For PRs that lead to Feldera-user visible changes labels Dec 13, 2023

Karakatiza666 requested a review from gz December 13, 2023 19:17

Karakatiza666 force-pushed the api-key branch from 8c2c26d to ff02539 Compare December 13, 2023 19:34

Karakatiza666 requested a review from lalithsuresh December 13, 2023 19:34

lalithsuresh reviewed Dec 13, 2023

View reviewed changes

Karakatiza666 force-pushed the api-key branch from ff02539 to 12d4cbe Compare December 13, 2023 19:50

Karakatiza666 force-pushed the api-key branch from 12d4cbe to 9e319bb Compare December 13, 2023 19:56

Karakatiza666 force-pushed the api-key branch from 9e319bb to d984509 Compare December 14, 2023 11:50

lalithsuresh approved these changes Dec 14, 2023

View reviewed changes

gz approved these changes Dec 14, 2023

View reviewed changes

Karakatiza666 added 2 commits December 15, 2023 21:13

Generate PipelineManager OpenAPI TypeScript v 0.5.0

b7fcaa7

Signed-off-by: George <bulakh.96@gmail.com>

Add Settings page, add a view to manage API keys

b80d8d0

Signed-off-by: George <bulakh.96@gmail.com>

Karakatiza666 force-pushed the api-key branch from d984509 to b80d8d0 Compare December 15, 2023 21:14

Karakatiza666 merged commit 4e27e64 into main Dec 15, 2023
4 checks passed

Karakatiza666 deleted the api-key branch December 15, 2023 21:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a way to manage API keys #1136

Add a way to manage API keys #1136

Karakatiza666 commented Dec 13, 2023 •

edited

Loading

github-actions bot commented Dec 13, 2023 •

edited

Loading

lalithsuresh left a comment

lalithsuresh Dec 13, 2023 •

edited

Loading

Karakatiza666 Dec 13, 2023 •

edited

Loading

lalithsuresh Dec 13, 2023

lalithsuresh Dec 13, 2023

Karakatiza666 Dec 13, 2023 •

edited

Loading

lalithsuresh Dec 13, 2023

lalithsuresh Dec 13, 2023

Karakatiza666 commented Dec 13, 2023

Karakatiza666 commented Dec 13, 2023

lalithsuresh commented Dec 13, 2023

lalithsuresh left a comment

gz commented Dec 14, 2023 •

edited

Loading

gz Dec 14, 2023

gz Dec 14, 2023

gz commented Dec 14, 2023

Karakatiza666 commented Dec 14, 2023

Karakatiza666 commented Dec 15, 2023

	<Icon270RingWithBg></Icon270RingWithBg>fetching keys...
	<Icon270RingWithBg></Icon270RingWithBg>Fetching keys...

Add a way to manage API keys #1136

Add a way to manage API keys #1136

Conversation

Karakatiza666 commented Dec 13, 2023 • edited Loading

github-actions bot commented Dec 13, 2023 • edited Loading

lalithsuresh left a comment

Choose a reason for hiding this comment

lalithsuresh Dec 13, 2023 • edited Loading

Choose a reason for hiding this comment

Karakatiza666 Dec 13, 2023 • edited Loading

Choose a reason for hiding this comment

lalithsuresh Dec 13, 2023

Choose a reason for hiding this comment

lalithsuresh Dec 13, 2023

Choose a reason for hiding this comment

Karakatiza666 Dec 13, 2023 • edited Loading

Choose a reason for hiding this comment

lalithsuresh Dec 13, 2023

Choose a reason for hiding this comment

lalithsuresh Dec 13, 2023

Choose a reason for hiding this comment

Karakatiza666 commented Dec 13, 2023

Karakatiza666 commented Dec 13, 2023

lalithsuresh commented Dec 13, 2023

lalithsuresh left a comment

Choose a reason for hiding this comment

gz commented Dec 14, 2023 • edited Loading

gz Dec 14, 2023

Choose a reason for hiding this comment

gz Dec 14, 2023

Choose a reason for hiding this comment

gz commented Dec 14, 2023

Karakatiza666 commented Dec 14, 2023

Karakatiza666 commented Dec 15, 2023

Karakatiza666 commented Dec 13, 2023 •

edited

Loading

github-actions bot commented Dec 13, 2023 •

edited

Loading

lalithsuresh Dec 13, 2023 •

edited

Loading

Karakatiza666 Dec 13, 2023 •

edited

Loading

Karakatiza666 Dec 13, 2023 •

edited

Loading

gz commented Dec 14, 2023 •

edited

Loading