Add a setting for the fields visibility (#14)

* Add a setting for the fields visibility, and a locker if it is hidden from page config

* Add the visibility and signal to the manager interface

* Lock the visibility of secret fields only if explicitly provided in the options

Author: brichet

package.json

@@ -19,7 +19,8 @@
     "files": [
         "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
         "style/**/*.{css,js,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
-        "src/**/*.{ts,tsx}"
+        "src/**/*.{ts,tsx}",
+        "schema/*.json"
     ],
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -58,9 +59,11 @@
     "dependencies": {
         "@jupyterlab/application": "^4.0.0",
         "@jupyterlab/coreutils": "^6.0.0",
+        "@jupyterlab/settingregistry": "^4.0.0",
         "@jupyterlab/statedb": "^4.0.0",
         "@lumino/algorithm": "^2.0.0",
-        "@lumino/coreutils": "^2.1.2"
+        "@lumino/coreutils": "^2.1.2",
+        "@lumino/signaling": "^2.1.2"
     },
     "devDependencies": {
         "@jupyterlab/builder": "^4.0.0",
@@ -99,7 +102,8 @@
     },
     "jupyterlab": {
         "extension": true,
-        "outputDir": "jupyter_secrets_manager/labextension"
+        "outputDir": "jupyter_secrets_manager/labextension",
+        "schemaDir": "schema"
     },
     "eslintIgnore": [
         "node_modules",

schema/manager.json

@@ -0,0 +1,14 @@
+{
+  "title": "Secrets manager",
+  "description": "The secrets manager settings",
+  "type": "object",
+  "properties": {
+    "ShowSecretFields": {
+      "type": "boolean",
+      "title": "Show secret fields",
+      "description": "Whether to show the secret fields in the UI or not",
+      "default": false
+    }
+  },
+  "additionalProperties": false
+}

src/index.ts

@@ -2,9 +2,12 @@ import {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
 } from '@jupyterlab/application';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
+
 import { SecretsManager } from './manager';
 import { ISecretsManager } from './token';
 import { InMemoryConnector } from './connectors';
+import { PageConfig } from '@jupyterlab/coreutils';
 
 /**
  * A basic secret connector extension, that should be disabled to provide a new
@@ -23,18 +26,58 @@ const inMemoryConnector: JupyterFrontEndPlugin<void> = {
 /**
  * The secret manager extension.
  */
-const manager: JupyterFrontEndPlugin<ISecretsManager> = {
+const managerPlugin: JupyterFrontEndPlugin<ISecretsManager> = {
   id: 'jupyter-secrets-manager:manager',
   description: 'A JupyterLab extension to manage secrets.',
   autoStart: true,
   provides: ISecretsManager,
-  activate: (app: JupyterFrontEnd): ISecretsManager => {
-    console.log('JupyterLab extension jupyter-secrets-manager is activated!');
-    return new SecretsManager();
+  optional: [ISettingRegistry],
+  activate: (
+    app: JupyterFrontEnd,
+    settingRegistry: ISettingRegistry
+  ): ISecretsManager => {
+    // Check if the fields are hidden from page config.
+    let showSecretFieldsConfig = true;
+    if (PageConfig.getOption('secretsManager-showFields') === 'false') {
+      showSecretFieldsConfig = false;
+    }
+
+    const manager = new SecretsManager({
+      showSecretFields: showSecretFieldsConfig
+    });
+
+    settingRegistry
+      .load(managerPlugin.id)
+      .then(settings => {
+        // If the fields are hidden from the manager, remove the setting.
+        if (!showSecretFieldsConfig) {
+          delete settings.schema.properties?.['ShowSecretFields'];
+          return;
+        }
+
+        // Otherwise listen to it to update the field visibility.
+        const updateFieldVisibility = () => {
+          const showSecretField =
+            settings.get('ShowSecretFields').composite ?? false;
+          manager.secretFieldsVisibility = showSecretField as boolean;
+        };
+
+        settings.changed.connect(() => updateFieldVisibility());
+        updateFieldVisibility();
+      })
+      .catch(reason => {
+        console.error(
+          `Failed to load settings for ${managerPlugin.id}`,
+          reason
+        );
+      });
+
+    console.debug('JupyterLab extension jupyter-secrets-manager is activated!');
+    return manager;
   }
 };
 
 export * from './connectors';
 export * from './manager';
 export * from './token';
-export default [inMemoryConnector, manager];
+export default [inMemoryConnector, managerPlugin];

src/manager.ts

@@ -8,17 +8,29 @@ import {
   ISecretsList,
   ISecretsManager
 } from './token';
+import { ISignal, Signal } from '@lumino/signaling';
+
+interface IOptions {
+  showSecretFields?: boolean;
+}
 
 /**
  * The default secrets manager.
  */
 export class SecretsManager implements ISecretsManager {
   /**
-   * the secrets manager constructor.
+   * The secrets manager constructor.
    */
-  constructor() {
+  constructor(options: IOptions) {
     this._storing = new PromiseDelegate<void>();
     this._storing.resolve();
+    Private.setSecretFieldsVisibility(options.showSecretFields ?? false);
+
+    // If the secret fields are hidden from constructor, this setting comes from
+    // PageConfig, we need to lock the fields visibility.
+    if (options.showSecretFields === false) {
+      Private.lockFieldsVisibility();
+    }
   }
 
   /**
@@ -33,14 +45,44 @@ export class SecretsManager implements ISecretsManager {
     this._ready.resolve();
   }
 
+  /**
+   * A promise that resolves when the connector is set.
+   */
   get ready(): Promise<void> {
     return this._ready.promise;
   }
 
+  /**
+   * A promise that locks the connector access during storage.
+   */
   protected get storing(): Promise<void> {
     return this._storing.promise;
   }
 
+  /**
+   * A signal emitting when the field visibility setting has changed.
+   */
+  get fieldVisibilityChanged(): ISignal<this, boolean> {
+    return this._fieldsVisibilityChanged;
+  }
+
+  /**
+   * Get the visibility of the secret fields.
+   */
+  get secretFieldsVisibility(): boolean {
+    return Private.getSecretFieldsVisibility();
+  }
+
+  /**
+   * Set the visibility of the secret fields.
+   * The visibility cannot be set if it is locked (from page config).
+   */
+  set secretFieldsVisibility(value: boolean) {
+    if (Private.setSecretFieldsVisibility(value)) {
+      this._fieldsVisibilityChanged.emit(Private.getSecretFieldsVisibility());
+    }
+  }
+
   /**
    * Get a secret given its namespace and ID.
    */
@@ -179,6 +221,7 @@ export class SecretsManager implements ISecretsManager {
 
   private _ready = new PromiseDelegate<void>();
   private _storing: PromiseDelegate<void>;
+  private _fieldsVisibilityChanged = new Signal<this, boolean>(this);
 }
 
 /**
@@ -293,7 +336,7 @@ namespace Private {
   }
 
   /**
-   * Actually fetch the secret from the connector.
+   * Fetch the secret from the connector.
    */
   export async function get(id: string): Promise<ISecret | undefined> {
     if (!connector?.fetch) {
@@ -303,7 +346,7 @@ namespace Private {
   }
 
   /**
-   * Actually list the secret from the connector.
+   * List the secret from the connector.
    */
   export async function list(
     namespace: string
@@ -314,7 +357,7 @@ namespace Private {
     return connector.list(namespace);
   }
   /**
-   * Actually save the secret using the connector.
+   * Save the secret using the connector.
    */
   export async function set(id: string, secret: ISecret): Promise<any> {
     if (!connector?.save) {
@@ -324,7 +367,7 @@ namespace Private {
   }
 
   /**
-   * Actually remove the secrets using the connector.
+   * Remove the secrets using the connector.
    */
   export async function remove(id: string): Promise<void> {
     if (!connector?.remove) {
@@ -333,6 +376,32 @@ namespace Private {
     return connector.remove(id);
   }
 
+  /**
+   * Lock the fields visibility value.
+   */
+  let fieldsVisibilityLocked = false;
+  export function lockFieldsVisibility() {
+    fieldsVisibilityLocked = true;
+  }
+
+  /**
+   * Get/set the fields visibility.
+   */
+  let secretFieldsVisibility = false;
+  export function getSecretFieldsVisibility(): boolean {
+    return secretFieldsVisibility;
+  }
+  export function setSecretFieldsVisibility(value: boolean): boolean {
+    if (!fieldsVisibilityLocked && value !== secretFieldsVisibility) {
+      secretFieldsVisibility = value;
+      return true;
+    }
+    return false;
+  }
+
+  /**
+   * The secret path type.
+   */
   export type SecretPath = {
     namespace: string;
     id: string;

src/token.ts

@@ -1,6 +1,7 @@
 import { JupyterFrontEndPlugin } from '@jupyterlab/application';
 import { IDataConnector } from '@jupyterlab/statedb';
 import { Token } from '@lumino/coreutils';
+import { ISignal } from '@lumino/signaling';
 
 /**
  * The secret object interface.
@@ -36,6 +37,14 @@ export interface ISecretsManager {
    * This is to prevent misconfiguration of competing plugins or MITM attacks.
    */
   setConnector(value: ISecretsConnector): void;
+  /**
+   * A signal emitting when the field visibility setting has changed.
+   */
+  readonly fieldVisibilityChanged: ISignal<ISecretsManager, boolean>;
+  /**
+   * Get the visibility of the secret fields.
+   */
+  readonly secretFieldsVisibility: boolean;
   /**
    * Get a secret given its namespace and ID.
    */

yarn.lock

@@ -2495,7 +2495,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@jupyterlab/settingregistry@npm:^4.3.5":
+"@jupyterlab/settingregistry@npm:^4.0.0, @jupyterlab/settingregistry@npm:^4.3.5":
   version: 4.3.5
   resolution: "@jupyterlab/settingregistry@npm:4.3.5"
   dependencies:
@@ -2915,7 +2915,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@lumino/signaling@npm:^1.10.0 || ^2.0.0, @lumino/signaling@npm:^2.1.3":
+"@lumino/signaling@npm:^1.10.0 || ^2.0.0, @lumino/signaling@npm:^2.1.2, @lumino/signaling@npm:^2.1.3":
   version: 2.1.3
   resolution: "@lumino/signaling@npm:2.1.3"
   dependencies:
@@ -6802,10 +6802,12 @@ __metadata:
     "@jupyterlab/application": ^4.0.0
     "@jupyterlab/builder": ^4.0.0
     "@jupyterlab/coreutils": ^6.0.0
+    "@jupyterlab/settingregistry": ^4.0.0
     "@jupyterlab/statedb": ^4.0.0
     "@jupyterlab/testutils": ^4.0.0
     "@lumino/algorithm": ^2.0.0
     "@lumino/coreutils": ^2.1.2
+    "@lumino/signaling": ^2.1.2
     "@types/jest": ^29.2.0
     "@types/json-schema": ^7.0.11
     "@types/react": ^18.0.26