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

Handle exceptions from TFVC Initialize/Reinitialize #239

Merged
merged 3 commits into from
May 22, 2017
Merged

Handle exceptions from TFVC Initialize/Reinitialize #239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
36aa528
Handle TFVC exceptions (and simplify setErrorStatus)
May 22, 2017
52d7cd5
Await on async Refresh() - otherwise, rejected promises can go unhandled
May 22, 2017
e890890
Utilize provided messageOptions when displaying errors
May 22, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 49 additions & 31 deletions src/extensionmanager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ export class ExtensionManager implements Disposable {
|| !this._serverContext.RepoInfo.IsTeamFoundation) {
//If the user previously signed out (in this session of VS Code), show a message to that effect
if (this._teamExtension.IsSignedOut) {
this.setErrorStatus(Strings.UserMustSignIn);
this.setErrorStatus(Strings.UserMustSignIn, CommandNames.Signin);
} else {
this.setErrorStatus(Strings.NoRepoInformation);
}
Expand Down Expand Up @@ -224,10 +224,18 @@ export class ExtensionManager implements Disposable {
displayError = util.format(Strings.NoAccessTokenLearnMoreRunSignin, this._serverContext.RepoInfo.Account);
}
Logger.LogError(error);
this.setErrorStatus(error, CommandNames.Signin, false);
this.setErrorStatus(error, CommandNames.Signin);
VsCodeUtils.ShowErrorMessage(displayError, ...messageItems);
}

private formatErrorLogMessage(err): string {
let logMsg: string = err.message;
if (err.stderr) { //Add stderr to logged message if we have it
logMsg = Utils.FormatMessage(`${logMsg} ${err.stderr}`);
}
return logMsg;
}

