Do not store passwords to server settings (#60)

* Update @jupyterlab/settingregistry dependency

* Avoid saving the passwords in settings

* update yarn.lock

* Use the secrets manager to restore the saved passwords in the provider registry

* Defer the loading of the provider if it is not yet in the registry

* Update secrets-manager dependency

Author: brichet

package.json

@@ -62,7 +62,7 @@
         "@jupyterlab/completer": "^4.4.0-alpha.0",
         "@jupyterlab/notebook": "^4.4.0-alpha.0",
         "@jupyterlab/rendermime": "^4.4.0-alpha.0",
-        "@jupyterlab/settingregistry": "^4.4.0-alpha.0",
+        "@jupyterlab/settingregistry": "^4.4.0-beta.1",
         "@jupyterlab/ui-components": "^4.4.0-alpha.0",
         "@langchain/anthropic": "^0.3.9",
         "@langchain/community": "^0.3.31",
@@ -77,7 +77,8 @@
         "@rjsf/core": "^4.2.0",
         "@rjsf/utils": "^5.18.4",
         "@rjsf/validator-ajv8": "^5.18.4",
-        "jupyter-secrets-manager": "^0.1.1",
+        "json5": "^2.2.3",
+        "jupyter-secrets-manager": "^0.2.0",
         "react": "^18.2.0",
         "react-dom": "^18.2.0"
     },
@@ -118,6 +119,9 @@
     "jupyterlab": {
         "extension": true,
         "outputDir": "jupyterlite_ai/labextension",
-        "schemaDir": "schema"
+        "schemaDir": "schema",
+        "disabledExtensions": [
+            "@jupyterlab/apputils-extension:settings-connector"
+        ]
     }
 }

pyproject.toml

@@ -29,9 +29,9 @@ dynamic = ["version", "description", "authors", "urls", "keywords"]
 
 [project.optional-dependencies]
 jupyter = [
-    "jupyterlab>=4.4.0a0",
+    "jupyterlab>=4.4.0b1",
     "jupyterlite>=0.6.0a0",
-    "notebook>=7.4.0a0"
+    "notebook>=7.4.0b1"
 ]
 
 [tool.hatch.version]

src/completion-provider.ts

