Improve consistency in client-side login/logout experience

Author: EhabY

src/commands.ts

@@ -159,31 +159,32 @@ export class Commands{
 }
 
 /**
- * Log into the provided deployment. If the deployment URL is not specified,
+ * Log into the provided deployment. If the deployment URL is not specified,
  * ask for it first with a menu showing recent URLs along with the default URL
  * and CODER_URL, if those are set.
  */
-publicasynclogin(...args: string[]): Promise<void>{
-// Destructure would be nice but VS Code can pass undefined which errors.
-constinputUrl=args[0];
-constinputToken=args[1];
-constinputLabel=args[2];
-constisAutologin=
-typeofargs[3]==="undefined" ? false : Boolean(args[3]);
-
-consturl=awaitthis.maybeAskUrl(inputUrl);
+publicasynclogin(args?: {
+url?: string;
+token?: string;
+label?: string;
+autoLogin?: boolean;
+}): Promise<void>{
+consturl=awaitthis.maybeAskUrl(args?.url);
 if(!url){
 return;// The user aborted.
 }
 
 // It is possible that we are trying to log into an old-style host, in which
 // case we want to write with the provided blank label instead of generating
 // a host label.
-constlabel=
-typeofinputLabel==="undefined" ? toSafeHost(url) : inputLabel;
+constlabel=args?.label===undefined ? toSafeHost(url) : args?.label;
 
 // Try to get a token from the user, if we need one, and their user.
-constres=awaitthis.maybeAskToken(url,inputToken,isAutologin);
+constres=awaitthis.maybeAskToken(
+url,
+args?.token,
+args?.autoLogin===true,
+);
 if(!res){
 return;// The user aborted, or unable to auth.
 }
@@ -237,21 +238,23 @@ export class Commands{
  */
 privateasyncmaybeAskToken(
 url: string,
-token: string,
-isAutologin: boolean,
+token: string|undefined,
+isAutoLogin: boolean,
 ): Promise<{user: User;token: string}|null>{
 constclient=CoderApi.create(url,token,this.storage.output,()=>
 vscode.workspace.getConfiguration(),
 );
-if(!needToken(vscode.workspace.getConfiguration())){
-try{
-constuser=awaitclient.getAuthenticatedUser();
-// For non-token auth, we write a blank token since the `vscodessh`
-// command currently always requires a token file.
-return{token: "", user };
-}catch(err){
+constneedsToken=needToken(vscode.workspace.getConfiguration());
+try{
+constuser=awaitclient.getAuthenticatedUser();
+// For non-token auth, we write a blank token since the `vscodessh`
+// command currently always requires a token file.
+// For token auth, we have valid access so we can just return the user here
+return{token: needsToken&&token ? token : "", user };
+}catch(err){
+if(!needToken(vscode.workspace.getConfiguration())){
 constmessage=getErrorMessage(err,"no response from the server");
-if(isAutologin){
+if(isAutoLogin){
 this.storage.output.warn(
 "Failed to log in to Coder server:",
 message,
@@ -286,6 +289,9 @@ export class Commands{
 value: token||(awaitthis.storage.getSessionToken()),
 ignoreFocusOut: true,
 validateInput: async(value)=>{
+if(!value){
+returnnull;
+}
 client.setSessionToken(value);
 try{
 user=awaitclient.getAuthenticatedUser();
@@ -354,7 +360,10 @@ export class Commands{
 // Sanity check; command should not be available if no url.
 thrownewError("You are not logged in");
 }
+awaitthis.forceLogout();
+}
 
+publicasyncforceLogout(): Promise<void>{
 // Clear from the REST client. An empty url will indicate to other parts of
 // the code that we are logged out.
 this.restClient.setHost("");
@@ -373,7 +382,7 @@ export class Commands{
 .showInformationMessage("You've been logged out of Coder!","Login")
 .then((action)=>{
 if(action==="Login"){
-vscode.commands.executeCommand("coder.login");
+this.login();
 }
 });
 

src/extension.ts

@@ -297,6 +297,21 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void>{
 commands.viewLogs.bind(commands),
 );
 
+ctx.subscriptions.push(
+storage.onDidChangeSessionToken(async()=>{
+consttoken=awaitstorage.getSessionToken();
+consturl=storage.getUrl();
+if(!token){
+output.info("Logging out");
+awaitcommands.forceLogout();
+}elseif(url){
+output.info("Logging in");
+// Should login the user directly if the URL+Token are valid
+awaitcommands.login({ url, token });
+}
+}),
+);
+
 // Since the "onResolveRemoteAuthority:ssh-remote" activation event exists
 // in package.json we're able to perform actions before the authority is
 // resolved by the remote SSH extension.
@@ -409,15 +424,10 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void>{
 // Handle autologin, if not already logged in.
 constcfg=vscode.workspace.getConfiguration();
 if(cfg.get("coder.autologin")===true){
-constdefaultUrl=cfg.get("coder.defaultUrl")||process.env.CODER_URL;
+constdefaultUrl=
+cfg.get<string>("coder.defaultUrl")||process.env.CODER_URL;
 if(defaultUrl){
-vscode.commands.executeCommand(
-"coder.login",
-defaultUrl,
-undefined,
-undefined,
-"true",
-);
+commands.login({url: defaultUrl,autoLogin: true});
 }
 }
 }

src/remote.ts

@@ -239,12 +239,7 @@ export class Remote{
 awaitthis.closeRemote();
 }else{
 // Log in then try again.
-awaitvscode.commands.executeCommand(
-"coder.login",
-baseUrlRaw,
-undefined,
-parts.label,
-);
+awaitthis.commands.login({url: baseUrlRaw,label: parts.label});
 awaitthis.setup(remoteAuthority,firstConnect);
 }
 return;
@@ -361,12 +356,7 @@ export class Remote{
 if(!result){
 awaitthis.closeRemote();
 }else{
-awaitvscode.commands.executeCommand(
-"coder.login",
-baseUrlRaw,
-undefined,
-parts.label,
-);
+awaitthis.commands.login({url: baseUrlRaw,label: parts.label});
 awaitthis.setup(remoteAuthority,firstConnect);
 }
 return;

src/storage.ts

@@ -115,6 +115,19 @@ export class Storage{
 }
 }
 
+/**
+ * Subscribe to changes to the session token which can be used to indicate user login status.
+ */
+publiconDidChangeSessionToken(
+listener: ()=>Promise<void>,
+): vscode.Disposable{
+returnthis.secrets.onDidChange((e)=>{
+if(e.key==="sessionToken"){
+listener();
+}
+});
+}
+
 /**
  * Returns the log path for the "Remote - SSH" output panel. There is no VS
  * Code API to get the contents of an output panel. We use this to get the