fixed path that is saved in the cache (#11525)

changed the name of the cache file
catch exception if what is saved in cache is not a string
avoid search if the kernel name is the default

Author: David Kutugata

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

@@ -29,6 +29,8 @@ const kernelPaths = new Map([
     ['macJupyterPath', path.join('Library', 'Jupyter', 'kernels')],
     ['kernel', path.join('share', 'jupyter', 'kernels')]
 ]);
+const cacheFile = 'kernelSpecPathCache.json';
+const defaultSpecName = 'python_defaultSpec_';
 
 // https://jupyter-client.readthedocs.io/en/stable/kernels.html
 const connectionFilePlaceholder = '{connection_file}';
@@ -68,7 +70,7 @@ export class KernelFinder implements IKernelFinder {
         this.cache = await this.readCache();
         let foundKernel: IJupyterKernelSpec | undefined;
 
-        if (kernelName) {
+        if (kernelName && !kernelName.includes(defaultSpecName)) {
             let kernelSpec = await this.searchCache(kernelName);
 
             if (kernelSpec) {
@@ -192,8 +194,13 @@ export class KernelFinder implements IKernelFinder {
     private async getKernelSpecFromDisk(paths: string[], kernelName: string): Promise<IJupyterKernelSpec | undefined> {
         const promises = paths.map((kernelPath) => this.file.search('**/kernel.json', kernelPath));
         const searchResults = await Promise.all(promises);
-        searchResults.forEach((result) => {
-            this.cache.push(...result);
+        searchResults.forEach((result, i) => {
+            result.forEach((res) => {
+                const specPath = path.join(paths[i], res);
+                if (!this.cache.includes(specPath)) {
+                    this.cache.push(specPath);
+                }
+            });
         });
 
         return this.searchCache(kernelName);
@@ -207,7 +214,7 @@ export class KernelFinder implements IKernelFinder {
         // This creates a default kernel spec. When launched, 'python' argument will map to using the interpreter
         // associated with the current resource for launching.
         const defaultSpec: Kernel.ISpecModel = {
-            name: `python_defaultSpec_${Date.now()}`,
+            name: defaultSpecName + Date.now().toString(),
             language: 'python',
             display_name: this.activeInterpreter?.displayName ? this.activeInterpreter.displayName : 'Python 3',
             metadata: {},
@@ -221,7 +228,7 @@ export class KernelFinder implements IKernelFinder {
     private async readCache(): Promise<string[]> {
         try {
             return JSON.parse(
-                await this.file.readFile(path.join(this.context.globalStoragePath, 'kernelSpecCache.json'))
+                await this.file.readFile(path.join(this.context.globalStoragePath, cacheFile))
             ) as string[];
         } catch {
             traceInfo('No kernelSpec cache found.');
@@ -230,18 +237,24 @@ export class KernelFinder implements IKernelFinder {
     }
 
     private async writeCache(cache: string[]) {
-        await this.file.writeFile(
-            path.join(this.context.globalStoragePath, 'kernelSpecCache.json'),
-            JSON.stringify(cache)
-        );
+        await this.file.writeFile(path.join(this.context.globalStoragePath, cacheFile), JSON.stringify(cache));
     }
 
     private async searchCache(kernelName: string): Promise<IJupyterKernelSpec | undefined> {
-        const kernelJsonFile = this.cache.find((kernelPath) => path.basename(path.dirname(kernelPath)) === kernelName);
+        const kernelJsonFile = this.cache.find((kernelPath) => {
+            try {
+                return path.basename(path.dirname(kernelPath)) === kernelName;
+            } catch (e) {
+                traceInfo('KernelSpec path in cache is not a string.', e);
+                return false;
+            }
+        });
 
         if (kernelJsonFile) {
             const kernelJson = JSON.parse(await this.file.readFile(kernelJsonFile));
-            return new JupyterKernelSpec(kernelJson, kernelJsonFile);
+            const spec = new JupyterKernelSpec(kernelJson, kernelJsonFile);
+            spec.name = kernelName;
+            return spec;
         }
 
         return undefined;

src/test/datascience/kernelFinder.unit.test.ts

@@ -35,6 +35,7 @@ suite('Kernel Finder', () => {
     const interpreters: PythonInterpreter[] = [];
     let resource: Resource;
     const kernelName = 'testKernel';
+    const cacheFile = 'kernelSpecPathCache.json';
     const kernel: JupyterKernelSpec = {
         name: 'testKernel',
         language: 'python',
@@ -43,7 +44,7 @@ suite('Kernel Finder', () => {
         metadata: {},
         env: {},
         argv: ['<python path>', '-m', 'ipykernel_launcher', '-f', '{connection_file}'],
-        specFile: path.join('kernels', kernelName, 'kernel.json')
+        specFile: path.join('1', 'share', 'jupyter', 'kernels', kernelName, 'kernel.json')
     };
 
     function setupFileSystem() {
@@ -55,9 +56,9 @@ suite('Kernel Finder', () => {
             .setup((fs) => fs.search(typemoq.It.isAnyString(), typemoq.It.isAnyString()))
             .returns(() =>
                 Promise.resolve([
-                    path.join('kernels', kernel.name, 'kernel.json'),
-                    path.join('kernels', 'kernelA', 'kernel.json'),
-                    path.join('kernels', 'kernelB', 'kernel.json')
+                    path.join(kernel.name, 'kernel.json'),
+                    path.join('kernelA', 'kernel.json'),
+                    path.join('kernelB', 'kernel.json')
                 ])
             );
     }
@@ -127,7 +128,7 @@ suite('Kernel Finder', () => {
         fileSystem
             .setup((fs) => fs.readFile(typemoq.It.isAnyString()))
             .returns((param: string) => {
-                if (param.includes('kernelSpecCache.json')) {
+                if (param.includes(cacheFile)) {
                     return Promise.resolve(`["${kernel.name}"]`);
                 }
                 return Promise.resolve(JSON.stringify(kernel));
@@ -142,7 +143,7 @@ suite('Kernel Finder', () => {
         fileSystem
             .setup((fs) => fs.readFile(typemoq.It.isAnyString()))
             .returns((pathParam: string) => {
-                if (pathParam.includes('kernelSpecCache.json')) {
+                if (pathParam.includes(cacheFile)) {
                     return Promise.resolve('[]');
                 }
                 return Promise.resolve(JSON.stringify(kernel));
@@ -160,7 +161,7 @@ suite('Kernel Finder', () => {
         fileSystem
             .setup((fs) => fs.readFile(typemoq.It.isAnyString()))
             .returns((pathParam: string) => {
-                if (pathParam.includes('kernelSpecCache.json')) {
+                if (pathParam.includes(cacheFile)) {
                     return Promise.resolve('[]');
                 }
                 return Promise.resolve(JSON.stringify(kernel));
@@ -178,7 +179,7 @@ suite('Kernel Finder', () => {
         fileSystem
             .setup((fs) => fs.readFile(typemoq.It.isAnyString()))
             .returns((pathParam: string) => {
-                if (pathParam.includes('kernelSpecCache.json')) {
+                if (pathParam.includes(cacheFile)) {
                     return Promise.resolve('[]');
                 }
                 return Promise.resolve(JSON.stringify(kernel));
@@ -193,7 +194,7 @@ suite('Kernel Finder', () => {
         fileSystem
             .setup((fs) => fs.readFile(typemoq.It.isAnyString()))
             .returns((pathParam: string) => {
-                if (pathParam.includes('kernelSpecCache.json')) {
+                if (pathParam.includes(cacheFile)) {
                     return Promise.resolve('[]');
                 }
                 return Promise.resolve('{}');
@@ -209,7 +210,7 @@ suite('Kernel Finder', () => {
         fileSystem
             .setup((fs) => fs.readFile(typemoq.It.isAnyString()))
             .returns((pathParam: string) => {
-                if (pathParam.includes('kernelSpecCache.json')) {
+                if (pathParam.includes(cacheFile)) {
                     return Promise.resolve('[]');
                 }
                 return Promise.resolve('{}');
@@ -224,7 +225,7 @@ suite('Kernel Finder', () => {
         fileSystem
             .setup((fs) => fs.readFile(typemoq.It.isAnyString()))
             .returns((pathParam: string) => {
-                if (pathParam.includes('kernelSpecCache.json')) {
+                if (pathParam.includes(cacheFile)) {
                     return Promise.resolve(`["${spec.path}"]`);
                 }
                 return Promise.resolve(JSON.stringify(spec));
@@ -244,7 +245,7 @@ suite('Kernel Finder', () => {
         fileSystem
             .setup((fs) => fs.readFile(typemoq.It.isAnyString()))
             .returns((pathParam: string) => {
-                if (pathParam.includes('kernelSpecCache.json')) {
+                if (pathParam.includes(cacheFile)) {
                     return Promise.resolve('[]');
                 } else if (pathParam.includes('kernelA')) {
                     const specA = {
@@ -267,7 +268,7 @@ suite('Kernel Finder', () => {
         fileSystem
             .setup((fs) => fs.readFile(typemoq.It.isAnyString()))
             .returns((pathParam: string) => {
-                if (pathParam.includes('kernelSpecCache.json')) {
+                if (pathParam.includes(cacheFile)) {
                     return Promise.resolve(
                         JSON.stringify([
                             path.join('kernels', kernel.name, 'kernel.json'),