Introduce Custom Settings for JupyterGIS (#619)

* Settings to configure proxy url

* don't use async method maybe

* Add settings to core

* Update python/jupytergis_core/src/jgisplugin/plugins.ts

Co-authored-by: martinRenou <[email protected]>

* list the schema folder as part of the package file

* get settings in tools.ts

* lint

* settingsregistry to model

* use settings

* lint

* load settings at plugin level

* investigate the culprit

* lint

* have more specific type

* Add temporary fallback

* handling for jupyterlite

* Update packages/base/src/tools.ts

Co-authored-by: martinRenou <[email protected]>

* lint

* lint

---------

Co-authored-by: martinRenou <[email protected]>

Author: arjxn-py

packages/base/src/tools.ts

@@ -410,12 +410,24 @@ export const getFromIndexedDB = async (key: string) => {
 
 const fetchWithProxies = async <T>(
   url: string,
+  model: IJupyterGISModel,
   parseResponse: (response: Response) => Promise<T>
 ): Promise<T | null> => {
+  let settings: any = null;
+
+  try {
+    settings = await model.getSettings();
+  } catch (e) {
+    console.warn('Failed to get settings from model. Falling back.', e);
+  }
+
+  const proxyUrl =
+    settings && settings.proxyUrl ? settings.proxyUrl : 'https://corsproxy.io';
+
   const proxyUrls = [
     url, // Direct fetch
     `/jupytergis_core/proxy?url=${encodeURIComponent(url)}`, // Internal proxy
-    `https://corsproxy.io/?url=${encodeURIComponent(url)}` // External proxy
+    `${proxyUrl}/?url=${encodeURIComponent(url)}` // External proxy
   ];
 
   for (const proxyUrl of proxyUrls) {
@@ -444,6 +456,7 @@ const fetchWithProxies = async <T>(
  */
 export const loadGeoTiff = async (
   sourceInfo: { url?: string | undefined },
+  model: IJupyterGISModel,
   file?: Contents.IModel | null
 ) => {
   if (!sourceInfo?.url) {
@@ -468,7 +481,9 @@ export const loadGeoTiff = async (
   let fileBlob: Blob | null = null;
 
   if (!file) {
-    fileBlob = await fetchWithProxies(url, async response => response.blob());
+    fileBlob = await fetchWithProxies(url, model, async response =>
+      response.blob()
+    );
     if (!fileBlob) {
       showErrorMessage('Network error', `Failed to fetch ${url}`);
       throw new Error(`Failed to fetch ${url}`);
@@ -535,10 +550,14 @@ export const loadFile = async (fileInfo: {
           return cached.file;
         }
 
-        const geojson = await fetchWithProxies(filepath, async response => {
-          const arrayBuffer = await response.arrayBuffer();
-          return shp(arrayBuffer);
-        });
+        const geojson = await fetchWithProxies(
+          filepath,
+          model,
+          async response => {
+            const arrayBuffer = await response.arrayBuffer();
+            return shp(arrayBuffer);
+          }
+        );
 
         if (geojson) {
           await saveToIndexedDB(filepath, geojson);
@@ -555,8 +574,10 @@ export const loadFile = async (fileInfo: {
           return cached.file;
         }
 
-        const geojson = await fetchWithProxies(filepath, async response =>
-          response.json()
+        const geojson = await fetchWithProxies(
+          filepath,
+          model,
+          async response => response.json()
         );
 
         if (geojson) {
@@ -627,7 +648,7 @@ export const loadFile = async (fileInfo: {
 
       case 'GeoTiffSource': {
         if (typeof file.content === 'string') {
-          const tiff = loadGeoTiff({ url: filepath }, file);
+          const tiff = loadGeoTiff({ url: filepath }, model, file);
           return tiff;
         } else {
           throw new Error('Invalid file format for tiff content.');

packages/schema/src/interfaces.ts

@@ -183,6 +183,7 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
   contentsManager: Contents.IManager | undefined;
   filePath: string;
 
+  getSettings(): IJupyterGISSettings;
   getContent(): IJGISContent;
   getLayers(): IJGISLayers;
   getLayer(id: string): IJGISLayer | undefined;
@@ -349,3 +350,7 @@ export interface IAnnotation {
   parent: string;
   open: boolean;
 }
+
+export interface IJupyterGISSettings {
+  proxyUrl: string;
+}

packages/schema/src/model.ts

@@ -30,13 +30,17 @@ import {
   IUserData,
   IViewPortState,
   JgisCoordinates,
-  Pointer
+  Pointer,
+  IJupyterGISSettings
 } from './interfaces';
 import jgisSchema from './schema/project/jgis.json';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
+
+const SETTINGS_ID = '@jupytergis/jupytergis-core:jupytergis-settings';
 
 export class JupyterGISModel implements IJupyterGISModel {
   constructor(options: JupyterGISModel.IOptions) {
-    const { annotationModel, sharedModel } = options;
+    const { annotationModel, sharedModel, settingRegistry } = options;
 
     if (sharedModel) {
       this._sharedModel = sharedModel;
@@ -50,6 +54,26 @@ export class JupyterGISModel implements IJupyterGISModel {
       this
     );
     this.annotationModel = annotationModel;
+    this.settingRegistry = settingRegistry;
+  }
+
+  /**
+   * Initialize custom settings for JupyterLab.
+   */
+  async initSettings(): Promise<void> {
+    if (this.settingRegistry) {
+      const setting = await this.settingRegistry.load(SETTINGS_ID);
+      this._settings = setting.composite as any;
+
+      setting.changed.connect(() => {
+        this._settings = setting.composite as any;
+        console.log('JupyterGIS Settings updated:', this._settings);
+      });
+    }
+  }
+
+  getSettings(): IJupyterGISSettings {
+    return this._settings;
   }
 
   private _onSharedModelChanged = (sender: any, changes: any): void => {
@@ -724,7 +748,9 @@ export class JupyterGISModel implements IJupyterGISModel {
   readonly defaultKernelName: string = '';
   readonly defaultKernelLanguage: string = '';
   readonly annotationModel?: IAnnotationModel;
+  readonly settingRegistry?: ISettingRegistry;
 
+  private _settings: IJupyterGISSettings;
   private _sharedModel: IJupyterGISDoc;
   private _filePath: string;
   private _contentsManager?: Contents.IManager;
@@ -770,6 +796,7 @@ export namespace JupyterGISModel {
   export interface IOptions
     extends DocumentRegistry.IModelOptions<IJupyterGISDoc> {
     annotationModel?: IAnnotationModel;
+    settingRegistry?: ISettingRegistry;
   }
 }
 

python/jupytergis_core/package.json

@@ -15,7 +15,8 @@
   "author": "JupyterGIS contributors",
   "files": [
     "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
-    "style/**/*.{css,js,eot,gif,html,jpg,json,png,svg,woff2,ttf}"
+    "style/**/*.{css,js,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
+    "schema/**/*.{json,js,ts}"
   ],
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -91,6 +92,7 @@
     "access": "public"
   },
   "jupyterlab": {
+    "schemaDir": "schema",
     "discovery": {
       "server": {
         "managers": [

python/jupytergis_core/schema/jupytergis-settings.json

@@ -0,0 +1,13 @@
+{
+  "title": "JupyterGIS Settings",
+  "description": "Settings for the JupyterGIS extension.",
+  "type": "object",
+  "properties": {
+    "proxyUrl": {
+      "type": "string",
+      "title": "Proxy URL",
+      "description": "The proxy URL to use for external requests.",
+      "default": "https://corsproxy.io"
+    }
+  }
+}

python/jupytergis_core/src/jgisplugin/modelfactory.ts

@@ -5,6 +5,7 @@ import {
 } from '@jupytergis/schema';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
 import { Contents } from '@jupyterlab/services';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
 
 /**
  * A Model factory to create new instances of JupyterGISModel.
@@ -14,6 +15,7 @@ export class JupyterGISModelFactory
 {
   constructor(options: JupyterGISModelFactory.IOptions) {
     this._annotationModel = options.annotationModel;
+    this._settingRegistry = options.settingRegistry;
   }
   /**
    * Whether the model is collaborative or not.
@@ -84,17 +86,21 @@ export class JupyterGISModelFactory
     const model = new JupyterGISModel({
       sharedModel: options.sharedModel,
       languagePreference: options.languagePreference,
-      annotationModel: this._annotationModel
+      annotationModel: this._annotationModel,
+      settingRegistry: this._settingRegistry
     });
+    model.initSettings();
     return model;
   }
 
   private _annotationModel: IAnnotationModel;
+  private _settingRegistry: ISettingRegistry;
   private _disposed = false;
 }
 
 export namespace JupyterGISModelFactory {
   export interface IOptions {
     annotationModel: IAnnotationModel;
+    settingRegistry: ISettingRegistry;
   }
 }

python/jupytergis_core/src/jgisplugin/plugins.ts

@@ -27,6 +27,7 @@ import { PageConfig } from '@jupyterlab/coreutils';
 import { IFileBrowserFactory } from '@jupyterlab/filebrowser';
 import { ILauncher } from '@jupyterlab/launcher';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
 
 import { CommandIDs, logoIcon, logoMiniIcon } from '@jupytergis/base';
 import { JupyterGISDocumentWidgetFactory } from '../factory';
@@ -37,8 +38,9 @@ const FACTORY = 'JupyterGIS .jgis Viewer';
 const CONTENT_TYPE = 'jgis';
 const PALETTE_CATEGORY = 'JupyterGIS';
 const MODEL_NAME = 'jupytergis-jgismodel';
+const SETTINGS_ID = '@jupytergis/jupytergis-core:jupytergis-settings';
 
-const activate = (
+const activate = async (
   app: JupyterFrontEnd,
   tracker: WidgetTracker<IJupyterGISWidget>,
   themeManager: IThemeManager,
@@ -49,14 +51,24 @@ const activate = (
   rendermime: IRenderMimeRegistry,
   consoleTracker: IConsoleTracker,
   annotationModel: IAnnotationModel,
+  settingRegistry: ISettingRegistry,
   launcher: ILauncher | null,
   palette: ICommandPalette | null,
   drive: ICollaborativeDrive | null
-): void => {
+): Promise<void> => {
   if (PageConfig.getOption('jgis_expose_maps')) {
     window.jupytergisMaps = {};
   }
 
+  let settings: ISettingRegistry.ISettings | null = null;
+
+  try {
+    settings = await settingRegistry.load(SETTINGS_ID);
+    console.log(`Loaded settings for ${SETTINGS_ID}`, settings);
+  } catch (error) {
+    console.warn(`Failed to load settings for ${SETTINGS_ID}`, error);
+  }
+
   const widgetFactory = new JupyterGISDocumentWidgetFactory({
     name: FACTORY,
     modelName: MODEL_NAME,
@@ -86,7 +98,10 @@ const activate = (
   app.docRegistry.addWidgetFactory(mimeDocumentFactory);
 
   // Creating and registering the model factory for our custom DocumentModel
-  const modelFactory = new JupyterGISModelFactory({ annotationModel });
+  const modelFactory = new JupyterGISModelFactory({
+    annotationModel,
+    settingRegistry
+  });
   app.docRegistry.addModelFactory(modelFactory);
 
   // register the filetype
@@ -233,7 +248,8 @@ const jGISPlugin: JupyterFrontEndPlugin<void> = {
     IEditorServices,
     IRenderMimeRegistry,
     IConsoleTracker,
-    IAnnotationToken
+    IAnnotationToken,
+    ISettingRegistry
   ],
   optional: [ILauncher, ICommandPalette, ICollaborativeDrive],
   autoStart: true,

python/jupytergis_qgis/src/modelfactory.ts

@@ -5,6 +5,7 @@ import {
 } from '@jupytergis/schema';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
 import { Contents } from '@jupyterlab/services';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
 
 /**
  * A Model factory to create new instances of JupyterGISModel.
@@ -86,18 +87,21 @@ export class JupyterGISModelFactoryBase
     const model = new JupyterGISModel({
       sharedModel: options.sharedModel,
       languagePreference: options.languagePreference,
-      annotationModel: this._annotationModel
+      annotationModel: this._annotationModel,
+      settingRegistry: this._settingRegistry
     });
     return model;
   }
 
   private _annotationModel: IAnnotationModel;
+  private _settingRegistry: ISettingRegistry;
   private _disposed = false;
 }
 
 export namespace JupyterGISModelFactoryBase {
   export interface IOptions {
     annotationModel: IAnnotationModel;
+    settingRegistry: ISettingRegistry;
   }
 }
 

python/jupytergis_qgis/src/plugins.ts

@@ -29,6 +29,7 @@ import { ConsolePanel, IConsoleTracker } from '@jupyterlab/console';
 import { PathExt } from '@jupyterlab/coreutils';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { Widget } from '@lumino/widgets';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
 
 import {
   JupyterGISDocumentWidget,
@@ -78,6 +79,7 @@ const activate = async (
   rendermime: IRenderMimeRegistry,
   consoleTracker: IConsoleTracker,
   annotationModel: IAnnotationModel,
+  settingRegistry: ISettingRegistry,
   commandPalette: ICommandPalette | null
 ): Promise<void> => {
   const fcCheck = await requestAPI<{ installed: boolean }>(
@@ -133,8 +135,12 @@ const activate = async (
   app.docRegistry.addWidgetFactory(QGZWidgetFactory);
 
   // Creating and registering the model factory for our custom DocumentModel
-  app.docRegistry.addModelFactory(new QGSModelFactory({ annotationModel }));
-  app.docRegistry.addModelFactory(new QGZModelFactory({ annotationModel }));
+  app.docRegistry.addModelFactory(
+    new QGSModelFactory({ annotationModel, settingRegistry })
+  );
+  app.docRegistry.addModelFactory(
+    new QGZModelFactory({ annotationModel, settingRegistry })
+  );
   // register the filetype
   app.docRegistry.addFileType({
     name: 'QGS',
@@ -311,7 +317,8 @@ export const qgisplugin: JupyterFrontEndPlugin<void> = {
     IEditorServices,
     IRenderMimeRegistry,
     IConsoleTracker,
-    IAnnotationToken
+    IAnnotationToken,
+    ISettingRegistry
   ],
   optional: [ICommandPalette],
   autoStart: true,