Use configurable refreshInterval for polling

Use lumino polling class for polling server proxy apps

Add schema to be able to configure refreshInterval

Author: mahendrapaipuri

labextension/package.json

@@ -57,6 +57,7 @@
   },
   "jupyterlab": {
     "extension": true,
+    "schemaDir": "schema",
     "outputDir": "../jupyter_server_proxy/labextension"
   }
 }

labextension/schema/add-launcher-entries.json

@@ -0,0 +1,14 @@
+{
+    "title": "Jupyter Server Proxy",
+    "description": "Jupyter Server Proxy Manager settings",
+    "properties": {
+      "refreshInterval": {
+        "type": "number",
+        "title": "Auto-refresh rate",
+        "description": "Time to wait (in ms) in between auto refreshes of server proxy applications",
+        "default": 10000
+      }
+    },
+    "additionalProperties": false,
+    "type": "object"
+  }

labextension/src/manager.ts

@@ -1,24 +1,43 @@
 import { Signal, ISignal } from "@lumino/signaling";
+import { Poll } from '@lumino/polling';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { ServerConnection } from "@jupyterlab/services";
+import { TranslationBundle } from '@jupyterlab/translation';
 import { listRunning, shutdown } from "./restapi";
 import * as ServerProxyApp from "./serverproxy";
 
