Fix the handling of the file browser configuration (jupyterlab#16870)

* Fix setting of the file browser defaults * Move handling of the file browser settings to a separate plugin * add docstring * rename plugin * add description * handle no settingRegistry * fix settings * keep same logic as before * keep previous assignment * Update Playwright Snapshots * Update Playwright Snapshots * revert partial snapshot update * update example snapshots * more snapshot update * simplify * Update packages/filebrowser-extension/src/index.ts Co-authored-by: Michał Krassowski <[email protected]> --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Michał Krassowski <[email protected]>
synopkg · Oct 21, 2024 · d6f97bd · d6f97bd
1 parent 48691c6
commit d6f97bd
Show file tree

Hide file tree

Showing 19 changed files with 51 additions and 41 deletions.
diff --git a/examples/app/example.spec.ts-snapshots/example-linux.png b/examples/app/example.spec.ts-snapshots/example-linux.png
diff --git a/examples/federated/example.spec.ts-snapshots/example-linux.png b/examples/federated/example.spec.ts-snapshots/example-linux.png
diff --git a/...umentation/custom_css.test.ts-snapshots/custom-css-main-documentation-linux.png b/...umentation/custom_css.test.ts-snapshots/custom-css-main-documentation-linux.png
diff --git a/...ion/customization.test.ts-snapshots/customized-menu-bar-documentation-linux.png b/...ion/customization.test.ts-snapshots/customized-menu-bar-documentation-linux.png
diff --git a/...n.test.ts-snapshots/customized-terminal-position-single-documentation-linux.png b/...n.test.ts-snapshots/customized-terminal-position-single-documentation-linux.png
diff --git a/...tation/customization.test.ts-snapshots/default-menu-bar-documentation-linux.png b/...tation/customization.test.ts-snapshots/default-menu-bar-documentation-linux.png
diff --git a/...tion.test.ts-snapshots/default-terminal-position-single-documentation-linux.png b/...tion.test.ts-snapshots/default-terminal-position-single-documentation-linux.png
diff --git a/.../documentation/general.test.ts-snapshots/interface-left-documentation-linux.png b/.../documentation/general.test.ts-snapshots/interface-left-documentation-linux.png
diff --git a/...test/documentation/general.test.ts-snapshots/jupyterlab-documentation-linux.png b/...test/documentation/general.test.ts-snapshots/jupyterlab-documentation-linux.png
diff --git a/...documentation/general.test.ts-snapshots/terminal-layout-documentation-linux.png b/...documentation/general.test.ts-snapshots/terminal-layout-documentation-linux.png
diff --git a/...internationalization.test.ts-snapshots/language-chinese-documentation-linux.png b/...internationalization.test.ts-snapshots/language-chinese-documentation-linux.png
diff --git a/...ntation/overview.test.ts-snapshots/interface-jupyterlab-documentation-linux.png b/...ntation/overview.test.ts-snapshots/interface-jupyterlab-documentation-linux.png
diff --git a/galata/test/documentation/plugins.test.ts-snapshots/plugins-documentation-linux.json b/galata/test/documentation/plugins.test.ts-snapshots/plugins-documentation-linux.json
@@ -89,7 +89,8 @@
   "@jupyterlab/extensionmanager-extension:plugin": "Adds the extension manager plugin.",
   "@jupyterlab/filebrowser-extension:factory": "Provides the file browser factory.",
   "@jupyterlab/filebrowser-extension:default-file-browser": "Provides the default file browser",
-  "@jupyterlab/filebrowser-extension:browser": "Set up the default file browser (commands, settings,...).",
+  "@jupyterlab/filebrowser-extension:browser": "Set up the default file browser commands",
+  "@jupyterlab/filebrowser-extension:settings": "Set up the default file browser settings",
   "@jupyterlab/filebrowser-extension:share-file": "Adds the \"Copy Shareable Link\" command; useful for JupyterHub deployment for example.",
   "@jupyterlab/filebrowser-extension:file-upload-status": "Adds a file upload status widget.",
   "@jupyterlab/filebrowser-extension:download": "Adds the download file commands. Disabling this plugin will NOT disable downloading files from the server, if the user enters the appropriate download URLs.",

diff --git a/galata/test/jupyterlab/general.test.ts-snapshots/dark-theme-jupyterlab-linux.png b/galata/test/jupyterlab/general.test.ts-snapshots/dark-theme-jupyterlab-linux.png
diff --git a/galata/test/jupyterlab/general.test.ts-snapshots/launch-jupyterlab-linux.png b/galata/test/jupyterlab/general.test.ts-snapshots/launch-jupyterlab-linux.png
diff --git a/galata/test/jupyterlab/general.test.ts-snapshots/simple-mode-jupyterlab-linux.png b/galata/test/jupyterlab/general.test.ts-snapshots/simple-mode-jupyterlab-linux.png
diff --git a/...st/jupyterlab/sidebars.test.ts-snapshots/filebrowser-right-jupyterlab-linux.png b/...st/jupyterlab/sidebars.test.ts-snapshots/filebrowser-right-jupyterlab-linux.png
diff --git a/...rlab/sidebars.test.ts-snapshots/opened-sidebar-filebrowser-jupyterlab-linux.png b/...rlab/sidebars.test.ts-snapshots/opened-sidebar-filebrowser-jupyterlab-linux.png
diff --git a/packages/filebrowser-extension/src/index.ts b/packages/filebrowser-extension/src/index.ts
@@ -160,7 +160,7 @@ const namespace = 'filebrowser';
  */
 const browser: JupyterFrontEndPlugin<IFileBrowserCommands> = {
   id: FILE_BROWSER_PLUGIN_ID,
-  description: 'Set up the default file browser (commands, settings,...).',
+  description: 'Set up the default file browser commands and state restoration',
   requires: [IDefaultFileBrowser, IFileBrowserFactory, ITranslator],
   optional: [
     ILayoutRestorer,
@@ -213,52 +213,60 @@ const browser: JupyterFrontEndPlugin<IFileBrowserCommands> = {
           treePathUpdater(args.newValue);
         });
       }
-
-      if (settingRegistry) {
-        void settingRegistry.load(FILE_BROWSER_PLUGIN_ID).then(settings => {
-          /**
-           * File browser configuration.
-           */
-          const fileBrowserConfig = {
-            navigateToCurrentDirectory: false,
-            singleClickNavigation: false,
-            showLastModifiedColumn: true,
-            showFileSizeColumn: false,
-            showHiddenFiles: false,
-            showFileCheckboxes: false,
-            sortNotebooksFirst: false,
-            showFullPath: false
-          };
-          const fileBrowserModelConfig = {
-            filterDirectories: true
-          };
-
-          function onSettingsChanged(
-            settings: ISettingRegistry.ISettings
-          ): void {
-            let key: keyof typeof fileBrowserConfig;
-            for (key in fileBrowserConfig) {
-              const value = settings.get(key).composite as boolean;
-              fileBrowserConfig[key] = value;
-              browser[key] = value;
-            }
-
-            const value = settings.get('filterDirectories')
-              .composite as boolean;
-            fileBrowserModelConfig.filterDirectories = value;
-            browser.model.filterDirectories = value;
-          }
-          settings.changed.connect(onSettingsChanged);
-          onSettingsChanged(settings);
-        });
-      }
     });
     return {
       openPath: CommandIDs.openPath
     };
   }
 };
 
