Drop modelDB from code editor #13247

fcollonval · 2022-10-14T16:36:56Z

References

Follow-up of #13168

Code changes

Remove modelDB from CodeEditor.Model
Use directly metadata from YJS.
CellModel and AttachementCellModel are now an abstract classes as the constructor does not need to access the cell type.
Remove onCellMoved on StaticNotebook and Notebook as motion does not exist. A motion will always be a removal + an addition (even when we will use the yjs move feature as there is no event for motion).
This also fixes the logic of cell selection when moving them.

User-facing changes

N/A

Backwards-incompatible changes

Break api for dealing with metadata for cells and notebook as it is not a observable json any longer.
CellModel and AttachementCellModel are now an abstract classes as the constructor does not need to access the cell type.

jupyterlab-probot · 2022-10-14T16:36:57Z

Thanks for making a pull request to jupyterlab!
To try out this branch on binder, follow this link:

hbcarlos

Thanks, @fcollonval! I left some comments.

packages/shared-models/src/api.ts

hbcarlos · 2022-10-27T10:45:20Z

packages/shared-models/src/ymodels.ts

+    notebook.nbformat = nbformat.MAJOR_VERSION;
+    notebook.nbformat_minor = nbformat.MINOR_VERSION;
+    if (!notebook.ymeta.get('metadata')) {
+      notebook.ymeta.set('metadata', {});
+    }


We shouldn't initialize the YNotebook here. We re-initialize the nbformat and metadata every time a new client joins because we use this static method to instantiate the YNotebook here:

jupyterlab/packages/notebook/src/model.ts

Lines 103 to 105 in 0fad099

this.sharedModel = YNotebook.create({

disableDocumentWideUndoRedo: options.disableDocumentWideUndoRedo ?? false

});

This is done for every client joining the session. Instead, we should initialize the document in the backend (only the first client will initialize it) when in collaborative mode and in the initialize method of the NotebookModel when we are not in collaborative mode.

Actually, the initialization of documents doesn't have a good solution due to having the document registry in the frontend with all the information regarding the documents.

I will remove the static methods.

hbcarlos · 2022-10-27T10:53:05Z

packages/notebook/src/model.ts

-    this._ensureMetadata();
-    this._metadata.changed.connect(this._onMetadataChanged, this);
-    this._deletedCells = [];
+    this._ensureMetadata(options.languagePreference ?? '');


We should not modify the YNotebook here. Instead, we should do it on the backend and NotebookModel.initialize. Otherwise, we are re-initializing the metadata every time a new client joins.

The problem, the languagePreference is only available in the frontend.

Same as here

packages/docregistry/src/default.ts

packages/cells/src/model.ts

jtpio · 2022-11-18T09:58:17Z

Break api for dealing with metadata for cells and notebook as it is not a observable json any longer.
CellModel and AttachementCellModel are now an abstract classes as the constructor does not need to access the cell type.

There doesn't seem to be an update to the extension migration guide as part of this update: https://jupyterlab.readthedocs.io/en/latest/extension/extension_migration.html#api-breaking-changes

Were you planning to add something to this guide in a follow-up PR? Or maybe it's tracked in a separate issue?

hbcarlos · 2022-11-18T18:15:18Z

@jtpio We are still making some changes to the API. I'll take care of documenting everything once we have a final version of the changes we need for Lab v4.0

jtpio · 2022-11-22T08:45:44Z

