@jupyter/docprovider 3.0.0-alpha.1 → 3.0.0-beta.0

package/lib/index.d.ts

@@ -3,6 +3,8 @@
  * @module docprovider
  */
 export * from './awareness';
+export * from './notebookCellExecutor';
+export * from './requests';
 export * from './ydrive';
 export * from './yprovider';
 export * from './tokens';

package/lib/index.js

@@ -7,6 +7,8 @@
  * @module docprovider
  */
 export * from './awareness';
+export * from './notebookCellExecutor';
+export * from './requests';
 export * from './ydrive';
 export * from './yprovider';
 export * from './tokens';

package/lib/notebookCellExecutor.d.ts

@@ -0,0 +1,23 @@
+import { INotebookCellExecutor } from '@jupyterlab/notebook';
+import { ServerConnection } from '@jupyterlab/services';
+/**
+ * Notebook cell executor posting a request to the server for execution.
+ */
+export declare class NotebookCellServerExecutor implements INotebookCellExecutor {
+    private _serverSettings;
+    /**
+     * Constructor
+     *
+     * @param options Constructor options; the contents manager, the collaborative drive and optionally the server settings.
+     */
+    constructor(options: {
+        serverSettings?: ServerConnection.ISettings;
+    });
+    /**
+     * Execute a given cell of the notebook.
+     *
+     * @param options Execution options
+     * @returns Execution success status
+     */
+    runCell({ cell, notebook, notebookConfig, onCellExecuted, onCellExecutionScheduled, sessionContext, sessionDialogs, translator }: INotebookCellExecutor.IRunCellOptions): Promise<boolean>;
+}

package/lib/notebookCellExecutor.js

@@ -0,0 +1,108 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+import { Dialog, showDialog } from '@jupyterlab/apputils';
+import { URLExt } from '@jupyterlab/coreutils';
+import { ServerConnection } from '@jupyterlab/services';
+import { nullTranslator } from '@jupyterlab/translation';
+/**
+ * Notebook cell executor posting a request to the server for execution.
+ */
+export class NotebookCellServerExecutor {
+    /**
+     * Constructor
+     *
+     * @param options Constructor options; the contents manager, the collaborative drive and optionally the server settings.
+     */
+    constructor(options) {
+        var _a;
+        this._serverSettings =
+            (_a = options.serverSettings) !== null && _a !== void 0 ? _a : ServerConnection.makeSettings();
+    }
+    /**
+     * Execute a given cell of the notebook.
+     *
+     * @param options Execution options
+     * @returns Execution success status
+     */
+    async runCell({ cell, notebook, notebookConfig, onCellExecuted, onCellExecutionScheduled, sessionContext, sessionDialogs, translator }) {
+        var _a, _b, _c;
+        translator = translator !== null && translator !== void 0 ? translator : nullTranslator;
+        const trans = translator.load('jupyterlab');
+        switch (cell.model.type) {
+            case 'markdown':
+                cell.rendered = true;
+                cell.inputHidden = false;
+                onCellExecuted({ cell, success: true });
+                break;
+            case 'code':
+                if (sessionContext) {
+                    if (sessionContext.isTerminating) {
+                        await showDialog({
+                            title: trans.__('Kernel Terminating'),
+                            body: trans.__('The kernel for %1 appears to be terminating. You can not run any cell for now.', (_a = sessionContext.session) === null || _a === void 0 ? void 0 : _a.path),
+                            buttons: [Dialog.okButton()]
+                        });
+                        break;
+                    }
+                    if (sessionContext.pendingInput) {
+                        await showDialog({
+                            title: trans.__('Cell not executed due to pending input'),
+                            body: trans.__('The cell has not been executed to avoid kernel deadlock as there is another pending input! Submit your pending input and try again.'),
+                            buttons: [Dialog.okButton()]
+                        });
+                        return false;
+                    }
+                    if (sessionContext.hasNoKernel) {
+                        const shouldSelect = await sessionContext.startKernel();
+                        if (shouldSelect && sessionDialogs) {
+                            await sessionDialogs.selectKernel(sessionContext);
+                        }
+                    }
+                    if (sessionContext.hasNoKernel) {
+                        cell.model.sharedModel.transact(() => {
+                            cell.model.clearExecution();
+                        });
+                        return true;
+                    }
+                    const kernelId = (_c = (_b = sessionContext === null || sessionContext === void 0 ? void 0 : sessionContext.session) === null || _b === void 0 ? void 0 : _b.kernel) === null || _c === void 0 ? void 0 : _c.id;
+                    const apiURL = URLExt.join(this._serverSettings.baseUrl, `api/kernels/${kernelId}/execute`);
+                    const cellId = cell.model.sharedModel.getId();
+                    const documentId = notebook.sharedModel.getState('document_id');
+                    const init = {
+                        method: 'POST',
+                        body: JSON.stringify({ cell_id: cellId, document_id: documentId })
+                    };
+                    onCellExecutionScheduled({ cell });
+                    let success = false;
+                    try {
+                        // FIXME quid of deletedCells and timing record
+                        const response = await ServerConnection.makeRequest(apiURL, init, this._serverSettings);
+                        success = response.ok;
+                    }
+                    catch (error) {
+                        onCellExecuted({
+                            cell,
+                            success: false
+                        });
+                        if (cell.isDisposed) {
+                            return false;
+                        }
+                        else {
+                            throw error;
+                        }
+                    }
+                    onCellExecuted({ cell, success });
+                    return true;
+                }
+                cell.model.sharedModel.transact(() => {
+                    cell.model.clearExecution();
+                }, false);
+                break;
+            default:
+                break;
+        }
+        return Promise.resolve(true);
+    }
+}

