Support server-side execution #279
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -14,9 +14,11 @@ import { | |
| EditorExtensionRegistry, | ||
| IEditorExtensionRegistry | ||
| } from '@jupyterlab/codemirror'; | ||
| import { type MarkdownCell } from '@jupyterlab/cells'; | ||
| import { INotebookCellExecutor, runCell } from '@jupyterlab/notebook'; | ||
| import { WebSocketAwarenessProvider } from '@jupyter/docprovider'; | ||
| import { SidePanel, usersIcon } from '@jupyterlab/ui-components'; | ||
| import { PageConfig, URLExt } from '@jupyterlab/coreutils'; | ||
| import { ServerConnection } from '@jupyterlab/services'; | ||
| import { IStateDB, StateDB } from '@jupyterlab/statedb'; | ||
| import { ITranslator, nullTranslator } from '@jupyterlab/translation'; | ||
|
|
@@ -189,3 +191,63 @@ export const userEditorCursors: JupyterFrontEndPlugin<void> = { | |
| }); | ||
| } | ||
| }; | ||
|
|
||
| export const notebookCellExecutor: JupyterFrontEndPlugin<INotebookCellExecutor> = | ||
|
There was a problem hiding this comment. Something to consider: do we want this plugin in a separate package in the future so that when we split frontend and backend (#269) we can still load this plugin but not the others? This question does not block merging this PR in any way. There was a problem hiding this comment. But does it make sense to have server-side execution without collaboration? The former is based on the latter, so in my opinion they go together. There was a problem hiding this comment. It would be sufficient to have the collaborative drive, right? |
||
| { | ||
| id: '@jupyter/collaboration-extension:notebook-cell-executor', | ||
| description: | ||
| 'Add notebook cell executor that uses REST API instead of kernel protocol over WebSocket.', | ||
| autoStart: true, | ||
| provides: INotebookCellExecutor, | ||
| activate: (app: JupyterFrontEnd): INotebookCellExecutor => { | ||
| if (PageConfig.getOption('serverSideExecution') === 'true') { | ||
davidbrochart marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return Object.freeze({ runCell: runCellServerSide }); | ||
| } | ||
| return Object.freeze({ runCell }); | ||
| } | ||
| }; | ||
|
|
||
| async function runCellServerSide({ | ||
| cell, | ||
| notebook, | ||
| notebookConfig, | ||
| onCellExecuted, | ||
| onCellExecutionScheduled, | ||
| sessionContext, | ||
| sessionDialogs, | ||
| translator | ||
| }: INotebookCellExecutor.IRunCellOptions): Promise<boolean> { | ||
| switch (cell.model.type) { | ||
| case 'markdown': | ||
| (cell as MarkdownCell).rendered = true; | ||
| cell.inputHidden = false; | ||
| onCellExecuted({ cell, success: true }); | ||
| break; | ||
| case 'code': { | ||
| const kernelId = sessionContext?.session?.kernel?.id; | ||
| const settings = ServerConnection.makeSettings(); | ||
| const apiURL = URLExt.join( | ||
| settings.baseUrl, | ||
| `api/kernels/${kernelId}/execute` | ||
| ); | ||
| const cellId = cell.model.sharedModel.getId(); | ||
| const documentId = `json:notebook:${notebook.sharedModel.getState( | ||
| 'file_id' | ||
| )}`; | ||
| const body = `{"cell_id":"${cellId}","document_id":"${documentId}"}`; | ||
| const init = { | ||
| method: 'POST', | ||
| body | ||
| }; | ||
| try { | ||
| await ServerConnection.makeRequest(apiURL, init, settings); | ||
| } catch (error: any) { | ||
| throw new ServerConnection.NetworkError(error); | ||
| } | ||
| break; | ||
| } | ||
| default: | ||
| break; | ||
| } | ||
| return Promise.resolve(true); | ||
| } | ||
This file contains hidden or 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 hidden or 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.
Uh oh!
There was an error while loading. Please reload this page.