Bring jupyterlab-recents into the core

Co-authored-by: Frédéric Collonval <[email protected]>
Co-authored-by: Shreyas Cholia <[email protected]>
Co-authored-by: Matt Henderson <[email protected]>
Co-authored-by: Trevor Slaton <[email protected]>
Co-authored-by: Adrien Delsalle <[email protected]>

packages/docmanager-extension/package.json

@@ -45,6 +45,7 @@
     "@jupyterlab/docregistry": "^4.1.0-alpha.3",
     "@jupyterlab/services": "^7.1.0-alpha.3",
     "@jupyterlab/settingregistry": "^4.1.0-alpha.3",
+    "@jupyterlab/statedb": "^4.1.0-alpha.3",
     "@jupyterlab/statusbar": "^4.1.0-alpha.3",
     "@jupyterlab/translation": "^4.1.0-alpha.3",
     "@jupyterlab/ui-components": "^4.1.0-alpha.3",

packages/docmanager-extension/schema/plugin.json

@@ -149,6 +149,13 @@
       "title": "Rename Untitled File On First Save",
       "description": "Whether to prompt to rename untitled file on first manual save.",
       "default": true
+    },
+    "maximalRecents": {
+      "type": "number",
+      "title": "Recent Items Number",
+      "description": "Number of recently opened/closed files and directories to remember.",
+      "default": 10,
+      "minimum": 0
     }
   },
   "additionalProperties": false,

packages/docmanager-extension/src/index.tsx