Thanks @hbcarlos, I just noticed there is an issue about this for 3.6.0: #13332 👍

) * Allow new sections in notebooktools, and set the 'common tools' section as RankedPanel * Add a first version of the metadataform extension * Update schema for a more generic usage mode. Several keys anywhere in the metadata set can now be used in a single form. * Add a tsx file for the form itself * Some refactoring for a better readability * Add rjsf livevalidation and remove duplicate objects * Insert the new section before the advancedTools by default * Allows an extenal extension to register and use it own widget in form * Allows any RJSF ui options in settings * (1) Allows default values, which are not written in metadata if selected, and (2) clean empty nested object when a nested metadata is deleted * Allows enable some metadata depending on cell type * Improve the layout with templates and style * update packages and clean schema * update package files * Includes modification in metapackage * Automatic application of license header * Update packages/ui-components-extension/src/index.ts Rename registry constant Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com> * Wraps the renderer in an interface * Fix the callbacks on MetadataFormWidgets when an event occurred on Notebook * Avoid updating the form if the widget is hidden * Use common RJSF template objects between settings-editor and metadata-form * Fixing UI tests * Update Playwright Snapshots * Put together meta information associated to properties * Allow working on notebook level metadata * Add dependency to @jupyterlab/observables * prettier... * Allow using custom fields in addition of custom widgets * (1) Homogenizes registries and (2) revertes form update after updating metadata * updateMetadata method can now be called from a custom field, and can reload the form too * Fix integrity * Invert logic of showing modified from default * Allows external extension to update the properties of a form * (1) Allows adding field(s) in an existing form, from an extension, and (2) orders fields if a rank is provided * Refactoring of the setting's schema to match the ones from react-JSONschema-form (JSONSchema and uiSchema) * Add support for 'allOf' feature of RJSF, to bring the conditional fields * Send the whole metadataSchema to the form (after having removed the non relevent), instead of rebuilding the form schema * Add tests on metadataform schema * Split package in a singleton and an extension package * Add unit test on metadataFromWidget * Update packages/metadataform-extension/package.json Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com> * Update packages/metadataform-extension/package.json Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com> * Update packages/metadataform/package.json Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com> * Update packages/metadataform/package.json Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com> * Update packages/metadataform/package.json Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com> * fix syntax and update dependencies * fix syntax * (1) Allow showing the default value when the current is not the default, and (2) allow avoiding writing default value to metadata * fix eslint * Update documentation snapshot * Update packages/metadataform/src/form.tsx Co-authored-by: Frédéric Collonval <fcollonval@users.noreply.github.com> * Update packages/metadataform/src/form.tsx Co-authored-by: Frédéric Collonval <fcollonval@users.noreply.github.com> * Update packages/metadataform/src/token.ts Co-authored-by: Frédéric Collonval <fcollonval@users.noreply.github.com> * Includes all options of MetadataFormWidget in one object * Include an interface for the object provided by the extension * Includes conditional fields when wondering metadataKeys * Update changes in usage of metadatada after #13247 * fix integrity * Fix metadataform tests * Fix metadataform ui-test * re-align version number * Bump to Jest 29 (follows #12584) * Fix Jest tests by adding 'nanoid' in ignored packages * Update Playwright Snapshots * Automatic application of license header * Update documentation snapshot Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com> Co-authored-by: foo <foo@bar.com> Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com> Co-authored-by: Frédéric Collonval <fcollonval@users.noreply.github.com>

fcollonval added api-change A change that should be accompanied by a major version increase enhancement tag:Real Time Collaboration labels Oct 14, 2022

github-actions bot assigned fcollonval Oct 14, 2022

github-actions bot added pkg:cells pkg:celltags pkg:codeeditor pkg:codemirror pkg:console pkg:debugger pkg:notebook pkg:shared-models labels Oct 14, 2022

fcollonval added this to the 4.0.0 milestone Oct 14, 2022

github-actions bot added pkg:completer tag:Testing labels Oct 25, 2022

fcollonval force-pushed the enh/drop-more-model-db branch from 1f35db5 to eeab398 Compare October 26, 2022 08:39

fcollonval marked this pull request as ready for review October 26, 2022 08:49

fcollonval requested a review from hbcarlos October 26, 2022 08:50

github-actions bot added the pkg:docregistry label Oct 26, 2022

hbcarlos reviewed Oct 27, 2022

View reviewed changes

fcollonval force-pushed the enh/drop-more-model-db branch from cf96848 to 7e73a83 Compare November 3, 2022 16:13

fcollonval added 8 commits November 4, 2022 09:05

Drop modelDB from code editor

6e75e01

Use dummy cellModel instead of real cell type

961dbe6

Only set metadata if there is a difference

98a0801

Only set tags when validating if it changes

a9530d2

Fix error when reloading a file

68fbf5e

Fix preserving selections when moving cells

d2503d3

Add tests for cell motion with selection

524c3fd

Fix CI error

8e2f78a

fcollonval and others added 7 commits November 4, 2022 09:05

Store cell id to restore state

4de49d4

