Feature - Update Extension Version (#28)

* Update dependencies and fix typescript and eslint errors

* Change apputils and services to use local dependencies and update code to change the session context server settings

* Replaces relative paths apputils/services by a link to tarball

* Make the extension works with the new version of jupyterlab

* Remove unnecessary jupyter notebook file

* Clean code and fix some errors with promises

* Try to reconnect if kernel change fails

* Remove unnecessary jupyter notebook file

* Set appendToken in the remote settings

* Create /tmp/data directory to upload dataset

* Use branch name instead of commit hash for the apputils and services dependencies

* 0.2.0

* Remove unnecessary commented line from install_requires inside setup.py file

* Recreate yarn.lock

* Remove unnecessary createSession function

Co-authored-by: Fabio Beranizo <[email protected]>

Author: LuanEdCosta

.eslintignore

@@ -3,3 +3,4 @@ dist
 coverage
 **/*.d.ts
 tests
+lib

.eslintrc.js

@@ -1,32 +1,31 @@
 module.exports = {
+  env: {
+    node: true,
+  },
   extends: [
     'eslint:recommended',
     'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
-    'plugin:prettier/recommended'
+    'plugin:prettier/recommended',
   ],
   parser: '@typescript-eslint/parser',
   parserOptions: {
-    project: 'tsconfig.json',
-    sourceType: 'module'
+    sourceType: 'module',
   },
   plugins: ['@typescript-eslint'],
   rules: {
-    '@typescript-eslint/interface-name-prefix': [
-      'error',
-      { prefixWithI: 'always' }
-    ],
+    '@typescript-eslint/interface-name-prefix': 'off',
     '@typescript-eslint/no-unused-vars': ['warn', { args: 'none' }],
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-namespace': 'off',
     '@typescript-eslint/no-use-before-define': 'off',
     '@typescript-eslint/quotes': [
       'error',
       'single',
-      { avoidEscape: true, allowTemplateLiterals: false }
+      { avoidEscape: true, allowTemplateLiterals: false },
     ],
     curly: ['error', 'all'],
     eqeqeq: 'error',
-    'prefer-arrow-callback': 'error'
-  }
+    'prefer-arrow-callback': 'error',
+  },
 };

jupyterlab_extension/services.py

@@ -82,6 +82,7 @@ def generate_name(filename: str, attempt: int = 1, path: str = "/tmp/data") -> s
         name = f"{name}-{attempt}{extension}"
 
     try:
+        os.makedirs("/tmp/data", exist_ok=True)
         open(f"{path}/{name}")
     except FileNotFoundError:
         return name
@@ -103,6 +104,7 @@ def create_dataset_locally(file: bytes, filename: str = "file", name: str = "fil
     """
 
     try:
+        os.makedirs("/tmp/data", exist_ok=True)
         with open(f"{path}/{name}", 'wb') as csv_file:
             csv_file.write(file)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platiagro/jupyterlab-extension",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "A JupyterLab extension that connects to PlatIAgro.",
   "keywords": [
     "jupyter",
@@ -39,28 +39,28 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@jupyterlab/application": "^2.0.0",
-    "@jupyterlab/apputils": "https://github.com/platiagro/jupyterlab/releases/download/v0.2.0platiagro-v2.1.2/jupyterlab-apputils-2.1.1.tgz",
-    "@jupyterlab/coreutils": "^4.0.0",
-    "@jupyterlab/docregistry": "^2.1.2",
-    "@jupyterlab/mainmenu": "^2.1.1",
-    "@jupyterlab/notebook": "^2.1.2",
-    "@jupyterlab/services": "https://github.com/platiagro/jupyterlab/releases/download/v0.2.0platiagro-v2.1.2/jupyterlab-services-5.1.0.tgz",
-    "@jupyterlab/ui-components": "^2.1.1",
-    "@lumino/disposable": "^1.3.6",
-    "@lumino/widgets": "^1.12.2"
+    "@jupyterlab/application": "^3.0.11",
+    "@jupyterlab/apputils": "https://github.com/platiagro/jupyterlab/raw/v0.2.0-jupyterlab-v3.0.16/packages/apputils/jupyterlab-apputils-v3.0.9.tgz",
+    "@jupyterlab/coreutils": "^5.0.6",
+    "@jupyterlab/docregistry": "^3.0.11",
+    "@jupyterlab/mainmenu": "^3.0.9",
+    "@jupyterlab/notebook": "^3.0.11",
+    "@jupyterlab/services": "https://github.com/platiagro/jupyterlab/raw/v0.2.0-jupyterlab-v3.0.16/packages/services/jupyterlab-services-v6.0.9.tgz",
+    "@jupyterlab/ui-components": "^3.0.7",
+    "@lumino/disposable": "^1.7.0",
+    "@lumino/widgets": "^1.23.0"
   },
   "devDependencies": {
-    "@types/node": "^14.14.5",
-    "@typescript-eslint/eslint-plugin": "^2.25.0",
-    "@typescript-eslint/parser": "^2.25.0",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.10.1",
-    "eslint-plugin-prettier": "^3.1.2",
-    "mkdirp": "^1.0.3",
-    "prettier": "1.16.4",
-    "rimraf": "^2.6.1",
-    "typescript": "~3.7.0"
+    "@types/node": "^16.3.1",
+    "@typescript-eslint/eslint-plugin": "^4.28.3",
+    "@typescript-eslint/parser": "^4.28.3",
+    "eslint": "^7.30.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "mkdirp": "^1.0.4",
+    "prettier": "2.3.2",
+    "rimraf": "^3.0.2",
+    "typescript": "~4.3.5"
   },
   "sideEffects": [
     "style/**/*"

setup.py

@@ -71,7 +71,6 @@
     cmdclass= cmdclass,
     packages=setuptools.find_packages(),
     install_requires=[
-        "jupyterlab @ git+https://github.com/platiagro/jupyterlab.git@fix/packages#egg=jupyterlab",
         "requests~=2.0",
     ],
     zip_safe=False,

src/add-widget.ts

@@ -38,7 +38,7 @@ export class AddWidget extends Widget {
       height: '18px',
       width: '18px',
       marginLeft: '3px',
-      marginRight: '-5px'
+      marginRight: '-5px',
     });
     this.addClass('unapplied-tag');
     option.appendChild(iconContainer);