private async initializeExtension(): Promise<void> {
//Don't initialize if we don't have a workspace
if (!workspace || !workspace.rootPath) {
Expand Down Expand Up @@ -307,7 +315,7 @@ export class ExtensionManager implements Disposable {
Logger.LogObject(settings);
this.logDebugInformation();
} catch (err) {
this.setErrorStatus(Utils.GetMessageForStatusCode(err, err.message), (err.statusCode === 401 ? CommandNames.Signin : undefined), false);
this.setErrorStatus(Utils.GetMessageForStatusCode(err, err.message), (err.statusCode === 401 ? CommandNames.Signin : undefined));
//Wrap err here to get a useful call stack
this.ReportError(new Error(err), Utils.GetMessageForStatusCode(err, err.message, "Failed to get results with accountClient: "));
}
Expand All @@ -316,51 +324,62 @@ export class ExtensionManager implements Disposable {
// We get a 404 on-prem if we aren't TFS 2015 Update 2 or later and 'core id' error with TFS 2013 RTM (and likely later)
if (this._serverContext.RepoInfo.IsTeamFoundationServer === true &&
(err.statusCode === 404 || (err.message && err.message.indexOf("Failed to find api location for area: core id:") === 0))) {
this.setErrorStatus(Strings.UnsupportedServerVersion, undefined, false);
this.setErrorStatus(Strings.UnsupportedServerVersion);
Logger.LogError(Strings.UnsupportedServerVersion);
Telemetry.SendEvent(TelemetryEvents.UnsupportedServerVersion);
} else {
this.setErrorStatus(Utils.GetMessageForStatusCode(err, err.message), (err.statusCode === 401 ? CommandNames.Signin : undefined), false);
this.setErrorStatus(Utils.GetMessageForStatusCode(err, err.message), (err.statusCode === 401 ? CommandNames.Signin : undefined));
//Wrap err here to get a useful call stack
this.ReportError(new Error(err), Utils.GetMessageForStatusCode(err, err.message, "Failed call with repositoryClient: "));
}
}
}

// Now that everything else is ready, create the SCM provider
if (this._repoContext.Type === RepositoryType.TFVC) {
const tfvcContext: TfvcContext = <TfvcContext>this._repoContext;
this.sendTfvcConfiguredTelemetry(tfvcContext.TfvcRepository);
Logger.LogInfo(`Sent TFVC tooling telemetry`);
if (!this._scmProvider) {
Logger.LogDebug(`Initializing the TfvcSCMProvider`);
this._scmProvider = new TfvcSCMProvider(this);
await this._scmProvider.Initialize();
Logger.LogDebug(`Initialized the TfvcSCMProvider`);
} else {
Logger.LogDebug(`Re-initializing the TfvcSCMProvider`);
await this._scmProvider.Reinitialize();
Logger.LogDebug(`Re-initialized the TfvcSCMProvider`);
try {
if (this._repoContext.Type === RepositoryType.TFVC) {
const tfvcContext: TfvcContext = <TfvcContext>this._repoContext;
this.sendTfvcConfiguredTelemetry(tfvcContext.TfvcRepository);
Logger.LogInfo(`Sent TFVC tooling telemetry`);
if (!this._scmProvider) {
Logger.LogDebug(`Initializing the TfvcSCMProvider`);
this._scmProvider = new TfvcSCMProvider(this);
await this._scmProvider.Initialize();
Logger.LogDebug(`Initialized the TfvcSCMProvider`);
} else {
Logger.LogDebug(`Re-initializing the TfvcSCMProvider`);
await this._scmProvider.Reinitialize();
Logger.LogDebug(`Re-initialized the TfvcSCMProvider`);
}
this.sendTfvcConnectedTelemetry(tfvcContext.TfvcRepository);
}
} catch (err) {
Logger.LogError(`Caught an exception during Tfvc SCM Provider initialization`);
const logMsg: string = this.formatErrorLogMessage(err);
Logger.LogError(logMsg);
if (err.tfvcErrorCode) {
this.setErrorStatus(err.message);
//Dispose of the Build and WIT status bar items so they don't show up (they should be re-created once a new folder is opened)
this._teamExtension.cleanup();
if (this.shouldDisplayTfvcError(err.tfvcErrorCode)) {
VsCodeUtils.ShowErrorMessage(err.message, ...err.messageOptions);
}
}
this.sendTfvcConnectedTelemetry(tfvcContext.TfvcRepository);
}
}).fail((err) => {
this.setErrorStatus(Utils.GetMessageForStatusCode(err, err.message), (err.statusCode === 401 ? CommandNames.Signin : undefined), false);
this.setErrorStatus(Utils.GetMessageForStatusCode(err, err.message), (err.statusCode === 401 ? CommandNames.Signin : undefined));
//If we can't get a requestHandler, report the error via the feedbackclient
const message: string = Utils.GetMessageForStatusCode(err, err.message, "Failed to get a credential handler");
Logger.LogError(message);
Telemetry.SendException(err);
});
}
} catch (err) {
let logMsg: string = err.message;
if (err.stderr) { //Add stderr to logged message if we have it
logMsg = Utils.FormatMessage(`${logMsg} ${err.stderr}`);
}
const logMsg: string = this.formatErrorLogMessage(err);
Logger.LogError(logMsg);
//For now, don't report these errors via the FeedbackClient
//For now, don't report these errors via the FeedbackClient (TFVC errors could result from TfvcContext creation failing)
if (!err.tfvcErrorCode || this.shouldDisplayTfvcError(err.tfvcErrorCode)) {
this.setErrorStatus(err.message, undefined, false);
this.setErrorStatus(err.message);
VsCodeUtils.ShowErrorMessage(err.message, ...err.messageOptions);
}
}
Expand Down Expand Up @@ -477,13 +496,12 @@ export class ExtensionManager implements Disposable {
this._errorMessage = undefined;
}

private setErrorStatus(message: string, commandOnClick?: string, showRetryMessage?: boolean): void {
private setErrorStatus(message: string, commandOnClick?: string): void {
this._errorMessage = message;
if (this._teamServicesStatusBarItem !== undefined) {
//TODO: Should the default command be to do nothing? Or perhaps to display the message?
this._teamServicesStatusBarItem.command = commandOnClick === undefined ? CommandNames.Reinitialize : commandOnClick;
this._teamServicesStatusBarItem.text = "Team " + `$(icon octicon-stop)`;
const message: string = this._errorMessage + (showRetryMessage !== undefined && showRetryMessage === true ? " " + Strings.ClickToRetryConnection : "") ;
//TODO: Should the default command be to display the message?
this._teamServicesStatusBarItem.command = commandOnClick; // undefined clears the command
this._teamServicesStatusBarItem.text = `Team $(icon octicon-stop)`;
this._teamServicesStatusBarItem.tooltip = message;
this._teamServicesStatusBarItem.show();
}
Expand Down
Loading