+// Default refresh interval (in milliseconds) for polling
+const DEFAULT_REFRESH_INTERVAL = 10000; // ms
+
 /**
  * A server proxy manager.
  */
 export class ServerProxyManager implements ServerProxyApp.IManager {
   /**
    * Construct a new server proxy manager.
    */
-  constructor(options: ServerProxyManager.IOptions = {}) {
-    this.serverSettings =
-      options.serverSettings || ServerConnection.makeSettings();
-    this._refreshTimer = (setInterval as any)(() => {
-      if (typeof document !== "undefined" && document.hidden) {
-        return;
+  constructor(trans: TranslationBundle, settings?: ISettingRegistry.ISettings) {
+    this._trans = trans;
+    this._settings = settings || null;
+    this.serverSettings = ServerConnection.makeSettings();
+
+    const interval = settings?.get('refreshInterval').composite as number || DEFAULT_REFRESH_INTERVAL;
+
+    // Start polling with exponential backoff.
+    this._proxyPoll = new Poll({
+      factory: () => this._refreshRunning(),
+      frequency: {
+        interval: interval,
+        backoff: true,
+        max: 300 * 1000
       }
-      this._refreshRunning();
-    }, 10000);
+    });
+
+    // Fire callback when settings are changed
+    if (settings) {
+      settings.changed.connect(this._onSettingsChange, this);
+      this._onSettingsChange(settings);
+    }
   }
 
   /**
@@ -55,7 +74,8 @@ export class ServerProxyManager implements ServerProxyApp.IManager {
       return;
     }
     this._isDisposed = true;
-    clearInterval(this._refreshTimer);
+    this._proxyPoll.dispose();
+    this._settings?.changed.disconnect(this._onSettingsChange, this);
     Signal.clearData(this);
   }
 
@@ -72,7 +92,7 @@ export class ServerProxyManager implements ServerProxyApp.IManager {
    * Shut down a server proxy app by name.
    */
   async shutdown(name: string): Promise<void> {
-    await shutdown(name, this.serverSettings);
+    await shutdown(name, this._trans, this.serverSettings);
     await this.refreshRunning();
   }
 
@@ -87,7 +107,7 @@ export class ServerProxyManager implements ServerProxyApp.IManager {
 
     // Shut down all models.
     await Promise.all(
-      this._names.map((name) => shutdown(name, this.serverSettings)),
+      this._names.map((name) => shutdown(name, this._trans, this.serverSettings)),
     );
 
     // Update the list of models to clear out our state.
@@ -100,7 +120,8 @@ export class ServerProxyManager implements ServerProxyApp.IManager {
    * @returns A promise that with the list of running proxy apps.
    */
   async refreshRunning(): Promise<void> {
-    return this._refreshRunning();
+    await this._proxyPoll.refresh();
+    await this._proxyPoll.tick;
   }
 
   /**
@@ -139,26 +160,45 @@ export class ServerProxyManager implements ServerProxyApp.IManager {
     this._runningChanged.emit(this._models);
   }
 
+  /**
+   * Callback invoked upon a change to plugin settings.
+   *
+   * @private
+   * @param settings - plugin settings
+   */
+  private _onSettingsChange(settings: ISettingRegistry.ISettings) {
+    this._proxyPoll.frequency = {
+      ...this._proxyPoll.frequency,
+      interval: settings.composite.refreshInterval as number
+    };
+  }
+
   private _names: string[] = [];
   private _models: ServerProxyApp.IModel[] = [];
-
+  private _proxyPoll: Poll;
+  private _trans: TranslationBundle;
+  private _settings: ISettingRegistry.ISettings | null;
   private _isDisposed = false;
-  private _refreshTimer = -1;
   private _runningChanged = new Signal<this, ServerProxyApp.IModel[]>(this);
   private _connectionFailure = new Signal<this, Error>(this);
 }
 
-/**
- * The namespace for `BaseManager` class statics.
- */
-export namespace ServerProxyManager {
-  /**
-   * The options used to initialize a SessionManager.
-   */
-  export interface IOptions {
-    /**
-     * The server settings for the manager.
-     */
-    serverSettings?: ServerConnection.ISettings;
-  }
-}
+// /**
+//  * The namespace for `ServerProxyManager` class statics.
+//  */
+// export namespace ServerProxyManager {
+//   /**
+//    * The options used to initialize a ServerProxyManager.
+//    */
+//   export interface IOptions {
+//     /**
+//      * The server settings for the manager.
+//      */
+//     serverSettings?: ServerConnection.ISettings;
+
+//     /**
+//      * When the manager stops polling the API. Defaults to `when-hidden`.
+//      */
+//      standby?: Poll.Standby;
+//   }
+// }

labextension/yarn.lock

@@ -696,10 +696,10 @@
   resolved "https://registry.npmjs.org/@types/estree/-/estree-1.0.0.tgz#5fb2e536c1ae9bf35366eed879e827fa59ca41c2"
   integrity sha512-WulqXMDUTYAXCjZnk6JtIHPigp55cVtDgDrO2gHRwhyJto21+1zbVCtOYB2L1F9w4qCQ0rOGWBnBe0FNTiEJIQ==
 
-"@types/estree@^0.0.51":
-  version "0.0.51"
-  resolved "https://registry.npmjs.org/@types/estree/-/estree-0.0.51.tgz#cfd70924a25a3fd32b218e5e420e6897e1ac4f40"
-  integrity sha512-CuPgU6f3eT/XgKKPqKd/gLZV1Xmvf1a2R5POBOGQa6uv82xpls89HU5zKeVoyR8XzHd1RGNOlQlvUe3CFkjWNQ==
+"@types/estree@^1.0.0":
+  version "1.0.1"
+  resolved "https://registry.npmjs.org/@types/estree/-/estree-1.0.1.tgz#aa22750962f3bf0e79d753d3cc067f010c95f194"
+  integrity sha512-LG4opVs2ANWZ1TJoKc937iMmNstM/d0ae1vNbnBvBhqCSezgVUOzcLCqbI5elV8Vy6WKwKjaqR+zO9VKirBBCA==
 
 "@types/json-schema@*", "@types/json-schema@^7.0.5", "@types/json-schema@^7.0.7", "@types/json-schema@^7.0.8":
   version "7.0.11"
@@ -744,10 +744,33 @@
     "@types/source-list-map" "*"
     source-map "^0.6.1"
 
-"@webassemblyjs/[email protected]":
-  version "1.11.1"
-  resolved "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.11.1.tgz#2bfd767eae1a6996f432ff7e8d7fc75679c0b6a7"
-  integrity sha512-ukBh14qFLjxTQNTXocdyksN5QdM28S1CxHt2rdskFyL+xFV7VremuBLVbmCePj+URalXBENx/9Lm7lnhihtCSw==
+"@webassemblyjs/[email protected]", "@webassemblyjs/ast@^1.11.5":
+  version "1.11.5"
+  resolved "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.11.5.tgz#6e818036b94548c1fb53b754b5cae3c9b208281c"
+  integrity sha512-LHY/GSAZZRpsNQH+/oHqhRQ5FT7eoULcBqgfyTB5nQHogFnK3/7QoN7dLnwSE/JkUAF0SrRuclT7ODqMFtWxxQ==
+  dependencies:
+    "@webassemblyjs/helper-numbers" "1.11.5"
+    "@webassemblyjs/helper-wasm-bytecode" "1.11.5"
+
+"@webassemblyjs/[email protected]":
+  version "1.11.5"
+  resolved "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.11.5.tgz#e85dfdb01cad16b812ff166b96806c050555f1b4"
+  integrity sha512-1j1zTIC5EZOtCplMBG/IEwLtUojtwFVwdyVMbL/hwWqbzlQoJsWCOavrdnLkemwNoC/EOwtUFch3fuo+cbcXYQ==
+
+"@webassemblyjs/[email protected]":
+  version "1.11.5"
+  resolved "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.11.5.tgz#1e82fa7958c681ddcf4eabef756ce09d49d442d1"
+  integrity sha512-L65bDPmfpY0+yFrsgz8b6LhXmbbs38OnwDCf6NpnMUYqa+ENfE5Dq9E42ny0qz/PdR0LJyq/T5YijPnU8AXEpA==
+
+"@webassemblyjs/[email protected]":
+  version "1.11.5"
+  resolved "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.11.5.tgz#91381652ea95bb38bbfd270702351c0c89d69fba"
+  integrity sha512-fDKo1gstwFFSfacIeH5KfwzjykIE6ldh1iH9Y/8YkAZrhmu4TctqYjSh7t0K2VyDSXOZJ1MLhht/k9IvYGcIxg==
+
+"@webassemblyjs/[email protected]":
+  version "1.11.5"
+  resolved "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.11.5.tgz#23380c910d56764957292839006fecbe05e135a9"
+  integrity sha512-DhykHXM0ZABqfIGYNv93A5KKDw/+ywBFnuWybZZWcuzWHfbp21wUfRkbtz7dMGwGgT4iXjWuhRMA2Mzod6W4WA==
   dependencies:
     "@webassemblyjs/floating-point-hex-parser" "1.11.5"
     "@webassemblyjs/helper-api-error" "1.11.5"
@@ -1331,10 +1354,10 @@ encoding-down@^6.3.0:
     level-codec "^9.0.0"
     level-errors "^2.0.0"
 
-enhanced-resolve@^5.10.0:
-  version "5.12.0"
-  resolved "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.12.0.tgz#300e1c90228f5b570c4d35babf263f6da7155634"
-  integrity sha512-QHTXI/sZQmko1cbDoNAa3mJ5qhWUUNAq3vR0/YiD379fWQrcfuoX1+HW2S0MTt7XmoPLapdaDKUtelUSPic7hQ==
+enhanced-resolve@^5.13.0:
+  version "5.13.0"
+  resolved "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.13.0.tgz#26d1ecc448c02de997133217b5c1053f34a0a275"
+  integrity sha512-eyV8f0y1+bzyfh8xAwW/WTSZpLbjhqc4ne9eGSH4Zo2ejdyiNG9pU6mf9DG8a7+Auk6MFTlNOT4Y2y/9k8GKVg==
   dependencies:
     graceful-fs "^4.2.4"
     tapable "^2.2.0"
@@ -1403,10 +1426,10 @@ es-abstract@^1.19.0, es-abstract@^1.20.4:
     unbox-primitive "^1.0.2"
     which-typed-array "^1.1.9"
 
-es-module-lexer@^0.9.0:
-  version "0.9.3"
-  resolved "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-0.9.3.tgz#6f13db00cc38417137daf74366f535c8eb438f19"
-  integrity sha512-1HQ2M2sPtxwnvOvT1ZClHyQDiggdNjURWpY2we6aMKCQiUVxTmVs2UYPLIrD84sS+kMdUwfBSylbJPwNnBrnHQ==
+es-module-lexer@^1.2.1:
+  version "1.2.1"
+  resolved "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.2.1.tgz#ba303831f63e6a394983fde2f97ad77b22324527"
+  integrity sha512-9978wrXM50Y4rTMmW5kXIC09ZdXQZqkE4mxhwkd8VbzsGkXGPgV4zWuqQJgCEzYngdo2dYDa0l8xhX4fkSwJSg==
 
 es-set-tostringtag@^2.0.1:
   version "2.0.1"
@@ -1565,7 +1588,7 @@ function.prototype.name@^1.1.5:
     es-abstract "^1.19.0"
     functions-have-names "^1.2.2"
 
-functions-have-names@^1.2.2, functions-have-names@^1.2.3:
+functions-have-names@^1.2.2:
   version "1.2.3"
   resolved "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz#0404fe4ee2ba2f607f0e0ec3c80bae994133b834"
   integrity sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==
@@ -2277,7 +2300,7 @@ moment@^2.24.0:
   resolved "https://registry.npmjs.org/moment/-/moment-2.29.4.tgz#3dbe052889fe7c1b2ed966fcb3a77328964ef108"
   integrity sha512-5LC9SOxjSc2HF6vO2CyuTDNivEdoz2IvyJJGj6X8DJ0eFyfszE0QiEd+iXmBvUP3WHxSjFH/vIsA0EN00cgr8w==
 
-nanoid@^3.1.23, nanoid@^3.3.4:
+nanoid@^3.1.23, nanoid@^3.3.6:
   version "3.3.6"
   resolved "https://registry.npmjs.org/nanoid/-/nanoid-3.3.6.tgz#443380c856d6e9f9824267d960b4236ad583ea4c"
   integrity sha512-BGcqMMJuToF7i1rt+2PWSNVnWIkGCU78jBG3RxO/bZlnZPK2Cmi2QaffxGO/2RvWi9sL+FAiRiXMgsyxQ1DIDA==
@@ -2540,7 +2563,7 @@ postcss@^8.2.15, postcss@^8.3.11:
   resolved "https://registry.npmjs.org/postcss/-/postcss-8.4.21.tgz#c639b719a57efc3187b13a1d765675485f4134f4"
   integrity sha512-tP7u/Sn/dVxK2NnruI4H9BG+x+Wxz6oeZ1cJ8P6G/PZY0IKk4k/63TDsQf2kQq3+qoJeLm2kIBUNlZe3zgb4Zg==
   dependencies:
-    nanoid "^3.3.6"
+    nanoid "^3.3.4"
     picocolors "^1.0.0"
     source-map-js "^1.0.2"
 
@@ -2689,8 +2712,8 @@ regexp.prototype.flags@^1.2.0, regexp.prototype.flags@^1.4.3:
   integrity sha512-0SutC3pNudRKgquxGoRGIz946MZVHqbNfPjBdxeOhBrdgDKlRoXmYLQN9xRbrR09ZXWeGAdPuif7egofn6v5LA==
   dependencies:
     call-bind "^1.0.2"
-    define-properties "^1.1.3"
-    functions-have-names "^1.2.2"
+    define-properties "^1.2.0"
+    functions-have-names "^1.2.3"
 
 requires-port@^1.0.0:
   version "1.0.0"
@@ -3047,7 +3070,7 @@ terser-webpack-plugin@^4.1.0:
     terser "^5.3.4"
     webpack-sources "^1.4.3"
 
-terser-webpack-plugin@^5.1.3:
+terser-webpack-plugin@^5.3.7:
   version "5.3.7"
   resolved "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.3.7.tgz#ef760632d24991760f339fe9290deb936ad1ffc7"
   integrity sha512-AfKwIktyP7Cu50xNjXF/6Qb5lBNzYaWpU6YfoX3uZicTx0zTy0stDDCsvjDapKsSDvOeWo5MEq4TmdBy2cNoHw==
@@ -3306,16 +3329,16 @@ webpack@^5.41.1:
   integrity sha512-gT5DP72KInmE/3azEaQrISjTvLYlSM0j1Ezhht/KLVkrqtv10JoP/RXhwmX/frrutOPuSq3o5Vq0ehR/4Vmd1g==
   dependencies:
     "@types/eslint-scope" "^3.7.3"
-    "@types/estree" "^1.0.0"
-    "@webassemblyjs/ast" "^1.11.5"
-    "@webassemblyjs/wasm-edit" "^1.11.5"
-    "@webassemblyjs/wasm-parser" "^1.11.5"
+    "@types/estree" "^0.0.51"
+    "@webassemblyjs/ast" "1.11.1"
+    "@webassemblyjs/wasm-edit" "1.11.1"
+    "@webassemblyjs/wasm-parser" "1.11.1"
     acorn "^8.7.1"
     acorn-import-assertions "^1.7.6"
     browserslist "^4.14.5"
     chrome-trace-event "^1.0.2"
-    enhanced-resolve "^5.13.0"
-    es-module-lexer "^1.2.1"
+    enhanced-resolve "^5.10.0"
+    es-module-lexer "^0.9.0"
     eslint-scope "5.1.1"
     events "^3.2.0"
     glob-to-regexp "^0.4.1"
@@ -3324,9 +3347,9 @@ webpack@^5.41.1:
     loader-runner "^4.2.0"
     mime-types "^2.1.27"
     neo-async "^2.6.2"
-    schema-utils "^3.1.2"
+    schema-utils "^3.1.0"
     tapable "^2.1.1"
-    terser-webpack-plugin "^5.3.7"
+    terser-webpack-plugin "^5.1.3"
     watchpack "^2.4.0"
     webpack-sources "^3.2.3"