Use serverSettings for API requests (#256)

Author: jtpio

packages/labextension/src/handler.ts

@@ -6,13 +6,15 @@ import { ServerConnection } from '@jupyterlab/services';
  *
  * @param endPoint API REST end point for the extension
  * @param init Initial values for the request
+ * @param serverSettings Optional server connection settings
  * @returns The response body interpreted as JSON
  */
 export async function requestAPI<T>(
   endPoint = '',
-  init: RequestInit = {}
+  init: RequestInit = {},
+  serverSettings?: ServerConnection.ISettings
 ): Promise<T> {
-  const settings = ServerConnection.makeSettings();
+  const settings = serverSettings ?? ServerConnection.makeSettings();
   const requestUrl = URLExt.join(
     settings.baseUrl,
     'api/metrics/v1/kernel_usage', // API Namespace

packages/labextension/src/index.ts

@@ -79,10 +79,12 @@ const resourceStatusPlugin: JupyterFrontEndPlugin<void> = {
     info: JupyterLab.IInfo | null
   ) => {
     const refreshRate = DEFAULT_REFRESH_RATE;
+    const { serverSettings } = app.serviceManager;
 
     const trans = translator.load('jupyter-resource-usage');
     const item = new ResourceUsageStatus(trans, {
       refreshRate,
+      serverSettings,
       refreshStandby: () => {
         if (info) {
           return !info.isConnected || 'when-hidden';
@@ -117,6 +119,7 @@ const systemMonitorPlugin: JupyterFrontEndPlugin<void> = {
     settingRegistry: ISettingRegistry | null,
     info: JupyterLab.IInfo | null
   ) => {
+    const { serverSettings } = app.serviceManager;
     let enablePlugin = DEFAULT_ENABLE_SYSTEM_MONITOR;
     let refreshRate = DEFAULT_REFRESH_RATE;
     let cpuLabel = DEFAULT_CPU_LABEL;
@@ -141,6 +144,7 @@ const systemMonitorPlugin: JupyterFrontEndPlugin<void> = {
 
     const model = new ResourceUsage.Model({
       refreshRate,
+      serverSettings,
       refreshStandby: () => {
         if (info) {
           return !info.isConnected || 'when-hidden';
@@ -188,6 +192,7 @@ const kernelUsagePlugin: JupyterFrontEndPlugin<void> = {
     const trans = translator.load('jupyter-resource-usage');
 
     const { commands, shell } = app;
+    const { serverSettings } = app.serviceManager;
     const category = trans.__('Kernel Resource');
 
     let panel: KernelUsagePanel | null = null;
@@ -203,6 +208,7 @@ const kernelUsagePlugin: JupyterFrontEndPlugin<void> = {
         panel = new KernelUsagePanel({
           tracker,
           trans,
+          serverSettings,
         });
         shell.add(panel, 'right', { rank: 200 });
       }

packages/labextension/src/model.ts

@@ -55,12 +55,14 @@ export namespace ResourceUsage {
      */
     constructor(options: Model.IOptions) {
       super();
+      this._serverSettings =
+        options.serverSettings ?? ServerConnection.makeSettings();
       for (let i = 0; i < N_BUFFER; i++) {
         this._values.push({ memoryPercent: 0, cpuPercent: 0, diskPercent: 0 });
       }
       this._poll = new Poll<Private.IMetricRequestResult | null>({
         factory: (): Promise<Private.IMetricRequestResult | null> =>
-          Private.factory(),
+          Private.factory(this._serverSettings),
         frequency: {
           interval: options.refreshRate,
           backoff: true,
@@ -310,6 +312,7 @@ export namespace ResourceUsage {
     private _memoryLimit: number | null = null;
     private _cpuLimit: number | null = null;
     private _poll: Poll<Private.IMetricRequestResult | null>;
+    private _serverSettings: ServerConnection.ISettings;
     private _memUnits: MemoryUnit = 'B';
     private _diskUnits: MemoryUnit = 'B';
     private _warn = new ResourceUsageWarning();
@@ -329,6 +332,11 @@ export namespace ResourceUsage {
        */
       refreshRate: number;
 
+      /**
+       * The server connection settings to use for API requests.
+       */
+      serverSettings?: ServerConnection.ISettings;
+
       /**
        * When the model stops polling the API. Defaults to `when-hidden`.
        */
@@ -361,19 +369,6 @@ export namespace ResourceUsage {
  * A namespace for module private statics.
  */
 namespace Private {
-  /**
-   * Settings for making requests to the server.
-   */
-  const SERVER_CONNECTION_SETTINGS = ServerConnection.makeSettings();
-
-  /**
-   * The url endpoint for making requests to the server.
-   */
-  const METRIC_URL = URLExt.join(
-    SERVER_CONNECTION_SETTINGS.baseUrl,
-    'api/metrics/v1'
-  );
-
   /**
    * The shape of a response from the metrics server extension.
    */
@@ -404,11 +399,13 @@ namespace Private {
   /**
    * Make a request to the backend.
    */
-  export const factory = async (): Promise<IMetricRequestResult | null> => {
+  export const factory = async (
+    serverSettings: ServerConnection.ISettings
+  ): Promise<IMetricRequestResult | null> => {
     const request = ServerConnection.makeRequest(
-      METRIC_URL,
+      URLExt.join(serverSettings.baseUrl, 'api/metrics/v1'),
       {},
-      SERVER_CONNECTION_SETTINGS
+      serverSettings
     );
     const response = await request;
 

packages/labextension/src/panel.ts

@@ -1,4 +1,5 @@
 import { Message } from '@lumino/messaging';
+import type { ServerConnection } from '@jupyterlab/services';
 import { TranslationBundle } from '@jupyterlab/translation';
 import { StackedPanel } from '@lumino/widgets';
 import { LabIcon } from '@jupyterlab/ui-components';
@@ -13,6 +14,7 @@ export class KernelUsagePanel extends StackedPanel {
   constructor(props: {
     tracker: KernelWidgetTracker;
     trans: TranslationBundle;
+    serverSettings?: ServerConnection.ISettings;
   }) {
     super();
     this.addClass(PANEL_CLASS);
@@ -27,6 +29,7 @@ export class KernelUsagePanel extends StackedPanel {
       tracker: props.tracker,
       panel: this,
       trans: props.trans,
+      serverSettings: props.serverSettings,
     });
     this.addWidget(widget);
   }

packages/labextension/src/widget.tsx

@@ -2,6 +2,7 @@ import React, { useRef, useState, useEffect } from 'react';
 import { ReactWidget, ISessionContext } from '@jupyterlab/apputils';
 import { IChangedArgs } from '@jupyterlab/coreutils';
 import { Kernel } from '@jupyterlab/services';
+import type { ServerConnection } from '@jupyterlab/services';
 import { TranslationBundle } from '@jupyterlab/translation';
 import { requestAPI } from './handler';
 import { KernelUsagePanel } from './panel';
@@ -126,8 +127,9 @@ const KernelUsage = (props: {
   tracker: KernelWidgetTracker;
   panel: KernelUsagePanel;
   trans: TranslationBundle;
+  serverSettings?: ServerConnection.ISettings;
 }) => {
-  const { panel } = props;
+  const { panel, serverSettings } = props;
   const [kernelId, setKernelId] = useState<string>();
   const [path, setPath] = useState<string>();
   const [usage, setUsage] = useState<Usage | undefined>();
@@ -147,30 +149,32 @@ const KernelUsage = (props: {
   kernelIdRef.current = kernelId;
 
   const requestUsage = (kid: string) => {
-    return requestAPI<any>(`get_usage/${kid}`).then((data) => {
-      // The kernel reply may arrive late due to lax timeouts, so we need to
-      // check if it is for the current kernel
+    return requestAPI<any>(`get_usage/${kid}`, {}, serverSettings).then(
+      (data) => {
+        // The kernel reply may arrive late due to lax timeouts, so we need to
+        // check if it is for the current kernel
 
-      if (kid !== kernelIdRef.current) {
-        // Ignore outdated response, but preserve current reason
-        return;
-      }
+        if (kid !== kernelIdRef.current) {
+          // Ignore outdated response, but preserve current reason
+          return;
+        }
 
-      if (data.content?.reason) {
-        const reason = data.content;
-        setReason(reason);
-        return;
-      } else {
-        setReason(undefined);
-      }
+        if (data.content?.reason) {
+          const reason = data.content;
+          setReason(reason);
+          return;
+        } else {
+          setReason(undefined);
+        }
 
-      const usage: Usage = {
-        ...data.content,
-        timestamp: new Date(),
-        kernel_id: kid,
-      };
-      setUsage(usage);
-    });
+        const usage: Usage = {
+          ...data.content,
+          timestamp: new Date(),
+          kernel_id: kid,
+        };
+        setUsage(usage);
+      }
+    );
   };
 
   useEffect(() => {
@@ -378,11 +382,13 @@ export class KernelUsageWidget extends ReactWidget {
     tracker: KernelWidgetTracker;
     panel: KernelUsagePanel;
     trans: TranslationBundle;
+    serverSettings?: ServerConnection.ISettings;
   }) {
     super();
     this._tracker = props.tracker;
     this._panel = props.panel;
     this._trans = props.trans;
+    this._serverSettings = props.serverSettings;
     this.addClass(KERNEL_USAGE_CLASS);
   }
 
@@ -392,7 +398,10 @@ export class KernelUsageWidget extends ReactWidget {
         tracker={this._tracker}
         panel={this._panel}
         trans={this._trans}
+        serverSettings={this._serverSettings}
       />
     );
   }
+
+  private _serverSettings: ServerConnection.ISettings | undefined;
 }