@@ -51,7 +51,14 @@ export class CompletionProvider implements IInlineCompletionProvider {
 
 export namespace CompletionProvider {
   export interface IOptions {
+    /**
+     * The registry where the completion provider belongs.
+     */
     providerRegistry: IAIProviderRegistry;
+    /**
+     * The request completion commands, can be useful if a provider needs to request
+     * the completion by itself.
+     */
     requestCompletion: () => void;
   }
 }

src/index.ts

@@ -14,7 +14,10 @@ import { ReactWidget, IThemeManager } from '@jupyterlab/apputils';
 import { ICompletionProviderManager } from '@jupyterlab/completer';
 import { INotebookTracker } from '@jupyterlab/notebook';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
-import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import {
+  ISettingConnector,
+  ISettingRegistry
+} from '@jupyterlab/settingregistry';
 import { IFormRendererRegistry } from '@jupyterlab/ui-components';
 import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
 import { ISecretsManager } from 'jupyter-secrets-manager';
@@ -23,7 +26,7 @@ import { ChatHandler } from './chat-handler';
 import { CompletionProvider } from './completion-provider';
 import { defaultProviderPlugins } from './default-providers';
 import { AIProviderRegistry } from './provider';
-import { aiSettingsRenderer } from './settings/panel';
+import { aiSettingsRenderer, SettingConnector } from './settings';
 import { IAIProviderRegistry } from './tokens';
 
 const chatCommandRegistryPlugin: JupyterFrontEndPlugin<IChatCommandRegistry> = {
@@ -138,21 +141,28 @@ const providerRegistryPlugin: JupyterFrontEndPlugin<IAIProviderRegistry> = {
   id: '@jupyterlite/ai:provider-registry',
   autoStart: true,
   requires: [IFormRendererRegistry, ISettingRegistry],
-  optional: [IRenderMimeRegistry, ISecretsManager],
+  optional: [IRenderMimeRegistry, ISecretsManager, ISettingConnector],
   provides: IAIProviderRegistry,
   activate: (
     app: JupyterFrontEnd,
     editorRegistry: IFormRendererRegistry,
     settingRegistry: ISettingRegistry,
     rmRegistry?: IRenderMimeRegistry,
-    secretsManager?: ISecretsManager
+    secretsManager?: ISecretsManager,
+    settingConnector?: ISettingConnector
   ): IAIProviderRegistry => {
-    const providerRegistry = new AIProviderRegistry();
+    const providerRegistry = new AIProviderRegistry({ secretsManager });
 
     editorRegistry.addRenderer(
       '@jupyterlite/ai:provider-registry.AIprovider',
-      aiSettingsRenderer({ providerRegistry, rmRegistry, secretsManager })
+      aiSettingsRenderer({
+        providerRegistry,
+        rmRegistry,
+        secretsManager,
+        settingConnector
+      })
     );
+
     settingRegistry
       .load(providerRegistryPlugin.id)
       .then(settings => {
@@ -161,10 +171,10 @@ const providerRegistryPlugin: JupyterFrontEndPlugin<IAIProviderRegistry> = {
           const providerSettings = (settings.get('AIprovider').composite ?? {
             provider: 'None'
           }) as ReadonlyPartialJSONObject;
-          providerRegistry.setProvider(
-            providerSettings.provider as string,
-            providerSettings
-          );
+          providerRegistry.setProvider({
+            name: providerSettings.provider as string,
+            settings: providerSettings
+          });
         };
 
         settings.changed.connect(() => updateProvider());
@@ -181,10 +191,25 @@ const providerRegistryPlugin: JupyterFrontEndPlugin<IAIProviderRegistry> = {
   }
 };
 
+/**
+ * Provides the settings connector as a separate plugin to allow for alternative
+ * implementations that may want to fetch settings from a different source or
+ * endpoint.
+ */
+const settingsConnector: JupyterFrontEndPlugin<ISettingConnector> = {
+  id: '@jupyterlite/ai:settings-connector',
+  description: 'Provides a settings connector which does not save passwords.',
+  autoStart: true,
+  provides: ISettingConnector,
+  activate: (app: JupyterFrontEnd) =>
+    new SettingConnector(app.serviceManager.settings)
+};
+
 export default [
   providerRegistryPlugin,
   chatCommandRegistryPlugin,
   chatPlugin,
   completerPlugin,
+  settingsConnector,
   ...defaultProviderPlugins
 ];

src/provider.ts

@@ -1,12 +1,22 @@
-import { ICompletionProviderManager } from '@jupyterlab/completer';
 import { BaseLanguageModel } from '@langchain/core/language_models/base';
 import { BaseChatModel } from '@langchain/core/language_models/chat_models';
 import { ISignal, Signal } from '@lumino/signaling';
 import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
+import { JSONSchema7 } from 'json-schema';
+import { ISecretsManager } from 'jupyter-secrets-manager';
 
 import { IBaseCompleter } from './base-completer';
-import { IAIProvider, IAIProviderRegistry } from './tokens';
-import { JSONSchema7 } from 'json-schema';
+import {
+  getSecretId,
+  SECRETS_NAMESPACE,
+  SECRETS_REPLACEMENT
+} from './settings';
+import {
+  IAIProvider,
+  IAIProviderRegistry,
+  IDict,
+  ISetProviderOptions
+} from './tokens';
 
 export const chatSystemPrompt = (
   options: AIProviderRegistry.IPromptOptions
@@ -39,6 +49,13 @@ Do not include the prompt in the output, only the string that should be appended
 `;
 
 export class AIProviderRegistry implements IAIProviderRegistry {
+  /**
+   * The constructor of the provider registry.
+   */
+  constructor(options: AIProviderRegistry.IOptions) {
+    this._secretsManager = options.secretsManager || null;
+  }
+
   /**
    * Get the list of provider names.
    */
@@ -56,6 +73,11 @@ export class AIProviderRegistry implements IAIProviderRegistry {
       );
     }
     this._providers.set(provider.name, provider);
+
+    // Set the provider if the loading has been deferred.
+    if (provider.name === this._deferredProvider?.name) {
+      this.setProvider(this._deferredProvider);
+    }
   }
 
   /**
@@ -131,15 +153,36 @@ export class AIProviderRegistry implements IAIProviderRegistry {
    * Set the providers (chat model and completer).
    * Creates the providers if the name has changed, otherwise only updates their config.
    *
-   * @param name - the name of the provider to use.
-   * @param settings - the settings for the models.
+   * @param options - An object with the name and the settings of the provider to use.
    */
-  setProvider(name: string, settings: ReadonlyPartialJSONObject): void {
+  async setProvider(options: ISetProviderOptions): Promise<void> {
+    const { name, settings } = options;
     this._currentProvider = this._providers.get(name) ?? null;
+    if (this._currentProvider === null) {
+      // The current provider may not be loaded when the settings are first loaded.
+      // Let's defer the provider loading.
+      this._deferredProvider = options;
+    } else {
+      this._deferredProvider = null;
+    }
+
+    // Build a new settings object containing the secrets.
+    const fullSettings: IDict = {};
+    for (const key of Object.keys(settings)) {
+      if (settings[key] === SECRETS_REPLACEMENT) {
+        const id = getSecretId(name, key);
+        const secrets = await this._secretsManager?.get(SECRETS_NAMESPACE, id);
+        fullSettings[key] = secrets?.value || settings[key];
+        continue;
+      }
+      fullSettings[key] = settings[key];
+    }
 
     if (this._currentProvider?.completer !== undefined) {
       try {
-        this._completer = new this._currentProvider.completer({ ...settings });
+        this._completer = new this._currentProvider.completer({
+          ...fullSettings
+        });
         this._completerError = '';
       } catch (e: any) {
         this._completerError = e.message;
@@ -150,7 +193,9 @@ export class AIProviderRegistry implements IAIProviderRegistry {
 
     if (this._currentProvider?.chatModel !== undefined) {
       try {
-        this._chatModel = new this._currentProvider.chatModel({ ...settings });
+        this._chatModel = new this._currentProvider.chatModel({
+          ...fullSettings
+        });
         this._chatError = '';
       } catch (e: any) {
         this._chatError = e.message;
@@ -170,6 +215,7 @@ export class AIProviderRegistry implements IAIProviderRegistry {
     return this._providerChanged;
   }
 
+  private _secretsManager: ISecretsManager | null;
   private _currentProvider: IAIProvider | null = null;
   private _completer: IBaseCompleter | null = null;
   private _chatModel: BaseChatModel | null = null;
@@ -178,6 +224,7 @@ export class AIProviderRegistry implements IAIProviderRegistry {
   private _chatError: string = '';
   private _completerError: string = '';
   private _providers = new Map<string, IAIProvider>();
+  private _deferredProvider: ISetProviderOptions | null = null;
 }
 
 export namespace AIProviderRegistry {
@@ -186,13 +233,9 @@ export namespace AIProviderRegistry {
    */
   export interface IOptions {
     /**
-     * The completion provider manager in which register the LLM completer.
-     */
-    completionProviderManager: ICompletionProviderManager;
-    /**
-     * The application commands registry.
+     * The secrets manager used in the application.
      */
-    requestCompletion: () => void;
+    secretsManager?: ISecretsManager;
   }
 
   /**

src/settings/index.ts

@@ -0,0 +1,3 @@
+export * from './panel';
+export * from './settings-connector';
+export * from './utils';

src/settings/panel.tsx

@@ -1,5 +1,8 @@
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
-import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import {
+  ISettingConnector,
+  ISettingRegistry
+} from '@jupyterlab/settingregistry';
 import { FormComponent, IFormRenderer } from '@jupyterlab/ui-components';
 import { ArrayExt } from '@lumino/algorithm';
 import { JSONExt } from '@lumino/coreutils';
@@ -10,10 +13,10 @@ import { JSONSchema7 } from 'json-schema';
 import { ISecretsManager } from 'jupyter-secrets-manager';
 import React from 'react';
 
+import { getSecretId, SECRETS_NAMESPACE, SettingConnector } from '.';
 import baseSettings from './base.json';
 import { IAIProviderRegistry, IDict } from '../tokens';
 
-const SECRETS_NAMESPACE = '@jupyterlite/ai';
 const MD_MIME_TYPE = 'text/markdown';
 const STORAGE_NAME = '@jupyterlite/ai:settings';
 const INSTRUCTION_CLASS = 'jp-AISettingsInstructions';
@@ -22,6 +25,7 @@ export const aiSettingsRenderer = (options: {
   providerRegistry: IAIProviderRegistry;
   rmRegistry?: IRenderMimeRegistry;
   secretsManager?: ISecretsManager;
+  settingConnector?: ISettingConnector;
 }): IFormRenderer => {
   return {
     fieldRenderer: (props: FieldProps) => {
@@ -54,6 +58,7 @@ export class AiSettings extends React.Component<
     this._providerRegistry = props.formContext.providerRegistry;
     this._rmRegistry = props.formContext.rmRegistry ?? null;
     this._secretsManager = props.formContext.secretsManager ?? null;
+    this._settingConnector = props.formContext.settingConnector ?? null;
     this._settings = props.formContext.settings;
 
     this._useSecretsManager =
@@ -130,7 +135,7 @@ export class AiSettings extends React.Component<
       if (inputs[i].type.toLowerCase() === 'password') {
         const label = inputs[i].getAttribute('label');
         if (label) {
-          const id = `${this._provider}-${label}`;
+          const id = getSecretId(this._provider, label);
           this._secretsManager.attach(
             SECRETS_NAMESPACE,
             id,
@@ -141,6 +146,9 @@ export class AiSettings extends React.Component<
         }
       }
     }
+    if (this._settingConnector instanceof SettingConnector) {
+      this._settingConnector.doNotSave = this._unsavedFields;
+    }
   }
 
   /**
@@ -187,6 +195,9 @@ export class AiSettings extends React.Component<
       this._secretsManager?.detachAll(SECRETS_NAMESPACE);
       this._formInputs = [];
       this._unsavedFields = [];
+      if (this._settingConnector instanceof SettingConnector) {
+        this._settingConnector.doNotSave = [];
+      }
       this.saveSettings(this._currentSettings);
     } else {
       // Remove all the keys stored locally and attach the password inputs to the
@@ -202,6 +213,9 @@ export class AiSettings extends React.Component<
       localStorage.setItem(STORAGE_NAME, JSON.stringify(settings));
       this.componentDidUpdate();
     }
+    this._settings
+      .set('AIprovider', { provider: this._provider, ...this._currentSettings })
+      .catch(console.error);
   };
 
   /**
@@ -337,6 +351,7 @@ export class AiSettings extends React.Component<
   private _useSecretsManager: boolean;
   private _rmRegistry: IRenderMimeRegistry | null;
   private _secretsManager: ISecretsManager | null;
+  private _settingConnector: ISettingConnector | null;
   private _currentSettings: IDict<any> = { provider: 'None' };
   private _uiSchema: IDict<any> = {};
   private _settings: ISettingRegistry.ISettings;