Use KernelSelection instead of KernelSpecInterpreter (microsoft#13416)

For #13406 Ensure we use the same type across most of the code. Still haven't renamed kernelSelection to KernelConnectionMetadata (that is a separate PR)

Author: DonJayamanne

src/client/common/application/commands.ts

@@ -6,7 +6,7 @@
 import { CancellationToken, Position, TextDocument, Uri } from 'vscode';
 import { Commands as LSCommands } from '../../activation/commands';
 import { Commands as DSCommands } from '../../datascience/constants';
-import { KernelSpecInterpreter } from '../../datascience/jupyter/kernels/kernelSelector';
+import { KernelConnectionMetadata } from '../../datascience/jupyter/kernels/types';
 import { INotebookModel, ISwitchKernelOptions } from '../../datascience/types';
 import { CommandSource } from '../../testing/common/constants';
 import { TestFunction, TestsToRun } from '../../testing/common/types';
@@ -192,7 +192,7 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu
  [DSCommands.ExportToHTML]: [INotebookModel, string | undefined];
  [DSCommands.ExportToPDF]: [INotebookModel, string | undefined];
  [DSCommands.Export]: [Uri | INotebookModel, string | undefined];
- [DSCommands.SetJupyterKernel]: [KernelSpecInterpreter, Uri, undefined | Uri];
+ [DSCommands.SetJupyterKernel]: [KernelConnectionMetadata, Uri, undefined | Uri];
  [DSCommands.SwitchJupyterKernel]: [ISwitchKernelOptions | undefined];
  [DSCommands.SelectJupyterCommandLine]: [undefined | Uri];
  [DSCommands.SaveNotebookNonCustomEditor]: [Uri];

src/client/common/utils/localize.ts

@@ -932,7 +932,7 @@ export namespace DataScience {
  '# Gathered Notebook\nGathered from ```{0}```\n\n| | |\n|---|---|\n|  &nbsp|This notebook was generated by the Gather Extension. It requires version 2020.7.94776 (or newer) of the Python Extension, please update [here](https://command:python.datascience.latestExtension). The intent is that it contains only the code and cells required to produce the same results as the cell originally selected for gathering. Please note that the Python analysis is quite conservative, so if it is unsure whether a line of code is necessary for execution, it will err on the side of including it.|\n\n**Are you satisfied with the code that was gathered?**\n\n[Yes](https://command:python.datascience.gatherquality?yes) [No](https://command:python.datascience.gatherquality?no)'
  );
  export const savePngTitle = localize('DataScience.savePngTitle', 'Save Image');
- export const fallbackToUseActiveInterpeterAsKernel = localize(
+ export const fallbackToUseActiveInterpreterAsKernel = localize(
  'DataScience.fallbackToUseActiveInterpeterAsKernel',
  "Couldn't find kernel '{0}' that the notebook was created with. Using the current interpreter."
  );

src/client/datascience/commands/notebookCommands.ts

@@ -8,8 +8,10 @@ import { Uri } from 'vscode';
 import { ICommandManager } from '../../common/application/types';
 import { IDisposable } from '../../common/types';
 import { Commands } from '../constants';
-import { KernelSelector, KernelSpecInterpreter } from '../jupyter/kernels/kernelSelector';
+import { kernelConnectionMetadataHasKernelModel } from '../jupyter/kernels/helpers';
+import { KernelSelector } from '../jupyter/kernels/kernelSelector';
 import { KernelSwitcher } from '../jupyter/kernels/kernelSwitcher';
+import { KernelConnectionMetadata } from '../jupyter/kernels/types';
 import { IInteractiveWindowProvider, INotebookEditorProvider, INotebookProvider, ISwitchKernelOptions } from '../types';
 
 @injectable()
@@ -69,9 +71,9 @@ export class NotebookCommands implements IDisposable {
  }
  }
 
- private async setKernel(kernel: KernelSpecInterpreter, identity: Uri, resource: Uri | undefined) {
- const specOrModel = kernel?.kernelModel || kernel?.kernelSpec;
- if (kernel && specOrModel) {
+ private async setKernel(kernel: KernelConnectionMetadata, identity: Uri, resource: Uri | undefined) {
+ const specOrModel = kernelConnectionMetadataHasKernelModel(kernel) ? kernel.kernelModel : kernel.kernelSpec;
+ if (specOrModel) {
  const notebook = await this.notebookProvider.getOrCreateNotebook({
  resource,
  identity,

src/client/datascience/interactive-common/interactiveBase.ts

@@ -70,9 +70,13 @@ import {
  VariableExplorerStateKeys
 } from '../interactive-common/interactiveWindowTypes';
 import { JupyterInvalidKernelError } from '../jupyter/jupyterInvalidKernelError';
+import {
+ kernelConnectionMetadataHasKernelModel,
+ kernelConnectionMetadataHasKernelSpec
+} from '../jupyter/kernels/helpers';
 import { JupyterKernelPromiseFailedError } from '../jupyter/kernels/jupyterKernelPromiseFailedError';
-import { KernelSelector, KernelSpecInterpreter } from '../jupyter/kernels/kernelSelector';
-import { LiveKernelModel } from '../jupyter/kernels/types';
+import { KernelSelector } from '../jupyter/kernels/kernelSelector';
+import { KernelConnectionMetadata, LiveKernelModel } from '../jupyter/kernels/types';
 import { CssMessages, SharedMessages } from '../messages';
 import {
  CellState,
@@ -1144,7 +1148,7 @@ export abstract class InteractiveBase extends WebViewHost<IInteractiveWindowMapp
  serverConnection.type,
  e.kernelSpec
  );
- if (newKernel?.kernelSpec) {
+ if (newKernel && kernelConnectionMetadataHasKernelSpec(newKernel) && newKernel.kernelSpec) {
  this.commandManager.executeCommand(
  Commands.SetJupyterKernel,
  newKernel,
@@ -1224,15 +1228,20 @@ export abstract class InteractiveBase extends WebViewHost<IInteractiveWindowMapp
  this.postMessage(InteractiveWindowMessages.ForceVariableRefresh).ignoreErrors();
  }
 
- private async potentialKernelChanged(data: { identity: Uri; kernel: KernelSpecInterpreter }): Promise<void> {
- const specOrModel = data.kernel.kernelModel || data.kernel.kernelSpec;
+ private async potentialKernelChanged(data: { identity: Uri; kernel: KernelConnectionMetadata }): Promise<void> {
+ const specOrModel = kernelConnectionMetadataHasKernelModel(data.kernel)
+ ? data.kernel.kernelModel
+ : data.kernel.kernelSpec;
  if (!this._notebook && specOrModel && this.notebookIdentity.resource.toString() === data.identity.toString()) {
+ const kernelSpecLanguage = kernelConnectionMetadataHasKernelSpec(data.kernel)
+ ? data.kernel.kernelSpec?.language
+ : undefined;
  // No notebook, send update to UI anyway
  this.postMessage(InteractiveWindowMessages.UpdateKernel, {
  jupyterServerStatus: ServerStatus.NotStarted,
  localizedUri: '',
  displayName: specOrModel?.display_name || specOrModel?.name || '',
- language: translateKernelLanguageToMonaco(data.kernel.kernelSpec?.language ?? PYTHON_LANGUAGE)
+ language: translateKernelLanguageToMonaco(kernelSpecLanguage ?? PYTHON_LANGUAGE)
  }).ignoreErrors();
 
  // Update our model

src/client/datascience/interactive-common/notebookProvider.ts

@@ -11,7 +11,7 @@ import { traceWarning } from '../../common/logger';
 import { IDisposableRegistry, Resource } from '../../common/types';
 import { noop } from '../../common/utils/misc';
 import { Identifiers } from '../constants';
-import { KernelSpecInterpreter } from '../jupyter/kernels/kernelSelector';
+import { KernelConnectionMetadata } from '../jupyter/kernels/types';
 import {
  ConnectNotebookProviderOptions,
  GetNotebookOptions,
@@ -28,7 +28,7 @@ export class NotebookProvider implements INotebookProvider {
  private _notebookCreated = new EventEmitter<{ identity: Uri; notebook: INotebook }>();
  private readonly _onSessionStatusChanged = new EventEmitter<{ status: ServerStatus; notebook: INotebook }>();
  private _connectionMade = new EventEmitter<void>();
- private _potentialKernelChanged = new EventEmitter<{ identity: Uri; kernel: KernelSpecInterpreter }>();
+ private _potentialKernelChanged = new EventEmitter<{ identity: Uri; kernel: KernelConnectionMetadata }>();
  private _type: 'jupyter' | 'raw' = 'jupyter';
  public get activeNotebooks() {
  return [...this.notebooks.values()];
@@ -154,7 +154,7 @@ export class NotebookProvider implements INotebookProvider {
 
  // This method is here so that the kernel selector can pick a kernel and not have
  // to know about any of the UI that's active.
- public firePotentialKernelChanged(identity: Uri, kernel: KernelSpecInterpreter) {
+ public firePotentialKernelChanged(identity: Uri, kernel: KernelConnectionMetadata) {
  this._potentialKernelChanged.fire({ identity, kernel });
  }
 

src/client/datascience/jupyter/jupyterExecution.ts

@@ -36,7 +36,9 @@ import {
 import { JupyterSelfCertsError } from './jupyterSelfCertsError';
 import { createRemoteConnectionInfo, expandWorkingDir } from './jupyterUtils';
 import { JupyterWaitForIdleError } from './jupyterWaitForIdleError';
-import { KernelSelector, KernelSpecInterpreter } from './kernels/kernelSelector';
+import { kernelConnectionMetadataHasKernelSpec } from './kernels/helpers';
+import { KernelSelector } from './kernels/kernelSelector';
+import { KernelConnectionMetadata } from './kernels/types';
 import { NotebookStarter } from './notebookStarter';
 
 const LocalHosts = ['localhost', '127.0.0.1', '::1'];
@@ -141,8 +143,10 @@ export class JupyterExecutionBase implements IJupyterExecution {
  return Cancellation.race(async () => {
  let result: INotebookServer | undefined;
  let connection: IJupyterConnection | undefined;
- let kernelSpecInterpreter: KernelSpecInterpreter | undefined;
- let kernelSpecInterpreterPromise: Promise<KernelSpecInterpreter> = Promise.resolve({});
+ let kernelConnectionMetadata: KernelConnectionMetadata | undefined;
+ let kernelConnectionMetadataPromise: Promise<KernelConnectionMetadata | undefined> = Promise.resolve<
+ KernelConnectionMetadata | undefined
+ >(undefined);
  traceInfo(`Connecting to ${options ? options.purpose : 'unknown type of'} server`);
  const allowUI = !options || options.allowUI();
  const kernelSpecCancelSource = new CancellationTokenSource();
@@ -157,7 +161,7 @@ export class JupyterExecutionBase implements IJupyterExecution {
  // Get hold of the kernelspec and corresponding (matching) interpreter that'll be used as the spec.
  // We can do this in parallel, while starting the server (faster).
  traceInfo(`Getting kernel specs for ${options ? options.purpose : 'unknown type of'} server`);
- kernelSpecInterpreterPromise = this.kernelSelector.getKernelForLocalConnection(
+ kernelConnectionMetadataPromise = this.kernelSelector.getKernelForLocalConnection(
  undefined,
  'jupyter',
  undefined,
@@ -174,9 +178,9 @@ export class JupyterExecutionBase implements IJupyterExecution {
  while (tryCount <= maxTries && !this.disposed) {
  try {
  // Start or connect to the process
- [connection, kernelSpecInterpreter] = await Promise.all([
+ [connection, kernelConnectionMetadata] = await Promise.all([
  this.startOrConnect(options, cancelToken),
- kernelSpecInterpreterPromise
+ kernelConnectionMetadataPromise
  ]);
 
  if (!connection.localLaunch && LocalHosts.includes(connection.hostName.toLowerCase())) {
@@ -186,12 +190,17 @@ export class JupyterExecutionBase implements IJupyterExecution {
  result = this.serviceContainer.get<INotebookServer>(INotebookServer);
 
  // In a remote non quest situation, figure out a kernel spec too.
- if (!kernelSpecInterpreter.kernelSpec && connection && !options?.skipSearchingForKernel) {
+ if (
+ (!kernelConnectionMetadata ||
+ !kernelConnectionMetadataHasKernelSpec(kernelConnectionMetadata)) &&
+ connection &&
+ !options?.skipSearchingForKernel
+ ) {
  const sessionManagerFactory = this.serviceContainer.get<IJupyterSessionManagerFactory>(
  IJupyterSessionManagerFactory
  );
  const sessionManager = await sessionManagerFactory.create(connection);
- kernelSpecInterpreter = await this.kernelSelector.getKernelForRemoteConnection(
+ kernelConnectionMetadata = await this.kernelSelector.getKernelForRemoteConnection(
  undefined,
  sessionManager,
  options?.metadata,
@@ -200,16 +209,14 @@ export class JupyterExecutionBase implements IJupyterExecution {
  await sessionManager.dispose();
  }
 
- // If no kernel and not going to pick one, exit early
- if (!Object.keys(kernelSpecInterpreter) && !allowUI) {
- return undefined;
- }
-
  // Populate the launch info that we are starting our server with
  const launchInfo: INotebookServerLaunchInfo = {
  connectionInfo: connection!,
- interpreter: kernelSpecInterpreter.interpreter,
- kernelSpec: kernelSpecInterpreter.kernelSpec,
+ interpreter: kernelConnectionMetadata?.interpreter,
+ kernelSpec:
+ kernelConnectionMetadata && kernelConnectionMetadataHasKernelSpec(kernelConnectionMetadata)
+ ? kernelConnectionMetadata?.kernelSpec
+ : kernelConnectionMetadata?.kernelModel,
  workingDir: options ? options.workingDir : undefined,
  uri: options ? options.uri : undefined,
  purpose: options ? options.purpose : uuid()
@@ -252,10 +259,9 @@ export class JupyterExecutionBase implements IJupyterExecution {
  cancelToken,
  launchInfo.kernelSpec?.display_name || launchInfo.kernelSpec?.name
  );
- if (Object.keys(kernelInterpreter).length > 0) {
+ if (kernelInterpreter) {
  launchInfo.interpreter = kernelInterpreter.interpreter;
- launchInfo.kernelSpec =
- kernelInterpreter.kernelSpec || kernelInterpreter.kernelModel;
+ launchInfo.kernelSpec = kernelInterpreter?.kernelSpec;
  continue;
  }
  }

src/client/datascience/jupyter/kernels/helpers.ts

@@ -10,6 +10,13 @@ const NamedRegexp = require('named-js-regexp') as typeof import('named-js-regexp
 
 // tslint:disable-next-line: no-require-imports
 import cloneDeep = require('lodash/cloneDeep');
+import {
+ DefaultKernelConnectionMetadata,
+ KernelConnectionMetadata,
+ KernelSpecConnectionMetadata,
+ LiveKernelConnectionMetadata,
+ PythonKernelConnectionMetadata
+} from './types';
 
 // Helper functions for dealing with kernels and kernelspecs
 
@@ -23,6 +30,20 @@ export function findIndexOfConnectionFile(kernelSpec: Readonly<IJupyterKernelSpe
  return kernelSpec.argv.indexOf(connectionFilePlaceholder);
 }
 
+type ConnectionWithKernelSpec =
+ | KernelSpecConnectionMetadata
+ | PythonKernelConnectionMetadata
+ | DefaultKernelConnectionMetadata;
+export function kernelConnectionMetadataHasKernelSpec(
+ connectionMetadata: KernelConnectionMetadata
+): connectionMetadata is ConnectionWithKernelSpec {
+ return connectionMetadata.kind !== 'connectToLiveKernel';
+}
+export function kernelConnectionMetadataHasKernelModel(
+ connectionMetadata: KernelConnectionMetadata
+): connectionMetadata is LiveKernelConnectionMetadata {
+ return connectionMetadata.kind === 'connectToLiveKernel';
+}
 // Create a default kernelspec with the given display name
 export function createDefaultKernelSpec(displayName?: string): IJupyterKernelSpec {
  // This creates a default kernel spec. When launched, 'python' argument will map to using the interpreter

src/client/datascience/jupyter/kernels/kernel.ts

@@ -36,8 +36,15 @@ import {
  InterruptResult,
  KernelSocketInformation
 } from '../../types';
+import { kernelConnectionMetadataHasKernelModel } from './helpers';
 import { KernelExecution } from './kernelExecution';
-import type { IKernel, IKernelProvider, IKernelSelectionUsage, KernelSelection, LiveKernelModel } from './types';
+import type {
+ IKernel,
+ IKernelProvider,
+ IKernelSelectionUsage,
+ KernelConnectionMetadata,
+ LiveKernelModel
+} from './types';
 
 export class Kernel implements IKernel {
  get connection(): INotebookProviderConnection | undefined {
@@ -47,7 +54,9 @@ export class Kernel implements IKernel {
  if (this.notebook) {
  return this.notebook.getKernelSpec();
  }
- return this.metadata.kernelSpec || this.metadata.kernelModel;
+ return kernelConnectionMetadataHasKernelModel(this.metadata)
+ ? this.metadata.kernelModel
+ : this.metadata.kernelSpec;
  }
  get onStatusChanged(): Event<ServerStatus> {
  return this._onStatusChanged.event;
@@ -81,7 +90,7 @@ export class Kernel implements IKernel {
  private startCancellation = new CancellationTokenSource();
  constructor(
  public readonly uri: Uri,
- public readonly metadata: Readonly<KernelSelection>,
+ public readonly metadata: Readonly<KernelConnectionMetadata>,
  private readonly notebookProvider: INotebookProvider,
  private readonly disposables: IDisposableRegistry,
  private readonly launchTimeout: number,
@@ -143,10 +152,12 @@ export class Kernel implements IKernel {
  } else {
  await this.validate(this.uri);
  const metadata = ((getDefaultNotebookContent().metadata || {}) as unknown) as nbformat.INotebookMetadata;
+ // tslint:disable-next-line: no-suspicious-comment
+ // TODO: Just pass the `this.metadata` into the func.
  updateNotebookMetadata(
  metadata,
  this.metadata.interpreter,
- this.metadata.kernelSpec || this.metadata.kernelModel
+ this.metadata.kind === 'connectToLiveKernel' ? this.metadata.kernelModel : this.metadata.kernelSpec
  );
 
  this._notebookPromise = this.notebookProvider.getOrCreateNotebook({

src/client/datascience/jupyter/kernels/kernelExecution.ts

@@ -156,7 +156,7 @@ export class KernelExecution implements IDisposable {
  interpreter: activeInterpreter!,
  kernelModel: undefined,
  kernelSpec: undefined,
- kind: 'pythonInterpreter'
+ kind: 'startUsingPythonInterpreter'
  },
  launchingFile: document.uri.fsPath
  });