Shared kernelconnection wrapper #10141
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| import type { Kernel } from '@jupyterlab/services'; | ||
| import { IDisposable } from '../../platform/common/types'; | ||
| import { BaseKernelConnectionWrapper } from '../jupyter/baseKernelConnectionWrapper'; | ||
|
|
||
| export class KernelConnectionWrapper extends BaseKernelConnectionWrapper { | ||
| /** | ||
| * Use `kernelConnection` to access the value as its not a constant (can change over time). | ||
| * E.g. when restarting kernels or the like. | ||
| */ | ||
| private _kernelConnection!: Kernel.IKernelConnection; | ||
| protected get possibleKernelConnection(): undefined | Kernel.IKernelConnection { | ||
| return this._kernelConnection; | ||
| } | ||
| public get kernel() { | ||
| return this._kernelConnection; | ||
| } | ||
|
|
||
| constructor(kernel: Kernel.IKernelConnection, disposables: IDisposable[]) { | ||
| super(kernel, disposables); | ||
| this._kernelConnection = kernel; | ||
| } | ||
| public changeKernel(kernel: Kernel.IKernelConnection) { | ||
| if (this.kernel === kernel) { | ||
| return; | ||
| } | ||
| this.stopHandlingKernelMessages(this.possibleKernelConnection!); | ||
| this._kernelConnection = kernel; | ||
| this.startHandleKernelMessages(kernel); | ||
| } | ||
| async shutdown(): Promise<void> { | ||
| await this._kernelConnection.shutdown(); | ||
| } | ||
| dispose(): void { | ||
| this._kernelConnection.dispose(); | ||
| } | ||
| async interrupt(): Promise<void> { | ||
| await this._kernelConnection.interrupt(); | ||
| } | ||
| async restart(): Promise<void> { | ||
| await this._kernelConnection.restart(); | ||
| } | ||
| protected override startHandleKernelMessages(kernelConnection: Kernel.IKernelConnection) { | ||
| super.startHandleKernelMessages(kernelConnection); | ||
| this._kernelConnection = kernelConnection; | ||
| kernelConnection.connectionStatusChanged.connect(this.onConnectionStatusChanged, this); | ||
| kernelConnection.statusChanged.connect(this.onStatusChanged, this); | ||
| kernelConnection.disposed.connect(this.onDisposed, this); | ||
| } | ||
| protected override stopHandlingKernelMessages(kernelConnection: Kernel.IKernelConnection): void { | ||
| super.stopHandlingKernelMessages(kernelConnection); | ||
| kernelConnection.connectionStatusChanged.disconnect(this.onConnectionStatusChanged, this); | ||
| kernelConnection.statusChanged.disconnect(this.onStatusChanged, this); | ||
| kernelConnection.disposed.disconnect(this.onDisposed, this); | ||
| } | ||
| private onDisposed(connection: Kernel.IKernelConnection) { | ||
| if (connection === this.possibleKernelConnection) { | ||
| this.disposed.emit(); | ||
| } | ||
| } | ||
| private onStatusChanged(connection: Kernel.IKernelConnection, args: Kernel.Status) { | ||
| if (connection === this.possibleKernelConnection) { | ||
| this.statusChanged.emit(args); | ||
| } | ||
| } | ||
| private onConnectionStatusChanged(connection: Kernel.IKernelConnection, args: Kernel.ConnectionStatus) { | ||
| if (connection === this.possibleKernelConnection) { | ||
| this.connectionStatusChanged.emit(args); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need a way to hook up to the
iopubandanymessageevents in the underlyiing Jupyter kernel connection.This property
onIOPubMessageis a custom event we wire up. If I were to introduceanyMessageevent then i'd have to handle kernel restarts all over again, tomorrow if we wanted to handle other events, then all over gain etc...Also, as we expose the underlying jupyter kernel (Kernel.IKenrelConnection) everywhere it makes sense to just hook to those events.
Hence created a kernel wrapper so that we have a single instance, of the Kernel.KernleConnection on which we can monitor the events (basically moved onIOPubMessage & similar events into the kernel.IKernelConnection and have that keep track of all the event handlers even when kernels restart)