auto detect environment when installing jupyter (microsoft#6629)

* instead of asking the user to select an installer, we now autodetect the environment being used, and use that installer. * added comments and a constant for a product name * changed errorHandler to use the installer with most priority, fixed channelManager so it returns the highest priority installer, increased the priority of the conda installer to 1 * updated the condaInstaller unit tests and changed channel manager to return all supported installers. * Added InstrallerNames.ts with an enum and a Map to help identify the installers used by the extension. Also updated all installers to use it. And returned channel Manager to work as it used to. * removed installerNames.ts and added 'name' to the IModuleInstaller, to be able to use it in code to identify the different installers.

Author: David Kutugata

news/1 Enhancements/6569.md

@@ -0,0 +1 @@
+instead of asking the user to select an installer, we now autodetect the environment being used, and use that installer.

src/client/common/installer/condaInstaller.ts

@@ -22,6 +22,10 @@ export class CondaInstaller extends ModuleInstaller implements IModuleInstaller
  super(serviceContainer);
  }
 
+ public get name(): string {
+ return 'Conda';
+ }
+
  public get displayName() {
  return 'Conda';
  }

src/client/common/installer/moduleInstaller.ts

@@ -16,6 +16,7 @@ import { noop } from '../utils/misc';
 
 @injectable()
 export abstract class ModuleInstaller {
+ public abstract get name(): string;
  public abstract get displayName(): string
  constructor(protected serviceContainer: IServiceContainer) { }
  public async installModule(name: string, resource?: vscode.Uri): Promise<void> {

src/client/common/installer/pipEnvInstaller.ts

@@ -15,6 +15,10 @@ export const pipenvName = 'pipenv';
 export class PipEnvInstaller extends ModuleInstaller implements IModuleInstaller {
  private readonly pipenv: IInterpreterLocatorService;
 
+ public get name(): string {
+ return 'pipenv';
+ }
+
  public get displayName() {
  return pipenvName;
  }

src/client/common/installer/pipInstaller.ts

@@ -12,6 +12,10 @@ import { IModuleInstaller } from './types';
 
 @injectable()
 export class PipInstaller extends ModuleInstaller implements IModuleInstaller {
+ public get name(): string {
+ return 'Pip';
+ }
+
  public get displayName() {
  return 'Pip';
  }

src/client/common/installer/poetryInstaller.ts

@@ -20,6 +20,10 @@ const poetryFile = 'poetry.lock';
 @injectable()
 export class PoetryInstaller extends ModuleInstaller implements IModuleInstaller {
 
+ public get name(): string {
+ return 'poetry';
+ }
+
  public get displayName() {
  return poetryName;
  }

src/client/common/installer/serviceRegistry.ts

@@ -12,7 +12,7 @@ import { InsidersBuildInstaller, StableBuildInstaller } from './extensionBuildIn
 import { PipEnvInstaller } from './pipEnvInstaller';
 import { PipInstaller } from './pipInstaller';
 import { PoetryInstaller } from './poetryInstaller';
-import { CTagsProductPathService, FormatterProductPathService, LinterProductPathService, RefactoringLibraryProductPathService, TestFrameworkProductPathService, DataScienceProductPathService } from './productPath';
+import { CTagsProductPathService, DataScienceProductPathService, FormatterProductPathService, LinterProductPathService, RefactoringLibraryProductPathService, TestFrameworkProductPathService } from './productPath';
 import { ProductService } from './productService';
 import { IExtensionBuildInstaller, IInstallationChannelManager, IModuleInstaller, INSIDERS_INSTALLER, IProductPathService, IProductService, STABLE_INSTALLER } from './types';
 

src/client/common/installer/types.ts

@@ -6,6 +6,7 @@ import { Product, ProductType } from '../types';
 
 export const IModuleInstaller = Symbol('IModuleInstaller');
 export interface IModuleInstaller {
+ readonly name: string;
  readonly displayName: string;
  readonly priority: number;
  installModule(name: string, resource?: Uri): Promise<void>;

src/client/datascience/errorHandler/errorHandler.ts

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 import { inject, injectable } from 'inversify';
 import { IApplicationShell } from '../../common/application/types';
+import { ProductNames } from '../../common/installer/productNames';
 import { IInstallationChannelManager } from '../../common/installer/types';
 import { ILogger, Product } from '../../common/types';
 import * as localize from '../../common/utils/localize';
@@ -25,7 +26,22 @@ export class DataScienceErrorHandler implements IDataScienceErrorHandler {
  localize.DataScience.notebookCheckForImportNo())
  .then(response => {
  if (response === localize.DataScience.jupyterInstall()) {
- return this.channels.getInstallationChannel(Product.jupyter);
+ return this.channels.getInstallationChannels()
+ .then(installers => {
+ if (installers) {
+ // If Conda is available, always pick it as the user must have a Conda Environment
+ const installer = installers.find(ins => ins.name === 'Conda');
+ const product = ProductNames.get(Product.jupyter);
+
+ if (installer && product) {
+ installer.installModule(product)
+ .catch(e => this.applicationShell.showErrorMessage(e.message, localize.DataScience.pythonInteractiveHelpLink()));
+ } else if (installers[0] && product) {
+ installers[0].installModule(product)
+ .catch(e => this.applicationShell.showErrorMessage(e.message, localize.DataScience.pythonInteractiveHelpLink()));
+ }
+ }
+ });
  } else {
  const jupyterError = err as JupyterInstallError;
 
@@ -37,11 +53,6 @@ export class DataScienceErrorHandler implements IDataScienceErrorHandler {
  }
  });
  }
- }).then(installer => {
- if (installer) {
- installer.installModule('jupyter')
- .catch(e => this.applicationShell.showErrorMessage(e.message, localize.DataScience.pythonInteractiveHelpLink()));
- }
  });
  } else if (err instanceof JupyterSelfCertsError) {
  // Don't show the message for self cert errors

src/test/mocks/moduleInstaller.ts

@@ -6,6 +6,11 @@ export class MockModuleInstaller extends EventEmitter implements IModuleInstalle
  constructor(public readonly displayName: string, private supported: boolean) {
  super();
  }
+
+ public get name(): string {
+ return 'mock';
+ }
+
  public get priority(): number {
  return 0;
  }