src/dataset.ts

@@ -4,7 +4,7 @@ import {
   showDialog as showDialogBase,
   Dialog,
   showErrorMessage,
-  Spinner
+  Spinner,
 } from '@jupyterlab/apputils';
 
 import { Notebook } from '@jupyterlab/notebook';
@@ -29,14 +29,14 @@ export namespace DatasetActions {
   export const showDialog = async (notebook: Notebook): Promise<void> => {
     // declare an object that will keep the inputted data
     const parameter: any = {
-      file: null
+      file: null,
     };
 
     // Open a dialog that hosts a form to select a file
     const result = await showDialogBase({
       title: 'Upload File and Set Dataset Name',
       body: new DialogBody(parameter),
-      buttons: [Dialog.cancelButton(), Dialog.okButton()]
+      buttons: [Dialog.cancelButton(), Dialog.okButton()],
     });
 
     if (result.button.accept) {
@@ -51,7 +51,7 @@ export namespace DatasetActions {
           name: 'dataset',
           value: parameterValue,
           variableType: 'string',
-          fieldType: 'input'
+          fieldType: 'input',
         };
         ParameterActions.setParameter(notebook, parameter);
       }
@@ -67,15 +67,15 @@ export namespace DatasetActions {
     spinnerDialogBody.node.appendChild(spinner.node);
     const spinnerDialog = new Dialog({
       body: spinnerDialogBody,
-      buttons: []
+      buttons: [],
     });
     spinnerDialog.launch();
     try {
       const formData = new FormData();
       formData.append('file', file);
       const response = await requestAPI<any>('datasets', {
         method: 'POST',
-        body: formData
+        body: formData,
       });
       spinnerDialog.dispose();
       return response;
@@ -141,5 +141,5 @@ class DialogBody extends Widget {
 
 export const setDatasetIcon = new LabIcon({
   name: 'platiagro:set-dataset',
-  svgstr: setDatasetSvgstr
+  svgstr: setDatasetSvgstr,
 });

src/dropdown-options.ts

@@ -11,6 +11,7 @@ export class DropdownOptions extends Widget {
   /**
    * Construct a new widget.
    */
+  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
   constructor(parameter: any) {
     super();
     this.parameter = parameter;

src/index.ts

@@ -1,7 +1,7 @@
 import {
   IRouter,
   JupyterFrontEnd,
-  JupyterFrontEndPlugin
+  JupyterFrontEndPlugin,
 } from '@jupyterlab/application';
 
 import { IMainMenu } from '@jupyterlab/mainmenu';
@@ -53,7 +53,7 @@ const extension: JupyterFrontEndPlugin<void> = {
     addContextMenuItems(app);
 
     addRouteHandlers(router);
-  }
+  },
 };
 
 /**
@@ -87,23 +87,23 @@ function addCommands(
     execute: () => {
       DatasetActions.showDialog(nbtracker.currentWidget.content);
     },
-    isEnabled
+    isEnabled,
   });
 
   app.commands.addCommand(CommandIDs.setParameter, {
     label: 'Add Parameter',
     execute: () => {
       ParameterActions.showDialog(nbtracker.currentWidget.content);
     },
-    isEnabled
+    isEnabled,
   });
 
   app.commands.addCommand(CommandIDs.openFiles, {
     label: 'Open Files…',
     execute: () => {
       UrlActions.openFiles(app, paths, router);
     },
-    isEnabled
+    isEnabled,
   });
 }
 
@@ -115,11 +115,11 @@ function addMainMenuItems(mainMenu: IMainMenu | null): void {
     mainMenu.editMenu.addGroup(
       [
         {
-          command: CommandIDs.setDataset
+          command: CommandIDs.setDataset,
         },
         {
-          command: CommandIDs.setParameter
-        }
+          command: CommandIDs.setParameter,
+        },
       ],
       20
     );
@@ -133,22 +133,22 @@ function addContextMenuItems(app: JupyterFrontEnd): void {
   app.contextMenu.addItem({
     type: 'separator',
     selector: '.jp-Notebook',
-    rank: 20
+    rank: 20,
   });
   app.contextMenu.addItem({
     command: CommandIDs.setDataset,
     selector: '.jp-Notebook',
-    rank: 21
+    rank: 21,
   });
   app.contextMenu.addItem({
     command: CommandIDs.setParameter,
     selector: '.jp-Notebook',
-    rank: 22
+    rank: 22,
   });
   app.contextMenu.addItem({
     type: 'separator',
     selector: '.jp-Notebook',
-    rank: 23
+    rank: 23,
   });
 }
 
@@ -159,7 +159,7 @@ function addRouteHandlers(router: IRouter): void {
   router.register({
     command: CommandIDs.openFiles,
     pattern: /(\?open=.*?|&open=.*?)($|&)/,
-    rank: 10 // High priority: 10:100.
+    rank: 10, // High priority: 10:100.
   });
 }
 

src/option-widget.ts

@@ -35,7 +35,7 @@ export class OptionWidget extends Widget {
       height: '18px',
       width: '18px',
       marginLeft: '5px',
-      marginRight: '-3px'
+      marginRight: '-3px',
     });
     if (this.applied) {
       this.addClass('applied-tag');

src/parameter.ts

@@ -29,14 +29,14 @@ export namespace ParameterActions {
       options: [],
       multiple: false,
       label: '',
-      description: ''
+      description: '',
     }
   ): Promise<void> => {
     // Open a dialog that hosts a form to set a parameter
     const result = await showDialogBase({
       title: 'Add Parameter',
       body: new DialogBody(parameter),
-      buttons: [Dialog.cancelButton(), Dialog.okButton()]
+      buttons: [Dialog.cancelButton(), Dialog.okButton()],
     });
 
     if (result.button.accept) {
@@ -52,22 +52,23 @@ export namespace ParameterActions {
    */
   export const setParameter = async (
     notebook: Notebook,
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     parameter: any
   ): Promise<void> => {
     // validate required fields
     if (!parameter.name || !parameter.fieldType || !parameter.variableType) {
       await showDialogBase({
         title: 'Cannot add parameter',
         body: 'Variable name, Variable type, and Form field type are required',
-        buttons: [Dialog.okButton()]
+        buttons: [Dialog.okButton()],
       });
 
       void ParameterActions.showDialog(notebook, parameter);
       return;
     }
 
     // get the index of first cell that has a tag 'parameters'
-    const index = notebook.widgets.findIndex(cell => {
+    const index = notebook.widgets.findIndex((cell) => {
       const tags = cell.model.metadata.get('tags') as string[];
       return tags === undefined ? false : tags.includes('parameters');
     });
@@ -233,9 +234,9 @@ class DialogBody extends Widget {
       'integer',
       'number',
       'boolean',
-      'feature'
+      'feature',
     ];
-    variableTypeOptions.forEach(item => {
+    variableTypeOptions.forEach((item) => {
       const option = document.createElement('option');
       option.value = item;
       option.textContent = item;
@@ -251,7 +252,7 @@ class DialogBody extends Widget {
     this.fieldTypeSelect = document.createElement('select');
     this.fieldTypeSelect.name = 'fieldType';
     const fieldTypeOptions = ['', 'input', 'dropdown'];
-    fieldTypeOptions.forEach(item => {
+    fieldTypeOptions.forEach((item) => {
       const option = document.createElement('option');
       option.value = item;
       option.textContent = item;
@@ -329,5 +330,5 @@ class DialogBody extends Widget {
 
 export const setParameterIcon = new LabIcon({
   name: 'platiagro:set-parameter',
-  svgstr: setParameterSvgstr
+  svgstr: setParameterSvgstr,
 });