add frontend panel and add docker instructions #8

Jas0nch · 2025-03-30T00:57:59Z

This Pull Request contains the following changes:

gitignore change to exclude junit.xml file created by jlpm test
README improvement to add develop instructions using docker
in-memory/localStorage connector fixes of list function to return all secrets if query parameter is absent
Add a side panel show secrets filtered by namespace.

There're also a lot of Todos/Improvements by introducing this Pull Request:

better UI/UX design
should we expose the secrets value?

jupyter-secrets-manager-side-panel.mov

brichet

Thanks @Jas0nch for working on this.

I left some comments below.

brichet · 2025-03-31T14:10:11Z

.gitignore

@@ -123,3 +123,6 @@ dmypy.json

 # Yarn cache
 .yarn/
+
+# Test results
+junit.xml


Suggested change

junit.xml

junit.xml

brichet · 2025-03-31T14:10:15Z

style/base.css

+
+.jp-SecretsPanel-add-form-buttons button {
+  flex: 1;
+}


Suggested change

}

}

brichet · 2025-03-31T14:10:22Z

src/index.ts

@@ -34,7 +43,16 @@ const manager: JupyterFrontEndPlugin<ISecretsManager> = {
    connector: ISecretsConnector
  ): ISecretsManager => {
    console.log('JupyterLab extension jupyter-secrets-manager is activated!');
-    return new SecretsManager({ connector });
+    const secretsManager = new SecretsManager({ connector });
+    const panel = new Panel();


We should probably build the side panel in another plugin, to be able to disable it.

Is it too much to have the UI in another plugin? Do you have a use case in mind where we want to enable the secrets manage functionality but disable the UI?

It already works to automatically populate inputs without UI, see #8 (comment).

brichet · 2025-03-31T14:10:26Z

src/index.ts

+    const secretsManager = new SecretsManager({ connector });
+    const panel = new Panel();
+    panel.id = 'jupyter-secrets-manager:panel';
+    panel.title.icon = logoIcon;


There is already a lock icon in Jupyterlab, we should reuse it.

import { lockIcon } from '@jupyterlab/ui-components';

good catch, I'll change to reuse that.

brichet · 2025-03-31T14:16:15Z

I wonder how we could handle namespaces in the panel.
The idea of the namespace is that each extension provides its own namespace.
In the long run, it would be really nice to isolate the the namespaced secrets from other extensions, to avoid malicious usage.

Maybe for a first implementation, the secrets manager could provide a list of existing namespaces, which would populate a drop down in the widget.

Jas0nch · 2025-03-31T17:36:37Z

Maybe for a first implementation, the secrets manager could provide a list of existing namespaces, which would populate a drop down in the widget.

Thanks @brichet to review my PR. I agree with you on this. Actually I'm thinking should we make it further to notebook level? It would be great to have the capability to grant/revoke a secrets to a notebook to get more fine-grained access control. But namespace level can be the first implementation.

I'm also very curious on the vision of this plugin, in the long run, how would it work? It will populate the secrets to kernel, right? It will also accept other plugin's code to add secrets, right? Anything else? Is there a documentation?

I was reading jupyterlab/jupyter-ai#1237 and found that there's already something developing. So I'm thinking if we should gather some input from jupyter-ai team to see how the secrets manager could be evolved.

brichet · 2025-03-31T19:42:59Z

I was reading jupyterlab/jupyter-ai#1237 and found that there's already something developing. So I'm thinking if we should gather some input from jupyter-ai team to see how the secrets manager could be evolved.

Indeed, we mentioned it quickly during a jupyter-ai meeting but did not mention it in the jupyter-ai issue. This is really at early stage currently.

It will populate the secrets to kernel, right?

Currently it works in the frontend only, but we should indeed think of a way to send the secrets to the kernel.

It will also accept other plugin's code to add secrets, right?

The way it works currently (frontend only):

a plugin 'attach' an input element to the secretsManager, associated to a namespace and an input ID (here).
the secretsManager queries the secretsConnector to look for a secret with the namespace/ID provided. If there is one, the input is populated with the secret value.
if the user update the secret, the value is updated using the secretsConnector.

For example, this is used in jupyterlite-ai, from this PR.

Plugins should probably not add secrets, but rather allow associating a namespace/ID to a secret by the user.

Jas0nch · 2025-04-01T04:50:20Z

Let me check the usage and think about how can I improve this PR

Jas0nch · 2025-04-02T03:49:48Z

src/components/SecretsPanel.tsx

+  manager: ISecretsManager;
+}
+
+const EyeIcon = () => (


I didn't find a good import for these eye icons, please let me know if any better eye icons

Jas0nch · 2025-04-02T04:10:59Z

Hi @brichet , I read the jupyterlite-ai usage of the secrets manager and now I understand how it works. I have update a new version of the PR along with the description and demo, please take a look when you have time.

I still have some questions and want to discuss in the early stage as it's more flexible.

Some open questions regarding this PR:

Do we want to have the ability to expose the secret value, it's kind of visible when using localStorage connector but may be hidden for in-memory connector?

Some proposals regarding this plugin:

From what I have seen, looks like this plugin was created to host secrets for other plugins. Do we also want to let user to manager their own secrets?
We should have the functionality to grant some API_KEY to be used in some notebooks' environment variable. This can be done once we implemented the feature to send the secrets to the kernel

brichet · 2025-04-03T13:17:43Z

Thanks @Jas0nch for updating the PR.

I opened #10 and #11 from you comments/questions.

Maybe we should wait for more visibility on the expected features of that project before moving forward with the UI component.

Jas0nch · 2025-04-03T15:18:36Z

I agree with you. Let’s hold this PR for now

brichet reviewed Mar 31, 2025

View reviewed changes

jtpio added the enhancement New feature or request label Mar 31, 2025

Jas0nch force-pushed the frontend-panel branch from 2e6df6b to 4499cf8 Compare April 2, 2025 03:45

Jas0nch commented Apr 2, 2025

View reviewed changes

add frontend panel and add docker instructions

20b5921

Jas0nch force-pushed the frontend-panel branch from 4499cf8 to 20b5921 Compare April 2, 2025 03:53

This was referenced Apr 3, 2025

Manually manage secrets #10

Open

Send secrets to the kernel #11

Open

Jas0nch closed this Apr 16, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add frontend panel and add docker instructions #8

add frontend panel and add docker instructions #8

Jas0nch commented Mar 30, 2025 •

edited

Loading

brichet left a comment

brichet Mar 31, 2025

brichet Mar 31, 2025

brichet Mar 31, 2025

Jas0nch Mar 31, 2025

brichet Mar 31, 2025

brichet Mar 31, 2025

Jas0nch Mar 31, 2025

brichet commented Mar 31, 2025

Jas0nch commented Mar 31, 2025 •

edited

Loading

brichet commented Mar 31, 2025

Jas0nch commented Apr 1, 2025

Jas0nch Apr 2, 2025

Jas0nch commented Apr 2, 2025 •

edited

Loading

brichet commented Apr 3, 2025

Jas0nch commented Apr 3, 2025

add frontend panel and add docker instructions #8

add frontend panel and add docker instructions #8

Conversation

Jas0nch commented Mar 30, 2025 • edited Loading

brichet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brichet commented Mar 31, 2025

Jas0nch commented Mar 31, 2025 • edited Loading

brichet commented Mar 31, 2025

Jas0nch commented Apr 1, 2025

Choose a reason for hiding this comment

Jas0nch commented Apr 2, 2025 • edited Loading

brichet commented Apr 3, 2025

Jas0nch commented Apr 3, 2025

Jas0nch commented Mar 30, 2025 •

edited

Loading

Jas0nch commented Mar 31, 2025 •

edited

Loading

Jas0nch commented Apr 2, 2025 •

edited

Loading