Use content providers to remove RTC prefix #418
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 |
|---|---|---|
|
|
@@ -4,72 +4,88 @@ | |
| */ | ||
|
|
||
| import { | ||
| JupyterFrontEnd, | ||
| JupyterFrontEndPlugin | ||
| } from '@jupyterlab/application'; | ||
| import { Dialog, showDialog } from '@jupyterlab/apputils'; | ||
| import { DocumentWidget, IDocumentWidget } from '@jupyterlab/docregistry'; | ||
| import { Widget } from '@lumino/widgets'; | ||
|
|
||
| import { IStatusBar } from '@jupyterlab/statusbar'; | ||
| import { ContentsManager } from '@jupyterlab/services'; | ||
|
|
||
| import { | ||
| IEditorTracker, | ||
| IEditorWidgetFactory, | ||
| FileEditorFactory | ||
| } from '@jupyterlab/fileeditor'; | ||
| import { ILogger, ILoggerRegistry } from '@jupyterlab/logconsole'; | ||
| import { | ||
| INotebookTracker, | ||
| INotebookWidgetFactory, | ||
| NotebookWidgetFactory | ||
| } from '@jupyterlab/notebook'; | ||
| import { ISettingRegistry } from '@jupyterlab/settingregistry'; | ||
| import { ITranslator, nullTranslator } from '@jupyterlab/translation'; | ||
|
|
||
| import { YFile, YNotebook } from '@jupyter/ydoc'; | ||
|
|
||
| import { | ||
| ICollaborativeContentProvider, | ||
| IGlobalAwareness | ||
| } from '@jupyter/collaborative-drive'; | ||
| import { | ||
| IForkProvider, | ||
| TimelineWidget, | ||
| RtcContentProvider | ||
| } from '@jupyter/docprovider'; | ||
| import { Awareness } from 'y-protocols/awareness'; | ||
| import { URLExt } from '@jupyterlab/coreutils'; | ||
|
|
||
| const DOCUMENT_TIMELINE_URL = 'api/collaboration/timeline'; | ||
|
|
||
| const TWO_SESSIONS_WARNING = | ||
| 'The file %1 has been opened with two different views. ' + | ||
| 'This is not supported. Please close this view; otherwise, ' + | ||
| 'some of your edits may not be saved properly.'; | ||
|
|
||
| export const rtcContentProvider: JupyterFrontEndPlugin<ICollaborativeContentProvider> = | ||
| { | ||
| id: '@jupyter/docprovider-extension:content-provider', | ||
| description: 'The RTC content provider', | ||
| provides: ICollaborativeContentProvider, | ||
| requires: [ITranslator], | ||
| optional: [IGlobalAwareness], | ||
| activate: ( | ||
| app: JupyterFrontEnd, | ||
| translator: ITranslator, | ||
| globalAwareness: Awareness | null | ||
| ): ICollaborativeContentProvider => { | ||
| const trans = translator.load('jupyter_collaboration'); | ||
| const defaultDrive = (app.serviceManager.contents as ContentsManager) | ||
| .defaultDrive; | ||
| if (!defaultDrive) { | ||
| throw Error( | ||
| 'Cannot initialize content provider: default drive property not accessible on contents manager instance.' | ||
| ); | ||
| } | ||
| const registry = defaultDrive.contentProviderRegistry; | ||
| if (!registry) { | ||
|
There was a problem hiding this comment. Will that make There was a problem hiding this comment. Yes, I would propose that, the next version of |
||
| throw Error( | ||
| 'Cannot initialize content provider: no content provider registry.' | ||
| ); | ||
| } | ||
| const rtcContentProvider = new RtcContentProvider({ | ||
| apiEndpoint: '/api/contents', | ||
| serverSettings: defaultDrive.serverSettings, | ||
| user: app.serviceManager.user, | ||
| trans, | ||
| globalAwareness | ||
| }); | ||
| registry.register('rtc', rtcContentProvider); | ||
| return rtcContentProvider; | ||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * Plugin to register the shared model factory for the content type 'file'. | ||
|
|
@@ -79,13 +95,20 @@ export const yfile: JupyterFrontEndPlugin<void> = { | |
| description: | ||
| "Plugin to register the shared model factory for the content type 'file'", | ||
| autoStart: true, | ||
| requires: [ICollaborativeContentProvider, IEditorWidgetFactory], | ||
| activate: ( | ||
| app: JupyterFrontEnd, | ||
| contentProvider: ICollaborativeContentProvider, | ||
| editorFactory: FileEditorFactory.IFactory | ||
| ): void => { | ||
| const yFileFactory = () => { | ||
| return new YFile(); | ||
| }; | ||
| contentProvider.sharedModelFactory.registerDocumentFactory( | ||
| 'file', | ||
| yFileFactory | ||
| ); | ||
| editorFactory.contentProviderId = 'rtc'; | ||
| } | ||
| }; | ||
|
|
||
|
|
@@ -97,11 +120,12 @@ export const ynotebook: JupyterFrontEndPlugin<void> = { | |
| description: | ||
| "Plugin to register the shared model factory for the content type 'notebook'", | ||
| autoStart: true, | ||
| requires: [ICollaborativeContentProvider, INotebookWidgetFactory], | ||
| optional: [ISettingRegistry], | ||
| activate: ( | ||
| app: JupyterFrontEnd, | ||
| contentProvider: ICollaborativeContentProvider, | ||
| notebookFactory: NotebookWidgetFactory.IFactory, | ||
| settingRegistry: ISettingRegistry | null | ||
| ): void => { | ||
| let disableDocumentWideUndoRedo = true; | ||
|
|
@@ -131,10 +155,11 @@ export const ynotebook: JupyterFrontEndPlugin<void> = { | |
| disableDocumentWideUndoRedo | ||
| }); | ||
| }; | ||
| contentProvider.sharedModelFactory.registerDocumentFactory( | ||
| 'notebook', | ||
| yNotebookFactory | ||
| ); | ||
| notebookFactory.contentProviderId = 'rtc'; | ||
|
There was a problem hiding this comment. This seems to indicate that multiple extensions could try to set their content provider on the default notebook and editor factories? What is the expected behavior if two extensions try to do this? There was a problem hiding this comment.
Currently the last one wins. Alternative, we could log a warning or reject a second use of setter. There was a problem hiding this comment.
Maybe a hard failure would be preferable for end users, so it's easier to debug and report? There was a problem hiding this comment. Make sense. Done in jupyterlab/jupyterlab@1173ca7. |
||
| } | ||
| }; | ||
| /** | ||
|
|
@@ -144,11 +169,11 @@ export const statusBarTimeline: JupyterFrontEndPlugin<void> = { | |
| id: '@jupyter/docprovider-extension:statusBarTimeline', | ||
| description: 'Plugin to add a timeline slider to the status bar', | ||
| autoStart: true, | ||
| requires: [IStatusBar, ICollaborativeContentProvider], | ||
| activate: async ( | ||
| app: JupyterFrontEnd, | ||
| statusBar: IStatusBar, | ||
| contentProvider: ICollaborativeContentProvider | ||
| ): Promise<void> => { | ||
| try { | ||
| let sliderItem: Widget | null = null; | ||
|
|
@@ -158,18 +183,17 @@ export const statusBarTimeline: JupyterFrontEndPlugin<void> = { | |
| documentPath: string, | ||
| documentId: string | ||
| ) => { | ||
| // TODO: check if documentId uses RTC | ||
| if (documentId) { | ||
| if (contentProvider) { | ||
| // Dispose of the previous timelineWidget if it exists | ||
| if (timelineWidget) { | ||
| timelineWidget.dispose(); | ||
| timelineWidget = null; | ||
| } | ||
|
|
||
| const [format, type] = documentId.split(':'); | ||
| const provider = contentProvider.providers.get( | ||
| `${format}:${type}:${documentPath}` | ||
| ) as unknown as IForkProvider; | ||
| const fullPath = URLExt.join( | ||
|
|
@@ -238,6 +262,7 @@ export const statusBarTimeline: JupyterFrontEndPlugin<void> = { | |
| currentWidget.context.model.sharedModel.getState( | ||
| 'document_id' | ||
| ) as string; | ||
| // TODO | ||
| return !!documentId && documentPath.split(':')[0] === 'RTC'; | ||
| } | ||
| return false; | ||
|
|
@@ -251,52 +276,6 @@ export const statusBarTimeline: JupyterFrontEndPlugin<void> = { | |
| } | ||
| }; | ||
|
|
||
| /** | ||
| * The default collaborative drive provider. | ||
| */ | ||
|
|
@@ -383,59 +362,3 @@ export const logger: JupyterFrontEndPlugin<void> = { | |
| })(); | ||
| } | ||
| }; | ||
Oops, something went wrong.
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.
Looks like we'll want to log that somewhere in the changelog as API breaking change, since other extensions may currently depend on
ICollaborativeDrive?For instance it's the case of JupyterCAD and JupyterGIS:
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.
It looks like the transition will be smooth because:
ICollaborativeDriveas an optional dependency (after all it was just added)Drivepart ofICollaborativeDrive- the same properties that they needed will be available onICollaborativeContentProviderSo when cutting the release we will just need to add a note that migration from
ICollaborativeDrivetoICollaborativeContentProvidertoken for access to shared factory and forks will be required. I do not see a good way to do that right now as the changelog for next version is not there yet - is it ok if we add it during/just after cutting the release?