fix: dispose a torn down NB controller's kernel

Fixes #17094

It's my first time looking at any of this code and the lifecycle of everything is a little challenging to discover at a glance. This change passed unit tests and manually verifying, it solves the issue. I'll lay out the problem and solution independently below to make reviewing easier.

If a server/kernel is removed, then another was created for the active notebook editor, cell executions against the new kernel would fail. The issue with clear repro steps and the corresponding logs: #17094.

The root cause is improper resource cleanup during the disposal of a `VSCodeNotebookController`. When a `JupyterServerProvider` is removed, the extension correctly disposes of the associated controllers. However, the `dispose` method for the controller did not explicitly dispose of the underlying `IKernel` instance that it had created and managed.

This left the kernel in an orphaned or "zombie" state. When a new server and controller were subsequently created for the same notebook, it'd try to use the old, still-lingering kernel, which was already in a started state, leading to the "Cannot call start again" error.

The fix enhances the dispose method within the `VSCodeNotebookController`. The new logic ensures that when a controller is disposed, it actively cleans up any kernels it was responsible for.

It iterates through all currently open NB docs and siposes any kernels who's connection metadata IDs match.

Author: kevineger

src/notebooks/controllers/vscodeNotebookController.ts

@@ -334,6 +334,13 @@ export class VSCodeNotebookController implements Disposable, IVSCodeNotebookCont
             } called from ${new Error('').stack}`
         );
         this.isDisposed = true;
+        // Dispose all kernels associated with this controller
+        workspace.notebookDocuments.forEach((doc) => {
+            const kernel = this.kernelProvider.get(doc);
+            if (kernel?.kernelConnectionMetadata.id === this.connection.id) {
+                kernel.dispose().catch(noop);
+            }
+        });
         this._onNotebookControllerSelectionChanged.dispose();
         this._onConnecting.dispose();
         this.controller.dispose();

src/notebooks/controllers/vscodeNotebookController.unit.test.ts

@@ -544,4 +544,26 @@ suite(`Notebook Controller`, function () {
             });
         });
     });
+    test('Disposing controller disposes of the kernel', async function () {
+        const controller = new VSCodeNotebookController(
+            instance(kernelConnection),
+            '1',
+            'jupyter-notebook',
+            instance(kernelProvider),
+            instance(context),
+            disposables,
+            instance(languageService),
+            instance(configService),
+            instance(extensionChecker),
+            instance(serviceContainer),
+            displayDataProvider
+        );
+        when(mockedVSCodeNamespaces.workspace.notebookDocuments).thenReturn([notebook]);
+        when(kernelProvider.get(notebook)).thenReturn(instance(kernel));
+        when(kernel.dispose()).thenResolve();
+
+        controller.dispose();
+
+        verify(kernel.dispose()).once();
+    });
 });