condaActivationProvider.ts

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
'use strict';
import '../../extensions';

import { inject, injectable } from 'inversify';
import * as path from 'path';
import { Uri } from 'vscode';

import { ICondaService } from '../../../interpreter/contracts';
import { IPlatformService } from '../../platform/types';
import { IConfigurationService } from '../../types';
import { ITerminalActivationCommandProvider, TerminalShellType } from '../types';

// Version number of conda that requires we call activate with 'conda activate' instead of just 'activate'
const CondaRequiredMajor = 4;
const CondaRequiredMinor = 4;
const CondaRequiredMinorForPowerShell = 6;

/**
 * Support conda env activation (in the terminal).
 */
@injectable()
export class CondaActivationCommandProvider implements ITerminalActivationCommandProvider {
    constructor(
        @inject(ICondaService) private readonly condaService: ICondaService,
        @inject(IPlatformService) private platform: IPlatformService,
        @inject(IConfigurationService) private configService: IConfigurationService
    ) {}

    /**
     * Is the given shell supported for activating a conda env?
     */
    public isShellSupported(_targetShell: TerminalShellType): boolean {
        return true;
    }

    /**
     * Return the command needed to activate the conda env.
     */
    public getActivationCommands(
        resource: Uri | undefined,
        targetShell: TerminalShellType
    ): Promise<string[] | undefined> {
        const pythonPath = this.configService.getSettings(resource).pythonPath;
        return this.getActivationCommandsForInterpreter(pythonPath, targetShell);
    }

    /**
     * Return the command needed to activate the conda env.
     *
     */
    public async getActivationCommandsForInterpreter(
        pythonPath: string,
        targetShell: TerminalShellType
    ): Promise<string[] | undefined> {
        const envInfo = await this.condaService.getCondaEnvironment(pythonPath);
        if (!envInfo) {
            return;
        }

        const condaEnv = envInfo.name.length > 0 ? envInfo.name : envInfo.path;

        // Algorithm differs based on version
        // Old version, just call activate directly.
        // New version, call activate from the same path as our python path, then call it again to activate our environment.
        // -- note that the 'default' conda location won't allow activate to work for the environment sometimes.
        const versionInfo = await this.condaService.getCondaVersion();
        if (versionInfo && versionInfo.major >= CondaRequiredMajor) {
            // Conda added support for powershell in 4.6.
            if (
                versionInfo.minor >= CondaRequiredMinorForPowerShell &&
                (targetShell === TerminalShellType.powershell || targetShell === TerminalShellType.powershellCore)
            ) {
                return this.getPowershellCommands(condaEnv);
            }
            if (versionInfo.minor >= CondaRequiredMinor) {
                // New version.
                const interpreterPath = await this.condaService.getCondaFileFromInterpreter(pythonPath, envInfo.name);
                if (interpreterPath) {
                    const activatePath = path.join(path.dirname(interpreterPath), 'activate').fileToCommandArgument();
                    const firstActivate = this.platform.isWindows ? activatePath : `source ${activatePath}`;
                    return [firstActivate, `conda activate ${condaEnv.toCommandArgument()}`];
                }
            }
        }

        switch (targetShell) {
            case TerminalShellType.powershell:
            case TerminalShellType.powershellCore:
                return this.getPowershellCommands(condaEnv);

            // tslint:disable-next-line:no-suspicious-comment
            // TODO: Do we really special-case fish on Windows?
            case TerminalShellType.fish:
                return this.getFishCommands(condaEnv, await this.condaService.getCondaFile());

            default:
                if (this.platform.isWindows) {
                    return this.getWindowsCommands(condaEnv);
                } else {
                    return this.getUnixCommands(condaEnv, await this.condaService.getCondaFile());
                }
        }
    }

    public async getWindowsActivateCommand(): Promise<string> {
        let activateCmd: string = 'activate';

        const condaExePath = await this.condaService.getCondaFile();

        if (condaExePath && path.basename(condaExePath) !== condaExePath) {
            const condaScriptsPath: string = path.dirname(condaExePath);
            // prefix the cmd with the found path, and ensure it's quoted properly
            activateCmd = path.join(condaScriptsPath, activateCmd);
            activateCmd = activateCmd.toCommandArgument();
        }

        return activateCmd;
    }

    public async getWindowsCommands(condaEnv: string): Promise<string[] | undefined> {
        const activate = await this.getWindowsActivateCommand();
        return [`${activate} ${condaEnv.toCommandArgument()}`];
    }
    /**
     * The expectation is for the user to configure Powershell for Conda.
     * Hence we just send the command `conda activate ...`.
     * This configuration is documented on Conda.
     * Extension will not attempt to work around issues by trying to setup shell for user.
     *
     * @param {string} condaEnv
     * @returns {(Promise<string[] | undefined>)}
     * @memberof CondaActivationCommandProvider
     */
    public async getPowershellCommands(condaEnv: string): Promise<string[] | undefined> {
        return [`conda activate ${condaEnv.toCommandArgument()}`];
    }

    public async getFishCommands(condaEnv: string, condaFile: string): Promise<string[] | undefined> {
        // https://github.com/conda/conda/blob/be8c08c083f4d5e05b06bd2689d2cd0d410c2ffe/shell/etc/fish/conf.d/conda.fish#L18-L28
        return [`${condaFile.fileToCommandArgument()} activate ${condaEnv.toCommandArgument()}`];
    }

    public async getUnixCommands(condaEnv: string, condaFile: string): Promise<string[] | undefined> {
        const condaDir = path.dirname(condaFile);
        const activateFile = path.join(condaDir, 'activate');
        return [`source ${activateFile.fileToCommandArgument()} ${condaEnv.toCommandArgument()}`];
    }
}