Skip to content
This repository has been archived by the owner on Dec 8, 2020. It is now read-only.

Commit

Permalink
Allows developers to specify the nightly toolchain (#299)
Browse files Browse the repository at this point in the history
  • Loading branch information
@KalitaAlexey
KalitaAlexey authored Jun 24, 2017
1 parent e78420c commit 5442989
Show file tree
Hide file tree
Showing 5 changed files with 277 additions and 204 deletions.
5 changes: 5 additions & 0 deletions doc/common_configuration_parameters.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,8 @@ This configuration parameter specifies which toolchain the extension will invoke
It is used for getting sysroot, installing components, invoking Cargo

However there are few exceptions. Currently RLS is available for nightly hence RLS and rust-analysis are installed for the nightly toolchain.

### nightlyToolchain

This configuration parameter specifies which toolchain the extension will invoke rustup with.
It is used for installing RLS and related stuff.
8 changes: 8 additions & 0 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,14 @@
"string",
"null"
]
},
"nightlyToolchain": {
"default": null,
"description": "The nightly toolchain to use for installing RLS and related components and running RLS",
"type": [
"string",
"null"
]
}
}
},
Expand Down
14 changes: 13 additions & 1 deletion src/components/configuration/RlsConfiguration.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ export class RlsConfiguration {
return new RlsConfiguration(rustup, rustSource, executableUserPath);
}

/**
* Returns if there is some executable path specified by the user
*/
public isExecutableUserPathSet(): boolean {
return this._executableUserPath !== undefined;
}

