Tree view enhancement #6588

brichet · 2022-10-17T15:28:14Z

This PR improves the tree view by:

~~activating by default all newly created tabs.~~
adding a command to open the file browser tab. This is useful when another tab send the command go-to-path, now the file browser is activated after the path has changed.

github-actions · 2022-10-17T15:28:27Z

👈 Launch a Binder on branch brichet/notebook/tree-view-enhancement

jtpio · 2022-10-18T07:22:23Z

packages/application-extension/src/index.ts

-        window.open(`${baseUrl}tree`);
-      }
-    });
+    if (PageConfig.getOption('notebookPage') !== 'tree') {


Wondering if we need this check, or simply let folks open the file browser again if they want?

In fact the filebrowser-extension already adds an entry in menu View:
https://github.com/jupyterlab/jupyterlab/blob/fc3f6ab716ef82944ab6c4e5d1a06418daad49dc/packages/filebrowser-extension/schema/browser.json#L24-L29
That would be a duplicated entry, one to switch to file browser tab, and one to open a new page.
This is also why I renamed the Open Files entry to File Browser, for consistency with the JupyterLab one.

In that case maybe it would useful to use isVisible when defining this command? So it's available on all pages of the notebook application in case some other extensions need it, but not visible on the notebook page if desired.

Thanks, I didn't know about that one.
I just realized that clicking on the same menu entry File Browser when the file browser is activated try to call filebrowser:hide, which is not currently defined in notebook. This raises an error in console.
Do you think we should defined the command filebrowser:hide without any action, to avoid the error ?

Does it? I just tried with this menu entry on Binder but it does not seem to be printing anything:

On binder too I have this error message in the console, when the file browser is already activated before clicking on the link:

The command added by JupyterLab is filebrowser:toggle-main, which calls filebrowser:activate or filebrowser:hide-main depending on the isHidden status. Maybe it is not triggered every time for some reason.

BTW I changed the way this command is defined (using isVisible) in 375ebd3

Do you think we should defined the command filebrowser:hide without any action, to avoid the error ?

We could also make the file browser tab 'closeable' and define properly the command filebrowser:hide.
Not sure this is expected for Jupyter Notebook, that may change a bit the philosophy.

I guess users might indeed close it by mistake and won't know what to do.

You are right.
It can be solved by fixing it in JupyterLab, as explain below: suppress the filebrowser:toggle-main entry from menu and create one only for filebrowser:activate.

packages/tree/src/notebook-tree.ts

jtpio · 2022-10-28T14:40:27Z

packages/application-extension/src/index.ts

-        window.open(`${baseUrl}tree`);
-      }
-    });
+    if (!app.commands.isVisible('filebrowser:toggle-main')) {


I was more wondering whether it would be possible to define isVisible as part of the command definition below.

@brichet would you mind posting a summary of what the intended behavior should be, to make sure I understand correctly? Thanks!

I may be confused about that, I'll try to clarify.

There are 2 different things:

1- What I was expected at first was a command to activate the file browser in tree view from another tab. For example nbgrader brings some tabs with links which open a path in file browser, using filebrowser:go-to-path command. This command already exists in tree view, it is created when importing the plugin '@jupyterlab/filebrowser-extension:browser'. But at the end, this command call the command filebrowser:activate, which is not registered in Notebook yet. The result is that the path is opened but the file browser tab is not activated, so it look like nothing happened for user.
This is fixed with the command below.

2- The plugin '@jupyterlab/filebrowser-extension:browser' also bring a command filebrowser:toggle-main, with a menu entry called Open Files, which call filebrowser:activate or filebrowser:hide-main depending on the file browser status. I thought we could use this entry already existing in tree view to open the file browser tab, instead of creating a new one which may be confusing.

Maybe the good thing to do is:

modifying the creation of the command filebrowser:toggle-main in JupyterLab, to register it (and create menu entry) in the plugin '@jupyterlab/filebrowser-extension:browserWidget' instead of '@jupyterlab/filebrowser-extension:browser'. this would avoid importing it in Notebook and having this menu entry by default in tree view.

creating a menu entry to open the file browser tab in Notebook when we create the command 'filebrowser:activate'.

creating the menu entry to open a new tree view page only if the previous one does not exists (as you said).

Hope it clarifies.

jtpio · 2022-10-28T14:40:39Z

packages/tree-extension/src/index.ts

+    factory: IFileBrowserFactory
+  ) => {
+    const { commands } = app;
+    commands.addCommand('filebrowser:activate', {


Defining a filebrowser:activate command to activate the filebrowser sounds fine though 👍

… fixes the broken menu entry 'file Browser' in view

…g a new browser tab with the same contents, and was like a duplication of 'File Browser' entry, and (2) rename the menu entry 'Open Files' to 'File Browser' for consistency

…current page contains a filebrowser plugin)

…d before create a new one

… or other)

jtpio · 2023-01-11T16:04:10Z

packages/application-extension/src/index.ts

      execute: () => {
-        window.open(`${baseUrl}tree`);
+        if (page === 'tree') {
+          app.commands.execute(filebrowserCommandIDs.activate);


To avoid bringing a dependency on @jupyter-notebook/tree for @jupyter-notebook/application-extension, maybe we should just use the filebrowser:activate string here directly?

For example this is what is done in the JupyterLab docmanager-extension, using a command defined in another plugin: https://github.com/jupyterlab/jupyterlab/blob/d614e293eb4b90055307828d5e81c9661e1147c9/packages/docmanager-extension/src/index.tsx#L1125

Sure, perhaps we should do the same in tree-extension:openFileBrowser and drop the CommandIDs namespace in tree.

EDIT: just saw the comment below.

jtpio · 2023-01-11T16:06:17Z

packages/tree/src/notebook-tree.ts

+/**
+ * The namespace for command IDs.
+ */
+export namespace CommandIDs {


With https://github.com/jupyter/notebook/pull/6588/files#r1067176298 above, these CommandIDs could be moved to the tree-extension package.

jtpio · 2023-01-11T17:28:22Z

packages/application-extension/package.json

@@ -40,6 +40,7 @@
  },
  "dependencies": {
    "@jupyter-notebook/application": "^7.0.0-alpha.10",
+    "@jupyter-notebook/tree": "^7.0.0-alpha.10",


Is this dependency still needed after the last commit?

Good catch, thanks

jtpio · 2023-01-11T17:46:08Z

packages/application-extension/src/index.ts

@@ -242,6 +242,11 @@ const menuSpacer: JupyterFrontEndPlugin<void> = {

 /**
 * Add commands to open the tree and running pages.
+ *
+ * ## NOTES:
+ * The optional token IFileBrowserCommands is useful to ensure the corresponding


Also this comment can probably be removed now.

jtpio

Thanks!

brichet · 2023-01-12T12:45:49Z

Thanks a lot for reviews @jtpio, especially since this PR was pretty confusing at first.

jtpio · 2023-01-19T13:46:57Z

FYI @brichet a new pre-release is now available, which includes this change: https://github.com/jupyter/notebook/releases/tag/v7.0.0a11

jtpio reviewed Oct 18, 2022

View reviewed changes

jtpio added this to the 7.0 milestone Oct 18, 2022

jtpio reviewed Oct 20, 2022

View reviewed changes

packages/tree/src/notebook-tree.ts Outdated Show resolved Hide resolved

jtpio added the enhancement label Oct 20, 2022

jtpio reviewed Oct 28, 2022

View reviewed changes

brichet mentioned this pull request Nov 22, 2022

Move the toggle file browser logic to the widget jupyterlab/jupyterlab#13466

Merged

brichet marked this pull request as draft December 7, 2022 08:28

brichet added 10 commits January 10, 2023 12:50

Opens by default the newly created tab in tree view

d1355a5

Adds a command to open the file browser when in tree view, which also…

ab9afa0

… fixes the broken menu entry 'file Browser' in view

(1) Remove the menu entry 'Open Files' in tree view, which was openin…

85d0849

…g a new browser tab with the same contents, and was like a duplication of 'File Browser' entry, and (2) rename the menu entry 'Open Files' to 'File Browser' for consistency

Add test on 'File Browser' menu entry

aa2861f

Fix pre-commit

219ff2c

Fix test on File Browser menu entry

0d0a0e0

update snapshots of view menu

f2fb9aa

Do not activate newly created tree tab by default

af53ab2

Do not add 'openTree' command if it already exists (meaning that the …

7c68346

…current page contains a filebrowser plugin)

Wait for the file browser commands from JupyterLab to be fully create…

441b957

…d before create a new one

brichet force-pushed the tree-view-enhancement branch 2 times, most recently from 7db0123 to fd3e8df Compare January 10, 2023 14:28

File Browser menu entry execution depends on the current page ('tree'…

2524344

… or other)

brichet force-pushed the tree-view-enhancement branch from fd3e8df to 2524344 Compare January 10, 2023 14:28

brichet marked this pull request as ready for review January 10, 2023 14:30

brichet added 2 commits January 10, 2023 16:10

Add the dependency to @jupyter-notebook/tree in application-extension

2bd478d

Fix typo

d46a28d

jtpio self-requested a review January 11, 2023 13:38

fcollonval assigned brichet Jan 11, 2023

jtpio reviewed Jan 11, 2023

View reviewed changes

Remove dependency to tree in application-extension

87458c4

jtpio reviewed Jan 11, 2023

View reviewed changes

Clean unused dependency

c16cfe2

jtpio reviewed Jan 11, 2023

View reviewed changes

Delete a remaining comment

f9ab05a

jtpio approved these changes Jan 12, 2023

View reviewed changes

jtpio merged commit a0b3a80 into jupyter:main Jan 12, 2023

brichet deleted the tree-view-enhancement branch January 12, 2023 14:10

github-actions bot locked as resolved and limited conversation to collaborators Jan 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tree view enhancement #6588

Tree view enhancement #6588

brichet commented Oct 17, 2022 •

edited

Loading

github-actions bot commented Oct 17, 2022

jtpio Oct 18, 2022

brichet Oct 18, 2022

jtpio Oct 20, 2022 •

edited

Loading

brichet Oct 20, 2022

jtpio Oct 23, 2022

brichet Oct 24, 2022 •

edited

Loading

brichet Oct 28, 2022

jtpio Oct 28, 2022

brichet Oct 28, 2022

jtpio Oct 28, 2022

jtpio Oct 28, 2022

brichet Oct 28, 2022

jtpio Oct 28, 2022

jtpio Jan 11, 2023

jtpio Jan 11, 2023

brichet Jan 11, 2023 •

edited

Loading

jtpio Jan 11, 2023

jtpio Jan 11, 2023

brichet Jan 11, 2023

jtpio Jan 11, 2023

jtpio left a comment

brichet commented Jan 12, 2023

jtpio commented Jan 19, 2023

Tree view enhancement #6588

Tree view enhancement #6588

Conversation

brichet commented Oct 17, 2022 • edited Loading

github-actions bot commented Oct 17, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtpio Oct 20, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brichet Oct 24, 2022 • edited Loading

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

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

brichet Jan 11, 2023 • edited Loading

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 left a comment

Choose a reason for hiding this comment

brichet commented Jan 12, 2023

jtpio commented Jan 19, 2023

brichet commented Oct 17, 2022 •

edited

Loading

jtpio Oct 20, 2022 •

edited

Loading

brichet Oct 24, 2022 •

edited

Loading

brichet Jan 11, 2023 •

edited

Loading