Merge pull request #320 from RRosio/pkg_actions

Split package actions from frontend components and add signals

Author: RRosio

packages/common/src/commands/registerPkgCommands.ts

@@ -0,0 +1,38 @@
+import { CommandRegistry } from '@lumino/commands';
+import { Conda } from '../tokens';
+import {
+  updateAllPackages,
+  applyPackageChanges,
+  refreshAvailablePackages as refreshAvailablePkgs
+} from '../packageActions';
+
+export function registerPkgCommands(
+  commands: CommandRegistry,
+  pkgModel: Conda.IPackageManager
+) {
+  commands.addCommand('gator-lab:update-all-packages', {
+    label: 'Update All Packages',
+    execute: async args => {
+      const environment = args['environment'] as string;
+      await updateAllPackages(pkgModel, environment);
+    }
+  });
+
+  commands.addCommand('gator-lab:apply-package-changes', {
+    label: 'Apply Package Changes',
+    execute: async args => {
+      const selectedPackages = args[
+        'selectedPackages'
+      ] as unknown as Conda.IPackage[];
+      const environment = args['environment'] as string;
+      await applyPackageChanges(pkgModel, selectedPackages, environment);
+    }
+  });
+  commands.addCommand('gator-lab:refresh-available-packages', {
+    label: 'Refresh Available Packages',
+    execute: async args => {
+      const environment = args['environment'] as string;
+      await refreshAvailablePkgs(pkgModel, environment);
+    }
+  });
+}

packages/common/src/components/CondaPkgPanel.tsx

@@ -10,6 +10,11 @@ import {
   PkgFilters
 } from './CondaPkgToolBar';
 import { PkgGraphWidget } from './PkgGraph';
+import {
+  updateAllPackages,
+  applyPackageChanges,
+  refreshAvailablePackages as refreshAvailablePkgs
+} from '../packageActions';
 
 // Minimal panel width to show package description
 const PANEL_SMALL_WIDTH = 500;
@@ -121,11 +126,6 @@ export class CondaPkgPanel extends React.Component<
       selected: []
     });
 
-    const loadingNotification = Notification.emit(
-      `Loading packages for ${environmentName}...`,
-      'in-progress'
-    );
-
     try {
       const environmentLoading =
         this._currentEnvironment || this._model.environment;
@@ -164,32 +164,32 @@ export class CondaPkgPanel extends React.Component<
         packages: available,
         hasUpdate
       });
-
-      Notification.update({
-        id: loadingNotification,
-        message: `Packages loaded successfully for ${environmentName}`,
-        type: 'success',
-        autoClose: 3000
-      });
     } catch (error) {
       if ((error as any).message !== 'cancelled') {
-        this.setState({
-          isLoading: false
-        });
         console.error(error);
-
-        Notification.update({
-          id: loadingNotification,
-          message: `Failed to load packages for ${environmentName}`,
-          type: 'error',
-          autoClose: 0
-        });
-      } else {
-        Notification.dismiss(loadingNotification);
+        Notification.error(`Failed to load packages for ${environmentName}`);
       }
+    } finally {
+      this.setState({
+        isLoading: false
+      });
     }
   }
 
