Create tree plugin #1374

trungleduc · 2023-08-08T13:00:52Z

References

Closes #1372

Code changes

pyzmq is pinned to 25.1.0 on the Mac OS pipeline because 25.1.1 is not available as wheel yet on Mac OS

User-facing changes

The default tree page of Voila is now using the file browser widget of JupyterLab
The jinja-based tree page is still supported, but users need to activate it with the --classic-tree CLI option, the VoilaConfiguration.classic_tree config or ?classic-tree=True in the query string.
JupyterLab custom theme is supported with the new tree page, for the classic tree page, only the light and dark theme are supported.

Backwards-incompatible changes

Users need to activate the classic tree to use existing tree templates.

github-actions · 2023-08-08T13:01:05Z

👈 Launch a Binder on branch trungleduc/voila/tree-page

jtpio · 2023-08-09T12:39:01Z

@trungleduc you mentioned offline that interacting with the file browser items in this PR only requires 1 click, instead of the double click like in JupyterLab?

There is an issue to add this behavior in JupyterLab so that it could be configured, which would be especially useful for Notebook 7: jupyterlab/jupyterlab#14071

Do you think this could be implemented upstream? This could go in JupyterLab 4.1 as a new feature.

trungleduc · 2023-08-09T12:44:58Z

@trungleduc you mentioned offline that interacting with the file browser items in this PR only requires 1 click, instead of the double click like in JupyterLab?

There is an issue to add this behavior in JupyterLab so that it could be configured, which would be especially useful for Notebook 7: jupyterlab/jupyterlab#14071

Do you think this could be implemented upstream? This could go in JupyterLab 4.1 as a new feature.

I was able to implement this feature since in the case of voila, I don't need other interactions like multiple selections or drag/drop. So I just need to overwrite the single click handler and disable all others.

Upstreaming this is not a technical problem but I think we need more UX studies before adding the single click behavior to Lab.

jtpio · 2023-08-09T12:46:56Z

packages/voila/src/plugins/tree/listing.ts

+  }
+
+  handleEvent(event: Event): void {
+    if (event.type === 'click') {


Maybe we can make this part configurable in JupyterLab:

https://github.com/jupyterlab/jupyterlab/blob/7678e68391c5f372cb29749389f176c103716cea/packages/filebrowser/src/listing.ts#L690-L692

jtpio · 2023-08-09T12:48:20Z

Upstreaming this is not a technical problem but I think we need more UX studies before adding the single click behavior to Lab.

Maybe it would be fine if it is behind a user setting (opt-in)?

trungleduc · 2023-08-09T12:57:00Z

Upstreaming this is not a technical problem but I think we need more UX studies before adding the single click behavior to Lab.

Maybe it would be fine if it is behind a user setting (opt-in)?

Indeed, I've just realized that we don't have any advanced interactions (drag/drop, ...) in the Notebook v6 browser. I'll open a PR after finishing this one.

I'll keep the implementation here to release Voila ASAP and will reuse the upstream version once it's released.

jtpio · 2023-08-09T12:58:57Z

Indeed, I've just realized that we don't have any advanced interactions (drag/drop, ...) in the Notebook v6 browser. I'll open a PR after finishing this one.

Yes, and in Notebook 7 we can use the checkboxes to select multiple items.

I'll keep the implementation here to release Voila ASAP and will reuse the upstream version once it's released.

Makes sense, it might take a little while to get this released in JupyterLab.

Thanks!

trungleduc · 2023-08-09T15:26:39Z

Please update galata references

voila/app.py

voila/treehandler.py

Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com>

trungleduc · 2023-08-10T09:16:27Z

Please update galata references

trungleduc · 2023-08-10T11:55:51Z

@jtpio could you re-take a look at this PR? I will release RC after this PR and update the documentation after that.

jtpio · 2023-08-10T13:07:38Z

.github/workflows/main.yml

@@ -84,7 +84,8 @@ jobs:

      - name: Create the conda environment
        shell: bash -l {0}
-        run: mamba install -q python=${{ matrix.python_version }} pip jupyterlab_pygments==0.1.0 pytest-cov pytest-rerunfailures nodejs=18 yarn ipywidgets matplotlib xeus-cling "traitlets>=5.0.3,<6" ipykernel
+        # TODO unpin pyzmq


What's the issue with pyzmq?

The 25.1.1 is not available as wheel yet on Mac OS

ah ok, maybe mentioning this in the comment could be useful for later when we get back to it?

I meant next to the TODO, or in a new issue.

voila/configuration.py

jtpio · 2023-08-10T13:17:16Z

update the documentation after that.

Nice. Maybe a note in the changelog (as a highlight) would also be useful (but could also be done later).

edit: opened #1377

Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com>

jtpio · 2023-08-10T14:01:48Z

voila/app.py

@@ -671,6 +680,13 @@ def init_handlers(self) -> List:
                        "no_cache_paths": ["/"],
                    },
                ),