/**
* Returns a path to RLS executable
*/
Expand All @@ -47,7 +54,12 @@ export class RlsConfiguration {
// When the user specifies some executable path, the user expects the extension not to add
// some arguments
if (this._executableUserPath === undefined && this._rustup && this._rustup.isRlsInstalled()) {
return ['run', 'nightly', 'rls'].concat(this._userArgs);
const userToolchain = this._rustup.getUserNightlyToolchain();
if (!userToolchain) {
// It is actually impossible because `isRlsInstalled` uses `getUserNightlyToolchain`
return this._userArgs;
}
return ['run', userToolchain.toString(true, false), 'rls'].concat(this._userArgs);
} else {
return this._userArgs;
}
Expand Down
119 changes: 46 additions & 73 deletions src/components/configuration/Rustup.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,6 @@ export class Rustup {
*/
private pathToRustSourceCode: string | undefined;

/**
* A path to the executable of RLS.
* It can be undefined if the component "rls" is not installed
*/
private pathToRlsExecutable: string | undefined;

/**
* Components received by invoking rustup
*/
Expand All @@ -48,6 +42,10 @@ export class Rustup {
*/
private _userToolchain: Toolchain | undefined;

/**
* The nightly toolchain chosen by the user
*/
private _userNightlyToolchain: Toolchain | undefined;

/**
* Returns the executable of Rustup
Expand All @@ -70,26 +68,6 @@ export class Rustup {
return rustup;
}

/**
* Return either the only nightly toolchain or undefined if there is no nightly toolchain or
* there are several nightly toolchains
*/
public getNightlyToolchain(logger: ChildLogger): Toolchain | undefined {
const functionLogger = logger.createChildLogger('getNightlyToolchain: ');
const nightlyToolchains = this.getNightlyToolchains();
switch (nightlyToolchains.length) {
case 0:
functionLogger.error('There is no nightly toolchain');
return undefined;
case 1:
functionLogger.debug('There is only one nightly toolchain');
return nightlyToolchains[0];
default:
functionLogger.debug(`There are ${nightlyToolchains.length} nightly toolchains`);
return undefined;
}
}

/**
* Returns either the default toolchain or undefined if there are no installed toolchains
*/
Expand All @@ -109,6 +87,10 @@ export class Rustup {
return this.toolchains;
}

public getNightlyToolchains(): Toolchain[] {
return this.toolchains.filter(t => t.channel === 'nightly');
}

/**
* Checks if the toolchain is installed
* @param toolchain The toolchain to check
Expand All @@ -125,10 +107,24 @@ export class Rustup {
}

/**
* Returns either the path to the executable of RLS or undefined
* Returns either the nightly toolchain chosen by the user or undefined
*/
public getPathToRlsExecutable(): string | undefined {
return this.pathToRlsExecutable;
public getUserNightlyToolchain(): Toolchain | undefined {
return this._userNightlyToolchain;
}

/**
* Sets the new value of the nightly toolchain in the object and in the configuration
* @param toolchain The new value
*/
public setUserNightlyToolchain(toolchain: Toolchain | undefined): void {
if (this._userNightlyToolchain === toolchain) {
return;
}
this._userNightlyToolchain = toolchain;
updateUserConfigurationParameter(c => {
c.nightlyToolchain = toolchain ? toolchain.toString(true, false) : null;
});
}

/**
Expand All @@ -143,7 +139,9 @@ export class Rustup {
return;
}
this._userToolchain = toolchain;
updateUserConfigurationParameter(c => c.toolchain = toolchain ? toolchain.toString(true, false) : null);
updateUserConfigurationParameter(c => {
c.toolchain = toolchain ? toolchain.toString(true, false) : null;
});
}

/**
Expand Down Expand Up @@ -188,7 +186,7 @@ export class Rustup {
*/
public async installRls(): Promise<boolean> {
const logger = this.logger.createChildLogger('installRls: ');
const nightlyToolchain = this.getNightlyToolchain(logger);
const nightlyToolchain = this.getUserNightlyToolchain();
if (!nightlyToolchain) {
logger.error('no nightly toolchain');
return false;
Expand All @@ -197,17 +195,7 @@ export class Rustup {
nightlyToolchain,
Rustup.getRlsComponentName()
);
if (!isComponentInstalled) {
return false;
}
// We need to update the field
await this.updatePathToRlsExecutable();
if (!this.pathToRlsExecutable) {
logger.error('RLS had been installed successfully, but we failed to find it in PATH. This should have not happened');

return false;
}
return true;
return isComponentInstalled;
}

/**
Expand All @@ -216,7 +204,7 @@ export class Rustup {
*/
public async installRustAnalysis(): Promise<boolean> {
const logger = this.logger.createChildLogger('installRustAnalysis: ');
const nightlyToolchain = this.getNightlyToolchain(logger);
const nightlyToolchain = this.getUserNightlyToolchain();
if (!nightlyToolchain) {
logger.error('no nightly toolchain');
return false;
Expand Down Expand Up @@ -291,31 +279,13 @@ export class Rustup {
}
}

/**
* Checks if the executable of RLS is installed.
* This method assigns either a path to the executable or undefined to the field `pathToRlsExecutable`, depending on if the executable is found
* This method is asynchronous because it checks if the executable exists
*/
public async updatePathToRlsExecutable(): Promise<void> {
const logger = this.logger.createChildLogger('updatePathToRlsExecutable: ');
this.pathToRlsExecutable = undefined;
const rlsPath: string | undefined = await FileSystem.findExecutablePath('rls');
logger.debug(`rlsPath=${rlsPath}`);
if (!rlsPath) {
// RLS is installed via Rustup, but isn't found. Let a user know about it
logger.error(`Rustup had reported that RLS had been installed, but RLS wasn't found in PATH=${process.env.PATH}`);
return;
}
this.pathToRlsExecutable = rlsPath;
}

/**
* Requests Rustup give a list of components, parses it, checks if RLS is present in the list and returns if it is
* @returns true if RLS can be installed otherwise false
*/
public canInstallRls(): boolean {
const logger = this.logger.createChildLogger('canInstallRls: ');
const nightlyToolchain = this.getNightlyToolchain(logger);
const nightlyToolchain = this.getUserNightlyToolchain();
if (!nightlyToolchain) {
logger.error('no nightly toolchain');
return false;
Expand Down Expand Up @@ -343,7 +313,7 @@ export class Rustup {
*/
public isRlsInstalled(): boolean {
const logger = this.logger.createChildLogger('isRlsInstalled: ');
const nightlyToolchain = this.getNightlyToolchain(logger);
const nightlyToolchain = this.getUserNightlyToolchain();
if (!nightlyToolchain) {
logger.error('no nightly toolchain');
return false;
Expand All @@ -357,7 +327,7 @@ export class Rustup {
*/
public isRustAnalysisInstalled(): boolean {
const logger = this.logger.createChildLogger('isRustAnalysisInstalled: ');
const nightlyToolchain = this.getNightlyToolchain(logger);
const nightlyToolchain = this.getUserNightlyToolchain();
if (!nightlyToolchain) {
logger.error('no nightly toolchain');
return false;
Expand All @@ -371,7 +341,7 @@ export class Rustup {
*/
public canInstallRustAnalysis(): boolean {
const logger = this.logger.createChildLogger('canInstallRustAnalysis: ');
const nightlyToolchain = this.getNightlyToolchain(logger);
const nightlyToolchain = this.getUserNightlyToolchain();
if (!nightlyToolchain) {
logger.error('no nightly toolchain');
return false;
Expand Down Expand Up @@ -502,20 +472,15 @@ export class Rustup {
* @param logger A value for the field `logger`
* @param pathToRustcSysRoot A value for the field `pathToRustcSysRoot`
* @param pathToRustSourceCode A value for the field `pathToRustSourceCode`
* @param pathToRlsExecutable A value fo the field `pathToRlsExecutable`
*/
private constructor(logger: ChildLogger) {
this.logger = logger;
this.pathToRustcSysRoot = undefined;
this.pathToRustSourceCode = undefined;
this.pathToRlsExecutable = undefined;
this.components = {};
this.toolchains = [];
this._userToolchain = getUserToolchain();
}

private getNightlyToolchains(): Toolchain[] {
return this.toolchains.filter(t => t.channel === 'nightly');
this._userNightlyToolchain = getUserNightlyToolchain();
}

/**
Expand Down Expand Up @@ -580,12 +545,12 @@ function getUserConfiguration(): any {
return rustupConfiguration;
}

function getUserToolchain(): Toolchain | undefined {
function getToolchainFromConfigurationParameter(parameter: string): Toolchain | undefined {
const rustupConfiguration = getUserConfiguration();
if (!rustupConfiguration) {
return undefined;
}
const toolchainAsString = rustupConfiguration.toolchain;
const toolchainAsString = rustupConfiguration[parameter];
if (!toolchainAsString) {
return undefined;
}
Expand All @@ -597,6 +562,14 @@ function getUserToolchain(): Toolchain | undefined {
}
}

function getUserNightlyToolchain(): Toolchain | undefined {
return getToolchainFromConfigurationParameter('nightlyToolchain');
}

function getUserToolchain(): Toolchain | undefined {
return getToolchainFromConfigurationParameter('toolchain');
}

function updateUserConfigurationParameter(updateParameter: (c: any) => void): void {
let configuration = getUserConfiguration();
if (!configuration) {
Expand Down
Loading

0 comments on commit 5442989

Please sign in to comment.