@@ -31,6 +31,7 @@ import {
   DocumentManager,
   IDocumentManager,
   IDocumentWidgetOpener,
+  IRecentsManager,
   PathStatus,
   renameDialog,
   SavingStatus
@@ -52,6 +53,7 @@ import { IDisposable } from '@lumino/disposable';
 import { ISignal, Signal } from '@lumino/signaling';
 import { Widget } from '@lumino/widgets';
 import * as React from 'react';
+import { recentsManagerPlugin } from './recents';
 
 /**
  * The command IDs used by the document manager plugin.
@@ -168,14 +170,21 @@ const manager: JupyterFrontEndPlugin<IDocumentManager> = {
   description: 'Provides the document manager.',
   provides: IDocumentManager,
   requires: [IDocumentWidgetOpener],
-  optional: [ITranslator, ILabStatus, ISessionContextDialogs, JupyterLab.IInfo],
+  optional: [
+    ITranslator,
+    ILabStatus,
+    ISessionContextDialogs,
+    JupyterLab.IInfo,
+    IRecentsManager
+  ],
   activate: (
     app: JupyterFrontEnd,
     widgetOpener: IDocumentWidgetOpener,
     translator_: ITranslator | null,
     status: ILabStatus | null,
     sessionDialogs_: ISessionContextDialogs | null,
-    info: JupyterLab.IInfo | null
+    info: JupyterLab.IInfo | null,
+    recentsManager: IRecentsManager | null
   ) => {
     const { serviceManager: manager, docRegistry: registry } = app;
     const translator = translator_ ?? nullTranslator;
@@ -196,7 +205,8 @@ const manager: JupyterFrontEndPlugin<IDocumentManager> = {
           return info.isConnected;
         }
         return true;
-      }
+      },
+      recentsManager: recentsManager ?? undefined
     });
 
     return docManager;
@@ -556,7 +566,8 @@ const plugins: JupyterFrontEndPlugin<any>[] = [
   savingStatusPlugin,
   downloadPlugin,
   openBrowserTabPlugin,
-  openerPlugin
+  openerPlugin,
+  recentsManagerPlugin
 ];
 export default plugins;
 

packages/docmanager-extension/src/recents.ts

@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+import {
+  JupyterFrontEnd,
+  JupyterFrontEndPlugin
+} from '@jupyterlab/application';
+import { IRecentsManager, RecentsManager } from '@jupyterlab/docmanager';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { IStateDB } from '@jupyterlab/statedb';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+
+/**
+ * A namespace for command IDs.
+ */
+namespace CommandIDs {
+  export const clearRecents = 'docmanager:clear-recents';
+}
+
+namespace PluginIDs {
+  export const recentsManager = '@jupyterlab/docmanager-extension:recents';
+  export const mainPlugin = '@jupyterlab/docmanager-extension:plugin';
+}
+
+export const recentsManagerPlugin: JupyterFrontEndPlugin<IRecentsManager> = {
+  id: PluginIDs.recentsManager,
+  autoStart: true,
+  requires: [IStateDB],
+  optional: [ISettingRegistry, ITranslator],
+  provides: IRecentsManager,
+  activate: (
+    app: JupyterFrontEnd,
+    stateDB: IStateDB,
+    settingRegistry: ISettingRegistry | null,
+    translator: ITranslator | null
+  ): IRecentsManager => {
+    const { serviceManager } = app;
+    const trans = (translator ?? nullTranslator).load('jupyterlab');
+
+    // Create the manager
+    const recentsManager = new RecentsManager({
+      stateDB: stateDB,
+      contents: serviceManager.contents
+    });
+
+    const updateSettings = (settings: ISettingRegistry.ISettings) => {
+      recentsManager.maximalRecentsLength = settings.get('maximalRecents')
+        .composite as number;
+    };
+
+    if (settingRegistry) {
+      Promise.all([
+        app.restored,
+        settingRegistry.load(PluginIDs.mainPlugin)
+      ]).then(([_, settings]) => {
+        settings.changed.connect(updateSettings);
+        updateSettings(settings);
+      });
+    }
+
+    app.commands.addCommand(CommandIDs.clearRecents, {
+      execute: () => {
+        recentsManager.clearRecents();
+      },
+      label: trans.__('Clear Recently Opened'),
+      caption: trans.__('Clear the list of recently opened items.')
+    });
+
+    return recentsManager;
+  }
+};

packages/docmanager-extension/tsconfig.json

@@ -27,6 +27,9 @@
     {
       "path": "../settingregistry"
     },
+    {
+      "path": "../statedb"
+    },
     {
       "path": "../statusbar"
     },

packages/docmanager/package.json

@@ -46,13 +46,15 @@
     "@jupyterlab/coreutils": "^6.1.0-alpha.3",
     "@jupyterlab/docregistry": "^4.1.0-alpha.3",
     "@jupyterlab/services": "^7.1.0-alpha.3",
+    "@jupyterlab/statedb": "^4.1.0-alpha.3",
     "@jupyterlab/statusbar": "^4.1.0-alpha.3",
     "@jupyterlab/translation": "^4.1.0-alpha.3",
     "@jupyterlab/ui-components": "^4.1.0-alpha.3",
     "@lumino/algorithm": "^2.0.1",
     "@lumino/coreutils": "^2.1.2",
     "@lumino/disposable": "^2.1.2",
     "@lumino/messaging": "^2.0.1",
+    "@lumino/polling": "^2.1.2",
     "@lumino/properties": "^2.0.1",
     "@lumino/signaling": "^2.1.2",
     "@lumino/widgets": "^2.3.1",

packages/docmanager/src/index.ts

@@ -12,3 +12,4 @@ export * from './savehandler';
 export * from './savingstatus';
 export * from './tokens';
 export * from './widgetmanager';
+export * from './recents';

packages/docmanager/src/manager.ts

@@ -17,7 +17,11 @@ import { AttachedProperty } from '@lumino/properties';
 import { ISignal, Signal } from '@lumino/signaling';
 import { Widget } from '@lumino/widgets';
 import { SaveHandler } from './savehandler';
-import { IDocumentManager, IDocumentWidgetOpener } from './tokens';
+import {
+  IDocumentManager,
+  IDocumentWidgetOpener,
+  IRecentsManager
+} from './tokens';
 import { DocumentWidgetManager } from './widgetmanager';
 
 /**
@@ -48,7 +52,8 @@ export class DocumentManager implements IDocumentManager {
 
     const widgetManager = new DocumentWidgetManager({
       registry: this.registry,
-      translator: this.translator
+      translator: this.translator,
+      recentsManager: options.recentsManager
     });
     widgetManager.activateRequested.connect(this._onActivateRequested, this);
     widgetManager.stateChanged.connect(this._onWidgetStateChanged, this);
@@ -766,6 +771,11 @@ export namespace DocumentManager {
      * By default, it always returns `true`.
      */
     isConnectedCallback?: () => boolean;
+
+    /**
+     * The manager for recent documents.
+     */
+    recentsManager?: IRecentsManager;
   }
 }