Throttle setting registry fetch requests at the connector level

jupyterlab · Mar 23, 2020 · 4add6c7 · 4add6c7
1 parent 60accd4
commit 4add6c7
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 14 deletions.
diff --git a/packages/apputils-extension/src/settingconnector.ts b/packages/apputils-extension/src/settingconnector.ts
@@ -1,8 +1,10 @@
 import { PageConfig } from '@jupyterlab/coreutils';
 
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
+
 import { DataConnector, IDataConnector } from '@jupyterlab/statedb';
 
-import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { Throttler } from '@lumino/polling';
 
 /**
  * A data connector for fetching settings.
@@ -19,8 +21,25 @@ export class SettingConnector extends DataConnector<
     this._connector = connector;
   }
 
+  /**
+   * Fetch settings for a plugin.
+   * @param id - The plugin ID
+   *
+   * #### Notes
+   * The REST API requests are throttled at one request per plugin per 100ms.
+   */
   fetch(id: string): Promise<ISettingRegistry.IPlugin | undefined> {
-    return this._connector.fetch(id);
+    const throttlers = this._throttlers;
+    if (!(id in throttlers)) {
+      throttlers[id] = new Throttler(async () => {
+        const fetched = await this._connector.fetch(id);
+        console.log('fetched', id);
+        throttlers[id].dispose();
+        delete throttlers[id];
+        return fetched;
+      }, 100);
+    }
+    return throttlers[id].invoke();
   }
 
   async list(
@@ -44,4 +63,5 @@ export class SettingConnector extends DataConnector<
   }
 
   private _connector: IDataConnector<ISettingRegistry.IPlugin, string>;
+  private _throttlers: { [key: string]: Throttler } = Object.create(null);
 }
diff --git a/packages/docmanager-extension/src/index.ts b/packages/docmanager-extension/src/index.ts
@@ -44,8 +44,6 @@ import { IDisposable } from '@lumino/disposable';
 
 import { Widget } from '@lumino/widgets';
 
-import { Throttler } from '@lumino/polling';
-
 /**
  * The command IDs used by the document manager plugin.
  */
@@ -244,18 +242,9 @@ ${fileTypes}`;
       }
     });
 
-    // callback to registry change that ensures not to invoke reload method when there is already a promise that is pending
-    let reloadSettingsRegistry = () => {
-      let reloadThrottle = new Throttler(() =>
-        settingRegistry.reload(pluginId)
-      );
-
-      return reloadThrottle.invoke.bind(reloadThrottle);
-    };
-
     // If the document registry gains or loses a factory or file type,
     // regenerate the settings description with the available options.
-    registry.changed.connect(reloadSettingsRegistry());
+    registry.changed.connect(() => settingRegistry.reload(pluginId));
 
     return docManager;
   }