package/lib/ydrive.d.ts

@@ -1,6 +1,7 @@
 import { TranslationBundle } from '@jupyterlab/translation';
 import { Contents, Drive, User } from '@jupyterlab/services';
 import { ICollaborativeDrive, ISharedModelFactory } from './tokens';
+import { Awareness } from 'y-protocols/awareness';
 /**
  * A Collaborative implementation for an `IDrive`, talking to the
  * server using the Jupyter REST API and a WebSocket connection.
@@ -11,7 +12,7 @@ export declare class YDrive extends Drive implements ICollaborativeDrive {
      *
      * @param user - The user manager to add the identity to the awareness of documents.
      */
-    constructor(user: User.IManager, translator: TranslationBundle);
+    constructor(user: User.IManager, translator: TranslationBundle, globalAwareness: Awareness | null);
     /**
      * SharedModel factory for the YDrive.
      */
@@ -47,4 +48,5 @@ export declare class YDrive extends Drive implements ICollaborativeDrive {
     private _user;
     private _trans;
     private _providers;
+    private _globalAwareness;
 }

package/lib/ydrive.js

@@ -18,9 +18,10 @@ export class YDrive extends Drive {
      *
      * @param user - The user manager to add the identity to the awareness of documents.
      */
-    constructor(user, translator) {
+    constructor(user, translator, globalAwareness) {
         super({ name: 'RTC' });
         this._onCreate = (options, sharedModel) => {
+            var _a, _b;
             if (typeof options.format !== 'string') {
                 return;
             }
@@ -34,14 +35,30 @@ export class YDrive extends Drive {
                     user: this._user,
                     translator: this._trans
                 });
+                // Add the document path in the list of opened ones for this user.
+                const state = ((_a = this._globalAwareness) === null || _a === void 0 ? void 0 : _a.getLocalState()) || {};
+                const documents = state.documents || [];
+                if (!documents.includes(options.path)) {
+                    documents.push(`${this.name}:${options.path}`);
+                    (_b = this._globalAwareness) === null || _b === void 0 ? void 0 : _b.setLocalStateField('documents', documents);
+                }
                 const key = `${options.format}:${options.contentType}:${options.path}`;
                 this._providers.set(key, provider);
                 sharedModel.disposed.connect(() => {
+                    var _a, _b;
                     const provider = this._providers.get(key);
                     if (provider) {
                         provider.dispose();
                         this._providers.delete(key);
                     }
+                    // Remove the document path from the list of opened ones for this user.
+                    const state = ((_a = this._globalAwareness) === null || _a === void 0 ? void 0 : _a.getLocalState()) || {};
+                    const documents = state.documents || [];
+                    const index = documents.indexOf(`${this.name}:${options.path}`);
+                    if (index > -1) {
+                        documents.splice(index, 1);
+                    }
+                    (_b = this._globalAwareness) === null || _b === void 0 ? void 0 : _b.setLocalStateField('documents', documents);
                 });
             }
             catch (error) {
@@ -52,6 +69,7 @@ export class YDrive extends Drive {
         };
         this._user = user;
         this._trans = translator;
+        this._globalAwareness = globalAwareness;
         this._providers = new Map();
         this.sharedModelFactory = new SharedModelFactory(this._onCreate);
     }

package/lib/yprovider.js

@@ -32,10 +32,13 @@ export class WebSocketProvider {
             }
         };
         this._onSync = (isSynced) => {
-            var _a;
             if (isSynced) {
+                if (this._yWebsocketProvider) {
+                    this._yWebsocketProvider.off('sync', this._onSync);
+                    const state = this._sharedModel.ydoc.getMap('state');
+                    state.set('document_id', this._yWebsocketProvider.roomname);
+                }
                 this._ready.resolve();
-                (_a = this._yWebsocketProvider) === null || _a === void 0 ? void 0 : _a.off('sync', this._onSync);
             }
         };
         this._ready = new PromiseDelegate();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-beta.0",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter-collaboration",
   "bugs": {
@@ -41,18 +41,23 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter/ydoc": "^1.1.0-a0",
-    "@jupyterlab/coreutils": "^6.0.5",
-    "@jupyterlab/services": "^7.0.5",
+    "@jupyter/ydoc": "^2.0.0",
+    "@jupyterlab/apputils": "^4.2.0",
+    "@jupyterlab/cells": "^4.2.0",
+    "@jupyterlab/coreutils": "^6.2.0",
+    "@jupyterlab/notebook": "^4.2.0",
+    "@jupyterlab/services": "^7.2.0",
+    "@jupyterlab/translation": "^4.2.0",
     "@lumino/coreutils": "^2.1.0",
     "@lumino/disposable": "^2.1.0",
     "@lumino/signaling": "^2.1.0",
+    "@lumino/widgets": "^2.2.0",
     "y-protocols": "^1.0.5",
     "y-websocket": "^1.3.15",
     "yjs": "^13.5.40"
   },
   "devDependencies": {
-    "@jupyterlab/testing": "^4.0.5",
+    "@jupyterlab/testing": "^4.0.0",
     "@types/jest": "^29.2.0",
     "jest": "^29.5.0",
     "rimraf": "^4.1.2",