Add option to override endpoint (#37)

* Add option to override endpoint * Bump version * Fix name, add icon for settings
nebari-dev · Jul 19, 2024 · 96c8b60 · 96c8b60
1 parent e9bb3d6
commit 96c8b60
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 28 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "jupyterlab-gallery",
-    "version": "0.4.0",
+    "version": "0.5.0",
     "description": "A JupyterLab gallery extension for presenting and downloading examples from remote repositories",
     "keywords": [
         "jupyter",

diff --git a/schema/plugin.json b/schema/plugin.json
@@ -1,8 +1,16 @@
 {
   "jupyter.lab.shortcuts": [],
-  "title": "jupyterlab-gallery",
+  "jupyter.lab.setting-icon": "jupyterlab-gallery:gallery",
+  "jupyter.lab.setting-icon-label": "Gallery",
+  "title": "Gallery",
   "description": "jupyterlab-gallery settings.",
   "type": "object",
-  "properties": {},
+  "properties": {
+    "endpoint": {
+      "title": "Server endpoint",
+      "type": "string",
+      "default": "jupyterlab-gallery"
+    }
+  },
   "additionalProperties": false
 }
diff --git a/src/gallery.tsx b/src/gallery.tsx
@@ -27,6 +27,7 @@ export class GalleryWidget extends ReactWidget {
       openPath: (path: string) => void;
       fileChanged: Contents.IManager['fileChanged'];
       refreshFileBrowser: () => Promise<void>;
+      serverAPI: string;
     }
   ) {
     super();
@@ -61,7 +62,7 @@ export class GalleryWidget extends ReactWidget {
         if (xsrfTokenMatch) {
           args['_xsrf'] = xsrfTokenMatch[1];
         }
-        await requestAPI('pull', {
+        await requestAPI('pull', this.options.serverAPI, {
           method: 'POST',
           body: JSON.stringify(args)
         });
@@ -82,7 +83,8 @@ export class GalleryWidget extends ReactWidget {
       error => {
         // TODO
         console.error(error);
-      }
+      },
+      this.options.serverAPI
     );
     this._stream.connect(this._reloadOnFinish);
     void this._load();
@@ -105,7 +107,10 @@ export class GalleryWidget extends ReactWidget {
 
   private async _load() {
     try {
-      const data = await requestAPI<IExhibitReply>('exhibits');
+      const data = await requestAPI<IExhibitReply>(
+        'exhibits',
+        this.options.serverAPI
+      );
       this.exhibits = data.exhibits;
       const allStatusesKnown = this.exhibits.every(
         exhibit =>

diff --git a/src/handler.ts b/src/handler.ts
@@ -10,16 +10,13 @@ import { ServerConnection } from '@jupyterlab/services';
  * @returns The response body interpreted as JSON
  */
 export async function requestAPI<T>(
-  endPoint = '',
+  endPoint: string,
+  namespace: string,
   init: RequestInit = {}
 ): Promise<T> {
   // Make request to Jupyter API
   const settings = ServerConnection.makeSettings();
-  const requestUrl = URLExt.join(
-    settings.baseUrl,
-    'jupyterlab-gallery', // API Namespace
-    endPoint
-  );
+  const requestUrl = URLExt.join(settings.baseUrl, namespace, endPoint);
 
   let response: Response;
   try {
@@ -67,14 +64,11 @@ export type IStreamMessage = IProgressStreamMessage | ITextStreamMessage;
 export function eventStream(
   endPoint = '',
   onStream: (message: IStreamMessage) => void,
-  onError: (error: Event) => void
+  onError: (error: Event) => void,
+  namespace: string
 ): EventSource {
   const settings = ServerConnection.makeSettings();
-  let requestUrl = URLExt.join(
-    settings.baseUrl,
-    'jupyterlab-gallery', // API Namespace
-    endPoint
-  );
+  let requestUrl = URLExt.join(settings.baseUrl, namespace, endPoint);
   const xsrfTokenMatch = document.cookie.match('\\b_xsrf=([^;]*)\\b');
   if (xsrfTokenMatch) {
     const fullUrl = new URL(requestUrl);

diff --git a/src/index.ts b/src/index.ts
@@ -37,6 +37,16 @@ const plugin: JupyterFrontEndPlugin<void> = {
   ) => {
     console.log('JupyterLab extension jupyterlab-gallery is activated!');
 
+    let settings: ISettingRegistry.ISettings;
+    try {
+      settings = await settingRegistry.load(plugin.id);
+      console.log('jupyterlab-gallery settings loaded:', settings.composite);
+    } catch (reason) {
+      console.error('Failed to load settings for jupyterlab-gallery.', reason);
+      return;
+    }
+    const serverAPI = settings.composite.endpoint as string;
+
     translator = translator ?? nullTranslator;
     const trans = translator.load('jupyterlab-gallery');
     const widget = new GalleryWidget({
@@ -51,10 +61,11 @@ const plugin: JupyterFrontEndPlugin<void> = {
       fileChanged: app.serviceManager.contents.fileChanged,
       refreshFileBrowser: () => {
         return app.commands.execute('filebrowser:refresh');
-      }
+      },
+      serverAPI
     });
 
-    const data = await requestAPI<IGalleryReply>('gallery');
+    const data = await requestAPI<IGalleryReply>('gallery', serverAPI);
     const expectedVersion = '1.0';
     if (data.apiVersion !== expectedVersion) {
       console.warn(
@@ -90,14 +101,6 @@ const plugin: JupyterFrontEndPlugin<void> = {
       widget.show();
       app.shell.add(widget, 'left', { rank: 850 });
     }
-
-    try {
-      const settings = await settingRegistry.load(plugin.id);
-      console.log('jupyterlab-gallery settings loaded:', settings.composite);
-    } catch (reason) {
-      console.error('Failed to load settings for jupyterlab-gallery.', reason);
-      return;
-    }
   }
 };