+/**
+ * Handle the file browser settings taking into account user defined settings.
+ */
+const browserSettings: JupyterFrontEndPlugin<void> = {
+  id: '@jupyterlab/filebrowser-extension:settings',
+  description: 'Set up the default file browser settings',
+  requires: [IDefaultFileBrowser],
+  optional: [ISettingRegistry],
+  autoStart: true,
+  activate: (
+    app: JupyterFrontEnd,
+    browser: IDefaultFileBrowser,
+    settingRegistry: ISettingRegistry | null
+  ) => {
+    if (settingRegistry) {
+      void settingRegistry.load(FILE_BROWSER_PLUGIN_ID).then(settings => {
+        /**
+         * File browser default configuration.
+         */
+        const defaultFileBrowserConfig = {
+          navigateToCurrentDirectory: false,
+          singleClickNavigation: false,
+          showLastModifiedColumn: true,
+          showFileSizeColumn: false,
+          showHiddenFiles: false,
+          showFileCheckboxes: false,
+          sortNotebooksFirst: false,
+          showFullPath: false
+        };
+
+        function onSettingsChanged(settings: ISettingRegistry.ISettings): void {
+          let key: keyof typeof defaultFileBrowserConfig;
+          for (key in defaultFileBrowserConfig) {
+            const value = settings.get(key).composite as boolean;
+            browser[key] = value;
+          }
+
+          const value = settings.get('filterDirectories').composite as boolean;
+          browser.model.filterDirectories = value;
+        }
+        settings.changed.connect(onSettingsChanged);
+        onSettingsChanged(settings);
+      });
+    }
+  }
+};
+
 /**
  * The default file browser factory provider.
  */
@@ -1377,6 +1385,7 @@ const plugins: JupyterFrontEndPlugin<any>[] = [
   factory,
   defaultFileBrowser,
   browser,
+  browserSettings,
   shareFile,
   fileUploadStatus,
   downloadPlugin,