Parameterized kernel specs

package.json

@@ -109,6 +109,8 @@
     "yjs": "^13.5.40"
   },
   "dependencies": {
+    "@jupyterlab/application": "workspace:^",
+    "@jupyterlab/apputils": "workspace:^",
     "@typescript-eslint/eslint-plugin": "~6.13.2",
     "@typescript-eslint/parser": "~6.13.2",
     "eslint": "~8.55.0",

packages/apputils/src/sessioncontext.tsx

@@ -1,7 +1,7 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
-import { IChangedArgs, PathExt } from '@jupyterlab/coreutils';
+import { IChangedArgs, PageConfig, PathExt } from '@jupyterlab/coreutils';
 import {
   Kernel,
   KernelMessage,
@@ -16,12 +16,20 @@
   TranslationBundle
 } from '@jupyterlab/translation';
 import { find } from '@lumino/algorithm';
-import { JSONExt, PromiseDelegate, UUID } from '@lumino/coreutils';
+import {
+  JSONExt,
+  PartialJSONObject,
+  PartialJSONValue,
+  PromiseDelegate,
+  UUID
+} from '@lumino/coreutils';
 import { IDisposable, IObservableDisposable } from '@lumino/disposable';
 import { ISignal, Signal } from '@lumino/signaling';
 import { Widget } from '@lumino/widgets';
 import * as React from 'react';
 import { Dialog, showDialog } from './dialog';
+import { DialogWidget } from '@jupyterlab/ui-components';
+import { IRenderMime } from '@jupyterlab/rendermime-interfaces';
 
 /**
  * A context object to manage a widget's kernel session connection.
@@ -297,6 +305,10 @@
      */
     readonly autoStartDefault?: boolean;
 
+    /**
+     * Kernel custom specs defined by kernel name
+     */
+    customKernelSpecs?: undefined | PartialJSONObject;
     /**
      * Skip showing the kernel restart dialog if checked (default `false`).
      */
@@ -694,7 +706,8 @@
    */
   async startKernel(): Promise<boolean> {
     const preference = this.kernelPreference;
-
+    const specs = this.specsManager.specs;
+    //
     if (!preference.autoStartDefault && preference.shouldStart === false) {
       return true;
     }
@@ -704,12 +717,19 @@
       options = { id: preference.id };
     } else {
       const name = Private.getDefaultKernel({
-        specs: this.specsManager.specs,
+        specs,
         sessions: this.sessionManager.running(),
         preference
       });
       if (name) {
-        options = { name };
+        if (preference.customKernelSpecs) {
+          options = {
+            name,
+            custom_kernel_specs: preference.customKernelSpecs
+          };
+        } else {
+          options = { name };
+        }
       }
     }
 
@@ -733,6 +753,7 @@
    */
   async restartKernel(): Promise<void> {
     const kernel = this.session?.kernel || null;
+
     if (this._isRestarting) {
       return;
     }
@@ -1407,19 +1428,37 @@
       return;
     }
 
-    if (hasCheckbox && result.isChecked !== null) {
-      sessionContext.kernelPreference = {
-        ...sessionContext.kernelPreference,
-        autoStartDefault: result.isChecked
+    const dialogResult = result.value as Kernel.IModel;
+
+    if (dialogResult) {
+      let model = {
+        name: dialogResult.name,
+        custom_kernel_specs: {}
       };
-    }
 
-    const model = result.value;
-    if (model === null && !sessionContext.hasNoKernel) {
-      return sessionContext.shutdown();
-    }
-    if (model) {
-      await sessionContext.changeKernel(model);
+      if (hasCheckbox && result.isChecked !== null) {
+        if (model && sessionContext.kernelPreference?.customKernelSpecs) {
+          sessionContext.kernelPreference.customKernelSpecs = undefined;
+        }
+
+        if (model && dialogResult.custom_kernel_specs) {
+          sessionContext.kernelPreference.customKernelSpecs =
+            dialogResult.custom_kernel_specs;
+          model['custom_kernel_specs'] = dialogResult.custom_kernel_specs;
+        }
+
+        sessionContext.kernelPreference = {
+          ...sessionContext.kernelPreference,
+          autoStartDefault: result.isChecked
+        };
+      }
+
+      if (model === null && !sessionContext.hasNoKernel) {
+        return sessionContext.shutdown();
+      }
+      if (model) {
+        await sessionContext.changeKernel(model);
+      }
     }
   }
 
@@ -1813,20 +1852,36 @@
     sessionContext: ISessionContext,
     translator?: ITranslator
   ) =>
-    new KernelSelector({
-      node: createSelectorNode(sessionContext, translator)
-    });
+    new KernelSelector(sessionContext, translator);
 
   /**
    * A widget that provides a kernel selection.
    */
-  class KernelSelector extends Widget {
+  export class KernelSelector extends Widget {
+    sessionContext: ISessionContext;
+    translator: ITranslator | undefined;
+    /**
+     * Create a new kernel selector widget.
+     */
+    constructor(sessionContext: ISessionContext, translator?: ITranslator) {
+      super({ node: createSelectorNode(sessionContext, translator) });
+      this.sessionContext = sessionContext;
+      this.translator = translator;
+    }
+
     /**
      * Get the value of the kernel selector widget.
      */
     getValue(): Kernel.IModel {
-      const selector = this.node.querySelector('select') as HTMLSelectElement;
-      return JSON.parse(selector.value) as Kernel.IModel;
+      const selector = this.node.querySelector(
+        'select#js-kernel-selector'
+      ) as HTMLSelectElement;
+      const selectorKernelSpecs = selector.getAttribute('data-kernel-spec');
+      let kernelData = JSON.parse(selector.value) as Kernel.IModel;
+      if (selectorKernelSpecs) {
+        kernelData['custom_kernel_specs'] = JSON.parse(selectorKernelSpecs);
+      }
+      return kernelData;
     }
   }
 
@@ -1842,11 +1897,24 @@
     const trans = translator.load('jupyterlab');
 
     const body = document.createElement('div');
+
+    const container = document.createElement('div');
+
+    const kernelSpecsContainer = document.createElement('div');
+
+    container.setAttribute('id', 'js-kernel-select-container');
+
+    kernelSpecsContainer.setAttribute(
+      'id',
+      'js-kernel-specs-select-container'
+    );
+
     const text = document.createElement('label');
     text.textContent = `${trans.__('Select kernel for:')} "${
       sessionContext.name
     }"`;
-    body.appendChild(text);
+
+    container.appendChild(text);
 
     const select = document.createElement('select');
     const options = SessionContextDialogs.kernelOptions(
@@ -1860,18 +1928,120 @@
       optgroup.label = label;
       for (const { selected, text, title, value } of options) {
         const option = document.createElement('option');
-        if (selected) option.selected = true;
+        if (selected) {
+          option.selected = true;
+          let val = JSON.parse(value);
+          let id = val && val.id ? val.id : '';
+          if (!id) {
+            select.setAttribute('data-kernel-spec', '');
+            checkCustomKernelSpecs(sessionContext, select, trans);
+          }
+        }
         if (title) option.title = title;
         option.text = text;
         option.value = value;
         optgroup.appendChild(option);
       }
       select.appendChild(optgroup);
     }
+    select.setAttribute('id', 'js-kernel-selector');
+    select.onchange = () => {
+      select.setAttribute('data-kernel-spec', '');
+      checkCustomKernelSpecs(sessionContext, select, trans);
+    };
+
     body.appendChild(select);
+    body.appendChild(kernelSpecsContainer);
     return body;
   }
 
+  function checkCustomKernelSpecs(
+    sessionContext: ISessionContext,
+    select: HTMLSelectElement,
+    trans: IRenderMime.TranslationBundle,
+    kernelSpeccSelectorContainer?: HTMLDivElement
+  ) {
+    let kernelConfiguration: PartialJSONObject = {};
+    let selectedKernel = JSON.parse(select.value) as Kernel.IModel;
+
+    let kernelSpecsContainer = document.querySelector(
+      '#js-kernel-specs-select-container'
+    ) as HTMLElement;
+
+    if (!kernelSpecsContainer && kernelSpeccSelectorContainer) {
+      kernelSpecsContainer = kernelSpeccSelectorContainer;
+    }
+
+    kernelSpecsContainer.innerHTML = '';
+    let kernelName =
+      selectedKernel && selectedKernel.name ? selectedKernel.name : '';
+    let kernel =
+      kernelName && sessionContext.specsManager.specs?.kernelspecs[kernelName];
+    const allowInsecureKernelspecParams =
+      PageConfig.getOption('allow_insecure_kernelspec_params') === 'true'
+        ? true
+        : false;
+    if (
+      (kernel &&
+        kernel?.metadata &&
+        kernel?.metadata?.is_secure &&
+        kernel?.metadata?.parameters) ||
+        allowInsecureKernelspecParams
+    ) {
+      if (kernel && kernel?.metadata && kernel?.metadata?.parameters) {
+        let kernelParameters = kernel?.metadata
+          ?.parameters as PartialJSONObject;
+
+        if (kernelParameters) {
+          if (sessionContext.kernelPreference?.customKernelSpecs) {
+            let customKernelSpecs = sessionContext.kernelPreference
+              ?.customKernelSpecs as PartialJSONObject;
+            for (let key in customKernelSpecs) {
+              let selectedValue = customKernelSpecs[key] as
+                | PartialJSONValue
+                | undefined;
+
+              if (kernelParameters.properties) {
+                let properties =
+                  kernelParameters.properties as PartialJSONObject;
+
+                let kernelParameter = properties[key] as PartialJSONObject;
+
+                if (kernelParameter) {
+                  let kernelParametersTmp = (
+                    kernelParameters.properties as PartialJSONObject
+                  )[key] as PartialJSONObject;
+                  (kernelParameters.properties as PartialJSONObject)[key] = {
+                    ...kernelParametersTmp,
+                    default: selectedValue
+                  };
+                }
+              }
+            }
+          }
+
+          let kernelSpecWidget = new DialogWidget(
+            kernelParameters,
+            kernelConfiguration,
+            formData => {
+              kernelConfiguration = formData as PartialJSONObject;
+              select.setAttribute(
+                'data-kernel-spec',
+                JSON.stringify(kernelConfiguration)
+              );
+            },
+            trans
+          );
+
+          //Update widget
+          if (kernelSpecsContainer) {
+            Widget.attach(kernelSpecWidget, kernelSpecsContainer);
+          }
+        }
+      }
+    }
+  }
+
   /**
    * Get the default kernel name given select options.
    */

packages/console-extension/package.json

@@ -53,7 +53,8 @@
     "@lumino/coreutils": "^2.1.2",
     "@lumino/disposable": "^2.1.2",
     "@lumino/properties": "^2.0.1",
-    "@lumino/widgets": "^2.3.2"
+    "@lumino/widgets": "^2.3.2",
+    "@rjsf/utils": "^5.13.4"
   },
   "devDependencies": {
     "rimraf": "~5.0.5",