Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Notebook renderer: Use SharedModelFactory to create shared model #145

Merged
merged 2 commits into from
Sep 17, 2024
Merged

Notebook renderer: Use SharedModelFactory to create shared model #145

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81d431d
Notebook renderer: Use SharedModelFactory to create shared model
martinRenou Sep 17, 2024
794714a
Linting
martinRenou Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 22 additions & 38 deletions python/jupytergis_lab/src/notebookrenderer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
import { WebSocketProvider } from '@jupyter/docprovider';
import { ICollaborativeDrive } from '@jupyter/docprovider';
import { JupyterGISPanel } from '@jupytergis/base';
import { JupyterGISModel } from '@jupytergis/schema';
import { JupyterGISModel, IJupyterGISDoc } from '@jupytergis/schema';

import {
JupyterFrontEnd,
JupyterFrontEndPlugin
} from '@jupyterlab/application';
import { URLExt } from '@jupyterlab/coreutils';
import { ServerConnection, User } from '@jupyterlab/services';
import { ITranslator, nullTranslator } from '@jupyterlab/translation';
import { Contents } from '@jupyterlab/services';
import { MessageLoop } from '@lumino/messaging';
import { Panel, Widget } from '@lumino/widgets';
import * as Y from 'yjs';
Expand All @@ -26,7 +24,6 @@ export interface ICommMetadata {
ymodel_name: string;
}

const Y_DOCUMENT_PROVIDER_URL = 'api/collaboration/room';
export const CLASS_NAME = 'jupytergis-notebook-widget';

export class YJupyterGISModel extends JupyterYModel {
Expand Down Expand Up @@ -57,50 +54,37 @@ export class YJupyterGISLuminoWidget extends Panel {
export const notebookRenderePlugin: JupyterFrontEndPlugin<void> = {
id: 'jupytergis:yjswidget-plugin',
autoStart: true,
optional: [IJupyterYWidgetManager, ITranslator],
optional: [IJupyterYWidgetManager, ICollaborativeDrive],
activate: (
app: JupyterFrontEnd,
yWidgetManager?: IJupyterYWidgetManager,
translator?: ITranslator
drive?: ICollaborativeDrive
): void => {
if (!yWidgetManager) {
console.error('Missing IJupyterYWidgetManager token!');
return;
}
const labTranslator = translator ?? nullTranslator;
if (!drive) {
console.error(
'Cannot setup JupyterGIS Python API without a collaborative drive'
);
return;
}
class YJupyterGISModelFactory extends YJupyterGISModel {
ydocFactory(commMetadata: ICommMetadata): Y.Doc {
const { path, format, contentType } = commMetadata;

this.jupyterGISModel = new JupyterGISModel({});
const user = app.serviceManager.user;
if (path && format && contentType) {
const server = ServerConnection.makeSettings();
const serverUrl = URLExt.join(server.wsUrl, Y_DOCUMENT_PROVIDER_URL);
const ywsProvider = new WebSocketProvider({
url: serverUrl,
path,
format,
contentType,
model: this.jupyterGISModel.sharedModel,
user,
translator: labTranslator.load('jupyterlab')
});
this.jupyterGISModel.disposed.connect(() => {
ywsProvider.dispose();
});
} else {
const awareness = this.jupyterGISModel.sharedModel.awareness;
const _onUserChanged = (user: User.IManager) => {
awareness.setLocalStateField('user', user.identity);
};
user.ready
.then(() => {
_onUserChanged(user);
})
.catch(e => console.error(e));
user.userChanged.connect(_onUserChanged, this);
}
const fileFormat = format as Contents.FileFormat;

const sharedModel = drive!.sharedModelFactory.createNew({
path,
format: fileFormat,
contentType,
collaborative: true
})!;
this.jupyterGISModel = new JupyterGISModel({
sharedModel: sharedModel as IJupyterGISDoc
});

return this.jupyterGISModel.sharedModel.ydoc;
}
Expand Down
Loading