Merge pull request #7695 from afshin/issue-4009

Restore default file browser manually.
jupyterlab · Jan 2, 2020 · 35cdd43 · 35cdd43
2 parents 065be47 + 435c61e
commit 35cdd43
Show file tree

Hide file tree

Showing 4 changed files with 81 additions and 45 deletions.
diff --git a/packages/filebrowser-extension/src/index.ts b/packages/filebrowser-extension/src/index.ts
@@ -224,6 +224,7 @@ async function activateFactory(
     options: IFileBrowserFactory.IOptions = {}
   ) => {
     const model = new FileBrowserModel({
+      auto: options.auto ?? true,
       iconRegistry: icoReg,
       manager: docManager,
       driveName: options.driveName || '',
@@ -250,42 +251,14 @@ async function activateFactory(
     return widget;
   };
 
-  // Manually restore the default file browser.
-  const id = 'filebrowser';
-  const defaultBrowser = createFileBrowser(id, { restore: false });
-  const plugin = { createFileBrowser, defaultBrowser, tracker };
-  const restoring = 'jp-mod-restoring';
-
-  defaultBrowser.addClass(restoring);
-
-  if (!router) {
-    void defaultBrowser.model.restore(id).then(() => {
-      defaultBrowser.removeClass(restoring);
-    });
-    return plugin;
-  }
-
-  const listener = async () => {
-    router.routed.disconnect(listener);
-
-    const paths = await tree?.paths;
-    if (paths) {
-      // Restore the model without populating it.
-      await defaultBrowser.model.restore(id, false);
-      if (paths.file) {
-        await commands.execute(CommandIDs.openPath, { path: paths.file });
-      }
-      if (paths.browser) {
-        await commands.execute(CommandIDs.openPath, { path: paths.browser });
-      }
-    } else {
-      await defaultBrowser.model.restore(id);
-    }
-    defaultBrowser.removeClass(restoring);
-  };
-  router.routed.connect(listener);
+  // Manually restore and load the default file browser.
+  const defaultBrowser = createFileBrowser('filebrowser', {
+    auto: false,
+    restore: false
+  });
+  void Private.restoreBrowser(defaultBrowser, commands, router, tree);
 
-  return plugin;
+  return { createFileBrowser, defaultBrowser, tracker };
 }
 
 /**
@@ -1089,4 +1062,46 @@ namespace Private {
     }
     return item;
   }
+
+  /**
+   * Restores file browser state and overrides state if tree resolver resolves.
+   */
+  export async function restoreBrowser(
+    browser: FileBrowser,
+    commands: CommandRegistry,
+    router: IRouter | null,
+    tree: JupyterFrontEnd.ITreeResolver | null
+  ): Promise<void> {
+    const restoring = 'jp-mod-restoring';
+
+    browser.addClass(restoring);
+
+    if (!router) {
+      await browser.model.restore(browser.id);
+      await browser.model.refresh();
+      browser.removeClass(restoring);
+      return;
+    }
+
+    const listener = async () => {
+      router.routed.disconnect(listener);
+
+      const paths = await tree?.paths;
+      if (paths?.file || paths?.browser) {
+        // Restore the model without populating it.
+        await browser.model.restore(browser.id, false);
+        if (paths.file) {
+          await commands.execute(CommandIDs.openPath, { path: paths.file });
+        }
+        if (paths.browser) {
+          await commands.execute(CommandIDs.openPath, { path: paths.browser });
+        }
+      } else {
+        await browser.model.restore(browser.id);
+        await browser.model.refresh();
+      }
+      browser.removeClass(restoring);
+    };
+    router.routed.connect(listener);
+  }
 }
diff --git a/packages/filebrowser/src/browser.ts b/packages/filebrowser/src/browser.ts
@@ -313,8 +313,11 @@ export namespace FileBrowser {
 
     /**
      * Whether a file browser automatically restores state when instantiated.
-     *
      * The default is `true`.
+     *
+     * #### Notes
+     * The file browser model will need to be restored before for the file
+     * browser to start saving its state.
      */
     restore?: boolean;
   }

diff --git a/packages/filebrowser/src/model.ts b/packages/filebrowser/src/model.ts
@@ -101,6 +101,8 @@ export class FileBrowserModel implements IDisposable {
     };
     window.addEventListener('beforeunload', this._unloadEventListener);
     this._poll = new Poll({
+      auto: options.auto ?? true,
+      name: '@jupyterlab/filebrowser:Model',
       factory: () => this.cd('.'),
       frequency: {
         interval: refreshInterval,
@@ -656,14 +658,10 @@ export namespace FileBrowserModel {
    */
   export interface IOptions {
     /**
-     * An icon registry instance.
+     * Whether a file browser automatically loads its initial path.
+     * The default is `true`.
      */
-    iconRegistry: IIconRegistry;
-
-    /**
-     * A document manager instance.
-     */
-    manager: IDocumentManager;
+    auto?: boolean;
 
     /**
      * An optional `Contents.IDrive` name for the model.
@@ -672,6 +670,16 @@ export namespace FileBrowserModel {
      */
     driveName?: string;
 
+    /**
+     * An icon registry instance.
+     */
+    iconRegistry: IIconRegistry;
+
+    /**
+     * A document manager instance.
+     */
+    manager: IDocumentManager;
+
     /**
      * The time interval for browser refreshing, in ms.
      */

diff --git a/packages/filebrowser/src/tokens.ts b/packages/filebrowser/src/tokens.ts
@@ -71,6 +71,14 @@ export namespace IFileBrowserFactory {
    * state database.
    */
   export interface IOptions {
+    /**
+     * Whether a file browser automatically loads its initial path.
+     *
+     * #### Notes
+     * The default is `true`.
+     */
+    auto?: boolean;
+
     /**
      * An optional `Contents.IDrive` name for the model.
      * If given, the model will prepend `driveName:` to
@@ -84,10 +92,12 @@ export namespace IFileBrowserFactory {
     refreshInterval?: number;
 
     /**
-     * Whether to restore the file browser state after instantiation.
+     * Whether a file browser automatically restores state when instantiated.
+     * The default is `true`.
      *
      * #### Notes
-     * The default value is `true`.
+     * The file browser model will need to be restored before for the file
+     * browser to start saving its state.
      */
     restore?: boolean;