+  /**
+   * Cancel package changes (reset selection state)
+   *
+   * @param selectedPackages List of packages with pending changes
+   */
+  private _cancelPackageChanges(selectedPackages: Conda.IPackage[]): void {
+    selectedPackages.forEach(
+      pkg =>
+        (pkg.version_selected = pkg.version_installed
+          ? pkg.version_installed
+          : 'none')
+    );
+  }
+
   handleCategoryChanged(event: React.ChangeEvent<HTMLSelectElement>): void {
     if (this.state.isApplyingChanges) {
       return;
@@ -295,50 +295,15 @@ export class CondaPkgPanel extends React.Component<
       return;
     }
 
-    let toastId = '';
+    // TODO: Handle the case where the user cancels the update: show a notification here rather than in the packageActions.ts file
     try {
       this.setState({
         searchTerm: '',
-        activeFilter: PkgFilters.Updatable
-      });
-
-      const confirmation = await showDialog({
-        title: 'Update all',
-        body: 'Please confirm you want to update all packages? Conda enforces environment consistency. So maybe only a subset of the available updates will be applied.'
+        activeFilter: PkgFilters.Updatable,
+        isApplyingChanges: true
       });
 
-      if (confirmation.button.accept) {
-        this.setState({
-          isApplyingChanges: true
-        });
-        toastId = Notification.emit('Updating packages', 'in-progress');
-        await this._model.update(['--all'], this._currentEnvironment);
-
-        Notification.update({
-          id: toastId,
-          message: 'Package updated successfully.',
-          type: 'success',
-          autoClose: 5000
-        });
-      }
-    } catch (error) {
-      if (error !== 'cancelled') {
-        console.error(error);
-        if (toastId) {
-          Notification.update({
-            id: toastId,
-            message: (error as any).message,
-            type: 'error',
-            autoClose: 0
-          });
-        } else {
-          Notification.error((error as any).message);
-        }
-      } else {
-        if (toastId) {
-          Notification.dismiss(toastId);
-        }
-      }
+      await updateAllPackages(this._model, this._currentEnvironment);
     } finally {
       this.setState({
         isApplyingChanges: false,
@@ -360,91 +325,19 @@ export class CondaPkgPanel extends React.Component<
       return;
     }
 
-    let toastId = '';
+    // TODO: Handle the case where the user cancels the modifications: show a notification here rather than in the packageActions.ts file
     try {
       this.setState({
         searchTerm: '',
-        activeFilter: PkgFilters.Selected
+        activeFilter: PkgFilters.Selected,
+        isApplyingChanges: true
       });
 
-      const confirmation = await showDialog({
-        title: 'Packages actions',
-        body: 'Please confirm you want to apply the selected actions?'
-      });
-
-      if (confirmation.button.accept) {
-        this.setState({
-          isApplyingChanges: true
-        });
-        toastId = Notification.emit('Starting packages actions', 'in-progress');
-
-        // Get modified pkgs
-        const toRemove: Array<string> = [];
-        const toUpdate: Array<string> = [];
-        const toInstall: Array<string> = [];
-        this.state.selected.forEach(pkg => {
-          if (pkg.version_installed && pkg.version_selected === 'none') {
-            toRemove.push(pkg.name);
-          } else if (pkg.updatable && pkg.version_selected === '') {
-            toUpdate.push(pkg.name);
-          } else {
-            toInstall.push(
-              pkg.version_selected
-                ? pkg.name + '=' + pkg.version_selected
-                : pkg.name
-            );
-          }
-        });
-
-        if (toRemove.length > 0) {
-          Notification.update({
-            id: toastId,
-            message: 'Removing selected packages'
-          });
-          await this._model.remove(toRemove, this._currentEnvironment);
-        }
-
-        if (toUpdate.length > 0) {
-          Notification.update({
-            id: toastId,
-            message: 'Updating selected packages'
-          });
-          await this._model.update(toUpdate, this._currentEnvironment);
-        }
-
-        if (toInstall.length > 0) {
-          Notification.update({
-            id: toastId,
-            message: 'Installing new packages'
-          });
-          await this._model.install(toInstall, this._currentEnvironment);
-        }
-
-        Notification.update({
-          id: toastId,
-          message: 'Package actions successfully done.',
-          type: 'success',
-          autoClose: 5000
-        });
-      }
-    } catch (error) {
-      if (error !== 'cancelled') {
-        console.error(error);
-        if (toastId) {
-          Notification.update({
-            id: toastId,
-            message: (error as any).message,
-            type: 'error',
-            autoClose: 0
-          });
-        } else {
-          Notification.error((error as any).message);
-        }
-      } else {
-        if (toastId) {
-          Notification.dismiss(toastId);
-        }
-      }
+      await applyPackageChanges(
+        this._model,
+        this.state.selected,
+        this._currentEnvironment
+      );
     } finally {
       this.setState({
         isApplyingChanges: false,
@@ -460,53 +353,23 @@ export class CondaPkgPanel extends React.Component<
       return;
     }
 
-    this.state.selected.forEach(
-      pkg =>
-        (pkg.version_selected = pkg.version_installed
-          ? pkg.version_installed
-          : 'none')
-    );
+    this._cancelPackageChanges(this.state.selected);
 
     this.setState({
       selected: []
     });
   }
 
   async handleRefreshPackages(): Promise<void> {
-    const environmentName = this._currentEnvironment || this._model.environment;
-    if (!environmentName) {
+    if (this.state.isApplyingChanges) {
       return;
     }
 
-    const refreshNotification = Notification.emit(
-      `Refreshing available packages for ${environmentName}...`,
-      'in-progress'
-    );
-
     try {
-      await this._model.refreshAvailablePackages();
-
-      Notification.update({
-        id: refreshNotification,
-        message: `Available packages refreshed for ${environmentName}`,
-        type: 'success',
-        autoClose: 3000
-      });
-    } catch (error) {
-      if ((error as any).message !== 'cancelled') {
-        console.error('Error when refreshing the available packages.', error);
-
-        Notification.update({
-          id: refreshNotification,
-          message: `Failed to refresh available packages for ${environmentName}`,
-          type: 'error',
-          autoClose: 0
-        });
-      } else {
-        Notification.dismiss(refreshNotification);
-      }
+      await refreshAvailablePkgs(this._model, this._currentEnvironment);
+    } finally {
+      this._updatePackages();
     }
-    this._updatePackages();
   }
 
   componentDidUpdate(prevProps: IPkgPanelProps): void {

packages/common/src/index.ts

@@ -3,9 +3,5 @@ export * from './constants';
 export * from './icon';
 export { CondaEnvironments } from './services';
 export { Conda, IEnvironmentManager } from './tokens';
-export {
-  cloneEnvironment,
-  exportEnvironment,
-  removeEnvironment
-} from './environmentActions';
 export { registerEnvCommands } from './commands/registerEnvCommands';
+export { registerPkgCommands } from './commands/registerPkgCommands';