Remove hardcoding of position of connection file in kernelspec… (#11299)

* Remove hardcoding of position of connection file
* Use correct name for connection files
* Use same types

Author: DonJayamanne

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

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 'use strict';
 import type { Kernel } from '@jupyterlab/services';
+import type { JSONObject } from '@phosphor/coreutils';
 import * as path from 'path';
 import { CancellationToken } from 'vscode';
 import { createPromiseFromCancellation } from '../../../common/cancellation';
@@ -17,6 +18,8 @@ export class JupyterKernelSpec implements IJupyterKernelSpec {
     public specFile: string | undefined;
     public display_name: string;
     public argv: string[];
+    public readonly env?: JSONObject;
+
     // tslint:disable-next-line: no-any
     public metadata?: Record<string, any> & { interpreter?: Partial<PythonInterpreter> };
     constructor(specModel: Kernel.ISpecModel, file?: string) {
@@ -27,6 +30,8 @@ export class JupyterKernelSpec implements IJupyterKernelSpec {
         this.specFile = file;
         this.display_name = specModel.display_name;
         this.metadata = specModel.metadata;
+        // tslint:disable-next-line: no-any
+        this.env = specModel.env as any;
     }
 }
 

src/client/datascience/kernel-launcher/kernelFinder.ts

@@ -20,6 +20,13 @@ const kernelPaths = new Map([
     ['kernel', path.join('share', 'jupyter', 'kernels')]
 ]);
 
+// https://jupyter-client.readthedocs.io/en/stable/kernels.html
+const connectionFilePlaceholder = '{connection_file}';
+
+export function findIndexOfConnectionFile(kernelSpec: Readonly<IJupyterKernelSpec>): number {
+    return kernelSpec.argv.indexOf(connectionFilePlaceholder);
+}
+
 // This class searches for a kernel that matches the given kernel name.
 // First it seraches on a global persistent state, then on the installed python interpreters,
 // and finally on the default locations that jupyter installs kernels on.
@@ -212,7 +219,13 @@ export class KernelFinder implements IKernelFinder {
             path: this.activeInterpreter?.path!,
             display_name: this.activeInterpreter?.displayName ? this.activeInterpreter.displayName : 'Python 3',
             metadata: {},
-            argv: [this.activeInterpreter?.path || 'python', '-m', 'ipykernel_launcher', '-f', '<connection_file>']
+            argv: [
+                this.activeInterpreter?.path || 'python',
+                '-m',
+                'ipykernel_launcher',
+                '-f',
+                connectionFilePlaceholder
+            ]
         };
 
         this.cache.push(defaultSpec);

src/client/datascience/kernel-launcher/kernelLauncher.ts

@@ -16,6 +16,7 @@ import { createDeferred, Deferred } from '../../common/utils/async';
 import * as localize from '../../common/utils/localize';
 import { noop } from '../../common/utils/misc';
 import { IJupyterKernelSpec } from '../types';
+import { findIndexOfConnectionFile } from './kernelFinder';
 import { IKernelConnection, IKernelFinder, IKernelLauncher, IKernelProcess } from './types';
 
 // Launches and disposes a kernel process given a kernelspec and a resource or python interpreter.
@@ -54,15 +55,18 @@ class KernelProcess implements IKernelProcess {
 
     public async launch(): Promise<void> {
         this.connectionFile = await this.file.createTemporaryFile('.json');
-
         const args = [...this._kernelSpec.argv];
         await this.file.writeFile(this.connectionFile.filePath, JSON.stringify(this._connection), {
             encoding: 'utf-8',
             flag: 'w'
         });
 
         // Inclide the conenction file in the arguments and remove the first argument which should be python
-        args[4] = this.connectionFile.filePath;
+        const indexOfConnectionFile = findIndexOfConnectionFile(this._kernelSpec);
+        if (indexOfConnectionFile === -1) {
+            throw new Error(`Connection file not found in kernelspec json args, ${args.join(' ')}`);
+        }
+        args[indexOfConnectionFile] = this.connectionFile.filePath;
         args.splice(0, 1);
 
         const executionService = await this.executionFactory.create({

src/client/datascience/types.ts

@@ -404,6 +404,10 @@ export interface IJupyterKernelSpec {
     // tslint:disable-next-line: no-any
     readonly metadata?: Record<string, any> & { interpreter?: Partial<PythonInterpreter> };
     readonly argv: string[];
+    /**
+     * A dictionary of environment variables to set for the kernel.
+     */
+    readonly env?: JSONObject;
 }
 
 export const INotebookImporter = Symbol('INotebookImporter');