+                (
+                    url_path_join(
+                        self.server_url, r"/voila/api/contents%s" % path_regex


Curious: could exposing this endpoint allow someone access the content of other files on disk when they are not supposed to? For example when starting voila with voila basics.ipynb and trying to access another notebook via this endpoint?

Indeed this endpoint is leaking the file structure (not the content) of the current working directory in the case of starting Voila with one notebook, I'll fix it.

ok thanks for confirming 👍

Fixed by 9c48666

jtpio

Looks good, thanks!

And CI all green.

Create tree plugin

c7082ad

trungleduc added the enhancement New feature or request label Aug 8, 2023

trungleduc added this to the 0.5.0 milestone Aug 8, 2023

Update style

9e2e567

jtpio reviewed Aug 9, 2023

View reviewed changes

trungleduc added 2 commits August 9, 2023 15:59

Add classic tree setting

8ef7f49

Update UI test

cf122ea

Update Playwright Snapshots

83b21a5

trungleduc closed this Aug 9, 2023

trungleduc reopened this Aug 9, 2023

jtpio reviewed Aug 10, 2023

View reviewed changes

voila/app.py Outdated Show resolved Hide resolved

jtpio reviewed Aug 10, 2023

View reviewed changes

voila/treehandler.py Outdated Show resolved Hide resolved

trungleduc and others added 3 commits August 10, 2023 10:36

Apply suggestions from code review

9819466

Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com>

Update test

ab0786b

Pin pyzmq

ec256cd

Update snapshot

2742e05

trungleduc marked this pull request as ready for review August 10, 2023 10:17

jtpio self-requested a review August 10, 2023 12:18

jtpio reviewed Aug 10, 2023

View reviewed changes

voila/configuration.py Outdated Show resolved Hide resolved

jtpio mentioned this pull request Aug 10, 2023

User facing changelog for the 0.5.0 release #1377

Closed

[skip ci] Update voila/configuration.py

98ddec3

Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com>

trungleduc mentioned this pull request Aug 10, 2023

pyzmq is pinned to 25.1.0 in the Mac OS pipeline #1380

Open

jtpio closed this Aug 10, 2023

jtpio reopened this Aug 10, 2023

jtpio reviewed Aug 10, 2023

View reviewed changes

Fix leakage contents

9c48666

trungleduc force-pushed the tree-page branch from 2d82e69 to 9c48666 Compare August 10, 2023 15:19

jtpio approved these changes Aug 10, 2023

View reviewed changes

trungleduc merged commit 8a46a25 into voila-dashboards:main Aug 10, 2023
25 checks passed

jtpio mentioned this pull request Sep 28, 2023

Allow single-click navigation in the file browser jupyterlab/jupyterlab#14071

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create tree plugin #1374

Create tree plugin #1374

trungleduc commented Aug 8, 2023 •

edited

github-actions bot commented Aug 8, 2023

jtpio commented Aug 9, 2023

trungleduc commented Aug 9, 2023

jtpio Aug 9, 2023

jtpio commented Aug 9, 2023

trungleduc commented Aug 9, 2023

jtpio commented Aug 9, 2023

trungleduc commented Aug 9, 2023

trungleduc commented Aug 10, 2023

trungleduc commented Aug 10, 2023

jtpio Aug 10, 2023

trungleduc Aug 10, 2023 •

edited

jtpio Aug 10, 2023

trungleduc Aug 10, 2023

jtpio Aug 10, 2023

trungleduc Aug 10, 2023

jtpio commented Aug 10, 2023 •

edited

jtpio Aug 10, 2023

trungleduc Aug 10, 2023

jtpio Aug 10, 2023

trungleduc Aug 10, 2023

jtpio left a comment

Create tree plugin #1374

Create tree plugin #1374

Conversation

trungleduc commented Aug 8, 2023 • edited

References

Code changes

User-facing changes

Backwards-incompatible changes

github-actions bot commented Aug 8, 2023

jtpio commented Aug 9, 2023

trungleduc commented Aug 9, 2023

Choose a reason for hiding this comment

jtpio commented Aug 9, 2023

trungleduc commented Aug 9, 2023

jtpio commented Aug 9, 2023

trungleduc commented Aug 9, 2023

trungleduc commented Aug 10, 2023

trungleduc commented Aug 10, 2023

Choose a reason for hiding this comment

trungleduc Aug 10, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtpio commented Aug 10, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtpio left a comment

Choose a reason for hiding this comment

trungleduc commented Aug 8, 2023 •

edited

trungleduc Aug 10, 2023 •

edited

jtpio commented Aug 10, 2023 •

edited