Use fallback directly

8f5d7fa

Apply review suggestions

5d74d55

Fix restoring view state

3d04ba6

Initialize nbformat for new standalone notebook

fa288fb

Set the default source when inserting a new heading cell

726ce36

Lint the code

9f066a3

fcollonval force-pushed the enh/drop-more-model-db branch from 71ebeaa to 9f066a3 Compare November 4, 2022 08:06

fcollonval merged commit cb9551c into jupyterlab:master Nov 4, 2022

fcollonval deleted the enh/drop-more-model-db branch November 4, 2022 10:25

brichet added a commit to brichet/jupyterlab that referenced this pull request Nov 16, 2022

Update changes in usage of metadatada after jupyterlab#13247

664db99

jtpio mentioned this pull request Nov 18, 2022

Update to JupyterLab 4.0.0a31 jupyter/notebook#6627

Merged

11 tasks

brichet added a commit to brichet/jupyterlab that referenced this pull request Nov 28, 2022

Update changes in usage of metadatada after jupyterlab#13247

24e448c

brichet added a commit to brichet/jupyterlab that referenced this pull request Nov 30, 2022

Update changes in usage of metadatada after jupyterlab#13247

5a4d498

brichet added a commit to brichet/jupyterlab that referenced this pull request Dec 2, 2022

Update changes in usage of metadatada after jupyterlab#13247

c1c20a5

brichet added a commit to brichet/jupyterlab that referenced this pull request Dec 5, 2022

Update changes in usage of metadatada after jupyterlab#13247

9651316

brichet added a commit to brichet/jupyterlab that referenced this pull request Dec 6, 2022

Update changes in usage of metadatada after jupyterlab#13247

f995618

brichet added a commit to brichet/jupyterlab that referenced this pull request Dec 12, 2022

Update changes in usage of metadatada after jupyterlab#13247

fc4adcc

brichet added a commit to brichet/jupyterlab that referenced this pull request Dec 15, 2022

Update changes in usage of metadatada after jupyterlab#13247

b1d40be

brichet added a commit to brichet/jupyterlab that referenced this pull request Dec 20, 2022

Update changes in usage of metadatada after jupyterlab#13247

3300583

brichet added a commit to brichet/jupyterlab that referenced this pull request Dec 20, 2022

Update changes in usage of metadatada after jupyterlab#13247

261d761

brichet added a commit to brichet/jupyterlab that referenced this pull request Dec 21, 2022

Update changes in usage of metadatada after jupyterlab#13247

5dbe687

github-actions bot locked as resolved and limited conversation to collaborators Nov 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Drop modelDB from code editor #13247

Drop modelDB from code editor #13247

fcollonval commented Oct 14, 2022 •

edited

jupyterlab-probot bot commented Oct 14, 2022

hbcarlos left a comment

hbcarlos Oct 27, 2022

hbcarlos Oct 27, 2022

fcollonval Oct 28, 2022 •

edited

hbcarlos Oct 27, 2022

hbcarlos Oct 27, 2022

jtpio commented Nov 18, 2022

hbcarlos commented Nov 18, 2022

jtpio commented Nov 22, 2022

	this.sharedModel = YNotebook.create({
	disableDocumentWideUndoRedo: options.disableDocumentWideUndoRedo ?? false
	});

Drop modelDB from code editor #13247

Drop modelDB from code editor #13247

Conversation

fcollonval commented Oct 14, 2022 • edited

References

Code changes

User-facing changes

Backwards-incompatible changes

jupyterlab-probot bot commented Oct 14, 2022

hbcarlos left a comment

Choose a reason for hiding this comment

hbcarlos Oct 27, 2022

Choose a reason for hiding this comment

hbcarlos Oct 27, 2022

Choose a reason for hiding this comment

fcollonval Oct 28, 2022 • edited

Choose a reason for hiding this comment

hbcarlos Oct 27, 2022

Choose a reason for hiding this comment

hbcarlos Oct 27, 2022

Choose a reason for hiding this comment

jtpio commented Nov 18, 2022

hbcarlos commented Nov 18, 2022

jtpio commented Nov 22, 2022

fcollonval commented Oct 14, 2022 •

edited

fcollonval Oct 28, 2022 •

edited